Menu

## OAuth extends Entity
in package

OAuth.php : 14

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

Entity.php : 16
`protected static mixed $_custom_headers = array()`

#### $_empty

Entity.php : 27
`protected mixed $_empty = false`

##### Tags

Attribute

  (serialize = false)

#### $_last

Entity.php : 21
`protected mixed $_last`

##### Tags

Attribute

  (serialize = false)

#### $_manager

Entity.php : 17
`protected static mixed $_manager`

#### $_pagination_params

Entity.php : 23
`protected mixed $_pagination_params`

#### $access_token

OAuth.php : 49

access_token

`protected string $access_token`

##### Tags

Attribute

  ()

#### $client_secret

OAuth.php : 21

client_secret

`protected string $client_secret`

##### Tags

Attribute

  ()

#### $code

OAuth.php : 35

code

`protected string $code`

##### Tags

Attribute

  ()

#### $error

Entity.php : 22
`protected mixed $error`

#### $expires_in

OAuth.php : 91

expires_in

`protected int $expires_in`

##### Tags

Attribute

  ()

#### $grant_type

OAuth.php : 28

grant_type

`protected string $grant_type`

##### Tags

Attribute

  ()

#### $live_mode

OAuth.php : 70

live_mode

`protected bool $live_mode`

##### Tags

Attribute

  ()

#### $public_key

OAuth.php : 56

public_key

`protected string $public_key`

##### Tags

Attribute

  ()

#### $redirect_uri

OAuth.php : 42

redirect_uri

`protected string $redirect_uri`

##### Tags

Attribute

  ()

#### $refresh_token

OAuth.php : 63

refresh_token

`protected string $refresh_token`

##### Tags

Attribute

  ()

#### $scope

OAuth.php : 98

scope

`protected string $scope`

##### Tags

Attribute

  ()

#### $token_type

OAuth.php : 84

token_type

`protected string $token_type`

##### Tags

Attribute

  ()

#### $user_id

OAuth.php : 77

user_id

`protected int $user_id`

##### Tags

Attribute

  ()

### Methods

#### __construct()

Entity.php : 35

Entity constructor.

`public __construct([array<string|int, mixed> $params = [] ]) : mixed`

##### Parameters

$params : array<string|int, mixed> = []

##### Tags

throws
  Exception

##### Return values

mixed —

#### __get()

Entity.php : 287
`public __get( $name) : mixed`

##### Parameters

$name :

##### Return values

mixed —

#### __isset()

Entity.php : 299
`public __isset( $name) : bool`

##### Parameters

$name :

##### Return values

bool —

#### __set()

Entity.php : 310
`public __set( $name, $value) : mixed`

##### Parameters

$name :
$value :

##### Tags

throws
  Exception

##### Return values

mixed —

#### all()

Entity.php : 134
`public static all([mixed $options = [] ]) : mixed`

##### Parameters

$options : mixed = []

##### Return values

mixed —

#### APCIteratorAll()

Entity.php : 196
`public APCIteratorAll() : mixed`

##### Tags

codeCoverageIgnore

##### Return values

mixed —

#### custom_action()

Entity.php : 237
`public custom_action(mixed $method, mixed $action) : mixed`

##### Parameters

$method : mixed
$action : mixed

##### Return values

mixed —

#### delete()

Entity.php : 501
`public delete([mixed $options = [] ]) : mixed`

##### Parameters

$options : mixed = []

##### Return values

mixed —

#### destroy()

Entity.php : 229
`public static destroy() : mixed`

##### Tags

codeCoverageIgnore

##### Return values

mixed —

#### Error()

Entity.php : 46
`public Error() : mixed`

##### Return values

mixed —

#### find_by_id()

Entity.php : 73
`public static find_by_id(mixed $id) : mixed`

##### Parameters

$id : mixed

##### Return values

mixed —

#### get()

Entity.php : 66
`public static get(mixed $id) : mixed`

##### Parameters

$id : mixed

##### Return values

mixed —

#### getAttributes()

Entity.php : 320
`public getAttributes() : array<string|int, mixed>`

##### Return values

array<string|int, mixed> —

#### getAuthorizationURL()

OAuth.php : 107

getAuthorizationURL

