PHP Class Scalr\Service\Aws\AbstractDataType

Since: 10.10.2012

Author: Vitaliy Demidov ([email protected])

Inheritance: extends Scalr\Service\Aws\AbstractServiceRelatedType

Show file Open project: scalr/scalr Class Usage Examples

Protected Properties

Property	Type	Description
$_externalKeys	array	List of external identifier names.
$_properties	array	List of the public properties which is managed by magic getter and setters internally.

Public Methods

Method	Description
__call ( string $name, $arguments ) : mixed	It allows to get\|set an external identifier value or internal property value
__construct ( )	Constructor
__get ( string $name ) : mixed
__isset ( string $name ) : boolean
__set ( string $name, mixed $data )
__unset ( unknown_type $name )
_getExternalKeysUpdated ( ) : boolean	This method is for internal usage only
_getServiceRelatedDatasetUpdated ( ) : boolean	This method is for internal usage only
_hasInheritedDataSet ( ) : boolean	Returns true if inherited data is set.
_setExternalKeysUpdated ( boolean $updated ) : AbstractDataType	This method is for internal usage only
_setServiceRelatedDatasetUpdated ( boolean $updated ) : AbstractDataType	This method is for internal usage only
appendContentToElement ( DOMNode $toElement ) : DOMNode	Appends DomDocument content to given element
getExternalIdentifiers ( ) : array	Gets an external identifier keys that are associated with this object.
getOriginalXml ( ) : string	Gets an original XML that is received in response from service.
getPropertiesForInheritance ( ) : array	Get the properties which are used for inheritance properties purposes.
getQueryArray ( string $uriParameterName = null, boolean $member = true ) : array	Gets query parameters array.
getQueryArrayBare ( string $uriParameterName = null ) : array	Gets query parameters array without member prefix
getReflectionClass ( ) : ReflectionClass	Gets a reflection class of this object
getServiceNames ( )
resetObject ( )	Resets object including internal properties values keys for which are defined in protected $_properties array.
setOriginalXml ( string $xml ) : AbstractDataType	Sets original xml that is received in response from service
toArray ( boolean $ucase = false, array &$known = null ) : array	Gets data as array.
toXml ( boolean $returnAsDom = false, array &$known = null ) : DOMDocument \| string	Gets object as XML

Protected Methods

Method	Description
setExternalIdentifiersRecursively ( mixed &$inner )	Sets external identifiers recursively
uppercaseProperty ( string $property ) : string	Gets uppercased property

Private Methods

Method	Description
_setExternalIdentifiersRecursively ( object &$holder, object &$inner )	Sets external identifiers recursively

Method Details

__call() public method

It allows to get|set an external identifier value or internal property value

public __call ( string $name, $arguments ) : mixed
$name	string
return	mixed

__construct() public method

Constructor

public __construct ( )

__get() public method

public __get ( string $name ) : mixed
$name	string	property name
return	mixed

__isset() public method

public __isset ( string $name ) : boolean
$name	string
return	boolean

__set() public method

public __set ( string $name, mixed $data )
$name	string
$data	mixed

__unset() public method

public __unset ( unknown_type $name )
$name	unknown_type

_getExternalKeysUpdated() public method

This method is for internal usage only

public _getExternalKeysUpdated ( ) : boolean
return	boolean

_getServiceRelatedDatasetUpdated() public method

This method is for internal usage only

public _getServiceRelatedDatasetUpdated ( ) : boolean
return	boolean

_hasInheritedDataSet() public method

Returns true if inherited data is set.

public _hasInheritedDataSet ( ) : boolean
return	boolean	Returns true if inherited data is set.

_setExternalKeysUpdated() public method

This method is for internal usage only

public _setExternalKeysUpdated ( boolean $updated ) : AbstractDataType
$updated	boolean
return	AbstractDataType

_setServiceRelatedDatasetUpdated() public method

This method is for internal usage only

public _setServiceRelatedDatasetUpdated ( boolean $updated ) : AbstractDataType
$updated	boolean
return	AbstractDataType

appendContentToElement() public method

Appends DomDocument content to given element

public appendContentToElement ( DOMNode $toElement ) : DOMNode
$toElement	DOMNode
return	DOMNode

getExternalIdentifiers() public method

Gets an external identifier keys that are associated with this object.

public getExternalIdentifiers ( ) : array
return	array	Returns the list of the external identifiers.

getOriginalXml() public method

Gets an original XML that is received in response from service.

public getOriginalXml ( ) : string
return	string	Returns XML

getPropertiesForInheritance() public method

Get the properties which are used for inheritance properties purposes.

public getPropertiesForInheritance ( ) : array
return	array	Returns a list of the public properties which is managed by magic getter and setters internally.

getQueryArray() public method

Gets query parameters array.

public getQueryArray ( string $uriParameterName = null, boolean $member = true ) : array
$uriParameterName	string	optional Parameter name
$member	boolean	optional Should it add member prefix
return	array	Returns query parameters array looks like array ( '[parameterName.member.][propName[.member.m]]' => value ) Values are not url encoded.

getQueryArrayBare() public method

Gets query parameters array without member prefix

public getQueryArrayBare ( string $uriParameterName = null ) : array
$uriParameterName	string	optional Parameter name.
return	array	Returns query parameters array looks like array ( '[parameterName.][propName[.n]]' => value ) Values are not url encoded.

getReflectionClass() public method

Gets a reflection class of this object

public getReflectionClass ( ) : ReflectionClass
return	ReflectionClass

getServiceNames() public method

public getServiceNames ( )

resetObject() public method

Resets object including internal properties values keys for which are defined in protected $_properties array.

public resetObject ( )

setExternalIdentifiersRecursively() protected method

Sets external identifiers recursively

protected setExternalIdentifiersRecursively ( mixed &$inner )
$inner	mixed

setOriginalXml() public method

Sets original xml that is received in response from service

public setOriginalXml ( string $xml ) : AbstractDataType
$xml	string	XML string
return	AbstractDataType

toArray() public method

Gets data as array.

public toArray ( boolean $ucase = false, array &$known = null ) : array
$ucase	boolean	optional If True if will uppercase key names of the array.
$known	array	optional It's only for internal usage
return	array	Returns data as array

toXml() public method

Gets object as XML

public toXml ( boolean $returnAsDom = false, array &$known = null ) : DOMDocument \| string
$returnAsDom	boolean	optional Should it return DOMDocument object or plain xml string. If it's true it will return DOMDocument.
$known	array	optional It's for internal usage
return	DOMDocument \| string	Returns object converted into either XML string or DOMDocument, depends on returnAsDom option.

uppercaseProperty() protected method

Gets uppercased property

protected uppercaseProperty ( string $property ) : string
$property	string
return	string	Returns uppercased property

Property Details

$_externalKeys protected property

List of external identifier names.

protected array $_externalKeys
return	array

$_properties protected property

List of the public properties which is managed by magic getter and setters internally.

protected array $_properties
return	array