RealMeSecurityExtension

class RealMeSecurityExtension extends Extension (View source)

Properties

protected SS_Object $owner

The object this extension is applied to.

 from  Extension
protected DataObject $ownerBaseClass

The base class that this extension was applied to; $this->owner must be one of these

 from  Extension
public $class from  Extension
public RealMeService $service

Methods

public
__construct()

No description

from  Extension
public static 
add_to_class(string $class, string $extensionClass, mixed $args = null)

Called when this extension is added to a particular class

from  Extension
public
setOwner(SS_Object $owner, string $ownerBaseClass = null)

Set the owner of this extension.

from  Extension
public
clearOwner()

No description

from  Extension
public
SS_Object
getOwner()

Returns the owner of this extension.

from  Extension
public static 
string
get_classname_without_arguments(string $extensionStr)

Helper method to strip eval'ed arguments from a string thats passed to DataObject::$extensions or Object::add_extension().

from  Extension
public
beforeCallActionHandler($request, $action)

Support the default security logout procedure by ensuring that RealMe hooks are cleared when the standard logout is called.

public
realme()

All publicly-accessible URLs are routed through this method. Possible method include:

  • acs: User is redirected here after authenticating with RealMe
  • error: Called when an error is logged by SimpleSAMLphp, we redirect to the login form with a messageset defined
  • logout: Ensures the user is logged out from RealMe, as well as this website (via Security::logout())

Details

in Extension at line 42
__construct()

No description

in Extension at line 54
static add_to_class(string $class, string $extensionClass, mixed $args = null)

Called when this extension is added to a particular class

Parameters

string $class
string $extensionClass
mixed $args

in Extension at line 66
setOwner(SS_Object $owner, string $ownerBaseClass = null)

Set the owner of this extension.

Parameters

SS_Object $owner

The owner object,
string $ownerBaseClass

The base class that the extension is applied to; this may be the class of owner, or it may be a parent. For example, if Versioned was applied to SiteTree, and then a Page object was instantiated, $owner would be a Page object, but $ownerBaseClass would be 'SiteTree'.

in Extension at line 74
clearOwner()

No description

in Extension at line 85
SS_Object getOwner()

Returns the owner of this extension.

Return Value

SS_Object

in Extension at line 97
static string get_classname_without_arguments(string $extensionStr)

Helper method to strip eval'ed arguments from a string thats passed to DataObject::$extensions or Object::add_extension().

Parameters

string $extensionStr

E.g. "Versioned('Stage','Live')"

Return Value

string

Extension classname, e.g. "Versioned"

at line 25
beforeCallActionHandler($request, $action)

Support the default security logout procedure by ensuring that RealMe hooks are cleared when the standard logout is called.

Parameters

$request
$action

at line 60
realme()

All publicly-accessible URLs are routed through this method. Possible method include:

  • acs: User is redirected here after authenticating with RealMe
  • error: Called when an error is logged by SimpleSAMLphp, we redirect to the login form with a messageset defined
  • logout: Ensures the user is logged out from RealMe, as well as this website (via Security::logout())