Documentation

OAuth extends Entity
in package

OAuth class

Tags
RestMethod

(resource="/oauth/token", method="create")

Table of Contents

$_custom_headers  : mixed
$_empty  : mixed
$_last  : mixed
$_manager  : mixed
$_pagination_params  : mixed
$access_token  : string
access_token
$client_secret  : string
client_secret
$code  : string
code
$error  : mixed
$expires_in  : int
expires_in
$grant_type  : string
grant_type
$live_mode  : bool
live_mode
$public_key  : string
public_key
$redirect_uri  : string
redirect_uri
$refresh_token  : string
refresh_token
$scope  : string
scope
$token_type  : string
token_type
$user_id  : int
user_id
__construct()  : mixed
Entity constructor.
__get()  : mixed
__isset()  : bool
__set()  : mixed
all()  : mixed
APCIteratorAll()  : mixed
custom_action()  : mixed
delete()  : mixed
destroy()  : mixed
Error()  : mixed
find_by_id()  : mixed
get()  : mixed
getAttributes()  : array<string|int, mixed>
getAuthorizationURL()  : string
getAuthorizationURL
getCustomHeader()  : mixed
getCustomHeaders()  : mixed
getOAuthCredentials()  : bool|mixed
getOAuthCredentials
not_found()  : mixed
process_error_body()  : mixed
read()  : mixed
refreshOAuthCredentials()  : bool|mixed
refreshOAuthCredentials
save()  : mixed
search()  : mixed
setCustomHeader()  : mixed
setCustomHeadersFromArray()  : mixed
setManager()  : mixed
toArray()  : array<string|int, mixed>
unSetManager()  : mixed
update()  : mixed
_camelize()  : mixed
_fillFromArray()  : mixed
Fill entity from data with nested object creation
_getDynamicAttributeDenied()  : mixed
_getPropertyType()  : mixed
_propertyExists()  : bool
_propertyTypeAllowed()  : bool
_setValue()  : mixed
tryFormat()  : array<string|int, mixed>|bool|float|int|string

Properties

$_custom_headers

protected static mixed $_custom_headers = array()

$_empty

protected mixed $_empty = false
Tags
Attribute

(serialize = false)

$_last

protected mixed $_last
Tags
Attribute

(serialize = false)

$_manager

protected static mixed $_manager

$_pagination_params

protected mixed $_pagination_params

$access_token

access_token

protected string $access_token
Tags
Attribute

()

$client_secret

client_secret

protected string $client_secret
Tags
Attribute

()

$code

code

protected string $code
Tags
Attribute

()

$expires_in

expires_in

protected int $expires_in
Tags
Attribute

()

$grant_type

grant_type

protected string $grant_type
Tags
Attribute

()

$live_mode

live_mode

protected bool $live_mode
Tags
Attribute

()

$public_key

public_key

protected string $public_key
Tags
Attribute

()

$redirect_uri

redirect_uri

protected string $redirect_uri
Tags
Attribute

()

$refresh_token

refresh_token

protected string $refresh_token
Tags
Attribute

()

$scope

scope

protected string $scope
Tags
Attribute

()

$token_type

token_type

protected string $token_type
Tags
Attribute

()

$user_id

user_id

protected int $user_id
Tags
Attribute

()

Methods

__construct()

Entity constructor.

public __construct([array<string|int, mixed> $params = [] ]) : mixed
Parameters
$params : array<string|int, mixed> = []
Tags
throws
Exception
Return values
mixed

__get()

public __get( $name) : mixed
Parameters
$name :
Return values
mixed

__isset()

public __isset( $name) : bool
Parameters
$name :
Return values
bool

__set()

public __set( $name,  $value) : mixed
Parameters
$name :
$value :
Tags
throws
Exception
Return values
mixed

all()

public static all([mixed $options = [] ]) : mixed
Parameters
$options : mixed = []
Return values
mixed

APCIteratorAll()

public APCIteratorAll() : mixed
Tags
codeCoverageIgnore
Return values
mixed

custom_action()

