PHP Class Pingpp\PingppObject

Inheritance: implements ArrayAcces\ArrayAccess, implements JsonSerializable

ファイルを表示 Open project: pingplusplus/pingpp-php Class Usage Examples

Public Properties

Property	Type	Description
$nestedUpdatableAttributes		Attributes that are nested but still updatable from the parent class's URL (e.g. metadata).
$permanentAttributes		Attributes that should not be sent to the API because they're not updatable (e.g. API key, ID).

Protected Properties

Property	Type	Description
$_opts
$_retrieveOptions
$_transientValues
$_unsavedValues
$_values

Public Methods

Method	Description
__construct ( $id = null, $opts = null )
__get ( $k )
__isset ( $k )
__set ( $k, $v )	Standard accessor magic methods
__toArray ( $recursive = false )
__toJSON ( )
__toStdObject ( )
__toString ( )
__unset ( $k )
constructFrom ( stdObject $values, array $opts ) : PingppObject	This unfortunately needs to be public to be used in Util.php
init ( )
jsonSerialize ( )
keys ( )
offsetExists ( $k )
offsetGet ( $k )
offsetSet ( $k, $v )	ArrayAccess methods
offsetUnset ( $k )
refreshFrom ( stdObject $values, array $opts, boolean $partial = false )	Refreshes this object using the provided values.
serializeParameters ( ) : array

Method Details

__construct() public method

public __construct ( $id = null, $opts = null )

__get() public method

public __get ( $k )

__isset() public method

public __isset ( $k )

__set() public method

Standard accessor magic methods

public __set ( $k, $v )

__toArray() public method

public __toArray ( $recursive = false )

__toJSON() public method

public __toJSON ( )

__toStdObject() public method

public __toStdObject ( )

__toString() public method

public __toString ( )

__unset() public method

public __unset ( $k )

constructFrom() public static method

This unfortunately needs to be public to be used in Util.php

public static constructFrom ( stdObject $values, array $opts ) : PingppObject
$values	stdObject
$opts	array
return	PingppObject	The object constructed from the given values.

init() public static method

public static init ( )

jsonSerialize() public method

public jsonSerialize ( )

keys() public method

public keys ( )

offsetExists() public method

public offsetExists ( $k )

offsetGet() public method

public offsetGet ( $k )

offsetSet() public method

ArrayAccess methods

public offsetSet ( $k, $v )

offsetUnset() public method

public offsetUnset ( $k )

refreshFrom() public method

Refreshes this object using the provided values.

public refreshFrom ( stdObject $values, array $opts, boolean $partial = false )
$values	stdObject
$opts	array
$partial	boolean	Defaults to false.

serializeParameters() public method

public serializeParameters ( ) : array
return	array	A recursive mapping of attributes to values for this object, including the proper value for deleted attributes.

Property Details

$_opts protected_oe property

protected $_opts

$_retrieveOptions protected_oe property

protected $_retrieveOptions

$_transientValues protected_oe property

protected $_transientValues

$_unsavedValues protected_oe property

protected $_unsavedValues

$_values protected_oe property

protected $_values

$nestedUpdatableAttributes public_oe static_oe property

Attributes that are nested but still updatable from the parent class's URL (e.g. metadata).

public static $nestedUpdatableAttributes

$permanentAttributes public_oe static_oe property

Attributes that should not be sent to the API because they're not updatable (e.g. API key, ID).

public static $permanentAttributes