Documentation

Siteuser_OpenID_Controller
in package

Site users.

Tags
subpackage

Siteuser

version
7.x
author

Hostmake LLC

copyright

© 2005-2024 ООО "Хостмэйк" (Hostmake LLC), http://www.hostcms.ru

Table of Contents

Properties

$instance  : mixed
The singleton instances.
$_aFields  : array<string|int, mixed>
List of requered fields
$_aURL  : array<string|int, mixed>
List of parameters
$_error  : array<string|int, mixed>
List of errors
$_identityURL  : string
Identity URL

Methods

getAttribute()  : mixed
Get OpenID attribute
getError()  : array<string|int, mixed>
Get error
getIdentityUrl()  : string
Get URL identity
getOpenIDServer()  : array<string|int, mixed>
Get OpenID server
getRedirectURL()  : array<string|int, mixed>
Get redirect URL
instance()  : object
Register an existing instance as a singleton.
isError()  : bool
Return TRUE if there are some errors
redirect()  : mixed
Execute redirection
setError()  : self
Set error
setIdentityURL()  : self
Set Identity URL
setOpenIDServer()  : self
Set OpenID server
setOptionalFields()  : self
Set optional fields
setRequiredFields()  : self
Set requered fields
setReturnURL()  : self
Set return URL
setTrustRoot()  : self
Set trust_root option
splitResponse()  : array<string|int, mixed>
Split response
validateWithServer()  : array<string|int, mixed>
Checkout OpenID server
_array2url()  : string
Сonverts associated array to URL Query String
_html2OpenIDServer()  : array<string|int, mixed>
Get details of their OpenID server and (optional) delegate

Properties

$instance

The singleton instances.

public static mixed $instance = \NULL

$_aFields

List of requered fields

protected array<string|int, mixed> $_aFields = array()

$_aURL

List of parameters

protected array<string|int, mixed> $_aURL = array()

$_error

List of errors

protected array<string|int, mixed> $_error = array()

$_identityURL

Identity URL

protected string $_identityURL = \NULL

Methods

getAttribute()

Get OpenID attribute

public getAttribute(string $name) : mixed
Parameters
$name : string

name

getError()

Get error

public getError() : array<string|int, mixed>
Return values
array<string|int, mixed>

getIdentityUrl()

Get URL identity

public getIdentityUrl() : string
Return values
string

getOpenIDServer()

Get OpenID server

public getOpenIDServer() : array<string|int, mixed>
Return values
array<string|int, mixed>

getRedirectURL()

Get redirect URL

public getRedirectURL() : array<string|int, mixed>
Return values
array<string|int, mixed>

instance()

Register an existing instance as a singleton.

public static instance() : object
Return values
object

isError()

Return TRUE if there are some errors

public isError() : bool
Return values
bool

redirect()

Execute redirection

public redirect() : mixed

setError()

Set error

public setError(int $code[, string $description = NULL ]) : self
Parameters
$code : int

error code

$description : string = NULL

error description

Return values
self

setIdentityURL()

Set Identity URL

public setIdentityURL(string $identityURL) : self
Parameters
$identityURL : string

URL

Return values
self

setOpenIDServer()

Set OpenID server

public setOpenIDServer(string $openid_server) : self
Parameters
$openid_server : string
Return values
self

setOptionalFields()

Set optional fields

public setOptionalFields(mixed $optional) : self
Parameters
$optional : mixed
Return values
self

setRequiredFields()

Set requered fields

public setRequiredFields(mixed $required) : self
Parameters
$required : mixed
Return values
self

setReturnURL()

Set return URL

public setReturnURL(string $return) : self
Parameters
$return : string
Return values
self

setTrustRoot()

Set trust_root option

public setTrustRoot(string $trust_root) : self
Parameters
$trust_root : string
Return values
self

splitResponse()

Split response

public splitResponse(string $response) : array<string|int, mixed>
Parameters
$response : string

response

Return values
array<string|int, mixed>

validateWithServer()

Checkout OpenID server

public validateWithServer() : array<string|int, mixed>
Return values
array<string|int, mixed>

_array2url()

Сonverts associated array to URL Query String

protected _array2url(array<string|int, mixed> $arr) : string
Parameters
$arr : array<string|int, mixed>
Return values
string

_html2OpenIDServer()

Get details of their OpenID server and (optional) delegate

protected _html2OpenIDServer(string $content) : array<string|int, mixed>
Parameters
$content : string

content

Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results