mirror of
https://github.com/moodle/moodle.git
synced 2025-01-19 06:18:28 +01:00
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
78 lines
2.5 KiB
PHP
78 lines
2.5 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/>.
|
|
|
|
/**
|
|
* Used while evaluating conditions in bulk.
|
|
*
|
|
* This object caches get_users_by_capability results in case they are needed
|
|
* by multiple conditions.
|
|
*
|
|
* @package core_availability
|
|
* @copyright 2014 The Open University
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
namespace core_availability;
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
/**
|
|
* Used while evaluating conditions in bulk.
|
|
*
|
|
* This object caches get_users_by_capability results in case they are needed
|
|
* by multiple conditions.
|
|
*
|
|
* @package core_availability
|
|
* @copyright 2014 The Open University
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class capability_checker {
|
|
/** @var \context Course or module context */
|
|
protected $context;
|
|
|
|
/** @var array Associative array of capability => result */
|
|
protected $cache = array();
|
|
|
|
/**
|
|
* Constructs for given context.
|
|
*
|
|
* @param \context $context Context
|
|
*/
|
|
public function __construct(\context $context) {
|
|
$this->context = $context;
|
|
}
|
|
|
|
/**
|
|
* Gets users on course who have the specified capability. Returns an array
|
|
* of user objects which only contain the 'id' field. If the same capability
|
|
* has already been checked (e.g. by another condition) then a cached
|
|
* result will be used.
|
|
*
|
|
* More fields are not necessary because this code is only used to filter
|
|
* users from an existing list.
|
|
*
|
|
* @param string $capability Required capability
|
|
* @return array Associative array of user id => objects containing only id
|
|
*/
|
|
public function get_users_by_capability($capability) {
|
|
if (!array_key_exists($capability, $this->cache)) {
|
|
$this->cache[$capability] = get_users_by_capability(
|
|
$this->context, $capability, 'u.id');
|
|
}
|
|
return $this->cache[$capability];
|
|
}
|
|
}
|