PHP Класс Scalr\Service\Aws\DataType\ListDataType

С версии: 23.09.2012
Автор: Vitaliy Demidov ([email protected])
Наследование: extends Scalr\Service\Aws\AbstractDataType, implements Iterato\Iterator, implements Countabl\Countable, implements ArrayAcces\ArrayAccess
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
__construct ( string | array | object $aListData = null, string | array $propertyName = null, string $dataClassName = null ) Constructor
append ( mixed $item ) Appends item to the list
count ( )
current ( )
get ( integer $position = null ) : mixed Gets an original object at position N
getComputed ( ) : array Gets computed list
getDataClassName ( ) : string | null Gets data class name restriction
getExternalIdentifiers ( ) : array Gets an external identifier keys that are associated with this object.
getNextToken ( ) : string Gets nextToken.
getOriginal ( ) : array Gets original list.
getPropertyName ( ) : string | array | null Gets property name of object or a key of assocciative array
getQueryArray ( string $uriParameterName = null, boolean $member = true ) : string Gets query parameters array.
isValidObject ( mixed $object ) : boolean Checks if required object is valid.
key ( )
next ( )
offsetExists ( $offset )
offsetGet ( $offset )
offsetSet ( $offset, $value )
offsetUnset ( $offset )
rewind ( )
setNextToken ( string $nextToken ) Sets nextToken.
valid ( )

Защищенные методы

Метод Описание
refresh ( ) Refreshes the list

Приватные методы

Метод Описание
typeCastData ( mixed $v ) : mixed Type casts an list data object.

Описание методов

__construct() публичный Метод

Constructor
public __construct ( string | array | object $aListData = null, string | array $propertyName = null, string $dataClassName = null )
$aListData string | array | object An array or single element of the list. It can be array of the objects of dataClassName class or a single object of the mentioned class.
$propertyName string | array optional A public property name of the object that is used as out for query string.
$dataClassName string optional A data class name of the objects which form a list.

append() публичный Метод

Appends item to the list
public append ( mixed $item )
$item mixed

count() публичный Метод

См. также: Countable::count()
public count ( )

current() публичный Метод

См. также: Iterator::current()
public current ( )

get() публичный Метод

Gets an original object at position N
public get ( integer $position = null ) : mixed
$position integer optional A position at the list. If null it will use current position.
Результат mixed Returns an original object at position N in the list.

getComputed() публичный Метод

Gets computed list
public getComputed ( ) : array
Результат array Returns computed array of values that represent list.

getDataClassName() публичный Метод

Gets data class name restriction
public getDataClassName ( ) : string | null
Результат string | null Returns data class name

getExternalIdentifiers() публичный Метод

Gets an external identifier keys that are associated with this object.
public getExternalIdentifiers ( ) : array
Результат array Returns the list of the external identifiers.

getNextToken() публичный Метод

Gets nextToken.
public getNextToken ( ) : string
Результат string Returns nextToken.

getOriginal() публичный Метод

Gets original data array that has been passed as argument in constructor.
public getOriginal ( ) : array
Результат array Returns original data array that has been passed as first argument in constructor.

getPropertyName() публичный Метод

Gets property name of object or a key of assocciative array
public getPropertyName ( ) : string | array | null
Результат string | array | null Returns property name of object or a key of assocciative array

getQueryArray() публичный Метод

This method overrides parent method.
public getQueryArray ( string $uriParameterName = null, boolean $member = true ) : string
$uriParameterName string optional Parameter name. If null it will use class property name that is provided in constructor.
$member boolean optional Should it add member prefix
Результат string Returns query parameters array looks like array ( 'parameterName.member.n[.propName[.member.m]]' => value ) Values are not url encoded.

isValidObject() публичный Метод

Checks if required object is valid.
public isValidObject ( mixed $object ) : boolean
$object mixed
Результат boolean Returns TRUE if object is an instancse of correct data class

key() публичный Метод

См. также: Iterator::key()
public key ( )

next() публичный Метод

См. также: Iterator::next()
public next ( )

offsetExists() публичный Метод

См. также: ArrayAccess::offsetExists()
public offsetExists ( $offset )

offsetGet() публичный Метод

См. также: ArrayAccess::offsetGet()
public offsetGet ( $offset )

offsetSet() публичный Метод

См. также: ArrayAccess::offsetSet()
public offsetSet ( $offset, $value )

offsetUnset() публичный Метод

См. также: ArrayAccess::offsetUnset()
public offsetUnset ( $offset )

refresh() защищенный Метод

Refreshes the list
protected refresh ( )

rewind() публичный Метод

См. также: Iterator::rewind()
public rewind ( )

setNextToken() публичный Метод

Sets nextToken.
public setNextToken ( string $nextToken )
$nextToken string Next Token

valid() публичный Метод

См. также: Iterator::valid()
public valid ( )