MDL-75759 courseformat: fix documentation of stateupdates tests
This commit is contained in:
committed by
Jun Pataleta
parent
dbf67c06bb
commit
e43fef8fc9
+3
-3
@@ -72,14 +72,14 @@ class update_course extends external_api {
|
||||
|
||||
/**
|
||||
* This webservice will execute any action from the course editor. The default actions
|
||||
* are located in core_course\stateactions but the format plugin can extend that class
|
||||
* are located in core_courseformat\stateactions but the format plugin can extend that class
|
||||
* in format_XXX\course.
|
||||
*
|
||||
* The specific action methods will register in a core_course\stateupdates all the affected
|
||||
* The specific action methods will register in a core_courseformat\stateupdates all the affected
|
||||
* sections, cms and course attribute. This object (in JSON) will be send back to the
|
||||
* frontend editor to refresh the updated state elements.
|
||||
*
|
||||
* By default, core_course\stateupdates will register only create, delete and update events
|
||||
* By default, core_courseformat\stateupdates will register only create, delete and update events
|
||||
* on cms, sections and the general course data. However, if some plugin needs adhoc messages for
|
||||
* its own mutation module, it extend this class in format_XXX\course.
|
||||
*
|
||||
|
||||
@@ -31,7 +31,7 @@ use JsonSerializable;
|
||||
* Each format plugin could extend this class to provide new updates to the frontend
|
||||
* mutation module.
|
||||
* Extended classes should be locate in "format_XXX\course" namespace and
|
||||
* extends core_course\stateupdates.
|
||||
* extends core_courseformat\stateupdates.
|
||||
*
|
||||
* @package core_course
|
||||
* @copyright 2021 Ferran Recio <[email protected]>
|
||||
|
||||
@@ -22,7 +22,7 @@ use stdClass;
|
||||
/**
|
||||
* Tests for the stateactions class.
|
||||
*
|
||||
* @package core_course
|
||||
* @package core_courseformat
|
||||
* @category test
|
||||
* @copyright 2021 Sara Arjona ([email protected])
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
|
||||
@@ -19,13 +19,13 @@ namespace core_courseformat;
|
||||
use stdClass;
|
||||
|
||||
/**
|
||||
* Tests for the stateactions class.
|
||||
* Tests for the stateupdates class.
|
||||
*
|
||||
* @package core_course
|
||||
* @package core_courseformat
|
||||
* @category test
|
||||
* @copyright 2021 Sara Arjona ([email protected])
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
* @coversDefaultClass \core_course\stateactions
|
||||
* @coversDefaultClass \core_courseformat\stateupdates
|
||||
*/
|
||||
class stateupdates_test extends \advanced_testcase {
|
||||
|
||||
@@ -128,9 +128,9 @@ class stateupdates_test extends \advanced_testcase {
|
||||
* Add track about a section state update.
|
||||
*
|
||||
* @dataProvider add_section_provider
|
||||
* @covers ::add_course_put
|
||||
* @covers ::add_course_create
|
||||
* @covers ::add_course_delete
|
||||
* @covers ::add_section_create
|
||||
* @covers ::add_section_remove
|
||||
* @covers ::add_section_put
|
||||
*
|
||||
* @param string $action the action name
|
||||
* @param string $role the user role name
|
||||
@@ -242,10 +242,10 @@ class stateupdates_test extends \advanced_testcase {
|
||||
|
||||
|
||||
/**
|
||||
* Add track about a section state update.
|
||||
* Add track about a course module state update.
|
||||
*
|
||||
* @dataProvider add_cm_provider
|
||||
* @covers ::add_cm_update
|
||||
* @covers ::add_cm_put
|
||||
* @covers ::add_cm_create
|
||||
* @covers ::add_cm_remove
|
||||
*
|
||||
@@ -339,7 +339,7 @@ class stateupdates_test extends \advanced_testcase {
|
||||
}
|
||||
|
||||
/**
|
||||
* Data provider for test_add_section.
|
||||
* Data provider for test_add_cm.
|
||||
*
|
||||
* @return array testing scenarios
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user