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

Files

file  auth.php
 Authentication Plugin: CAS Authentication.
 
file  lib.php
 Authentication Plugin: CAS Authentication.
 
file  provider.php
 Privacy Subsystem implementation for auth_cas.
 
file  settings.php
 Admin settings and defaults.
 
file  sync_task.php
 A scheduled task for CAS user sync.
 
file  tasks.php
 Definition of auth_cas tasks.
 
file  upgrade.php
 CAS authentication plugin upgrade code.
 
file  version.php
 Version details.
 

Namespaces

 auth_cas\privacy
  
 
 auth_cas\task
  
 

Classes

class  auth_cas\privacy\provider
 Privacy Subsystem for auth_cas implementing null_provider. More...
 
class  auth_cas\task\sync_task
 A scheduled task class for CAS user sync. More...
 
class  auth_plugin_cas
 CAS authentication plugin. More...
 

Functions

 auth_cas_pluginfile ($course, $cm, $context, $filearea, $args, $forcedownload, array $options=[])
 Serves the logo file settings. More...
 
 xmldb_auth_cas_upgrade ($oldversion)
 Function to upgrade auth_cas. More...
 

Variables

 $tasks
 
$plugin component = 'auth_cas'
 
$plugin dependencies = array('auth_ldap' => 2019111200)
 
$plugin requires = 2019111200
 
$plugin version = 2019111801
 

Detailed Description

Function Documentation

◆ auth_cas_pluginfile()

auth_cas_pluginfile (   $course,
  $cm,
  $context,
  $filearea,
  $args,
  $forcedownload,
array  $options = [] 
)

Serves the logo file settings.

Parameters
stdClass$coursecourse object
stdClass$cmcourse module object
stdClass$contextcontext object
string$fileareafile area
array$argsextra arguments
bool$forcedownloadwhether or not force download
array$optionsadditional options affecting the file serving
Return values
boolfalse|void

◆ xmldb_auth_cas_upgrade()

xmldb_auth_cas_upgrade (   $oldversion)

Function to upgrade auth_cas.

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

Variable Documentation

◆ $tasks

$tasks
Initial value:
= array(
array(
'classname' => 'auth_cas\task\sync_task',
'blocking' => 0,
'minute' => '0',
'hour' => '0',
'day' => '*',
'month' => '*',
'dayofweek' => '*',
'disabled' => 1
)
)