|
| __construct ($structure, $lax=false, $root=true) |
| Decodes availability structure.
|
|
| __toString () |
| Display a representation of this tree (used for debugging).
|
|
| check_available ($not, info $info, $grabthelot, $userid) |
|
| check_available ($not, core_availability\info $info, $grabthelot, $userid) |
| Determines whether this particular item is currently available according to the availability criteria.
|
|
| filter_user_list (array $users, $not, info $info, capability_checker $checker) |
| Tests against a user list.
|
|
| filter_user_list (array $users, $not, core_availability\info $info, capability_checker $checker) |
| Tests this condition against a user list.
|
|
| get_all_children ($classname) |
| Recursively gets all children of a particular class (you can use a base class to get all conditions, or a specific class).
|
|
| get_full_information (info $info) |
| Gets full information about this tree (including all children) as HTML for display to staff.
|
|
| get_logic_flags ($not) |
| Converts the operator for the tree into two flags used for computing the result.
|
|
| get_result_information (info $info, result $result) |
| Gets information about this tree corresponding to the given result object.
|
|
| get_user_list_sql ($not, info $info, $onlyactive) |
|
| get_user_list_sql ($not, core_availability\info $info, $onlyactive) |
| Obtains SQL that returns a list of enrolled users that has been filtered by the conditions applied in the availability API, similar to calling get_enrolled_users and then filter_user_list.
|
|
| include_after_restore ($restoreid, $courseid, base_logger $logger, $name, base_task $task) |
| Checks whether this node should be included after restore or not.
|
|
| is_applied_to_user_lists () |
| Checks whether this condition applies to user lists.
|
|
| is_available_for_all ($not=false) |
| Checks whether this condition is actually going to be available for all users under normal circumstances.
|
|
| is_empty () |
| Checks whether this tree is empty (contains no children).
|
|
| save () |
| Saves tree data back to a structure object.
|
|
| update_after_restore ($restoreid, $courseid, base_logger $logger, $name) |
| Updates this node after restore, returning true if anything changed.
|
|
| update_dependency_id ($table, $oldid, $newid) |
| Updates this node if it contains any references (dependencies) to the given table and id.
|
|
Class that holds a tree of availability conditions.
The structure of this tree in JSON input data is:
{ op:'&', c:[] }
where 'op' is one of the OP_xx constants and 'c' is an array of children.
At the root level one of the following additional values must be included:
op '|' or '!&' show:true Boolean value controlling whether a failed match causes the item to display to students with information, or be completely hidden. op '&' or '!|' showc:[] Array of same length as c with booleans corresponding to each child; you can make it be hidden or shown depending on which one they fail. (Anything with false takes precedence.)
- Copyright
- 2014 The Open University
- License
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
Determines whether this particular item is currently available according to the availability criteria.
- This does not include the 'visible' setting (i.e. this might return true even if visible is false); visible is handled independently.
- This does not take account of the viewhiddenactivities capability. That should apply later.
The $not option is potentially confusing. This option always indicates the 'real' value of NOT. For example, a condition inside a 'NOT AND' group will get this called with $not = true, but if you put another 'NOT OR' group inside the first group, then a condition inside that will be called with $not = false. We need to use the real values, rather than the more natural use of the current value at this point inside the tree, so that the information displayed to users makes sense.
- Parameters
-
bool | $not | Set true if we are inverting the condition |
core_availability\info | $info | Item we're checking |
bool | $grabthelot | Performance hint: if true, caches information required for all course-modules, to make the front page and similar pages work more quickly (works only for current user) |
int | $userid | User ID to check availability for |
- Return values
-
result | Availability check result |
Tests against a user list.
Users who cannot access the activity due to availability restrictions will be removed from the list.
This test ONLY includes conditions which are marked as being applied to user lists. For example, group conditions are included but date conditions are not included.
The function operates reasonably efficiently i.e. should not do per-user database queries. It is however likely to be fairly slow.
- Parameters
-
array | $users | Array of userid => object |
bool | $not | If tree's parent indicates it's being checked negatively |
info | $info | Info about current context |
capability_checker | $checker | Capability checker |
- Return values
-
array | Filtered version of input array |
Tests this condition against a user list.
Users who do not meet the condition will be removed from the list, unless they have the ability to view hidden activities/sections.
This function must be implemented if is_applied_to_user_lists returns true. Otherwise it will not be called.
The function must operate efficiently, e.g. by using a fixed number of database queries regardless of how many users are in the list.
Within this function, if you need to check capabilities, please use the provided checker which caches results where possible.
Conditions do not need to check the viewhiddenactivities or viewhiddensections capabilities. These are handled by core_availability\info\filter_user_list.
- Parameters
-
array | $users | Array of userid => object |
bool | $not | True if this condition is applying in negative mode |
core_availability\info | $info | Item we're checking |
capability_checker | $checker | |
- Return values
-
array | Filtered version of input array |
- Exceptions
-
static core_availability\tree::get_root_json |
( |
array | $children, |
|
|
| $op = self::OP_AND, |
|
|
| $show = true ) |
|
static |
Returns a JSON object which corresponds to a tree at root level.
Intended for unit testing, as normally the JSON values are constructed by JavaScript code.
The $show parameter can be a boolean for all OP_xx options. For OP_AND and OP_NOT_OR where you have individual show options, you can specify a boolean (same for all) or an array.
- Parameters
-
array | $children | Array of JSON objects from component children |
string | $op | Operator (tree\OP_xx) |
bool | array | $show | Whether 'show' option is turned on (see above) |
- Return values
-
stdClass | JSON object ready for encoding |
- Exceptions
-
Obtains SQL that returns a list of enrolled users that has been filtered by the conditions applied in the availability API, similar to calling get_enrolled_users and then filter_user_list.
As for filter_user_list, this ONLY filters out users with conditions that are marked as applying to user lists. For example, group conditions are included but date conditions are not included.
The returned SQL is a query that returns a list of user IDs. It does not include brackets, so you neeed to add these to make it into a subquery. You would normally use it in an SQL phrase like "WHERE u.id IN ($sql)".
The SQL will be complex and may be slow. It uses named parameters (sorry, I know they are annoying, but it was unavoidable here).
If there are no conditions, the returned result is array('', array()).
Conditions do not need to check the viewhiddenactivities or viewhiddensections capabilities. These are handled by core_availability\info\get_user_list_sql.
- Parameters
-
bool | $not | True if this condition is applying in negative mode |
core_availability\info | $info | Item we're checking |
bool | $onlyactive | If true, only returns active enrolments |
- Return values
-
array | Array with two elements: SQL subquery and parameters array |
- Exceptions
-
core_availability\tree::is_applied_to_user_lists |
( |
| ) |
|
Checks whether this condition applies to user lists.
The default is false (the condition is used to control access, but does not prevent the student from appearing in lists).
For example, group conditions apply to user lists: we do not want to include a student in a list of users if they are prohibited from accessing the activity because they don't belong to a relevant group. However, date conditions do not apply - we still want to show users in a list of people who might have submitted an assignment, even if they are no longer able to access the assignment in question because there is a date restriction.
The general idea is that conditions which are likely to be permanent (group membership, user profile) apply to user lists. Conditions which are likely to be temporary (date, grade requirement) do not.
Conditions which do apply to user lists must implement the filter_user_list function.
- Return values
-
bool | True if this condition applies to user lists |
Reimplemented from core_availability\tree_node.
core_availability\tree::is_available_for_all |
( |
| $not = false | ) |
|
Checks whether this condition is actually going to be available for all users under normal circumstances.
Normally, if there are any conditions, then it may be hidden. However in the case of date conditions there are some conditions which will definitely not result in it being hidden for anyone.
- Parameters
-
bool | $not | Set true if we are inverting the condition |
- Return values
-
bool | True if condition will return available for everyone |
Reimplemented from core_availability\tree_node.
core_availability\tree::update_after_restore |
( |
| $restoreid, |
|
|
| $courseid, |
|
|
base_logger | $logger, |
|
|
| $name ) |
Updates this node after restore, returning true if anything changed.
The default behaviour is simply to return false. If there is a problem with the update, $logger can be used to output a warning.
Note: If you need information about the date offset, call core_availability\info\get_restore_date_offset($restoreid). For information on the restoring task and its settings, call core_availability\info\get_restore_task($restoreid).
- Parameters
-
string | $restoreid | Restore ID |
int | $courseid | ID of target course |
base_logger | $logger | Logger for any warnings |
string | $name | Name of this item (for use in warning messages) |
- Return values
-
bool | True if there was any change |
Reimplemented from core_availability\tree_node.