Path

ez components / documentation / api reference / 2006.2 / base

eZ Components 2006.2

Base: ezcBaseOptions

[ Tutorial ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Class: ezcBaseOptions

Base options class for all eZ components. [source]

Implemented Interfaces

  • ArrayAccess (internal interface)

Descendents

Child Class Description
ezcCacheStorageOptions Option class for the ezcCacheStorage class.
ezcConsoleOutputOptions Struct class to store the options of the ezcConsoleOutput class.
ezcConsoleProgressbarOptions Struct class to store the options of the ezcConsoleOutput class.
ezcConsoleStatusbarOptions Struct class to store the options of the ezcConsoleOutput class.
ezcConsoleProgressMonitorOptions Struct class to store the options of the ezcConsoleOutput class.
ezcConsoleTableOptions Struct class to store the options of the ezcConsoleTable class.
ezcGraphAxisLabelRenderer Abstract class to render labels and grids on axis. Will be extended to make it possible using different algorithms for rendering axis labels.
ezcGraphChartElement Class for basic chart elements
ezcGraphColor ezcGraphColor
ezcGraphFontOptions Class containing the basic options for charts
ezcGraphChartOptions Class containing the basic options for charts
ezcGraphDriverOptions Class containing the basic options for charts
ezcTranslationTsBackendOptions Struct class to store the options of the ezcTranslationTsBackend class.

Member Variables

protected array(string=>mixed) $properties
Container to hold the properties

Method Summary

public void __construct( [$options = array()] )
Construct a new options object.
public void merge( $newOptions )
Merge an array into the actual options object.
public bool offsetExists( $propertyName )
Returns if an option exists.
public mixed offsetGet( $propertyName )
Returns an option value.
public void offsetSet( $propertyName, $propertyValue )
Set an option.
public void offsetUnset( $propertyName )
Unset an option.
public mixed __get( $propertyName )
Property get access.

Methods

__construct

void __construct( [ $options = array()] )
Construct a new options object.
Options are constructed from an option array by default. The constructor automatically passes the given options to the __set() method to set them in the class.

Parameters

Name Type Description
$options array(string=>mixed) The initial options to set.

Throws

ClassDescription
ezcBasePropertyNotFoundException If a the value for the property options is not an instance of
ezcBaseValueException If a the value for a property is out of range.

Redefined in descendants as

Method Description
ezcCacheStorageOptions::__construct() Constructs a new options class.
ezcConsoleOutputOptions::__construct() Construct a new options object.
ezcConsoleProgressbarOptions::__construct() Construct a new options object.
ezcConsoleStatusbarOptions::__construct() Construct a new options object.
ezcConsoleProgressMonitorOptions::__construct() Construct a new options object.
ezcConsoleTableOptions::__construct() Construct a new options object.
ezcGraphLinearGradient::__construct() Constructor
ezcGraphRadialGradient::__construct() Constructor
ezcGraphChartOptions::__construct()  
ezcTranslationTsBackendOptions::__construct() Constructs a new options class.

merge

void merge( $newOptions )
Merge an array into the actual options object.
This method merges an array of new options into the actual options object.

Parameters

Name Type Description
$newOptions array The new options.

Throws

ClassDescription
ezcBasePropertyNotFoundException If a the value for the property options is not an instance of
ezcBaseValueException If a the value for a property is out of range.

offsetExists

bool offsetExists( string $propertyName )
Returns if an option exists.
Allows isset() using ArrayAccess.

Parameters

Name Type Description
$propertyName string The name of the option to get.

offsetGet

mixed offsetGet( string $propertyName )
Returns an option value.
Get an option value by ArrayAccess.

Parameters

Name Type Description
$propertyName string The name of the option to get.

Throws

ClassDescription
ezcBasePropertyNotFoundException If a the value for the property options is not an instance of

offsetSet

void offsetSet( string $propertyName, mixed $propertyValue )
Set an option.
Sets an option using ArrayAccess.

Parameters

Name Type Description
$propertyName string The option to set.
$propertyValue mixed The value for the option.

Throws

ClassDescription
ezcBasePropertyNotFoundException If a the value for the property options is not an instance of
ezcBaseValueException If a the value for a property is out of range.

offsetUnset

void offsetUnset( string $propertyName )
Unset an option.
Unsets an option using ArrayAccess.

Parameters

Name Type Description
$propertyName string The options to unset.

Throws

ClassDescription
ezcBasePropertyNotFoundException If a the value for the property options is not an instance of
ezcBaseValueException If a the value for a property is out of range.

__get

mixed __get( string $propertyName )
Property get access.
Simply returns a given option.

Parameters

Name Type Description
$propertyName string The name of the option to get.

Throws

ClassDescription
ezcBasePropertyNotFoundException If a the value for the property options is not an instance of

Redefined in descendants as

Method Description
ezcGraphChartElementBackground::__get()  
ezcGraphChartElementLegend::__get()  

Last updated: Thu, 01 Nov 2007