public custom_action(mixed $method, mixed $action) : mixed
Parameters
$method : mixed
$action : mixed
Return values
mixed

delete()

public delete([mixed $options = [] ]) : mixed
Parameters
$options : mixed = []
Return values
mixed

destroy()

public static destroy() : mixed
Tags
codeCoverageIgnore
Return values
mixed

Error()

public Error() : mixed
Return values
mixed

find_by_id()

public static find_by_id(mixed $id) : mixed
Parameters
$id : mixed
Return values
mixed

get()

public static get(mixed $id) : mixed
Parameters
$id : mixed
Return values
mixed

getAttributes()

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

getAuthorizationURL()

getAuthorizationURL

public getAuthorizationURL( $app_id,  $redirect_uri) : string
Parameters
$app_id :
$redirect_uri :
Return values
string

getCustomHeader()

public static getCustomHeader(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed

getCustomHeaders()

public static getCustomHeaders() : mixed
Return values
mixed

getOAuthCredentials()

getOAuthCredentials

public getOAuthCredentials( $authorization_code,  $redirect_uri) : bool|mixed
Parameters
$authorization_code :
$redirect_uri :
Tags
throws
Exception
Return values
bool|mixed

not_found()

public not_found() : mixed
Return values
mixed

process_error_body()

public process_error_body(mixed $message) : mixed
Parameters
$message : mixed
Return values
mixed

read()

public static read([mixed $params = [] ][, mixed $options = [] ]) : mixed
Parameters
$params : mixed = []
$options : mixed = []
Return values
mixed

refreshOAuthCredentials()

refreshOAuthCredentials

public refreshOAuthCredentials( $refresh_token) : bool|mixed
Parameters
$refresh_token :
Tags
throws
Exception
Return values
bool|mixed

save()

public save([mixed $options = [] ]) : mixed
Parameters
$options : mixed = []
Return values
mixed
public static search([mixed $filters = [] ][, mixed $options = [] ]) : mixed
Parameters
$filters : mixed = []
$options : mixed = []
Return values
mixed

setCustomHeader()

public static setCustomHeader(mixed $key, mixed $value) : mixed
Parameters
$key : mixed
$value : mixed
Return values
mixed

setCustomHeadersFromArray()

public static setCustomHeadersFromArray(mixed $array) : mixed
Parameters
$array : mixed
Return values
mixed

setManager()

public static setManager(Manager $manager) : mixed
Parameters
$manager : Manager
Return values
mixed

toArray()

public toArray([null $attributes = null ]) : array<string|int, mixed>
Parameters
$attributes : null = null
Return values
array<string|int, mixed>

unSetManager()

public static unSetManager() : mixed
Return values
mixed

update()

public update([mixed $options = [] ]) : mixed
Parameters
$options : mixed = []
Return values
mixed

_camelize()

protected _camelize( $input[, string $separator = '_' ]) : mixed
Parameters
$input :
$separator : string = '_'
Return values
mixed

_fillFromArray()

Fill entity from data with nested object creation

protected _fillFromArray( $entity,  $data) : mixed
Parameters
$entity :
$data :
Return values
mixed

_getDynamicAttributeDenied()

protected _getDynamicAttributeDenied() : mixed
Return values
mixed

_getPropertyType()

protected _getPropertyType( $property) : mixed
Parameters
$property :
Return values
mixed

_propertyExists()

protected _propertyExists( $property) : bool
Parameters
$property :
Return values
bool

_propertyTypeAllowed()

protected _propertyTypeAllowed( $property,  $type) : bool
Parameters
$property :
$type :
Return values
bool

_setValue()

protected _setValue( $property,  $value[, mixed $validate = true ]) : mixed
Parameters
$property :
$value :
$validate : mixed = true
Tags
throws
Exception
Return values
mixed

tryFormat()

protected tryFormat( $value,  $type,  $property) : array<string|int, mixed>|bool|float|int|string
Parameters
$value :
$type :
$property :
Tags
throws
Exception
Return values
array<string|int, mixed>|bool|float|int|string

Search results