`public getAuthorizationURL( $app_id, $redirect_uri) : string`

##### Parameters

$app_id :
$redirect_uri :

##### Return values

string —

#### getCustomHeader()

Entity.php : 81
`public static getCustomHeader(mixed $key) : mixed`

##### Parameters

$key : mixed

##### Return values

mixed —

#### getCustomHeaders()

Entity.php : 90
`public static getCustomHeaders() : mixed`

##### Return values

mixed —

#### getOAuthCredentials()

OAuth.php : 120

getOAuthCredentials

`public getOAuthCredentials( $authorization_code, $redirect_uri) : bool|mixed`

##### Parameters

$authorization_code :
$redirect_uri :

##### Tags

throws
  Exception

##### Return values

bool|mixed —

#### not_found()

Entity.php : 98
`public not_found() : mixed`

##### Return values

mixed —

#### process_error_body()

Entity.php : 272
`public process_error_body(mixed $message) : mixed`

##### Parameters

$message : mixed

##### Return values

mixed —

#### read()

Entity.php : 106
`public static read([mixed $params = [] ][, mixed $options = [] ]) : mixed`

##### Parameters

$params : mixed = []
$options : mixed = []

##### Return values

mixed —

#### refreshOAuthCredentials()

OAuth.php : 136

refreshOAuthCredentials

`public refreshOAuthCredentials( $refresh_token) : bool|mixed`

##### Parameters

$refresh_token :

##### Tags

throws
  Exception

##### Return values

bool|mixed —

#### save()

Entity.php : 251
`public save([mixed $options = [] ]) : mixed`

##### Parameters

$options : mixed = []

##### Return values

mixed —

#### search()

Entity.php : 163
`public static search([mixed $filters = [] ][, mixed $options = [] ]) : mixed`

##### Parameters

$filters : mixed = []
$options : mixed = []

##### Return values

mixed —

#### setCustomHeader()

Entity.php : 77
`public static setCustomHeader(mixed $key, mixed $value) : mixed`

##### Parameters

$key : mixed
$value : mixed

##### Return values

mixed —

#### setCustomHeadersFromArray()

Entity.php : 85
`public static setCustomHeadersFromArray(mixed $array) : mixed`

##### Parameters

$array : mixed

##### Return values

mixed —

#### setManager()

Entity.php : 53
`public static setManager(Manager $manager) : mixed`

##### Parameters

$manager : Manager

##### Return values

mixed —

#### toArray()

Entity.php : 328
`public toArray([null $attributes = null ]) : array<string|int, mixed>`

##### Parameters

$attributes : null = null

##### Return values

array<string|int, mixed> —

#### unSetManager()

Entity.php : 59
`public static unSetManager() : mixed`

##### Return values

mixed —

#### update()

Entity.php : 205
`public update([mixed $options = [] ]) : mixed`

##### Parameters

$options : mixed = []

##### Return values

mixed —

#### _camelize()

Entity.php : 495
`protected _camelize( $input[, string $separator = '_' ]) : mixed`

##### Parameters

$input :
$separator : string = '_'

##### Return values

mixed —

#### _fillFromArray()

Entity.php : 467

Fill entity from data with nested object creation

`protected _fillFromArray( $entity, $data) : mixed`

##### Parameters

$entity :
$data :

##### Return values

mixed —

#### _getDynamicAttributeDenied()

Entity.php : 415
`protected _getDynamicAttributeDenied() : mixed`

##### Return values

mixed —

#### _getPropertyType()

Entity.php : 408
`protected _getPropertyType( $property) : mixed`

##### Parameters

$property :

##### Return values

mixed —

#### _propertyExists()

Entity.php : 382
`protected _propertyExists( $property) : bool`

##### Parameters

$property :

##### Return values

bool —

#### _propertyTypeAllowed()

Entity.php : 392
`protected _propertyTypeAllowed( $property, $type) : bool`

##### Parameters

$property :
$type :

##### Return values

bool —

#### _setValue()

Entity.php : 359
`protected _setValue( $property, $value[, mixed $validate = true ]) : mixed`

##### Parameters

$property :
$value :
$validate : mixed = true

##### Tags

throws
  Exception

##### Return values

mixed —

#### tryFormat()

Entity.php : 427
`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