Class: DataComponent

Source Location: /framework/util/datacomponent.inc.php

Class Overview

DataSpace
   |
   --DataComponent

The DataSpace is a container for a set of named data values (properties).

Methods

Child classes:

RectangleDataSpace: The DataSpace is a container for a set of named data values (properties).

Inherited Variables

Class: DataSpace

DataSpace::$filter
DataSpace::$properties

Inherited Methods

Class: DataSpace

DataSpace::export(): Returns a reference to the complete array of properties stored
DataSpace::get(): Gets a copy of a stored property by name
DataSpace::getPath(): Gets a property value by navagating a dot separated path that dereferences elements within the dataspace.
DataSpace::getPropertyList(): Return a unique list of available properties This method is probably going to have capitalization problems.
DataSpace::hasProperty(): Has a value been assigned under this name for this dataspace?
DataSpace::import(): replaces the current properties of this dataspace with the proprties and values passed as a parameter
DataSpace::isDataSource(): Any class that implements the DataSource interface should implement this method This is a PHP4 way of detecting which objects implement the interface.
DataSpace::makeDataSpace(): Static method to convert a variable into a dataspace.
DataSpace::merge(): Append a new list of values to the DataSpace.
DataSpace::prepare(): Prepares the dataspace, executing the doFilter() method of the registered filter, if one exists
DataSpace::registerFilter(): Registers a filter with the dataspace.
DataSpace::remove(): removes stored property value
DataSpace::removeAll(): removes all property values
DataSpace::set(): Stores a copy of value into a Property
DataSpace::setPath(): Stores a copy of value into a Property based on a dot separated path.

Class Details

The DataSpace is a container for a set of named data values (properties).

Class Methods

method get

Gets a copy of a stored property by name

mixed get(
string
$name)

API Tags:

return:	value of property or NULL if not found
access:	public

Overrides DataSpace::get() (Gets a copy of a stored property by name)

Parameters:

string

$name

name of property

method getPropertyList

Return a unique list of available properties This method is probably going to have capitalization problems.

array getPropertyList(
)

API Tags:

access:

public

Overrides DataSpace::getPropertyList() (Return a unique list of available properties This method is probably going to have capitalization problems.)

method hasProperty

Has a value been assigned under this name for this dataspace?

boolean hasProperty(
string
$name)

API Tags:

return:	TRUE if property exists
access:	public

Overrides DataSpace::hasProperty() (Has a value been assigned under this name for this dataspace?)

Parameters:

string

$name

name of property

method import

replaces the current properties of this dataspace with the proprties and values passed as a parameter

void import(
array
$property_list)

API Tags:

access:

public

Overrides DataSpace::import() (replaces the current properties of this dataspace with the proprties and values passed as a parameter)

Parameters:

array

$property_list

method set

Stores a copy of value into a Property

void set(
string
$name, mixed
$value)

API Tags:

access:

public

Overrides DataSpace::set() (Stores a copy of value into a Property)

Parameters:

string	$name	name of property
mixed	$value	value of property

Documentation generated on Sun, 28 Nov 2004 19:45:06 -0800 by phpDocumentor 1.2.3