libopensso-php
Back to top  

Helper class for OpenSSO integration

package libopensso-php

 Methods

Constructs a new OpenSSO client handler

__construct(string $env, boolean $fetch_cookie_name, string $metadata_dir) 

Parameters

$env

string

Which environment from metadata should this helper use

$fetch_cookie_name

boolean

When true cookie name will be fetched from server using getCookieNameForToken

$metadata_dir

string

Directory to load metadata from

Exceptions

\Exception On error

Returns all attributes

allAttributes(boolean $force_arrays) 

Parameters

$force_arrays

boolean

Force use of arrays even on single valued attributes

Returns an attribute value/values

attribute(string $atr, boolean $force_array) : mixed

Parameters

$atr

string

Attribute name

$force_array

boolean

Whether to cast to array even if attribute has a single value

Returns

mixedArray value(s) or false if attribute was not found

Returns login URL for current environment

getLoginUrl() : string

Returns

stringOpenSSO login URL

Returns logout URL for current environment

getLogoutUrl() : string

Returns

stringOpenSSO logout URL

Checks if current user has a valid SSO session

validateToken() : boolean

Returns

booleanUser has a valid SSO session or not

 Properties

 

$env 
 

$metadata 
 

$path 
 

$attributes 
 

$context 
 

$cookiename 
 

$token 

 Constants

 

Default cookie name

DEFAULT_COOKIENAME 
 

Library version, used inside User-Agent

VERSION