Class CFDictionary

Description

Implements interfaces:

  • Iterator (internal interface)

Array Type of CFPropertyList

Located in /CFType.php (line 559)

CFType
   |
   --CFDictionary
Variable Summary
Method Summary
CFDictionary __construct ([array $value = array()])
void add (string $key, [CFType $value = null])
CFType del (string $key)
CFType get (string $key)
string key ()
void next ()
void rewind ()
void setValue ( $value)
array toArray ()
The toBinary (CFBinaryPropertyList &$bplist)
DOMNode toXML ( $doc, [string $nodeName = ""])
boolean valid ()
CFType __get (integer $key)
Variables
array $iteratorKeys = null (line 570)

List of Keys for numerical iterator access http://php.net/manual/en/class.iterator.php

integer $iteratorPosition = 0 (line 564)

Position of iterator http://php.net/manual/en/class.iterator.php

Inherited Variables

Inherited from CFType

CFType::$value
Methods
Constructor __construct (line 577)

Create new CFType.

  • access: public
CFDictionary __construct ([array $value = array()])
  • array $value: Value of CFType

Redefinition of:
CFType::__construct()
Create new CFType.
add (line 596)

Add CFType to collection.

void add (string $key, [CFType $value = null])
  • string $key: Key to add to collection
  • CFType $value: CFType to add to collection, defaults to null which results in an empty CFString
current (line 704)

Get Iterator's current CFType identified by $iteratorPosition

CFType current ()

Implementation of:
Iterator::current
del (line 633)

Remove CFType from collection.

  • return: removed CFType, null else
  • access: public
  • uses: CFType::$value - for removing CFType of $key
CFType del (string $key)
  • string $key: Key of CFType to removes from collection
get (line 610)

Get CFType from collection.

CFType get (string $key)
  • string $key: Key of CFType to retrieve from collection
key (line 715)

Get Iterator's current key identified by $iteratorPosition

string key ()

Implementation of:
Iterator::key
next (line 725)

Increment $iteratorPosition to address next {@see CFType}

void next ()

Implementation of:
Iterator::next
rewind (line 692)

Rewind $iteratorPosition to first position (being 0)

void rewind ()

Implementation of:
Iterator::rewind
setValue (line 586)

Set the CFType's value

Note: this dummy does nothing

  • access: public
void setValue ( $value)
  • $value

Redefinition of:
CFType::setValue()
Set the CFType's value
toArray (line 673)

Get CFType's value.

  • return: primitive value
  • access: public
  • uses: CFType::$value - for retrieving primitive of CFType
array toArray ()

Redefinition of:
CFType::toArray()
Get CFType's value.
toBinary (line 664)

convert value to binary representation

  • return: offset in the object table
  • access: public
The toBinary (CFBinaryPropertyList &$bplist)

Redefinition of:
CFType::toBinary()
convert value to binary representation
toXML (line 648)

Get XML-Node.

  • return: <dict>-Element
  • access: public
DOMNode toXML ( $doc, [string $nodeName = ""])
  • DOMDocument $doc: DOMDocument to create DOMNode in
  • string $nodeName: For compatibility reasons; just ignore it

Redefinition of:
CFType::toXML()
Get XML-Node.
valid (line 736)

Test if $iteratorPosition addresses a valid element of $value

boolean valid ()

Implementation of:
Iterator::valid
__get (line 623)

Generic getter (magic)

CFType __get (integer $key)
  • integer $key: Key of CFType to retrieve from collection

Inherited Methods

Inherited From CFType

CFType::__construct()
CFType::getValue()
CFType::setValue()
CFType::toArray()
CFType::toBinary()
CFType::toXML()

Documentation generated on Fri, 01 Jan 2010 21:33:34 +0100 by phpDocumentor 1.4.1