Moodle APIs  3.8
Moodle 3.8.6 (Build: 20201109)
Files | Namespaces | Classes | Functions | Variables
tool_cohortroles

Files

file  api.php
 Class exposing the api for the cohortroles tool.
 
file  assign_role_cohort.php
 Assign role to cohort form.
 
file  cohort_role_assignment.php
 Class for cohort_role_assignment persistence.
 
file  cohort_role_assignments_table.php
 Cohort role assignments table.
 
file  cohort_role_sync.php
 Scheduled task for syncing cohort roles.
 
file  provider.php
 Privacy Subsystem implementation for tool_cohortroles.
 
file  renderer.php
 Renderer class for cohort roles.
 
file  settings.php
 Link to user roles management.
 
file  tasks.php
 Tasks definitions.
 
file  upgrade.php
 Plugin upgrade code.
 
file  version.php
 Plugin version info.
 

Namespaces

 tool_cohortroles
  
 
 tool_cohortroles\form
  
 
 tool_cohortroles\output
  
 
 tool_cohortroles\privacy
  
 
 tool_cohortroles\task
  
 

Classes

class  tool_cohortroles\api
 Class for doing things with cohort roles. More...
 
class  tool_cohortroles\cohort_role_assignment
 Class for loading/storing cohort_role_assignments from the DB. More...
 
class  tool_cohortroles\form\assign_role_cohort
 Assign role to cohort form. More...
 
class  tool_cohortroles\output\cohort_role_assignments_table
 Cohort role assignments table. More...
 
class  tool_cohortroles\output\renderer
 Renderer class for cohort roles. More...
 
class  tool_cohortroles\privacy\provider
 Privacy Subsystem for tool_cohortroles implementing metadata and plugin providers. More...
 
class  tool_cohortroles\task\cohort_role_sync
 Scheduled task for syncing cohort roles. More...
 

Functions

 xmldb_tool_cohortroles_upgrade ($oldversion)
 Function to upgrade tool_cohortroles. More...
 

Variables

 $capabilities
 
 $context = context_system::instance()
 
 $hasaccess = has_all_capabilities($capabilities, $context)
 
 $tasks
 
$plugin component = 'tool_cohortroles'
 
$plugin dependencies
 
$plugin requires = 2019111200
 
$plugin version = 2019111801
 

Detailed Description

Function Documentation

◆ xmldb_tool_cohortroles_upgrade()

xmldb_tool_cohortroles_upgrade (   $oldversion)

Function to upgrade tool_cohortroles.

Parameters
int$oldversionthe version we are upgrading from
Return values
boolresult

Variable Documentation

◆ $capabilities

$capabilities
Initial value:
= [
'moodle/cohort:view',
'moodle/role:manage'
]

◆ $tasks

$tasks
Initial value:
= array(
array(
'classname' => 'tool_cohortroles\task\cohort_role_sync',
'blocking' => 0,
'minute' => 'R',
'hour' => '*',
'day' => '*',
'dayofweek' => '*',
'month' => '*'
),
)

◆ dependencies

$plugin dependencies
Initial value:
= array(
'tool_lp' => ANY_VERSION
)
ANY_VERSION
const ANY_VERSION
Any version - special value that can be used in $plugin->dependencies in version.php files.
Definition: component.php:38