Merge pull request #89 from ferishili/500-issue-77

 Add help infos and tabs descriptions in simple and advanced upload pages (v 5.x)

Author: bluetom

classes/local/advancedupload_field.php

@@ -77,6 +77,11 @@ class advancedupload_field {
      */
     private $subfields = [];
 
+    /**
+     * @var string Field description.
+     */
+    private $description = null;
+
     /**
      * Constructor to set field properties.
      *
@@ -251,4 +256,22 @@ public function set_subfield(advancedupload_field $subfield): void {
     public function get_subfields(): array {
         return $this->subfields;
     }
+
+    /**
+     * Get the field description.
+     *
+     * @return ?string
+     */
+    public function get_description(): ?string {
+        return $this->description;
+    }
+
+    /**
+     * Set the field description.
+     *
+     * @param string $description
+     */
+    public function set_description(string $description): void {
+        $this->description = $description;
+    }
 }

classes/local/upload_helper.php

@@ -188,7 +188,13 @@ private static function convert_metadatacatalog(
         if (!empty($additionalattr)) {
             $attributes = array_merge($additionalattr, $attributes);
         }
-        return new advancedupload_field($datatype, $id, $label, $params, $attributes, $default, $required);
+
+        $advanceduploadfield = new advancedupload_field($datatype, $id, $label, $params, $attributes, $default, $required);
+
+        if (!empty($field->description)) {
+            $advanceduploadfield->set_description($field->description);
+        }
+        return $advanceduploadfield;
     }
 
     /**

classes/output/renderer.php

@@ -248,13 +248,19 @@ public function render_advanced_upload_form_tab_field(
                 "$CFG->dirroot/local/chunkupload/classes/chunkupload_form_element.php",
                 'local_chunkupload\chunkupload_form_element');
         }
-        $mform->addElement(
+        $element = $mform->addElement(
             $field->get_datatype(),
             $field->get_id(),
             $field->get_label(),
             $field->get_params(),
             $attributes
         );
+        if (!empty($field->get_description())) {
+            $mainrenderer = $this->page->get_renderer('tool_opencast');
+            $element->_helpbutton = $mainrenderer->render_help_icon_with_custom_text(
+                $field->get_label(), $field->get_description()
+            );
+        }
         if (!empty($field->get_default())) {
             $mform->setDefault($field->get_id(), $field->get_default());
         }
@@ -288,4 +294,18 @@ public function render_advanced_upload_form_tab_field(
             }
         }
     }
+
+    /**
+     * Renders a description for a tab in the advanced upload form.
+     *
+     * Adds the provided description as a paragraph element to the Moodle form.
+     *
+     * @param MoodleQuickForm $mform The Moodle form object.
+     * @param string $description The description text to display.
+     * @return void
+     */
+    public function render_tab_description(MoodleQuickForm &$mform, string $description): void {
+        $tabdescription = html_writer::tag('p', $description, ['class' => 'pb-2']);
+        $mform->addElement('html', $tabdescription);
+    }
 }

lang/en/opencast.php

@@ -152,6 +152,7 @@
 $string['uploadform_inplace_edit_visibility_hidden'] = 'Make it hidden!';
 $string['uploadform_ocinstancesselect'] = 'Opencast Instance';
 $string['uploadform_visibility'] = 'Visibility';
+$string['uploadform_visibility_help'] = 'Set whether students in this course can view the video or keep it hidden from them.';
 $string['uploadform_seriessselect'] = 'Series';
 $string['uploadform_submit'] = 'Upload now!';
 $string['uploadform_subtitle_field_enabled'] = 'Enable upload field';
@@ -170,9 +171,15 @@
 $string['uploadtitledisplay'] = 'Upload video:';
 $string['videotitle'] = 'Video title';
 $string['uploadform_tab_metadata'] = 'Video Metadata';
+$string['uploadform_tab_metadata_desc'] = 'Set metadata fields for your video. These details will be saved with the upload.';
 $string['uploadform_tab_presentation'] = 'Presentation Upload';
+$string['uploadform_tab_presentation_desc'] = 'Optionally upload a presentation file with your video.';
 $string['uploadform_tab_visibility'] = 'Video Visibility';
+$string['uploadform_tab_visibility_desc'] = 'Set the initial visibility for your video before uploading.';
 $string['uploadform_tab_processing'] = 'Processing Settings';
+$string['uploadform_tab_processing_desc'] = 'The following settings options are available to customized the upload process according to your likings.';
 $string['uploadform_tab_subtitle'] = 'Subtitles Upload';
+$string['uploadform_tab_subtitle_desc'] = 'Upload subtitle files for each language to enable captions.';
 $string['uploadform_presentation_upload'] = 'Presentation file';
+$string['uploadform_processing_options_general_help'] = 'Choose extra processing options for your upload. For example, "Straight to publishing" will publish the video immediately. Contact your administrator for details about available options';
 $string['uploaddeactivatedadvancedmode'] = 'Advanced mode is deactivated for this Opencast instance, please contact your system administrator.';

styles.css

@@ -110,3 +110,16 @@ body.path-mod-opencast .mod-opencast-paella-player {
 .form-filetypes-descriptions li .text-dark {
     font-size: 12px;
 }
+
+#mod-opencast-simple-upload-page .form-control-static {
+    align-self: center;
+}
+
+#mod-opencast-simple-upload-page .fitem {
+    padding-top: calc(0.375rem + 1px);
+    padding-bottom: calc(0.375rem + 1px);
+}
+
+#mod-opencast-simple-upload-page .fitem .col-form-label {
+    padding-top: 0px;
+}

