eZ Components 2007.2beta1

Getting Started

Components

Archive (1.2.4)
Authentication (1.1beta1)
AuthenticationDatabaseTiein (1.1beta1)
Base (1.4beta1)
Cache (1.3beta1)
Configuration (1.2)
ConsoleTools (1.3.1)
Database (1.3.2)
DatabaseSchema (1.3beta1)
Debug (1.1)
EventLog (1.2beta1)
EventLogDatabaseTiein (1.0.2)
Execution (1.1beta1)
Feed (1.0beta1)
File (1.2beta1)
Graph (1.2beta1)
GraphDatabaseTiein (1.0)
ImageAnalysis (1.1.2)
ImageConversion (1.3.1)
Mail (1.4beta1)
PersistentObject (1.3.2)
PersistentObjectDatabaseSchemaTiein (1.2.1)
PhpGenerator (1.0.4)
SignalSlot (1.1)
SystemInformation (1.0.5)
Template (1.2)
Translation (1.1.5)
TranslationCacheTiein (1.1.2)
Tree (1.0beta1)
TreeDatabaseTiein (1.0beta1)
TreePersistentObjectTiein (1.0beta1)
Url (1.2beta1)
UserInput (1.2beta1)
Webdav (1.0beta1)
Workflow (1.1beta1)
WorkflowDatabaseTiein (1.1beta1)
WorkflowEventLogTiein (1.1beta1)

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
ezcAuthenticationSessionOptions	Class containing the options for the authentication session.
ezcAuthenticationOpenidStoreOptions	Class containing the options for the OpenID store.
ezcAuthenticationOptions	Class containing the basic options for the authentication main class.
ezcAuthenticationFilterOptions	Class containing the basic options for authentication filters.
ezcCacheStorageApcOptions	Option class for defining a connection to APC.
ezcCacheStorageFileOptions	Option class for the ezcCacheStorageFile class.
ezcCacheStorageMemcacheOptions	Option class for defining a connection to a Memcache server.
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 options for font configuration.
ezcGraphChartOptions	Class containing the basic options for charts.
ezcGraphDriverOptions	Class containing the basic driver options.
ezcImageSaveOptions	Options class for ezcImageHandler->save() methods.
ezcMailImapSetOptions	Class containing the options for IMAP mail set.
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.
ezcTreeVisitorXHTMLOptions	Class containing the options for the ezcTreeVisitorXHTMLOptions class.
ezcTreeVisitorYUIOptions	Class containing the options for the ezcTreeVisitorYUIOptions class.
ezcWebdavTransportOptions	Class containing the options for basic webdav server.

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

ezcBaseOptions __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

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.
`ezcAuthenticationOpenidDbStoreOptions::__construct()`	Constructs an object with the specified values.
`ezcAuthenticationOptions::__construct()`	Constructs an object with the specified values.
`ezcAuthenticationFilterOptions::__construct()`	Constructs an object with the specified values.
`ezcAuthenticationTypekeyOptions::__construct()`	Constructs an object with the specified values.
`ezcAuthenticationGroupOptions::__construct()`	Constructs an object with the specified values.
`ezcAuthenticationOpenidOptions::__construct()`	Constructs an object with the specified values.
`ezcAuthenticationLdapOptions::__construct()`	Constructs an object with the specified values.
`ezcAuthenticationHtpasswdOptions::__construct()`	Constructs an object with the specified values.
`ezcAuthenticationTokenOptions::__construct()`	Constructs an object with the specified values.
`ezcAuthenticationDatabaseOptions::__construct()`	Constructs an object with the specified values.
`ezcCacheStorageApcOptions::__construct()`	Constructs an object with the specified values.
`ezcCacheStorageFileApcArrayOptions::__construct()`	Constructs an object with the specified values.
`ezcCacheStorageFileOptions::__construct()`	Constructs a new options class.
`ezcCacheStorageMemcacheOptions::__construct()`	Constructs an object with the specified values.
`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
`ezcMailImapSetOptions::__construct()`	Constructs an object with the specified values.
`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.
`ezcTreeVisitorXHTMLOptions::__construct()`	Constructs an object with the specified values.
`ezcTreeVisitorYUIOptions::__construct()`	Constructs an object with the specified values.
`ezcWebdavTransportOptions::__construct()`	Constructs an object with the specified values.

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(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

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

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

offsetSet

void offsetSet( string $propertyName, mixed $propertyValue )

Set an option.

Sets an option using ArrayAccess.

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

void offsetUnset( string $propertyName )

Unset an option.

Unsets an option using ArrayAccess.

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.

Last updated: Wed, 28 Nov 2007

eZ Components

User menu

Path

eZ Components 2007.2beta1

Getting Started

Components

Base: ezcBaseOptions

Class: ezcBaseOptions

Implemented Interfaces

Descendents

Member Variables

Method Summary

Methods

__construct

Parameters

Throws

Redefined in descendants as

merge

Parameters

Throws

offsetExists

Parameters

offsetGet

Parameters

Throws

offsetSet

Parameters

Throws

offsetUnset

Parameters

Throws