Path

ez components / documentation / api reference / 2009.2.1 / base


eZ Components 2009.2.1

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
ezcArchiveOptions Class containing the basic options for ezcBase' autoload.
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.
ezcAuthenticationSessionOptions Class containing the options for the authentication session.
ezcCacheStorageApcOptions Option class for defining a connection to APC.
ezcCacheStorageMemcacheOptions Option class for defining a connection to a Memcache server.
ezcCacheStorageOptions Option class for the ezcCacheStorage class.
ezcCacheStackOptions Options class for ezcCacheStack instances.
ezcCacheStorageFileOptions Option class for the ezcCacheStorageFile 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.
ezcConsoleDialogOptions Basic options class for ezcConsoleDialog implementations.
ezcConsoleProgressbarOptions Struct class to store the options of the ezcConsoleOutput class.
ezcConsoleOutputOptions Struct class to store the options of the ezcConsoleOutput class.
ezcDbMssqlOptions Class containing the options for MS SQL Server connections
ezcDbSchemaOptions Class containing the basic options for charts
ezcDebugOptions Options class for ezcDebug.
ezcDocumentOptions Class containing the basic options for the ezcDocument
ezcDocumentConverterOptions Class containing the basic options for the ezcDocumentConverter
ezcDocumentParserOptions Class containing the basic options for the ezcDocumentParser.
ezcGraphColor ezcGraphColor
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 Base class for chart elements
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.
ezcMailParserOptions Class containing the basic options for the mail parser.
ezcMailTransportOptions Class containing the basic options for mail transports.
ezcMailImapSetOptions Class containing the options for IMAP mail set.
ezcMailOptions Class containing the options for the mail generator.
ezcMvcAuthenticationFilterOptions Class containing authentication filter options
ezcPersistentSessionIdentityDecoratorOptions Options class for ezcPersistentSessionIdentityDecorator.
ezcPersistentObjectTemplateSchemaWriterOptions Option class for ezcPersistentObjectTemplateSchemaWriter.
ezcSignalCollectionOptions Struct class to store the options of the ezcConsoleOutput class.
ezcTranslationTsBackendOptions Struct class to store the options of the ezcTranslationTsBackend class.
ezcTreeVisitorYUIOptions Class containing the options for the ezcTreeVisitorYUIOptions class.
ezcTreeVisitorXHTMLOptions Class containing the options for the ezcTreeVisitorXHTMLOptions class.
ezcWebdavLockPluginOptions Option class for the Webdav lock plugin.
ezcWebdavFileBackendOptions Class containing the options for the file backend.
ezcWebdavServerOptions Options class for ezcWebdavServer.
ezcWorkflowExecutionVisualizerPluginOptions Options class for ezcWorkflowExecutionVisualizerPlugin.
ezcWorkflowVisitorVisualizationOptions Options class for ezcWorkflowVisitorVisualization.
ezcWorkflowDatabaseOptions Options class for ezcWorkflowDatabase.
ezcWorkflowSignalSlotPluginOptions Options class for ezcWorkflowVisitorVisualization.

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

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

Redefined in descendants as

Method Description
ezcArchiveOptions::__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.
ezcAuthenticationLdapOptions::__construct() Constructs an object with the specified values.
ezcAuthenticationHtpasswdOptions::__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.
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.
ezcAuthenticationSessionOptions::__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.
ezcCacheStorageMemcacheOptions::__construct() Constructs an object with the specified values.
ezcCacheStorageOptions::__construct() Constructs a new options object.
ezcCacheStackOptions::__construct() Construct a new options object.
ezcCacheStorageFileOptions::__construct() Constructs a new options class.
ezcConsoleTableOptions::__construct() Construct a new options object.
ezcConsoleMenuDialogOptions::__construct() Construct a new options object.
ezcConsoleQuestionDialogOptions::__construct() Construct a new options object.
ezcConsoleOutputOptions::__construct() Construct a new options object.
ezcDbMssqlOptions::__construct() Creates an ezcDbMssqlOptions object with default option values.
ezcDocumentPdfFooterOptions::__construct() Constructs an object with the specified values.
ezcDocumentBBCodeOptions::__construct() Constructs an object with the specified values.
ezcDocumentWikiOptions::__construct() Constructs an object with the specified values.
ezcDocumentPdfOptions::__construct() Constructs an object with the specified values.
ezcDocumentRstOptions::__construct() Constructs an object with the specified values.
ezcDocumentXmlOptions::__construct() Constructs an object with the specified values.
ezcDocumentEzXmlOptions::__construct() Constructs an object with the specified values.
ezcDocumentDocbookOptions::__construct() Constructs an object with the specified values.
ezcDocumentXhtmlOptions::__construct() Constructs an object with the specified values.
ezcDocumentOdtOptions::__construct() Constructs an object with the specified values.
ezcDocumentXsltConverterOptions::__construct() Constructs an object with the specified values.
ezcDocumentDocbookToHtmlXsltConverterOptions::__construct() Constructs an object with the specified values.
ezcDocumentDocbookToEzXmlConverterOptions::__construct() Constructs an object with the specified values.
ezcDocumentDocbookToOdtConverterOptions::__construct() Constructs an object with the specified values.
ezcDocumentHtmlConverterOptions::__construct() Constructs an object with the specified values.
ezcDocumentDocbookToHtmlConverterOptions::__construct() Constructs an object with the specified values.
ezcDocumentDocbookToWikiConverterOptions::__construct() Constructs an object with the specified values.
ezcDocumentEzXmlToDocbookConverterOptions::__construct() Constructs an object with the specified values.
ezcDocumentDocbookToRstConverterOptions::__construct() Constructs an object with the specified 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.
ezcMailImapTransportOptions::__construct() Constructs an object with the specified values.
ezcMailPop3TransportOptions::__construct() Constructs an object with the specified values.
ezcMailSmtpTransportOptions::__construct() Constructs an object with the specified values.
ezcMailImapSetOptions::__construct() Constructs an object with the specified values.
ezcMailOptions::__construct() Constructs an object with the specified values.
ezcMailComposerOptions::__construct() Constructs an object with the specified values.
ezcMvcAuthenticationFilterOptions::__construct() Constructs an object with the specified values.
ezcPersistentSessionIdentityDecoratorOptions::__construct() Construct a new options object.
ezcPersistentObjectTemplateSchemaWriterOptions::__construct() Construct a new options object.
ezcSignalCollectionOptions::__construct() Construct a new options object.
ezcTranslationTsBackendOptions::__construct() Constructs a new options class.
ezcTreeVisitorYUIOptions::__construct() Constructs an object with the specified values.
ezcTreeVisitorXHTMLOptions::__construct() Constructs an object with the specified values.
ezcWebdavLockPluginOptions::__construct() Construct a new options object.
ezcWebdavFileBackendOptions::__construct() Constructs an object with the specified values.
ezcWebdavServerOptions::__construct() Constructs a new options objet with the given $options;

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

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

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

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

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

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

Last updated: Tue, 23 Mar 2010