sam marshall
d3db4b037c
This commit defines the new /availability root folder, with /availability/classes, /availability/tests, and /availability/condition where the condition plugins will live. Condition plugin prefix is availability_, e.g. availability_date. Rationale for this organisation: 1. I was originally going to put this in /lib/availability but it has been pointed out that putting even more junk in lib is probably bad. 2. 'availability' and 'condition' are the two names used in code to refer to this system ($CFG->enableavailability). 3. The prefix has to be short enough to allow database tables (although in practice I assume that condition plugins will not normally contain database tables). The new API includes a Boolean tree structure that controls the availability of an item. AMOS BEGIN CPY [availabilityconditions,core_condition],[restrictaccess,core_availability] CPY [enableavailability,core_condition],[enableavailability,core_availability] CPY [configenableavailability,core_condition],[enableavailability_desc,core_availability] AMOS END
126 lines
4.3 KiB
PHP
126 lines
4.3 KiB
PHP
<?php
|
|
// This file is part of Moodle - http://moodle.org/
|
|
//
|
|
// Moodle is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Moodle is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
/**
|
|
* Mock condition.
|
|
*
|
|
* @package core_availability
|
|
* @copyright 2014 The Open University
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
namespace availability_mock;
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
/**
|
|
* Mock condition.
|
|
*
|
|
* @package core_availability
|
|
* @copyright 2014 The Open University
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class condition extends \core_availability\condition {
|
|
/** @var bool True if available */
|
|
protected $available;
|
|
/** @var string Message if not available */
|
|
protected $message;
|
|
/** @var bool True if available for all (normal state) */
|
|
protected $forall;
|
|
/** @var bool True if available for all (NOT state) */
|
|
protected $forallnot;
|
|
/** @var string Dependency table (empty if none) */
|
|
protected $dependtable;
|
|
/** @var id Dependency id (0 if none) */
|
|
protected $dependid;
|
|
/** @var array Array of user ids for filter results, empty if no filter support */
|
|
protected $filter;
|
|
|
|
/**
|
|
* Constructs a mock condition with given structure.
|
|
*
|
|
* @param \stdClass $structure Structure object
|
|
*/
|
|
public function __construct($structure) {
|
|
$this->available = isset($structure->a) ? $structure->a : false;
|
|
$this->message = isset($structure->m) ? $structure->m : '';
|
|
$this->forall = isset($structure->all) ? $structure->all : false;
|
|
$this->forallnot = isset($structure->allnot) ? $structure->allnot : false;
|
|
$this->dependtable = isset($structure->table) ? $structure->table : '';
|
|
$this->dependid = isset($structure->id) ? $structure->id : 0;
|
|
$this->filter = isset($structure->filter) ? $structure->filter : array();
|
|
}
|
|
|
|
public function save() {
|
|
return (object)array('a' => $this->available, 'm' => $this->message,
|
|
'all' => $this->forall, 'allnot' => $this->forallnot,
|
|
'table' => $this->dependtable, 'id' => $this->dependid,
|
|
'filter' => $this->filter);
|
|
}
|
|
|
|
public function is_available($not, \core_availability\info $info, $grabthelot, $userid) {
|
|
return $not ? !$this->available : $this->available;
|
|
}
|
|
|
|
public function is_available_for_all($not = false) {
|
|
return $not ? $this->forallnot : $this->forall;
|
|
}
|
|
|
|
public function get_description($full, $not, \core_availability\info $info) {
|
|
$fulltext = $full ? '[FULL]' : '';
|
|
$nottext = $not ? '!' : '';
|
|
return $nottext . $fulltext . $this->message;
|
|
}
|
|
|
|
public function get_standalone_description(
|
|
$full, $not, \core_availability\info $info) {
|
|
// Override so that we can spot that this function is used.
|
|
return 'SA: ' . $this->get_description($full, $not, $info);
|
|
}
|
|
|
|
public function update_dependency_id($table, $oldid, $newid) {
|
|
if ($table === $this->dependtable && (int)$oldid === (int)$this->dependid) {
|
|
$this->dependid = $newid;
|
|
return true;
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
protected function get_debug_string() {
|
|
return ($this->available ? 'y' : 'n') . ',' . $this->message;
|
|
}
|
|
|
|
public function is_applied_to_user_lists() {
|
|
return $this->filter;
|
|
}
|
|
|
|
public function filter_user_list(array $users, $not, \core_availability\info $info,
|
|
\core_availability\capability_checker $checker) {
|
|
$result = array();
|
|
foreach ($users as $id => $user) {
|
|
$match = in_array($id, $this->filter);
|
|
if ($not) {
|
|
$match = !$match;
|
|
}
|
|
if ($match) {
|
|
$result[$id] = $user;
|
|
}
|
|
}
|
|
return $result;
|
|
}
|
|
}
|