uploadvideo_form.php

@@ -54,13 +54,15 @@ class mod_opencast_uploadvideo_form extends moodleform {
      * Defines forms elements
      */
     public function definition() {
+        global $PAGE;
         $cmid = $this->_customdata['cmid'];
         $ocmoduleinstance = $this->_customdata['moduleinstance'];
         $uploadoptions = json_decode($ocmoduleinstance->uploadoptionsjson);
         $simpleuploaddata = mod_upload_helper::get_simple_upload_form_data($ocmoduleinstance, $cmid);
         $ocinstanceformdata = $simpleuploaddata['ocinstanceformdata'];
         $defaultocinstance = (int) $uploadoptions->selectedocinstanceid;
         $ocinstancesoptions = $uploadoptions->options;
+        $mainrenderer = $PAGE->get_renderer('tool_opencast');
 
         $mform = $this->_form;
 
@@ -116,7 +118,7 @@ public function definition() {
                 foreach ($formdata->metadatacatalogs as $field) {
                     $elementid = "{$field->name}_{$formdata->ocinstanceid}";
                     $value = (isset($field->userdefault) ? $field->userdefault : null);
-                    $lbltext = $this->try_get_string($field->name, 'block_opencast');
+                    $lbltext = $this->try_get_string($field->name, 'tool_opencast');
 
                     if (!empty($ocinstancesoptions?->{$formdata->ocinstanceid}?->metadata?->{$field->name}->value)) {
                         $value = $ocinstancesoptions->{$formdata->ocinstanceid}->metadata->{$field->name}->value;
@@ -156,13 +158,20 @@ public function definition() {
                     }
 
                     if (!empty($inplaceobjhtml)) {
-                        $mform->addElement(
+                        $element = $mform->addElement(
                             'static',
                             $elementid,
                             $lbltext,
                             $inplaceobjhtml
                         );
                         $this->set_element_toggles($mform, $elementid, $formdata->ocinstanceid);
+
+                        // Check if the description is set for the field, to display it as help icon.
+                        if (isset($field->description) && !empty($field->description)) {
+                            // Use the renderer to generate a help icon with custom text.
+                            $element->_helpbutton = $mainrenderer->render_help_icon_with_custom_text(
+                                $this->try_get_string($field->name, 'tool_opencast'), $field->description);
+                        }
                     }
 
                     // We record the required metadata fields to verify them later on.
@@ -187,12 +196,14 @@ public function definition() {
                 }
                 $inplaceobj = new inplace_edit_toggle_visibility($inplvisibilitydata);
                 $inplaceobjhtml = mod_upload_helper::render_inplace_editable_object($inplaceobj);
-                $mform->addElement(
+                $element = $mform->addElement(
                     'static',
                     $elementid,
                     $lbltext,
                     $inplaceobjhtml
                 );
+                $visibilityhelp = get_string('uploadform_visibility_help', 'mod_opencast');
+                $element->_helpbutton = $mainrenderer->render_help_icon_with_custom_text($lbltext, $visibilityhelp);
                 $this->set_element_toggles($mform, $elementid, $formdata->ocinstanceid);
             }
 
@@ -229,12 +240,16 @@ public function definition() {
                         }
                         if (!empty($inplaceobj)) {
                             $inplaceobjhtml = mod_upload_helper::render_inplace_editable_object($inplaceobj);
-                            $mform->addElement(
+                            $element = $mform->addElement(
                                 'static',
                                 $elementid,
                                 $lbltext,
                                 $inplaceobjhtml
                             );
+                            $processingoptionsdesc = get_string('uploadform_processing_options_general_help', 'mod_opencast');
+                            $element->_helpbutton = $mainrenderer->render_help_icon_with_custom_text(
+                                $lbltext, $processingoptionsdesc
+                            );
                             $this->set_element_toggles($mform, $elementid, $formdata->ocinstanceid);
                         }
                     }
@@ -252,6 +267,8 @@ public function definition() {
         $mform->addElement('hidden', 'cmid', $cmid);
         $mform->setType('cmid', PARAM_INT);
 
+        $mform->setAttributes(['id' => 'mod-opencast-simple-upload-page'] + $mform->getAttributes());
+
         $mform->closeHeaderBefore('buttonar');
         $this->add_action_buttons(true, get_string('uploadform_submit', 'mod_opencast'));
     }

uploadvideoadvanced_form.php

@@ -71,8 +71,13 @@ public function definition() {
             // Make sure the first tab is marked activated.
             $renderer->tab_pane_start($mform, $tabid, ($tabindex == 0), true);
 
-            // Here we look for the values already set in the uploadoptionsjson.
+            // Here we add some helper texts and information regarding each tab if the string exists.
+            $tabdescriptionstringid = "uploadform_tab_{$tabid}_desc";
+            if (get_string_manager()->string_exists($tabdescriptionstringid, 'mod_opencast')) {
+                $renderer->render_tab_description($mform, get_string($tabdescriptionstringid, 'mod_opencast'));
+            }
 
+            // Here we look for the values already set in the uploadoptionsjson.
             foreach ($tabcontent as $field) {
                 // Add default title to the metadata field when it is set.
                 if ($field->get_id() === mod_upload_helper::METADATA_ID_PREFIX . 'title') {