Skip to content

Commit

Permalink
MDL-41219 course: Make properties of course_modinfo read-only
Browse files Browse the repository at this point in the history 
added phpdocs and unittests
  • Loading branch information
@marinaglancy
marinaglancy committed Sep 10, 2013
1 parent cbd6b1f commit 44ddd2a
Show file tree
Hide file tree
Showing 5 changed files with 214 additions and 60 deletions.
177 changes: 128 additions & 49 deletions lib/modinfolib.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,69 +39,140 @@
*
* This includes information about the course-modules and the sections on the course. It can also
* include dynamic data that has been updated for the current user.
*
* Use {@link get_fast_modinfo()} to retrieve the instance of the object for particular course
* and particular user.
*
* @property-read int $courseid Course ID
* @property-read int $userid User ID
* @property-read array $sections Array from section number (e.g. 0) to array of course-module IDs in that
* section; this only includes sections that contain at least one course-module
* @property-read cm_info[] $cms Array from course-module instance to cm_info object within this course, in
* order of appearance
* @property-read cm_info[][] $instances Array from string (modname) => int (instance id) => cm_info object
* @property-read array $groups Groups that the current user belongs to. Calculated on the first request.
* Is an array of grouping id => array of group id => group id. Includes grouping id 0 for 'all groups'
*/
class course_modinfo extends stdClass {
// For convenience we store the course object here as it is needed in other parts of code
class course_modinfo {
/**
* For convenience we store the course object here as it is needed in other parts of code
* @var stdClass
*/
private $course;
// Array of section data from cache
private $sectioninfo;

// Existing data fields
///////////////////////

// These are public for backward compatibility. Note: it is not possible to retain BC
// using PHP magic get methods because behaviour is different with regard to empty().

/**
* Course ID
* @var int
* @deprecated For new code, use get_course_id instead.
* Array of section data from cache
* @var section_info[]
*/
public $courseid;
private $sectioninfo;

/**
* User ID
* @var int
* @deprecated For new code, use get_user_id instead.
*/
public $userid;
private $userid;

/**
* Array from int (section num, e.g. 0) => array of int (course-module id); this list only
* includes sections that actually contain at least one course-module
* @var array
* @deprecated For new code, use get_sections instead
*/
public $sections;
private $sections;

/**
* Array from int (cm id) => cm_info object
* @var array
* @deprecated For new code, use get_cms or get_cm instead.
* @var cm_info[]
*/
public $cms;
private $cms;

/**
* Array from string (modname) => int (instance id) => cm_info object
* @var array
* @deprecated For new code, use get_instances or get_instances_of instead.
* @var cm_info[][]
*/
public $instances;
private $instances;

/**
* Groups that the current user belongs to. This value is usually not available (set to null)
* unless the course has activities set to groupmembersonly. When set, it is an array of
* grouping id => array of group id => group id. Includes grouping id 0 for 'all groups'.
* @var int[][]
*/
private $groups;

/**
* List of class read-only properties and their getter methods.
* Used by magic functions __get(), __isset(), __empty()
* @var array
* @deprecated Don't use this! For new code, use get_groups.
*/
public $groups;
private static $standardproperties = array(
'courseid' => 'get_course_id',
'userid' => 'get_user_id',
'sections' => 'get_sections',
'cms' => 'get_cms',
'instances' => 'get_instances',
'groups' => 'get_groups_all',
);

// Get methods for data
///////////////////////
/**
* Magic method getter
*
* @param string $name
* @return mixed
*/
public function __get($name) {
if (isset(self::$standardproperties[$name])) {
$method = self::$standardproperties[$name];
return $this->$method();
} else {
debugging('Invalid course_modinfo property accessed: '.$name);
return null;
}
}

/**
* @return object Moodle course object that was used to construct this data
* Magic method for function isset()
*
* @param string $name
* @return bool
*/
public function __isset($name) {
if (isset(self::$standardproperties[$name])) {
$value = $this->__get($name);
return isset($value);
}
return false;
}

/**
* Magic method for function empty()
*
* @param string $name
* @return bool
*/
public function __empty($name) {
if (isset(self::$standardproperties[$name])) {
$value = $this->__get($name);
return empty($value);
}
return true;
}

/**
* Magic method setter
*
* Will display the developer warning when trying to set/overwrite existing property.
*
* @param string $name
* @param mixed $value
*/
public function __set($name, $value) {
debugging("It is not allowed to set the property course_modinfo::\${$name}", DEBUG_DEVELOPER);
}

/**
* Returns course object that was used in the first get_fast_modinfo() call.
*
* @return stdClass
*/
public function get_course() {
return $this->course;
Expand All @@ -111,7 +182,7 @@ public function get_course() {
* @return int Course ID
*/
public function get_course_id() {
return $this->courseid;
return $this->course->id;
}

/**
Expand All @@ -130,7 +201,7 @@ public function get_sections() {
}

/**
* @return array Array from course-module instance to cm_info object within this course, in
* @return cm_info[] Array from course-module instance to cm_info object within this course, in
* order of appearance
*/
public function get_cms() {
Expand All @@ -152,7 +223,7 @@ public function get_cm($cmid) {

/**
* Obtains all module instances on this course.
* @return array Array from module name => array from instance id => cm_info
* @return cm_info[][] Array from module name => array from instance id => cm_info
*/
public function get_instances() {
return $this->instances;
Expand All @@ -179,7 +250,7 @@ public function get_used_module_names($plural = false) {
/**
* Obtains all instances of a particular module on this course.
* @param $modname Name of module (not full frankenstyle) e.g. 'label'
* @return array Array from instance id => cm_info for modules on this course; empty if none
* @return cm_info[] Array from instance id => cm_info for modules on this course; empty if none
*/
public function get_instances_of($modname) {
if (empty($this->instances[$modname])) {
Expand All @@ -189,29 +260,38 @@ public function get_instances_of($modname) {
}

/**
* Returns groups that the current user belongs to on the course. Note: If not already
* available, this may make a database query.
* @param int $groupingid Grouping ID or 0 (default) for all groups
* @return array Array of int (group id) => int (same group id again); empty array if none
* Groups that the current user belongs to organised by grouping id. Calculated on the first request.
* @return int[][] array of grouping id => array of group id => group id. Includes grouping id 0 for 'all groups'
*/
public function get_groups($groupingid=0) {
private function get_groups_all() {
if (is_null($this->groups)) {
// NOTE: Performance could be improved here. The system caches user groups
// in $USER->groupmember[$courseid] => array of groupid=>groupid. Unfortunately this
// structure does not include grouping information. It probably could be changed to
// do so, without a significant performance hit on login, thus saving this one query
// each request.
$this->groups = groups_get_user_groups($this->courseid, $this->userid);
$this->groups = groups_get_user_groups($this->course->id, $this->userid);
}
if (!isset($this->groups[$groupingid])) {
return $this->groups;
}

/**
* Returns groups that the current user belongs to on the course. Note: If not already
* available, this may make a database query.
* @param int $groupingid Grouping ID or 0 (default) for all groups
* @return int[] Array of int (group id) => int (same group id again); empty array if none
*/
public function get_groups($groupingid = 0) {
$allgroups = $this->get_groups_all();
if (!isset($allgroups[$groupingid])) {
return array();
}
return $this->groups[$groupingid];
return $allgroups[$groupingid];
}

/**
* Gets all sections as array from section number => data about section.
* @return array Array of section_info objects organised by section number
* @return section_info[] Array of section_info objects organised by section number
*/
public function get_section_info_all() {
return $this->sectioninfo;
Expand Down Expand Up @@ -255,7 +335,6 @@ public function __construct($course, $userid) {
}

// Set initial values
$this->courseid = $course->id;
$this->userid = $userid;
$this->sections = array();
$this->cms = array();
Expand Down Expand Up @@ -315,19 +394,19 @@ public function __construct($course, $userid) {
}

// Loop through each piece of module data, constructing it
$modexists = array();
static $modexists = array();
foreach ($info as $mod) {
if (empty($mod->name)) {
// something is wrong here
continue;
}

// Skip modules which don't exist
if (empty($modexists[$mod->mod])) {
if (!file_exists("$CFG->dirroot/mod/$mod->mod/lib.php")) {
continue;
}
$modexists[$mod->mod] = true;
if (!array_key_exists($mod->mod, $modexists)) {
$modexists[$mod->mod] = file_exists("$CFG->dirroot/mod/$mod->mod/lib.php");
}
if (!$modexists[$mod->mod]) {
continue;
}

// Construct info for this module
Expand Down
82 changes: 82 additions & 0 deletions lib/tests/modinfolib_test.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,88 @@ public function test_cm_info_properties() {
set_config('enablecompletion', $oldcfgenablecompletion);
}

public function test_course_modinfo_properties() {
global $USER, $DB;

$this->resetAfterTest();
$this->setAdminUser();

// Generate the course and some modules. Make one section hidden.
$course = $this->getDataGenerator()->create_course(
array('format' => 'topics',
'numsections' => 3),
array('createsections' => true));
$DB->execute('UPDATE {course_sections} SET visible = 0 WHERE course = ? and section = ?',
array($course->id, 3));
$coursecontext = context_course::instance($course->id);
$forum0 = $this->getDataGenerator()->create_module('forum',
array('course' => $course->id), array('section' => 0));
$assign0 = $this->getDataGenerator()->create_module('assign',
array('course' => $course->id), array('section' => 0, 'visible' => 0));
$forum1 = $this->getDataGenerator()->create_module('forum',
array('course' => $course->id), array('section' => 1));
$assign1 = $this->getDataGenerator()->create_module('assign',
array('course' => $course->id), array('section' => 1));
$page1 = $this->getDataGenerator()->create_module('page',
array('course' => $course->id), array('section' => 1));
$page3 = $this->getDataGenerator()->create_module('page',
array('course' => $course->id), array('section' => 3));

$modinfo = get_fast_modinfo($course->id);

$this->assertEquals(array($forum0->cmid, $assign0->cmid, $forum1->cmid, $assign1->cmid, $page1->cmid, $page3->cmid),
array_keys($modinfo->cms));
$this->assertEquals($course->id, $modinfo->courseid);
$this->assertEquals($USER->id, $modinfo->userid);
$this->assertEquals(array(0 => array($forum0->cmid, $assign0->cmid),
1 => array($forum1->cmid, $assign1->cmid, $page1->cmid), 3 => array($page3->cmid)), $modinfo->sections);
$this->assertEquals(array('forum', 'assign', 'page'), array_keys($modinfo->instances));
$this->assertEquals(array($assign0->id, $assign1->id), array_keys($modinfo->instances['assign']));
$this->assertEquals(array($forum0->id, $forum1->id), array_keys($modinfo->instances['forum']));
$this->assertEquals(array($page1->id, $page3->id), array_keys($modinfo->instances['page']));
$this->assertEquals(groups_get_user_groups($course->id), $modinfo->groups);
$this->assertEquals(array(0 => array($forum0->cmid, $assign0->cmid),
1 => array($forum1->cmid, $assign1->cmid, $page1->cmid),
3 => array($page3->cmid)), $modinfo->get_sections());
$this->assertEquals(array(0, 1, 2, 3), array_keys($modinfo->get_section_info_all()));
$this->assertEquals($forum0->cmid . ',' . $assign0->cmid, $modinfo->get_section_info(0)->sequence);
$this->assertEquals($forum1->cmid . ',' . $assign1->cmid . ',' . $page1->cmid, $modinfo->get_section_info(1)->sequence);
$this->assertEquals('', $modinfo->get_section_info(2)->sequence);
$this->assertEquals($page3->cmid, $modinfo->get_section_info(3)->sequence);
$this->assertEquals($course->id, $modinfo->get_course()->id);
$this->assertEquals(array('assign', 'forum', 'page'),
array_keys($modinfo->get_used_module_names()));
$this->assertEquals(array('assign', 'forum', 'page'),
array_keys($modinfo->get_used_module_names(true)));
// Admin can see hidden modules/sections.
$this->assertTrue($modinfo->cms[$assign0->cmid]->uservisible);
$this->assertTrue($modinfo->get_section_info(3)->uservisible);

// Get modinfo for non-current user (without capability to view hidden activities/sections).
$user = $this->getDataGenerator()->create_user();
$modinfo = get_fast_modinfo($course->id, $user->id);
$this->assertEquals($user->id, $modinfo->userid);
$this->assertFalse($modinfo->cms[$assign0->cmid]->uservisible);
$this->assertFalse($modinfo->get_section_info(3)->uservisible);

// Attempt to access and set non-existing field.
$this->assertTrue(empty($modinfo->somefield));
$this->assertFalse(isset($modinfo->somefield));
$modinfo->somefield;
$this->assertDebuggingCalled();
$modinfo->somefield = 'Some value';
$this->assertDebuggingCalled();
$this->assertEmpty($modinfo->somefield);
$this->assertDebuggingCalled();

// Attempt to overwrite existing field.
$this->assertFalse(empty($modinfo->cms));
$this->assertTrue(isset($modinfo->cms));
$modinfo->cms = 'Illegal overwriting';
$this->assertDebuggingCalled();
$this->assertNotEquals('Illegal overwriting', $modinfo->cms);
}

/**
* Test is_user_access_restricted_by_group()
*
Expand Down
1 change: 1 addition & 0 deletions lib/upgrade.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ information provided here is intended especially for developers.
to report progress during long operations. Related to this, zip_archive now supports an estimated_count()
function that returns an approximate number of entries in the zip faster than the count() function.
* Class cm_info no longer extends stdClass. All properties are read-only and calculated on first request only.
* Class course_modinfo no longer extends stdClass. All properties are read-only.

DEPRECATIONS:
Various previously deprecated functions have now been altered to throw DEBUG_DEVELOPER debugging notices
Expand Down
Loading

0 comments on commit 44ddd2a

Please sign in to comment.