JanRain OpenID Library

Auth_OpenID_ServiceEndpointLoader extends Auth_Yadis_SessionLoader
in package

A concrete loader implementation for Auth_OpenID_ServiceEndpoints.

Table of Contents

check()  : bool
Override this.
fromSession()  : null
Given a session data value (an array), this creates an object (returned by $this->newObject()) whose attributes and values are those in $data. Returns null if $data lacks keys found in $this->requiredKeys(). Returns null if $this->check($data) evaluates to false. Returns null if $this->newObject() evaluates to false.
newObject()  : null
Returns a new instance of this loader's class, using the session data to construct it if necessary. The object need only be created; $this->fromSession() will take care of setting the object's attributes.
prepareForLoad()  : array<string|int, mixed>
Prepares the data array by making any necessary changes.
prepareForSave()  : array<string|int, mixed>
Override this.
requiredKeys()  : mixed
toSession()  : array<string|int, mixed>
Returns an array of keys and values built from the attributes of $obj. If $this->prepareForSave($obj) returns an array, its keys and values are used to update the $data array of attributes from $obj.

Methods

check()

Override this.

public check(mixed $data) : bool
Parameters
$data : mixed
Return values
bool —

fromSession()

Given a session data value (an array), this creates an object (returned by $this->newObject()) whose attributes and values are those in $data. Returns null if $data lacks keys found in $this->requiredKeys(). Returns null if $this->check($data) evaluates to false. Returns null if $this->newObject() evaluates to false.

public fromSession(array<string|int, mixed> $data) : null
Parameters
$data : array<string|int, mixed>
Tags
access

private

Return values
null —

newObject()

Returns a new instance of this loader's class, using the session data to construct it if necessary. The object need only be created; $this->fromSession() will take care of setting the object's attributes.

public newObject(mixed $data) : null
Parameters
$data : mixed
Return values
null —

prepareForLoad()

Prepares the data array by making any necessary changes.

public prepareForLoad(array<string|int, mixed> $data) : array<string|int, mixed>

Returns an array whose keys and values will be used to update the original data array before calling $this->newObject($data).

Parameters
$data : array<string|int, mixed>
Tags
access

private

Return values
array<string|int, mixed> —

prepareForSave()

Override this.

public prepareForSave(object $obj) : array<string|int, mixed>
Parameters
$obj : object
Tags
access

private

Return values
array<string|int, mixed> —

requiredKeys()

public requiredKeys() : mixed
Return values
mixed —

toSession()

Returns an array of keys and values built from the attributes of $obj. If $this->prepareForSave($obj) returns an array, its keys and values are used to update the $data array of attributes from $obj.

public toSession(object $obj) : array<string|int, mixed>
Parameters
$obj : object
Tags
access

private

Return values
array<string|int, mixed> —

Search results