PHP Class Scalr\Service\Aws\AbstractDataType

Since: 10.10.2012

Author: Vitaliy Demidov ([email protected])

Inheritance: extends Scalr\Service\Aws\AbstractServiceRelatedType

Afficher le fichier Open project: scalr/scalr Class Usage Examples

Protected Properties

Свойство	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.

Méthodes publiques

Méthode	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

Méthodes protégées

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

Private Methods

Méthode	Description
_setExternalIdentifiersRecursively ( object &$holder, object &$inner )	Sets external identifiers recursively

Method Details

__call() public méthode

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

public __call ( string $name, $arguments ) : mixed
$name	string
Résultat	mixed

__construct() public méthode

Constructor

public __construct ( )

__get() public méthode

public __get ( string $name ) : mixed
$name	string	property name
Résultat	mixed

__isset() public méthode

public __isset ( string $name ) : boolean
$name	string
Résultat	boolean

__set() public méthode

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

__unset() public méthode

public __unset ( unknown_type $name )
$name	unknown_type

_getExternalKeysUpdated() public méthode

This method is for internal usage only

public _getExternalKeysUpdated ( ) : boolean
Résultat	boolean

_getServiceRelatedDatasetUpdated() public méthode

This method is for internal usage only

public _getServiceRelatedDatasetUpdated ( ) : boolean
Résultat	boolean

_hasInheritedDataSet() public méthode

Returns true if inherited data is set.

public _hasInheritedDataSet ( ) : boolean
Résultat	boolean	Returns true if inherited data is set.

_setExternalKeysUpdated() public méthode

This method is for internal usage only

public _setExternalKeysUpdated ( boolean $updated ) : AbstractDataType
$updated	boolean
Résultat	AbstractDataType

_setServiceRelatedDatasetUpdated() public méthode

This method is for internal usage only

public _setServiceRelatedDatasetUpdated ( boolean $updated ) : AbstractDataType
$updated	boolean
Résultat	AbstractDataType

appendContentToElement() public méthode

Appends DomDocument content to given element

public appendContentToElement ( DOMNode $toElement ) : DOMNode
$toElement	DOMNode
Résultat	DOMNode

getExternalIdentifiers() public méthode

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

public getExternalIdentifiers ( ) : array
Résultat	array	Returns the list of the external identifiers.

getOriginalXml() public méthode

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

public getOriginalXml ( ) : string
Résultat	string	Returns XML

getPropertiesForInheritance() public méthode

Get the properties which are used for inheritance properties purposes.

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

getQueryArray() public méthode

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
Résultat	array	Returns query parameters array looks like array ( '[parameterName.member.][propName[.member.m]]' => value ) Values are not url encoded.

getQueryArrayBare() public méthode

Gets query parameters array without member prefix

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

getReflectionClass() public méthode

Gets a reflection class of this object

public getReflectionClass ( ) : ReflectionClass
Résultat	ReflectionClass

getServiceNames() public méthode

public getServiceNames ( )

resetObject() public méthode

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

public resetObject ( )

setExternalIdentifiersRecursively() protected méthode

Sets external identifiers recursively

protected setExternalIdentifiersRecursively ( mixed &$inner )
$inner	mixed

setOriginalXml() public méthode

Sets original xml that is received in response from service

public setOriginalXml ( string $xml ) : AbstractDataType
$xml	string	XML string
Résultat	AbstractDataType

toArray() public méthode

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
Résultat	array	Returns data as array

toXml() public méthode

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
Résultat	DOMDocument \| string	Returns object converted into either XML string or DOMDocument, depends on returnAsDom option.

uppercaseProperty() protected méthode

Gets uppercased property

protected uppercaseProperty ( string $property ) : string
$property	string
Résultat	string	Returns uppercased property

Property Details

$_externalKeys protected_oe property

List of external identifier names.

protected array $_externalKeys
Résultat	array

$_properties protected_oe property

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

protected array $_properties
Résultat	array