Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/availability/condition/group/classes/ -> condition.php (source)

[Source view]

Differences Between: [Versions 39 and 401]

Condition main class.

Copyright: 2014 The Open University
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 291 lines (11 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

condition:: (13 methods):
  __construct()
  save()
  is_available()
  get_description()
  get_debug_string()
  include_after_restore()
  update_after_restore()
  update_dependency_id()
  wipe_static_cache()
  is_applied_to_user_lists()
  filter_user_list()
  get_json()
  get_user_list_sql()


Class: condition  - X-Ref

Condition main class.

__construct($structure)   X-Ref
Constructor.

param: \stdClass $structure Data structure from JSON decode

save()   X-Ref
No description

is_available($not, \core_availability\info $info, $grabthelot, $userid)   X-Ref
No description

get_description($full, $not, \core_availability\info $info)   X-Ref
No description

get_debug_string()   X-Ref
No description

include_after_restore($restoreid, $courseid, \base_logger $logger,$name, \base_task $task)   X-Ref
Include this condition only if we are including groups in restore, or
if it's a generic 'same activity' one.

param: int $restoreid The restore Id.
param: int $courseid The ID of the course.
param: base_logger $logger The logger being used.
param: string $name Name of item being restored.
param: base_task $task The task being performed.
return: Integer groupid

update_after_restore($restoreid, $courseid, \base_logger $logger, $name)   X-Ref
No description

update_dependency_id($table, $oldid, $newid)   X-Ref
No description

wipe_static_cache()   X-Ref
Wipes the static cache used to store grouping names.


is_applied_to_user_lists()   X-Ref
No description

filter_user_list(array $users, $not, \core_availability\info $info,\core_availability\capability_checker $checker)   X-Ref
No description

get_json($groupid = 0)   X-Ref
Returns a JSON object which corresponds to a condition of this type.

Intended for unit testing, as normally the JSON values are constructed
by JavaScript code.

param: int $groupid Required group id (0 = any group)
return: stdClass Object representing condition

get_user_list_sql($not, \core_availability\info $info, $onlyactive)   X-Ref
No description