Add possibility to sort videos by title

classes/local/apibridge.php

@@ -70,11 +70,18 @@ public static function get_instance($ocinstanceid, $forcenewinstance = false) {
     /**
      * Get all events in the specified series.
      * @param string $seriesid
+     * @param int|null $sortseriesby 1 for sorting by title. Everything else for sorting by date.
      * @return false|mixed
      */
-    public function get_episodes_in_series($seriesid) {
+    public function get_episodes_in_series($seriesid, int|null $sortseriesby = null) {
+
+        $sortstring = 'start_date:DESC,title:ASC';
+        if ($sortseriesby == 1) {
+            $sortstring = 'title:ASC,start_date:DESC';
+        }
+
         $api = new api($this->ocinstanceid);
-        $resource = "/api/events?filter=is_part_of:$seriesid&withpublications=true&sort=start_date:DESC,title:ASC&sign=true";
+        $resource = "/api/events?filter=is_part_of:$seriesid&withpublications=true&sort=$sortstring&sign=true";
         $response = $api->oc_get($resource);
 
         if ($api->get_http_code() != 200) {

classes/local/output_helper.php

@@ -41,16 +41,19 @@ class output_helper {
 
     /**
      * Prints output for series view.
-     * @param int $ocinstanceid Opencast instance id
-     * @param string $seriesid opencast id of series.
-     * @param string $activityname name of Activity.
+     * @param stdClass $moduleinstance
      * @throws \coding_exception
      */
-    public static function output_series($ocinstanceid, $seriesid, $activityname): void {
+    public static function output_series(stdClass $moduleinstance): void {
         global $OUTPUT, $PAGE;
 
+        $ocinstanceid = $moduleinstance->ocinstanceid;
+        $seriesid = $moduleinstance->opencastid;
+        $activityname = $moduleinstance->name;
+        $sortseriesby = $moduleinstance->sortseriesby;
+
         $api = apibridge::get_instance($ocinstanceid);
-        $response = $api->get_episodes_in_series($seriesid);
+        $response = $api->get_episodes_in_series($seriesid, $sortseriesby);
 
         if ($response === false) {
             throw new \exception('There was a problem reaching opencast!');

db/install.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<XMLDB PATH="mod/opencast/db" VERSION="20230523" COMMENT="XMLDB file for Moodle mod_opencast"
+<XMLDB PATH="mod/opencast/db" VERSION="20231009" COMMENT="XMLDB file for Moodle mod_opencast"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:noNamespaceSchemaLocation="../../../lib/xmldb/xmldb.xsd"
 >
@@ -19,6 +19,7 @@
         <FIELD NAME="type" TYPE="int" LENGTH="4" NOTNULL="true" DEFAULT="0" SEQUENCE="false" COMMENT="The type of instance. See opencasttype"/>
         <FIELD NAME="ocinstanceid" TYPE="int" LENGTH="10" NOTNULL="true" SEQUENCE="false"/>
         <FIELD NAME="allowdownload" TYPE="int" LENGTH="1" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
+        <FIELD NAME="sortseriesby" TYPE="int" LENGTH="2" NOTNULL="false" SEQUENCE="false" COMMENT="1 = title, 0 / null = upload date."/>
       </FIELDS>
       <KEYS>
         <KEY NAME="primary" TYPE="primary" FIELDS="id"/>

db/upgrade.php

@@ -122,5 +122,20 @@ function xmldb_opencast_upgrade($oldversion) {
         upgrade_mod_savepoint(true, 2023052300, 'opencast');
     }
 
+    if ($oldversion < 2023100900) {
+
+        // Define field sortseriesby to be added to opencast.
+        $table = new xmldb_table('opencast');
+        $field = new xmldb_field('sortseriesby', XMLDB_TYPE_INTEGER, '2', null, null, null, null, 'allowdownload');
+
+        // Conditionally launch add field sortseriesby.
+        if (!$dbman->field_exists($table, $field)) {
+            $dbman->add_field($table, $field);
+        }
+
+        // Opencast savepoint reached.
+        upgrade_mod_savepoint(true, 2023100900, 'opencast');
+    }
+
     return true;
 }

lang/en/opencast.php

@@ -92,3 +92,10 @@
 $string['uploadinprogress'] = 'Uploading video ({$a}) is in progress, please try again later.';
 $string['uploadedvideoisbeingprocesses'] = 'This video ({$a}) is already uploaded and is being processed by Opencast, please wait!';
 $string['uploadjobmissing'] = 'There was an error fetching upload data for this video, please try uploading a new one. Due to insufficient data this module is deleted.';
+
+// Strings for mod form.
+$string['sortseriesby'] = 'Order videos by';
+$string['sortseriesby_help'] = 'Only affects series';
+$string['uploaddate'] = 'Upload date';
+$string['videotitle'] = 'Video title';
+$string['advancedsettings'] = 'Advanced settings';

mod_form.php

@@ -123,6 +123,14 @@ public function definition() {
                 $mform->setType('allowdownload', PARAM_INT);
                 $mform->setDefault('allowdownload', get_config('mod_opencast', 'download_default_' . $ocinstanceid));
             }
+
+            $mform->addElement('header', 'advancedsettings', get_string('advancedsettings', 'mod_opencast'));
+
+            $mform->addElement('select', 'sortseriesby', get_string('sortseriesby', 'mod_opencast'), [
+                    0 => get_string('uploaddate', 'mod_opencast'),
+                    1 => get_string('videotitle', 'mod_opencast')
+            ]);
+            $mform->addHelpButton('sortseriesby', 'sortseriesby', 'mod_opencast');
         }
 
         $mform->addElement('hidden', 'type');

version.php

@@ -26,7 +26,7 @@
 
 $plugin->component = 'mod_opencast';
 $plugin->release = 'development-version';
-$plugin->version = 2023052300;
+$plugin->version = 2023100900;
 $plugin->requires = 2020061500; // Requires Moodle 3.9+.
 $plugin->maturity = MATURITY_ALPHA;
 $plugin->dependencies = array(

view.php

@@ -92,7 +92,7 @@
     if ($episode) {
         output_helper::output_episode($moduleinstance->ocinstanceid, $episode, $moduleinstance->id, $moduleinstance->opencastid);
     } else {
-        output_helper::output_series($moduleinstance->ocinstanceid, $moduleinstance->opencastid, $moduleinstance->name);
+        output_helper::output_series($moduleinstance);
     }
 } else if ($moduleinstance->type == opencasttype::UPLOAD) {
     // Redirect to the upload video page in the mod_opencast by default.