dojo.data support for Zend Framework

uses
uses
uses
package Zend_Dojo
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

Constructor

__construct(string|null $identifier = null, array|\Traversable|null $items = null, string|null $label = null) : void

Parameters

$identifier

stringnull

$items

array\Traversablenull

$label

stringnull

Serialize to string (proxy to {@link toJson()})

__toString() : string

Returns

string

Add an individual item, optionally by identifier

addItem(array|object $item, string|null $id = null) : \Zend_Dojo_Data

Parameters

$item

arrayobject

$id

stringnull

Returns

\Zend_Dojo_Data

Add multiple items at once

addItems(array|\Traversable $items) : \Zend_Dojo_Data

Parameters

$items

array\Traversable

Returns

\Zend_Dojo_Data

Remove all items at once

clearItems() : \Zend_Dojo_Data

Returns

\Zend_Dojo_Data

Countable: how many items are present

count() : integer

Returns

integer

Iterator: get current value

current() : array

Returns

array

Load object from array

fromArray(array $data) : \Zend_Dojo_Data

Parameters

$data

array

Returns

\Zend_Dojo_Data

Load object from JSON

fromJson(string $json) : \Zend_Dojo_Data

Parameters

$json

string

Returns

\Zend_Dojo_Data

Retrieve current item identifier

getIdentifier() : string | integer | null

Returns

stringintegernull

Retrieve an item by identifier

getItem(string $id) : array

Item retrieved will be flattened to an array.

Parameters

$id

string

Returns

array

Get all items as an array

getItems() : array

Serializes items to arrays.

Returns

array

Retrieve item association label

getLabel() : string | null

Returns

stringnull

Does an item with the given identifier exist?

hasItem(string|integer $id) : boolean

Parameters

$id

stringinteger

Returns

boolean

Iterator: get current key

key() : string | integer

Returns

stringinteger

Iterator: get next item

next() : void

ArrayAccess: does offset exist?

offsetExists(string|integer $offset) : boolean

Parameters

$offset

stringinteger

Returns

boolean

ArrayAccess: retrieve by offset

offsetGet(string|integer $offset) : array

Parameters

$offset

stringinteger

Returns

array

ArrayAccess: set value by offset

offsetSet(string $offset, array|object|null $value) : void

Parameters

$offset

string

$value

arrayobjectnull

ArrayAccess: unset value by offset

offsetUnset(string $offset) : void

Parameters

$offset

string

Remove item by identifier

removeItem(string $id) : \Zend_Dojo_Data

Parameters

$id

string

Returns

\Zend_Dojo_Data

Iterator: rewind to first value in collection

rewind() : void

Set identifier for item lookups

setIdentifier(string|integer|null $identifier) : \Zend_Dojo_Data

Parameters

$identifier

stringintegernull

Returns

\Zend_Dojo_Data

Set an individual item, optionally by identifier (overwrites)

setItem(array|object $item, $id = null) : \Zend_Dojo_Data

Parameters

$item

arrayobject

$id

Returns

\Zend_Dojo_Data

Set the items to collect

setItems(array|\Traversable $items) : \Zend_Dojo_Data

Parameters

$items

array\Traversable

Returns

\Zend_Dojo_Data

Set label to use for displaying item associations

setLabel(string|null $label) : \Zend_Dojo_Data

Parameters

$label

stringnull

Returns

\Zend_Dojo_Data

Seralize entire data structure, including identifier and label, to array

toArray() : array

Returns

array

Serialize to JSON (dojo.data format)

toJson() : string

Returns

string

Iterator: is item valid?

valid() : boolean

Returns

boolean

Normalize an item to attach to the collection

_normalizeItem(array|object $item, string|integer|null $id) : array

Parameters

$item

arrayobject

$id

stringintegernull

Returns

array

 Properties

 

Identifier field of item

$_identifier : string | integer

Default

 

Collected items

$_items : array

Default

array()
 

Label field of item

$_label : string

Default