Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
auth_cas

Namespaces

namespace  auth_cas\privacy
  
 
namespace  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.
 
 xmldb_auth_cas_upgrade ($oldversion)
 Function to upgrade auth_cas.
 

Variables

 $plugin = 2024041600
 
 $tasks
 
$plugin component = 'auth_cas'
 
$plugin dependencies = ['auth_ldap' => 2024041600]
 
$plugin version = 2024042200
 

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
)
)