MDL-59241 mod_workshop: Fix testing found issues
authorJuan Leyva <juanleyvadelgado@gmail.com>
Wed, 4 Oct 2017 11:09:59 +0000 (13:09 +0200)
committerEloy Lafuente (stronk7) <stronk7@moodle.org>
Wed, 4 Oct 2017 18:23:02 +0000 (20:23 +0200)
- totalfilesize counting all submissions
- Improved function documentation

mod/workshop/classes/external.php
mod/workshop/db/services.php

index 56bf244..773fb0b 100644 (file)
@@ -782,7 +782,8 @@ class mod_workshop_external extends external_api {
     }
 
     /**
-     * Retrieves all the workshop submissions visible by the current user or the one done by the given user.
+     * Retrieves all the workshop submissions visible by the current user or the one done by the given user
+     * (except example submissions).
      *
      * @param int $workshopid       the workshop instance id
      * @param int $userid           get submissions done by this user
@@ -847,7 +848,7 @@ class mod_workshop_external extends external_api {
             $fs = get_file_storage();
             $files = $fs->get_area_files($context->id, 'mod_workshop', array('submission_content', 'submission_attachment'));
             foreach ($files as $file) {
-                if ($file->is_directory() || !isset($submissionsrecords[$file->get_itemid()])) {
+                if ($file->is_directory()) {
                     continue;
                 }
                 $totalfilesize += $file->get_filesize();
@@ -874,7 +875,8 @@ class mod_workshop_external extends external_api {
                     submission_exporter::get_read_structure()
                 ),
                 'totalcount' => new external_value(PARAM_INT, 'Total count of submissions.'),
-                'totalfilesize' => new external_value(PARAM_INT, 'Total size (bytes) of the files included in the submissions.'),
+                'totalfilesize' => new external_value(PARAM_INT, 'Total size (bytes) of the files attached to all the
+                    submissions (even the ones not returned due to pagination).'),
                 'warnings' => new external_warnings()
             )
         );
index bbe4a90..c17640a 100644 (file)
@@ -88,7 +88,7 @@ $functions = array(
     'mod_workshop_get_submissions' => array(
         'classname'     => 'mod_workshop_external',
         'methodname'    => 'get_submissions',
-        'description'   => 'Retrieves all the workshop submissions or the one done by the given user.',
+        'description'   => 'Retrieves all the workshop submissions or the one done by the given user (except example submissions).',
         'type'          => 'read',
         'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
     ),