Path

ez components / documentation / api reference / 1.0.1 /

eZ Components 1.0.1

All Classes Index

[A] [B] [C] [D] [E] [I] [L] [M] [P] [Q] [T]
A :
ezcArchive The ezcArchive class provides the common interface for reading and writing the archive formats Tar and Zip.
ezcArchiveBlockSizeException Exception will be thrown when the prefix given to the file that should be appended, is incorrect.
ezcArchiveChecksumException Exception will be thrown when the checksum of the file is invalid.
ezcArchiveEmptyException Archive is empty.
ezcArchiveEntry The ezcArchiveEntry class provides system-independent file information.
ezcArchiveEntryPrefixException
ezcArchiveException General exception class for the Archive package.
ezcArchiveFileException This class provides an exception for errors occuring while accessing file based archives.
ezcArchiveGnuTar The ezcArchiveGnuTar class implements the GNU Tar archive format.
ezcArchiveIoException Exception will be thrown when the prefix given to the file that should be appended, is incorrect.
ezcArchivePaxTar The ezcArchivePaxTar class implements the Tar pax or posix archive format.
ezcArchiveUnknownTypeException Exception will be thrown when the prefix given to the file that should be appended, is incorrect.
ezcArchiveUstarTar The ezcArchiveUstarTar class implements the Tar ustar archive format.
ezcArchiveV7Tar The ezcArchiveV7Tar class implements the Tar v7 archive format.
ezcArchiveValueException Archive value is wrong.
ezcArchiveZip The ezcArchiveZip class implements the Zip archive format.
B :
ezcBase Base class implements the methods needed to use the ezComponents.
ezcBaseException ezcBaseException is a container from which all other exceptions in the components library descent.
ezcBaseFileException ezcBaseFileException is the exception from which all file related exceptions inherit.
ezcBaseFileIoException ezcBaseFileIoException is thrown when a problem occurs while writing and reading to/from an open file.
ezcBaseFileNotFoundException ezcBaseFileNotFoundException is thrown when a file or directory was tried to be opened, but did not exist.
ezcBaseFilePermissionException ezcBaseFilePermissionException is thrown whenever a permission problem with a file, directory or stream occurred.
ezcBasePropertyNotFoundException ezcBasePropertyNotFoundException is thrown whenever a non existent property is accessed in the Components library.
ezcBasePropertyPermissionException ezcBasePropertyPermissionException is thrown whenever a read-only property is tried to be changed, or when a write-only property was accessed for reading.
ezcBaseSettingNotFoundException ezcBaseSettingNotFoundException is thrown whenever there is a name passed as part as the options array to setOptions() for an option that doesn't exist.
ezcBaseSettingValueException ezcBaseSettingValueExeception is thrown whenever a value to a class' configuration option is either of the wrong type, or has a wrong value.
ezcBaseValueException ezcBaseValueException is thrown whenever the type or value of the given variable is not as expected.
C :
ezcCacheException General exception container for the Cache component.
ezcCacheInvalidDataException Thrown if the data to be stored in a cache can not be handled by the storage.
ezcCacheInvalidIdException Exception that is thrown if the given cache ID does not exist.
ezcCacheInvalidStorageClassException Exception that is thrown when an invalid storage class is used.
ezcCacheManager This is the main class of the Cache package. It gives you a handy interface to create and manage multiple caches at once. It enables you to configure all caches you need in your application in a central place and access them on demand in any place in your application.
ezcCacheStorage This is the abstract base class for all cache storages. It provides the interface to be implemented by a cache backend as abstract methods.
ezcCacheStorageFile This class implements most of the methods which have been declared abstract in ezcCacheStorage, but also declares 2 new methods abstract, which have to be implemented by storage driver itself.
ezcCacheStorageFileArray This cache storage implementation stores arrays and scalar values
ezcCacheStorageFileEvalArray This cache storage implementation stores arrays and scalar values (int,
ezcCacheStorageFilePlain This class implements a simple storage to cache plain text on the filesystem. It takes it's base methods from the extended storage base class ezcCacheStorageFile.
ezcCacheUsedLocationException Exception that is thrown when a given location is already in use.
ezcConfiguration This class provides persistent platform-independent and format independent application settings.
ezcConfigurationArrayReader This class provides functionality for reading files containing specific PHP arrays into ezcConfiguration objects.
ezcConfigurationArrayWriter This class provides functionality for writing ezcConfiguration object into files containing PHP arrays.
ezcConfigurationException This class provides an exception container for use with the Configuration component.
ezcConfigurationFileReader ezcConfigurationFileReader class provides the functionality for reading file based configuration formats.
ezcConfigurationFileWriter ezcConfigurationFileWriter class provides the functionality for writing file based configuration formats.
ezcConfigurationGroupExistsAlreadyException Exception that is thrown if a group is tried to be added, while it already exists.
ezcConfigurationIniItem A container to store one INI settings item
ezcConfigurationIniParser This class provides functionality for parsing INI files
ezcConfigurationIniReader ezcConfigurationIniReader provides functionality for reading INI files into ezcConfiguration objects.
ezcConfigurationIniWriter This class provides functionality for writing ezcConfiguration objects into INI files.
ezcConfigurationInvalidReaderClassException Exception that is thrown if an invalid class is passed as INI reader to the manager.
ezcConfigurationInvalidSuffixException Exception that is thrown if the current location is not valid. This means it is impossible to read or write using the location values.
ezcConfigurationManager ezcConfigurationManager provides easy access to application settings.
ezcConfigurationNoConfigException Exception that is thrown if no configuration object is present to work on.
ezcConfigurationNoConfigObjectException Exception that is thrown if no configuration object has been set to operate on. The operation cannot continue with this object.
ezcConfigurationParseErrorException Exception that is thrown if there were errors while parsing a file while the parser was not in validation mode.
ezcConfigurationReadFailedException Exception that is thrown if the read operation for the configuration failed.
ezcConfigurationReader This class provides the interface for readers of configuration objects of type ezcConfiguration.
ezcConfigurationSettingWrongTypeException Exception that is thrown if the accessed setting is not of the requested type.
ezcConfigurationSettingnameNotStringException Exception that is thrown if the name of a setting is not a string.
ezcConfigurationUnknownConfigException Exception that is thrown if the specified configuration does not exist in the system.
ezcConfigurationUnknownGroupException Exception that is thrown if the specified group does not exist in the settings.
ezcConfigurationUnknownSettingException Exception that is thrown if the specified setting does not exist in the settings.
ezcConfigurationValidationItem This class provides the result of one error item in the ezcConfigurationValidationResult class.
ezcConfigurationValidationResult Provides the result of an ezcConfigurationFileReader::validate() operation.
ezcConfigurationWriteFailedException Exception that is thrown if the write operation for the configuration failed.
ezcConfigurationWriter This class provides the interface for writers of configuration objects of type ezcConfiguration.
ezcConsoleException General exception container for the ConsoleTools component.
ezcConsoleInput Class for handling input submitted to console based programs (meaning options and arguments) .
ezcConsoleNoPositionStoredException 'Cannot restore position, if no position has been stored before.'.
ezcConsoleOption Struct like class to store data about a single option for ezcConsoleInput.
ezcConsoleOptionAlreadyRegisteredException The option name you tried to register is already in use.
ezcConsoleOptionArgumentsViolationException An option excludes the usage of arguments, but there were arguments submitted.
ezcConsoleOptionDependencyViolationException A dependency rule for a parameter was violated.
ezcConsoleOptionException General exception container for the ConsoleTools component referring to option handling.
ezcConsoleOptionExclusionViolationException An exclusion rule for a parameter was violated.
ezcConsoleOptionMandatoryViolationException An option was marked to be mandatory but was not submitted.
ezcConsoleOptionMissingValueException An option which expects a value was submitted without.
ezcConsoleOptionNoAliasException The alias you tried to unregister is a real option.
ezcConsoleOptionNotExistsException The requested option is not registered.
ezcConsoleOptionRule Struct class to store a parameter rule.
ezcConsoleOptionStringNotWellformedException The option definition string supplied is not wellformed.
ezcConsoleOptionTooManyValuesException An option that expects only a single value was submitted with multiple values.
ezcConsoleOptionTypeViolationException An option was submitted with an illigal type.
ezcConsoleOutput Class for handling console output.
ezcConsoleOutputFormat Struct class to store formating entities used by ezcConsoleOutput.
ezcConsoleOutputFormats Class to store the collection for formating classes.
ezcConsoleOutputOptions Struct class to store the options of the ezcConsoleOutput class.
ezcConsoleProgressbar Creating and maintaining progressbars to be printed to the console.
ezcConsoleProgressbarOptions Struct class to store the options of the ezcConsoleOutput class.
ezcConsoleStatusbar Creating and maintaining statusbars to be printed to the console.
ezcConsoleTable Creating tables to be printed to the console.
ezcConsoleTableCell Representation of a table cell.
ezcConsoleTableOptions Struct class to store the options of the ezcConsoleTable class.
ezcConsoleTableRow Structure representing a table row in ezcConsoleTable.
D :
ezcDbException This class provides exception for misc errors that may occur in the component, such as errors parsing database parameters and connecting to the database.
ezcDbFactory ezcDbFactory manages the list of known database drivers and is used to create their instances.
ezcDbHandler Defines interface for all the database drivers implementations.
ezcDbHandlerMysql MySQL driver implementation
ezcDbHandlerNotFoundException This exceptions is used when a database handler could not be found.
ezcDbHandlerOracle Oracle driver implementation
ezcDbHandlerPgsql PostgreSQL driver implementation
ezcDbHandlerSqlite SQLite driver implementation
ezcDbInstance Holds database instances for global access throughout an application.
ezcDbMissingParameterException This exception is thrown when a database handler misses a required parameter.
ezcDbTransactionException This class provides exception for misc errors that may occur in the component, such as errors parsing database parameters and connecting to the database.
ezcDebug The ezcDebug class provides functionality to format and store debug messages and timers.
ezcDebugHtmlFormatter ezcDebugHtmlFormatter class implements a HTML debug formatter that outputs debug information nicely formated for inclusion on your web page.
ezcDebugOutputFormatter ezcDebugOutputFormatter provides the common interface for all classes writing debug output.
E :
ezcExecution Class for handling fatal errors
ezcExecutionAlreadyInitializedException Thrown when the Execution framework was already initialized.
ezcExecutionBasicErrorHandler Simple implementation of a callback handler to use with ezcExecution.
ezcExecutionErrorHandler Interface for Execution callback handlers.
ezcExecutionException General exception for use in ezcExecution class.
ezcExecutionInvalidCallbackException Thrown when an non-existend class was passed as callback handler.
ezcExecutionNotInitializedException Thrown when the Execution framework was not initialized when cleanExit() was called.
ezcExecutionWrongClassException Thrown when the passed classname does not represent a class that implements the ezcExecutionErrorHandler interface.
I :
ezcImageAnalyzer Class to retreive information about a given image file.
ezcImageAnalyzerData Struct to store the data retrieved from an image analysis.
ezcImageAnalyzerException General exception container for the ImageAnalysis component.
ezcImageAnalyzerFileNotProcessableException The option name you tried to register is already in use.
ezcImageAnalyzerHandler This base class has to be extended by all ezcImageAnalyzerHandler classes.
ezcImageAnalyzerImagemagickHandler Class to retrieve information about a given image file.
ezcImageAnalyzerInvalidHandlerException A registered handler class does not exist or does not inherit from ezcImageAnalyzerHandler.
ezcImageAnalyzerPhpHandler Class to retrieve information about a given image file.
ezcImageColorspaceFilters This interface has to implemented by ezcImageFilters classes to support colorspace filters.
ezcImageConverter Class to manage conversion and filtering of image files.
ezcImageConverterSettings Struct to store the settings for objects of ezcImageConverter.
ezcImageEffectFilters This interface has to implemented by ezcImageFilters classes to support useless filters.
ezcImageException General exception container for the ImageConversion component.
ezcImageFileNameInvalidException Thrown if a given file name contains illegal characters (', ", $).
ezcImageFileNotProcessableException Thrown if a specified handler class is not available.
ezcImageFilter Struct to store information about a filter operation.
ezcImageFilterFailedException Thrown if the given filter failed.
ezcImageFilterNotAvailableException Thrown if the given filter is not available.
ezcImageGeometryFilters This interface has to implemented by ezcImageFilters classes to support geometry filters.
ezcImageHandler Driver interface to access different image manipulation backends of PHP.
ezcImageHandlerNotAvailableException Thrown if a specified handler class is not available.
ezcImageHandlerSettings Struct to store the settings for objects of ezcImageHandler.
ezcImageHandlerSettingsInvalidException Thrown if invalid handler settings are submitted when creating an ezcImageConverter.
ezcImageInvalidFilterParameterException Thrown if the given filter failed.
ezcImageInvalidReferenceException Thrown if no valid image reference could be found for an action (conversion, filter, load, save,...).
ezcImageMimeTypeUnsupportedException Thrown if a requested MIME type is not supported for input, output or input/output.
ezcImageMissingFilterParameterException Thrown if an expected parameter for a filter was not submitted.
ezcImageTransformation Provides transformations on images using filters and MIME conversions.
ezcImageTransformationAlreadyExistsException Thrown if a transformation with the given name already exists.
ezcImageTransformationException Exception to be thrown be ezcImageTransformation classes.
ezcImageTransformationNotAvailableException Thrown if a transformation with the given name does not exists.
ezcInputFilter Provides a set of standard filters.
ezcInputForm Provides access to form variables.
ezcInputFormDefinitionElement This struct records information about Input Form definition elements.
ezcInputFormException General exception container for the UserInput component.
ezcInputFormFieldNotFoundException Exception that is thrown when a specified field is not found
ezcInputFormInvalidDefinitionException Exception that is thrown when an invalid definition array is used.
ezcInputFormNoValidDataException Exception that is thrown when an invalid field name is requested.
ezcInputFormUnknownFieldException Exception that is thrown when a fieldname is used that was not defined in a definition array.
ezcInputFormValidDataAvailableException Exception that is used when valid data is available and you try to access RAW data.
ezcInputFormVariableMissingException Exception that is thrown when a required input field is missing.
ezcInputFormWrongInputSourceException Exception that is thrown when an invalid input source is used.
L :
ezcLog The ezcLog class records log messages and audit trails to one or multiple writers.
ezcLogDatabaseWriter The ezcLogDatabaseWriter provides an implementation to write log messages to the database.
ezcLogFileWriter The ezcLogFileWriter class provides functionality to write log files to the file system.
ezcLogFilter The ezcLogFilter class provides a structure to set a log filter.
ezcLogMapper The ezcLogMapper provides a public interface to implement a mapper.
ezcLogUnixFileWriter Writes the log messages to a file in a format that is frequently used on the Unix operating system.
ezcLogWriter ezcLogWriter defines the common interface for all classes that implement their log writer.
ezcLogWriterException The ezcLogWriterException will be thrown when an {@class ezcLogWriter} or a subclass encounters an exceptional state.
M :
ezcMail The main mail class.
ezcMailAddress A container to store a mail address in RFC822 format.
ezcMailComposer Convenience class for writing mail.
ezcMailException ezcMailExceptions are thrown when an exceptional state occures in the Mail package.
ezcMailFile Mail part for all forms of binary data.
ezcMailMultipart Abstract base class for all multipart types.
ezcMailMultipartAlternative ezcMailMultipartAlternative is used to bundle a group of mail parts where only one should be shown.
ezcMailMultipartMixed The mixed multipart type is used to bundle an ordered list of mail parts.
ezcMailMultipartRelated ezcMailMultipartRelated is intended for mail parts consisting of several inter-related body parts.
ezcMailPart Abstract base class for all mail MIME parts.
ezcMailText Mail part used for sending all forms of plain text.
ezcMailTools This class contains static convenience methods for composing addresses and ensuring correct line-breaks in the mail.
ezcMailTransport Interface for classes that implement a mail transport.
ezcMailTransportException Transport exceptions are thrown by implementors of the ezcMailTransport interface when mail sending fails.
ezcMailTransportMta Implementation of the mail transport interface using the system MTA.
ezcMailTransportSmtp This class implements the Simple Mail Transfer Protocol (SMTP) with authentication support.
P :
ezcPersistentCodeManager Handles persistent object definitions in plain code style.
ezcPersistentDefinitionManager Defines the interface for all persistent object definition managers.
ezcPersistentDefinitionNotFoundException General exception class for the PersistentObject package.
ezcPersistentFindIterator This class provides functionality to iterate over a database result set in the form of persistent objects.
ezcPersistentGeneratorDefinition Defines a persistent object id generator.
ezcPersistentIdentifierGenerationException Exception thrown when generating an ID for a persistent object failed.
ezcPersistentObjectAlreadyPersistentException Exception thrown when a method that requires a non-persistent object is provided an object that is already persistent.
ezcPersistentObjectDefinition Main definition of a persistent object.
ezcPersistentObjectException General exception class for the PersistentObject package.
ezcPersistentObjectIdProperty Defines a persistent object id field.
ezcPersistentObjectNotPersistentException Exception thrown when a method that requires a persistent object is provided an object not yet persistent.
ezcPersistentObjectProperty Defines a persistent object field.
ezcPersistentQueryException Exception thrown when a query failed internally in Persistent Object.
ezcPersistentSession ezcPersistentSession is the main runtime interface for manipulation of persistent objects.
ezcPhpGenerator ezcPhpGenerator provides a simple API to generate PHP code.
ezcPhpGeneratorException General exception class for the PhpGenerator package.
ezcPhpGeneratorFlowException Flow exceptions are thrown when control structures like if and while are closed out of order.
ezcPhpGeneratorParameter ezcPhpGeneratorParameter holds information about a function or method parameter.
ezcPhpGeneratorReturnData Holds metadata about a function/method return data.
Q :
ezcQuery The ezcQuery class provides the common API for all Query objects.
ezcQueryDelete Class to create select database independent DELETE queries.
ezcQueryException Base class for exceptions related to the SQL abstraction.
ezcQueryExpression The ezcQueryExpression class is used to create database independent SQL expression.
ezcQueryExpressionOracle The ezcQueryExpressionPgsql class is used to create SQL expression for PostgreSQL.
ezcQueryExpressionPgsql The ezcQueryExpressionPgsql class is used to create SQL expression for PostgreSQL.
ezcQueryExpressionSqlite The ezcQueryExpressionSqlite class is used to create SQL expression for SQLite.
ezcQueryInsert Class to create select database independent INSERT queries.
ezcQueryInvalidException Base class for exceptions related to the SQL abstraction.
ezcQuerySelect Class to create select database independent SELECT queries.
ezcQuerySelectOracle Oracle specific implementation of ezcQuery.
ezcQuerySelectSqlite SQLite specific implementation of ezcQuery.
ezcQuerySqliteFunctions The ezcQueryExpressionSqlite class is used to create SQL expression for SQLite.
ezcQueryUpdate Class to create select database independent UPDATE queries.
ezcQueryVariableParameterException Base class for exceptions related to the SQL abstraction.
T :
ezcTranslation ezcTranslation is a container that holds the translated strings for a specific context.
ezcTranslationBackend Interface for Translation backends.
ezcTranslationBorkFilter Implements the Bork translation filter.
ezcTranslationCacheBackend Translation backend that reads translation data from a cache.
ezcTranslationComplementEmptyFilter Implements the ComplementEmpty translation filter.
ezcTranslationContextNotAvailableException Thrown by the getContext() method when a requested context doesn't exist.
ezcTranslationContextRead Common interface for all context readers.
ezcTranslationContextWrite Common interface for all context writers.
ezcTranslationData A container to store one translatable string.
ezcTranslationException The general exception class as used by the Translator Classes.
ezcTranslationFilter ezcTranslationFilter defines the common interface for all translation filters.
ezcTranslationKeyNotAvailableException Thrown by the getTranslation() method when a requested key doesn't exist.
ezcTranslationLeetFilter Implements the Leet translation filter.
ezcTranslationManager ezcTranslationManager handles a specific translation file and provides functionality to apply filters and retrieve contexts and translations.
ezcTranslationMissingTranslationFileException Thrown when the translation file does not exist.
ezcTranslationNotConfiguredException Thrown when a required configuration setting was not made for a backend.
ezcTranslationParameterMissingException Thrown by the getTranslation() method when a paramater was missing to a parameterized translation string.
ezcTranslationReaderNotInitializedException Thrown when methods are called that require a ContextReader to be initialized.
ezcTranslationTsBackend Translation backend that reads Qt's Linguist TS files.
ezcTranslationWriterNotInitializedException Thrown when methods are called that require a ContextWriter to be initialized.