phpDocumentor CCL
[ class tree: CCL ] [ index: CCL ] [ all elements ]

Class: Container

Source Location: /Container.php

Class Container

Class Overview

Implements interfaces:

  • ArrayAccess (internal interface)
  • Iterator (internal interface)
  • Serializable (internal interface)

Abstract class with properties contained as associative array and simple methods to access them.

Located in /Container.php [line 14]



		
				Author(s):
		
API Tags:
Abstract:  

Properties

Methods

[ Top ]
Descendants
Child Class Description
Entity Data model entity in terms of ER design.

[ Top ]
Property Summary
array   $data   Fields containing values

[ Top ]
Method Summary
Container   __construct()   Constructs container and puts data inside
mixed   current()   Returns current container element
mixed   key()   Fetches current key from the container
bool   key_exists()   Checks if key exists in container
mixed   next()   Fetches next element from the container
bool   offsetExists()   Checks if any item is assigned to a key
mixed   offsetGet()   Returns contained item by key or NULL on error
void   offsetSet()   Sets a contained item value in array style
void   offsetUnset()   Removes contained item by key
void   rewind()   Sets iterator pointer to the beginning of the container
string   serialize()   Serializes the container
void   unserialize()   Unserializes container data
bool   valid()   Checks if iterator pointer points to a valid element (non-false)

[ Top ]
Properties
array   $data = array() [line 19]

Fields containing values

API Tags:
Access:  protected


[ Top ]
Methods
Constructor __construct  [line 25]

  Container __construct( array $data  )

Constructs container and puts data inside

Parameters:
array   $data:  Property set

API Tags:
Access:  public


Redefined in descendants as:

[ Top ]
current  [line 37]

  mixed current( )

Returns current container element


API Tags:
Return:  Data element
Access:  public


Implementation of:
Iterator::current

[ Top ]
key  [line 46]

  mixed key( )

Fetches current key from the container


API Tags:
Return:  Current key
Access:  public


Implementation of:
Iterator::key

[ Top ]
key_exists  [line 56]

  bool key_exists( mixed $key  )

Checks if key exists in container

Parameters:
mixed   $key:  Key to search for

API Tags:
Return:  TRUE if key exists, FALSE otherwise
Access:  public


[ Top ]
next  [line 65]

  mixed next( )

Fetches next element from the container


API Tags:
Return:  Next element
Access:  public


Implementation of:
Iterator::next

[ Top ]
offsetExists  [line 85]

  bool offsetExists( mixed $offset  )

Checks if any item is assigned to a key

Parameters:
mixed   $offset:  Key

API Tags:
Return:  Item exists
Access:  public


Implementation of:
ArrayAccess::offsetExists

[ Top ]
offsetGet  [line 104]

  mixed offsetGet( mixed $offset  )

Returns contained item by key or NULL on error

Parameters:
mixed   $offset:  Key

API Tags:
Return:  Contained item or NULL if none exists
Access:  public


Implementation of:
ArrayAccess::offsetGet

[ Top ]
offsetSet  [line 75]

  void offsetSet( mixed $offset, mixed $value  )

Sets a contained item value in array style

Parameters:
mixed   $offset:  Key
mixed   $value:  Value

API Tags:
Access:  public


Implementation of:
ArrayAccess::offsetSet

[ Top ]
offsetUnset  [line 94]

  void offsetUnset( mixed $offset  )

Removes contained item by key

Parameters:
mixed   $offset:  Key

API Tags:
Access:  public


Implementation of:
ArrayAccess::offsetUnset

[ Top ]
rewind  [line 112]

  void rewind( )

Sets iterator pointer to the beginning of the container


API Tags:
Access:  public


Implementation of:
Iterator::rewind

[ Top ]
serialize  [line 121]

  string serialize( )

Serializes the container


API Tags:
Return:  Serialized data
Access:  public


Implementation of:
Serializable::serialize

[ Top ]
unserialize  [line 139]

  void unserialize( string $srl_data  )

Unserializes container data

Parameters:
string   $srl_data:  Serialized data

API Tags:
Access:  public


Implementation of:
Serializable::unserialize

[ Top ]
valid  [line 130]

  bool valid( )

Checks if iterator pointer points to a valid element (non-false)


API Tags:
Return:  Current element validity
Access:  public


Implementation of:
Iterator::valid

[ Top ]

Documentation generated on Thu, 09 Jul 2009 14:11:32 +0400 by phpDocumentor 1.4.1