Dojo/Data.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Dojo
version: $Id: Data.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Dojo_Data

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Dojo_Data
jump to top

Implements
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Dojo
uses: ArrayAccess
uses: Iterator
uses: Countable
Properties: $_identifier; $_items; $_label; $_metadata
Methods: __construct; setItems; setItem; addItem; addItems; getItems; hasItem; getItem; removeItem; clearItems; setIdentifier; getIdentifier; setLabel; getLabel; setMetadata; getMetadata; clearMetadata; fromArray; fromJson; toArray; toJson; __toString; offsetExists; offsetGet; offsetSet; offsetUnset; current; key; next; rewind; valid; count; _normalizeItem

Description

dojo.data support for Zend Framework

Properties

$_identifier
jump to class

string|int $_identifier = ''

Identifier field of item

Details

$_identifier: string|int
visibility: protected
default
final: false
static: false

$_items
jump to class

array $_items = 'array'

Collected items

Details

$_items: array
visibility: protected
default: array
final: false
static: false

$_label
jump to class

string $_label = ''

Label field of item

Details

$_label: string
visibility: protected
default
final: false
static: false

$_metadata
jump to class

array $_metadata = 'array'

Data container metadata

Details

$_metadata: array
visibility: protected
default: array
final: false
static: false

Methods

__construct
jump to class

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

Constructor

Arguments

$identifier: stringnull
$items: arrayTraversablenull
$label: stringnull

Details

visibility: public
final: false
static: false

__toString
jump to class

__toString(
          
          )
        
        :
        string

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

Output

string

Details

visibility: public
final: false
static: false

_normalizeItem
jump to class

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

Normalize an item to attach to the collection

Arguments

$item: arrayobject
$id: stringintnull

Output

array

Details

visibility: protected
final: false
static: false

addItem
jump to class

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

Add an individual item, optionally by identifier

Arguments

$item: arrayobject
$id: stringnull

Output

Zend_Dojo_Data

Details

visibility: public
final: false
static: false

addItems
jump to class

addItems(
          array|Traversable $items
          )
        
        :
        Zend_Dojo_Data

Add multiple items at once

Arguments

$items: arrayTraversable

Output

Zend_Dojo_Data

Details

visibility: public
final: false
static: false

clearItems
jump to class

clearItems(
          
          )
        
        :
        Zend_Dojo_Data

Remove all items at once

Output

Zend_Dojo_Data

Details

visibility: public
final: false
static: false

clearMetadata
jump to class

clearMetadata(
          null|string $key
              =
              null
          )
        
        :
        Zend_Dojo_Data

Clear individual or all metadata item(s)

Arguments

$key: nullstring

Output

Zend_Dojo_Data

Details

visibility: public
final: false
static: false

count
jump to class

Countable: how many items are present

Output

int

Details

visibility: public
final: false
static: false

current
jump to class

current(
          
          )
        
        :
        array

Iterator: get current value

Output

array

Details

visibility: public
final: false
static: false

fromArray
jump to class

fromArray(
          array $data
          )
        
        :
        Zend_Dojo_Data

Load object from array

Arguments

$data: array

Output

Zend_Dojo_Data

Details

visibility: public
final: false
static: false

fromJson
jump to class

fromJson(
          string $json
          )
        
        :
        Zend_Dojo_Data

Load object from JSON

Arguments

$json: string

Output

Zend_Dojo_Data

Details

visibility: public
final: false
static: false

getIdentifier
jump to class

getIdentifier(
          
          )
        
        :
        string|int|null

Retrieve current item identifier

Output

string|int|null

Details

visibility: public
final: false
static: false

getItem
jump to class

getItem(
          string $id
          )
        
        :
        array

Retrieve an item by identifier

Item retrieved will be flattened to an array.

Arguments

$id: string

Output

array

Details

visibility: public
final: false
static: false

getItems
jump to class

getItems(
          
          )
        
        :
        array

Get all items as an array

Serializes items to arrays.

Output

array

Details

visibility: public
final: false
static: false

getLabel
jump to class

getLabel(
          
          )
        
        :
        string|null

Retrieve item association label

Output

string|null

Details

visibility: public
final: false
static: false

getMetadata
jump to class

getMetadata(
          null|string $key
              =
              null
          )
        
        :
        mixed

Get metadata item or all metadata

Arguments

$key: nullstring
Metadata key when pulling single metadata item

Output

mixed

Details

visibility: public
final: false
static: false

hasItem
jump to class

hasItem(
          string|int $id
          )
        
        :
        bool

Does an item with the given identifier exist?

Arguments

$id: stringint

Output

bool

Details

visibility: public
final: false
static: false

key
jump to class

key(
          
          )
        
        :
        string|int

Iterator: get current key

Output

string|int

Details

visibility: public
final: false
static: false

next
jump to class

Iterator: get next item

Details

visibility: public
final: false
static: false

offsetExists
jump to class

