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

Namespaces

namespace  auth_shibboleth
  
 
namespace  auth_shibboleth\privacy
  
 

Classes

class  auth_plugin_shibboleth
 Shibboleth authentication plugin. More...
 
class  auth_shibboleth\helper
 The helper class for the Shibboleth authentication plugin. More...
 
class  auth_shibboleth\privacy\provider
 Privacy Subsystem for auth_shibboleth implementing null_provider. More...
 
class  auth_shibboleth_admin_setting_convert_data
 Admin settings class for the convert_data option. More...
 
class  auth_shibboleth_admin_setting_special_idp_configtextarea
 Special setting for auth_shibboleth WAYF. More...
 
class  auth_shibboleth_admin_setting_special_wayf_select
 Special settings for auth_shibboleth WAYF. More...
 

Functions

 appendCookieValue ($value, $CookieArray)
 Append a value to the array of IDPs.
 
 auth_shibboleth_pluginfile ($course, $cm, $context, $filearea, $args, $forcedownload, array $options=array())
 Serves the logo file settings.
 
 generate_cookie_array ($value)
 Generates an array of IDPs using the cookie value.
 
 generate_cookie_value ($CookieArray)
 Generate the value that is stored in the cookie using the list of IDPs.
 
 get_idp_list ($organization_selection)
 Generate array of IdPs from Moodle Shibboleth settings.
 
 set_saml_cookie ($selectedIDP)
 Sets the standard SAML domain cookie that is also used to preselect the right entry on the local way.
 
 xmldb_auth_shibboleth_upgrade ($oldversion)
 Function to upgrade auth_shibboleth.
 

Variables

 $plugin = 2024041600
 
$plugin component = 'auth_shibboleth'
 
$plugin version = 2024042200
 

Detailed Description

Function Documentation

◆ appendCookieValue()

appendCookieValue ( $value,
$CookieArray )

Append a value to the array of IDPs.

Parameters
stringIdP identifier
arrayIdP identifiers
Return values
arrayIdP identifiers with appended IdP

◆ auth_shibboleth_pluginfile()

auth_shibboleth_pluginfile ( $course,
$cm,
$context,
$filearea,
$args,
$forcedownload,
array $options = array() )

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 if file not found, does not return if found - justsend the file

◆ generate_cookie_array()

generate_cookie_array ( $value)

Generates an array of IDPs using the cookie value.

Parameters
stringValue of SAML domain cookie
Return values
arrayIdentifiers of IdPs

◆ generate_cookie_value()

generate_cookie_value ( $CookieArray)

Generate the value that is stored in the cookie using the list of IDPs.

Parameters
arrayIdP identifiers
Return values
stringSAML domain cookie value

◆ get_idp_list()

get_idp_list ( $organization_selection)

Generate array of IdPs from Moodle Shibboleth settings.

Parameters
stringText containing tuble/triple of IdP entityId, name and (optionally) session initiator
Return values
arrayIdentifier of IdPs and their name/session initiator

◆ set_saml_cookie()

set_saml_cookie ( $selectedIDP)

Sets the standard SAML domain cookie that is also used to preselect the right entry on the local way.

Parameters
string$selectedIDPIDP identifier

◆ xmldb_auth_shibboleth_upgrade()

xmldb_auth_shibboleth_upgrade ( $oldversion)

Function to upgrade auth_shibboleth.

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