external_auth
in package
Root class for external authorizaton plugins
Tags
Table of Contents
- $auth : mixed
- check() : mixed
- This is the cookie processor filter handler it invokes the child class check() method to see if there is a valid visitor to the site The check() method should return "false" if there is no valid visitor or an array of User information if there is one.
- user() : mixed
- returns an array with the user details from the external authorization
Properties
$auth
public
mixed
$auth
= 'external'
Methods
check()
This is the cookie processor filter handler it invokes the child class check() method to see if there is a valid visitor to the site The check() method should return "false" if there is no valid visitor or an array of User information if there is one.
public
check(BIT $authorized) : mixed
If there is a valid user, the user name is checked against Zenphoto users. If such user exists he will be automatically logged in. If no user by that userid exists a transient user will be created and logged in. User details are filled in from the user information in the passed array.
Most enteries in the result array are simply stored into the user property of the same name. However, there are some special handling items that may be present:
- groups: an array of the user's group membership
- objects: a Zenphoto "managed object list" array
- album: the name of the user's primary album
- logout_link: information that the plugin can use when a user loggs out
All the above may be missing. However, if there is no groups entry, there needs to be an entry for the user's rights otherwise he will have none. There should not be both a rights entry and a groups entry as they are mutually exclusive.
album and objects entries should come last in the list so all other properties are processed first as these methods may modify other properties.
Parameters
- $authorized : BIT
Return values
mixed —user()
returns an array with the user details from the external authorization
protected
user() : mixed