[ 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
ezcAuthenticationSessionOptions	Class containing the options for the authentication session.
ezcAuthenticationOpenidStoreOptions	Class containing the options for the OpenID store.
ezcAuthenticationFilterOptions	Class containing the basic options for authentication filters.
ezcAuthenticationOptions	Class containing the basic options for the authentication main class.
ezcCacheStorageFileOptions	Option class for the ezcCacheStorageFile class.
ezcCacheStorageOptions	Option class for the ezcCacheStorage class.
ezcConsoleOutputOptions	Struct class to store the options of the ezcConsoleOutput class.
ezcConsoleDialogOptions	Basic options class for ezcConsoleDialog implementations.
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.
ezcDbMssqlOptions	Class containing the options for MS SQL Server connections
ezcDbSchemaOptions	Class containing the basic options for charts
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
ezcImageSaveOptions	Options class for ezcImageHandler->save() methods.
ezcMailParserOptions	Class containing the basic options for the mail parser.
ezcMailTransportOptions	Class containing the basic options for mail transports.
ezcSignalCollectionOptions	Struct class to store the options of the ezcConsoleOutput class.
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 ezcBaseOptions	__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.

Methods

__construct

Parameters

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

Throws

Class	Description
ezcBasePropertyNotFoundException	If trying to access a non existent property.
ezcBaseValueException	If the value for a property is out of range.

Redefined in descendants as

Method	Description
ezcAuthenticationSessionOptions::__construct()	Constructs an object with the specified values.
ezcAuthenticationOpenidStoreOptions::__construct()	Constructs an object with the specified values.
ezcAuthenticationOpenidFileStoreOptions::__construct()	Constructs an object with the specified values.
ezcAuthenticationFilterOptions::__construct()	Constructs an object with the specified values.
ezcAuthenticationLdapOptions::__construct()	Constructs an object with the specified values.
ezcAuthenticationGroupOptions::__construct()	Constructs an object with the specified values.
ezcAuthenticationTokenOptions::__construct()	Constructs an object with the specified values.
ezcAuthenticationHtpasswdOptions::__construct()	Constructs an object with the specified values.
ezcAuthenticationOpenidOptions::__construct()	Constructs an object with the specified values.
ezcAuthenticationTypekeyOptions::__construct()	Constructs an object with the specified values.
ezcAuthenticationDatabaseOptions::__construct()	Constructs an object with the specified values.
ezcAuthenticationOptions::__construct()	Constructs an object with the specified values.
ezcCacheStorageFileOptions::__construct()	Constructs a new options class.
ezcCacheStorageOptions::__construct()	Constructs a new options object.
ezcConsoleOutputOptions::__construct()	Construct a new options object.
ezcConsoleQuestionDialogOptions::__construct()	Construct a new options object.
ezcConsoleMenuDialogOptions::__construct()	Construct a new options object.
ezcConsoleTableOptions::__construct()	Construct a new options object.
ezcDbMssqlOptions::__construct()	Creates an ezcDbMssqlOptions object with default option values.
ezcGraphLinearGradient::__construct()	Constructor
ezcGraphRadialGradient::__construct()	Constructor
ezcMailParserOptions::__construct()	Constructs an object with the specified values.
ezcMailTransportOptions::__construct()	Constructs an object with the specified values.
ezcMailSmtpTransportOptions::__construct()	Constructs an object with the specified values.
ezcMailImapTransportOptions::__construct()	Constructs an object with the specified values.
ezcMailPop3TransportOptions::__construct()	Constructs an object with the specified values.
ezcSignalCollectionOptions::__construct()	Construct a new options object.
ezcTranslationTsBackendOptions::__construct()	Constructs a new options class.

merge

Parameters

Name	Type	Description
$newOptions	array(string=>mixed)	The new options.

Throws

Class	Description
ezcBasePropertyNotFoundException	If trying to access a non existent property.
ezcBaseValueException	If the value for a property is out of range.

offsetExists

Parameters

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

offsetGet

Parameters

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

Throws

Class	Description
ezcBasePropertyNotFoundException	If $propertyName is not a key in the $properties array.

offsetSet

Parameters

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

Throws

Class	Description
ezcBasePropertyNotFoundException	If $propertyName is not a key in the $properties array.
ezcBaseValueException	If the value for a property is out of range.

offsetUnset

Parameters

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

Throws

Class	Description
ezcBasePropertyNotFoundException	If $propertyName is not a key in the $properties array.
ezcBaseValueException	If a the value for a property is out of range.