offsetExists(
          string|int $offset
          )
        
        :
        bool

ArrayAccess: does offset exist?

Arguments

$offset: stringint

Output

bool

Details

visibility: public
final: false
static: false

offsetGet
jump to class

offsetGet(
          string|int $offset
          )
        
        :
        array

ArrayAccess: retrieve by offset

Arguments

$offset: stringint

Output

array

Details

visibility: public
final: false
static: false

offsetSet
jump to class

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

ArrayAccess: set value by offset

Arguments

$offset: string
$value: arrayobjectnull

Details

visibility: public
final: false
static: false

offsetUnset
jump to class

offsetUnset(
          string $offset
          )
        
        :
        void

ArrayAccess: unset value by offset

Arguments

$offset: string

Details

visibility: public
final: false
static: false

removeItem
jump to class

removeItem(
          string $id
          )
        
        :
        Zend_Dojo_Data

Remove item by identifier

Arguments

$id: string

Output

Zend_Dojo_Data

Details

visibility: public
final: false
static: false

rewind
jump to class

rewind(
          
          )
        
        :
        void

Iterator: rewind to first value in collection

Details

visibility: public
final: false
static: false

setIdentifier
jump to class

setIdentifier(
          string|int|null $identifier
          )
        
        :
        Zend_Dojo_Data

Set identifier for item lookups

Arguments

$identifier: stringintnull

Output

Zend_Dojo_Data

Details

visibility: public
final: false
static: false

setItem
jump to class

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

Set an individual item, optionally by identifier (overwrites)

Arguments

$item: arrayobject
$id

Output

Zend_Dojo_Data

Details

visibility: public
final: false
static: false

setItems
jump to class

setItems(
          array|Traversable $items
          )
        
        :
        Zend_Dojo_Data

Set the items to collect

Arguments

$items: arrayTraversable

Output

Zend_Dojo_Data

Details

visibility: public
final: false
static: false

setLabel
jump to class

setLabel(
          string|null $label
          )
        
        :
        Zend_Dojo_Data

Set label to use for displaying item associations

Arguments

$label: stringnull

Output

Zend_Dojo_Data

Details

visibility: public
final: false
static: false

setMetadata
jump to class

setMetadata(
          string|array $spec, mixed $value
              =
              null
          )
        
        :
        Zend_Dojo_Data

Set metadata by key or en masse

Arguments

$spec: stringarray
$value: mixed

Output

Zend_Dojo_Data

Details

visibility: public
final: false
static: false

toArray
jump to class

toArray(
          
          )
        
        :
        array

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

Output

array

Details

visibility: public
final: false
static: false

toJson
jump to class

toJson(
          
          )
        
        :
        string

Serialize to JSON (dojo.data format)

Output

string

Details

visibility: public
final: false
static: false

valid
jump to class

Iterator: is item valid?

Output

bool

Details

visibility: public
final: false
static: false

API Documentation

Dojo/Data.php

Description

Zend_Dojo_Datajump to top

Description

Properties

$_identifierjump to class

Details

$_itemsjump to class

Details

$_labeljump to class

Details

$_metadatajump to class

Details

Methods

__constructjump to class

Arguments

Details

__toStringjump to class

Output

Details

_normalizeItemjump to class

Arguments

Output

Details

addItemjump to class

Arguments

Output

Details

addItemsjump to class

Arguments

Output

Details

clearItemsjump to class

Output

Details

clearMetadatajump to class

Arguments

Output

Details

countjump to class

Output

Details

currentjump to class

Output

Details

fromArrayjump to class

Arguments

Output

Details

fromJsonjump to class

Arguments

Output

Details

getIdentifierjump to class

Output

Details

getItemjump to class

Arguments

Output

Details

getItemsjump to class

Output

Details

getLabeljump to class

Output

Details

getMetadatajump to class

Arguments

Output

Details

hasItemjump to class

Arguments

Output

Details

keyjump to class

Output

Details

nextjump to class

Details

Zend_Dojo_Data
jump to top

$_identifier
jump to class

$_items
jump to class

$_label
jump to class

$_metadata
jump to class

__construct
jump to class

__toString
jump to class

_normalizeItem
jump to class

addItem
jump to class

addItems
jump to class

clearItems
jump to class

clearMetadata
jump to class

count
jump to class

current
jump to class

fromArray
jump to class

fromJson
jump to class

getIdentifier
jump to class

getItem
jump to class

getItems
jump to class

getLabel
jump to class

getMetadata
jump to class

hasItem
jump to class

key
jump to class

next
jump to class

offsetExists
jump to class

offsetGet
jump to class

offsetSet
jump to class

offsetUnset
jump to class

removeItem
jump to class

rewind
jump to class

setIdentifier
jump to class

setItem
jump to class

setItems
jump to class

setLabel
jump to class

setMetadata
jump to class

toArray
jump to class

toJson
jump to class

valid
jump to class