PHP Class EasyPost\Object

Inheritance: implements ArrayAccess
Show file Open project: easypost/easypost-php

Protected Properties

Property Type Description
$_apiKey string
$_immutableValues array
$_retrieveOptions array
$_unsavedValues array
$_values array

Public Methods

Method Description
__construct ( string $id = null, string $apiKey = null, string $parent = null, string $name = null ) constructor
__get ( string $k ) : mixed getter
__isset ( string $k ) : boolean isset magic method
__set ( string $k, mixed $v ) Standard accessor magic methods
__toArray ( boolean $recursive = false ) : array convert object to an array
__toJSON ( ) : string convert object to JSON
__toString ( ) : string convert object to a string
__unset ( string $k ) unset magic method
constructFrom ( array $values, string $class = null, string $apiKey = null, string $parent = null, string $name = null ) : mixed construct from
current ( ) : mixed Iterator methods
key ( ) : mixed Iterator methods
next ( ) : mixed Iterator methods
offsetExists ( string $k ) : boolean ArrayAccess methods
offsetGet ( string $k ) : mixed ArrayAccess methods
offsetSet ( string $k, mixed $v ) ArrayAccess methods
offsetUnset ( string $k ) ArrayAccess methods
refreshFrom ( array $values, string $apiKey, boolean $partial = false ) refresh from
rewind ( ) : void Iterator methods
valid ( ) : boolean Iterator methods

Method Details

__construct() public method

constructor
public __construct ( string $id = null, string $apiKey = null, string $parent = null, string $name = null )
$id string
$apiKey string
$parent string
$name string

__get() public method

getter
public __get ( string $k ) : mixed
$k string
return mixed

__isset() public method

isset magic method
public __isset ( string $k ) : boolean
$k string
return boolean

__set() public method

Standard accessor magic methods
public __set ( string $k, mixed $v )
$k string
$v mixed

__toArray() public method

convert object to an array
public __toArray ( boolean $recursive = false ) : array
$recursive boolean
return array

__toJSON() public method

convert object to JSON
public __toJSON ( ) : string
return string

__toString() public method

convert object to a string
public __toString ( ) : string
return string

__unset() public method

unset magic method
public __unset ( string $k )
$k string

constructFrom() public static method

construct from
public static constructFrom ( array $values, string $class = null, string $apiKey = null, string $parent = null, string $name = null ) : mixed
$values array
$class string
$apiKey string
$parent string
$name string
return mixed

current() public method

Iterator methods
public current ( ) : mixed
return mixed

key() public method

Iterator methods
public key ( ) : mixed
return mixed

next() public method

Iterator methods
public next ( ) : mixed
return mixed

offsetExists() public method

ArrayAccess methods
public offsetExists ( string $k ) : boolean
$k string
return boolean

offsetGet() public method

ArrayAccess methods
public offsetGet ( string $k ) : mixed
$k string
return mixed

offsetSet() public method

ArrayAccess methods
public offsetSet ( string $k, mixed $v )
$k string
$v mixed

offsetUnset() public method

ArrayAccess methods
public offsetUnset ( string $k )
$k string

refreshFrom() public method

refresh from
public refreshFrom ( array $values, string $apiKey, boolean $partial = false )
$values array
$apiKey string
$partial boolean

rewind() public method

Iterator methods
public rewind ( ) : void
return void

valid() public method

Iterator methods
public valid ( ) : boolean
return boolean

Property Details

$_apiKey protected property

protected string $_apiKey
return string

$_immutableValues protected property

protected array $_immutableValues
return array

$_retrieveOptions protected property

protected array $_retrieveOptions
return array

$_unsavedValues protected property

protected array $_unsavedValues
return array

$_values protected property

protected array $_values
return array