Apache Zeta Components - high quality PHP components

Tutorial
API

Apache Zeta Components Manual :: Package Base Element Index

Element index for package Base

Package indexes

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ l ] [ m ] [ o ] [ p ] [ r ] [ s ] [ t ] [ v ] [ w ] [ _ ]

Letter '_'

__construct: in file persistable.php, method ezcBasePersistable::__construct()
The constructor for the object needs to be able to accept no arguments.
__construct: in file property_not_found.php, method ezcBasePropertyNotFoundException::__construct()
Constructs a new ezcBasePropertyNotFoundException for the property $name.
__construct: in file pear.php, method ezcBaseMetaDataPearReader::__construct()
Creates the reader object and initialized the registry for querying
__construct: in file options.php, method ezcBaseOptions::__construct()
Construct a new options object.
__construct: in file metadata.php, method ezcBaseMetaData::__construct()
Creates a ezcBaseMetaData object
__construct: in file property_permission.php, method ezcBasePropertyPermissionException::__construct()
Constructs a new ezcPropertyPermissionException for the property $name.
__construct: in file repository_directory.php, method ezcBaseRepositoryDirectory::__construct()
Constructs a new ezcBaseRepositoryDirectory of type $type with base path $basePath and autoload path $autoloadPath.
__construct: in file value.php, method ezcBaseValueException::__construct()
Constructs a new ezcBaseValueException on the $name variable.
__construct: in file tarball.php, method ezcBaseMetaDataTarballReader::__construct()
Creates the reader object and opens the release-info file.
__construct: in file setting_value.php, method ezcBaseSettingValueException::__construct()
Constructs a new ezcBaseConfigException
__construct: in file setting_not_found.php, method ezcBaseSettingNotFoundException::__construct()
Constructs a new ezcBaseSettingNotFoundException for $settingName.
__construct: in file double_class_repository_prefix.php, method ezcBaseDoubleClassRepositoryPrefixException::__construct()
Constructs a new ezcBaseDoubleClassRepositoryPrefixException for the $prefix that points to $basePath with autoload directory $autoloadDirPath.
__construct: in file invalid_parent_class.php, method ezcBaseInvalidParentClassException::__construct()
Constructs an ezcBaseInvalidParentClassException for custom class $customClass
__construct: in file file_find_context.php, method ezcBaseFileFindContext::__construct()
Constructs a new ezcBaseFileFindContext with initial values.
__construct: in file extension_not_found.php, method ezcBaseExtensionNotFoundException::__construct()
Constructs a new ezcBaseExtensionNotFoundException.
__construct: in file exception.php, method ezcBaseException::__construct()
Constructs a new ezcBaseException with $message
__construct: in file invalid_callback_class.php, method ezcBaseInitInvalidCallbackClassException::__construct()
Constructs a new ezcBaseInitInvalidCallbackClassException for the $callbackClass.
__construct: in file file_io.php, method ezcBaseFileIoException::__construct()
Constructs a new ezcBaseFileIoException for the file $path.
__construct: in file functionality_not_supported.php, method ezcBaseFunctionalityNotSupportedException::__construct()
Constructs a new ezcBaseFunctionalityNotSupportedException.
__construct: in file init_callback_configured.php, method ezcBaseInitCallbackConfiguredException::__construct()
Constructs a new ezcBaseInitCallbackConfiguredException.
__construct: in file file_not_found.php, method ezcBaseFileNotFoundException::__construct()
Constructs a new ezcBaseFileNotFoundException.
__construct: in file file_permission.php, method ezcBaseFilePermissionException::__construct()
Constructs a new ezcPropertyPermissionException for the property $name.
__set_state: in file file_find_context.php, method ezcBaseFileFindContext::__set_state()
Returns a new instance of this class with the data specified by $array.
__set_state: in file exportable.php, method ezcBaseExportable::__set_state()
Returns an instance of the desired object, initialized from $state.
__set_state: in file repository_directory.php, method ezcBaseRepositoryDirectory::__set_state()
Returns a new instance of this class with the data specified by $array.

Letter 'a'

$autoloadArray: in file base.php, variable ezcBase::$autoloadArray
This variable stores all the elements from the autoload arrays. When a new autoload file is loaded, their files are added to this array.
$autoloadPath: in file repository_directory.php, variable ezcBaseRepositoryDirectory::$autoloadPath
The path to the autoload files.
addClassRepository: in file base.php, method ezcBase::addClassRepository()
Adds an additional class repository.
autoload: in file base.php, method ezcBase::autoload()
Tries to autoload the given className. If the className could be found this method returns true, otherwise false.

Letter 'b'

$basePath: in file repository_directory.php, variable ezcBaseRepositoryDirectory::$basePath
The path to the configured repository.
base.php: procedural page base.php

Letter 'c'

$count: in file file_find_context.php, variable ezcBaseFileFindContext::$count
The number of files
configuration_initializer.php: procedural page configuration_initializer.php
calculateRelativePath: in file file.php, method ezcBaseFile::calculateRelativePath()
Calculates the relative path of the file/directory '$path' to a given $base path.
CHANGE: in file file_exception.php, class constant ezcBaseFileException::CHANGE
checkDependency: in file base.php, method ezcBase::checkDependency()
Checks for dependencies on PHP versions or extensions
classExists: in file features.php, method ezcBaseFeatures::classExists()
Returns if a given class exists.
configureObject: in file configuration_initializer.php, method ezcBaseConfigurationInitializer::configureObject()
Configures the given object, or returns the proper object depending on the given identifier.
copyRecursive: in file file.php, method ezcBaseFile::copyRecursive()
Recursively copy a file or directory.

Letter 'd'

double_class_repository_prefix.php: procedural page double_class_repository_prefix.php
DEP_PHP_EXTENSION: in file base.php, class constant ezcBase::DEP_PHP_EXTENSION
Used for dependency checking, to check for a PHP extension.
DEP_PHP_VERSION: in file base.php, class constant ezcBase::DEP_PHP_VERSION
Used for dependency checking, to check for a PHP version.

Letter 'e'

$elements: in file file_find_context.php, variable ezcBaseFileFindContext::$elements
The list of files
$externalAutoloadArray: in file base.php, variable ezcBase::$externalAutoloadArray
This variable stores all the elements from the autoload arrays for external repositories. When a new autoload file is loaded, their files are added to this array.
exception.php: procedural page exception.php
extension_not_found.php: procedural page extension_not_found.php
exportable.php: procedural page exportable.php
EXECUTE: in file file_exception.php, class constant ezcBaseFileException::EXECUTE
ezcBase: in file base.php, class ezcBase
Base class implements the methods needed to use the eZ components.
ezcBaseConfigurationInitializer: in file configuration_initializer.php, class ezcBaseConfigurationInitializer
This class provides the interface that classes need to implement to act as an callback initializer class to work with the delayed initialization mechanism.
ezcBaseDoubleClassRepositoryPrefixException: in file double_class_repository_prefix.php, class ezcBaseDoubleClassRepositoryPrefixException
ezcBaseDoubleClassRepositoryPrefixException is thrown whenever you try to register a class repository with a prefix that has already been added before.
ezcBaseException: in file exception.php, class ezcBaseException
ezcBaseException is a container from which all other exceptions in the components library descent.
ezcBaseExportable: in file exportable.php, class ezcBaseExportable
Interface for class of which instances can be exported using var_export().
ezcBaseExtensionNotFoundException: in file extension_not_found.php, class ezcBaseExtensionNotFoundException
ezcBaseExtensionNotFoundException is thrown when a requested PHP extension was not found.
ezcBaseFeatures: in file features.php, class ezcBaseFeatures
Provides methods needed to check for features.
ezcBaseFile: in file file.php, class ezcBaseFile
Provides a selection of static independent methods to provide functionality for file and file system handling.
ezcBaseFileException: in file file_exception.php, class ezcBaseFileException
ezcBaseFileException is the exception from which all file related exceptions inherit.
ezcBaseFileFindContext: in file file_find_context.php, class ezcBaseFileFindContext
Struct which defines the information collected by the file walker for locating files.
ezcBaseFileIoException: in file file_io.php, class ezcBaseFileIoException
ezcBaseFileIoException is thrown when a problem occurs while writing and reading to/from an open file.
ezcBaseFileNotFoundException: in file file_not_found.php, class ezcBaseFileNotFoundException
ezcBaseFileNotFoundException is thrown when a file or directory was tried to be opened, but did not exist.
ezcBaseFilePermissionException: in file file_permission.php, class ezcBaseFilePermissionException
ezcBaseFilePermissionException is thrown whenever a permission problem with a file, directory or stream occurred.
ezcBaseFunctionalityNotSupportedException: in file functionality_not_supported.php, class ezcBaseFunctionalityNotSupportedException
The ezcBaseFunctionalityNotSupportedException is thrown when a requested PHP function was not found.
ezcBaseInit: in file init.php, class ezcBaseInit
Provides a method to implement delayed initialization of objects.
ezcBaseInitCallbackConfiguredException: in file init_callback_configured.php, class ezcBaseInitCallbackConfiguredException
ezcBaseInitCallbackConfiguredException is thrown when you try to assign a callback clasname to an identifier, while there is already a callback class configured for this identifier.
ezcBaseInitInvalidCallbackClassException: in file invalid_callback_class.php, class ezcBaseInitInvalidCallbackClassException
Exception that is thrown if an invalid class is passed as callback class for delayed object configuration.
ezcBaseInvalidParentClassException: in file invalid_parent_class.php, class ezcBaseInvalidParentClassException
Exception that is thrown if an invalid class is passed as custom class.
ezcBaseMetaData: in file metadata.php, class ezcBaseMetaData
Base class implements ways of fetching information about the installed eZ Components. It knows whether to use the PEAR registry or the bundled XML file, depending on how eZ Components is installed.
ezcBaseMetaDataPearReader: in file pear.php, class ezcBaseMetaDataPearReader
Base class implements ways of fetching information about the installed eZ Components when installed as tarball.
ezcBaseMetaDataTarballReader: in file tarball.php, class ezcBaseMetaDataTarballReader
Base class implements ways of fetching information about the installed eZ Components when installed as tarball.
ezcBaseOptions: in file options.php, class ezcBaseOptions
Base options class for all eZ components.
ezcBasePersistable: in file persistable.php, class ezcBasePersistable
This class provides the interface that classes need to implement to be able to be used by the PersistentObject and Search components.
ezcBasePropertyNotFoundException: in file property_not_found.php, class ezcBasePropertyNotFoundException
ezcBasePropertyNotFoundException is thrown whenever a non existent property is accessed in the Components library.
ezcBasePropertyPermissionException: in file property_permission.php, class ezcBasePropertyPermissionException
ezcBasePropertyPermissionException is thrown whenever a read-only property is tried to be changed, or when a write-only property was accessed for reading.
ezcBaseRepositoryDirectory: in file repository_directory.php, class ezcBaseRepositoryDirectory
Struct which defines a repository directory.
ezcBaseSettingNotFoundException: in file setting_not_found.php, class 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: in file setting_value.php, class ezcBaseSettingValueException
ezcBaseSettingValueExeception is thrown whenever a value to a class' configuration option is either of the wrong type, or has a wrong value.
ezcBaseStruct: in file struct.php, class ezcBaseStruct
Base class for all struct classes.
ezcBaseValueException: in file value.php, class ezcBaseValueException
ezcBaseValueException is thrown whenever the type or value of the given variable is not as expected.

Letter 'f'

file_exception.php: procedural page file_exception.php
file_io.php: procedural page file_io.php
file_not_found.php: procedural page file_not_found.php
file_permission.php: procedural page file_permission.php
functionality_not_supported.php: procedural page functionality_not_supported.php
features.php: procedural page features.php
file.php: procedural page file.php
file_find_context.php: procedural page file_find_context.php
fetchConfig: in file init.php, method ezcBaseInit::fetchConfig()
Uses the configured callback belonging to $identifier to configure the $object.
findExecutableInPath: in file features.php, method ezcBaseFeatures::findExecutableInPath()
Returns the path of the specified executable, if it can be found in the system's path.
findRecursive: in file file.php, method ezcBaseFile::findRecursive()
Finds files recursively on a file system
findRecursiveCallback: in file file.php, method ezcBaseFile::findRecursiveCallback()
This is the callback used by findRecursive to collect data.

Letter 'g'

getBundleVersion: in file metadata.php, method ezcBaseMetaData::getBundleVersion()
Returns the version string for the installed eZ Components bundle.
getBundleVersion: in file tarball.php, method ezcBaseMetaDataTarballReader::getBundleVersion()
Returns the version string for the installed eZ Components bundle.
getBundleVersion: in file pear.php, method ezcBaseMetaDataPearReader::getBundleVersion()
Returns the version string for the installed eZ Components bundle.
getComponentDependencies: in file pear.php, method ezcBaseMetaDataPearReader::getComponentDependencies()
Returns a list of components that $componentName depends on.
getComponentDependencies: in file tarball.php, method ezcBaseMetaDataTarballReader::getComponentDependencies()
Returns a list of components that $componentName depends on.
getComponentDependencies: in file metadata.php, method ezcBaseMetaData::getComponentDependencies()
Returns a list of components that $componentName depends on.
getComponentVersion: in file tarball.php, method ezcBaseMetaDataTarballReader::getComponentVersion()
Returns the version string of the available $componentName or false when the component is not installed.
getComponentVersion: in file pear.php, method ezcBaseMetaDataPearReader::getComponentVersion()
Returns the version string of the available $componentName or false when the component is not installed.
getComponentVersion: in file metadata.php, method ezcBaseMetaData::getComponentVersion()
Returns the version string of the available $componentName or false when the component is not installed.
getImageConvertExecutable: in file features.php, method ezcBaseFeatures::getImageConvertExecutable()
Returns the path to the ImageMagick convert utility.
getImageIdentifyExecutable: in file features.php, method ezcBaseFeatures::getImageIdentifyExecutable()
Returns the path to the ImageMagick identify utility.
getInstallationPath: in file base.php, method ezcBase::getInstallationPath()
Returns the base path of the eZ Components installation
getInstallMethod: in file base.php, method ezcBase::getInstallMethod()
Returns the installation method
getRepositoryDirectories: in file base.php, method ezcBase::getRepositoryDirectories()
Return the list of directories that contain class repositories.
getRequiredPhpVersion: in file tarball.php, method ezcBaseMetaDataTarballReader::getRequiredPhpVersion()
Returns a PHP version string that describes the required PHP version for this installed eZ Components bundle.
getRequiredPhpVersion: in file metadata.php, method ezcBaseMetaData::getRequiredPhpVersion()
Returns a PHP version string that describes the required PHP version for this installed eZ Components bundle.
getRequiredPhpVersion: in file pear.php, method ezcBaseMetaDataPearReader::getRequiredPhpVersion()
Returns a PHP version string that describes the required PHP version for this installed eZ Components bundle.
getRunMode: in file base.php, method ezcBase::getRunMode()
Returns the current development mode.
getState: in file persistable.php, method ezcBasePersistable::getState()
Returns all the object's properties so that they can be stored or indexed.

Letter 'h'

hasExtensionSupport: in file features.php, method ezcBaseFeatures::hasExtensionSupport()
Determines if the specified extension is loaded.
hasFunction: in file features.php, method ezcBaseFeatures::hasFunction()
Determines if the specified function is available.
hasImageConvert: in file features.php, method ezcBaseFeatures::hasImageConvert()
Determines if the ImageMagick convert utility is installed.
hasImageIdentify: in file features.php, method ezcBaseFeatures::hasImageIdentify()
Determines if the ImageMagick identify utility is installed.

Letter 'i'

init_callback_configured.php: procedural page init_callback_configured.php
invalid_callback_class.php: procedural page invalid_callback_class.php
invalid_parent_class.php: procedural page invalid_parent_class.php
init.php: procedural page init.php
inDevMode: in file base.php, method ezcBase::inDevMode()
Returns true when we are in development mode.
isAbsolutePath: in file file.php, method ezcBaseFile::isAbsolutePath()
Returns whether the passed $path is an absolute path, giving the current $os.
isComponentInstalled: in file tarball.php, method ezcBaseMetaDataTarballReader::isComponentInstalled()
Returns whether $componentName is installed
isComponentInstalled: in file metadata.php, method ezcBaseMetaData::isComponentInstalled()
Returns whether $componentName is installed
isComponentInstalled: in file pear.php, method ezcBaseMetaDataPearReader::isComponentInstalled()
Returns whether $componentName is installed

Letter 'l'

loadExternalFile: in file base.php, method ezcBase::loadExternalFile()
Loads, require(), the given file name from an external package.
loadFile: in file base.php, method ezcBase::loadFile()
Loads, require(), the given file name. If we are in development mode, "/src/" is inserted into the path.

Letter 'm'

metadata.php: procedural page metadata.php
merge: in file options.php, method ezcBaseOptions::merge()
Merge an array into the actual options object.
MODE_DEVELOPMENT: in file base.php, class constant ezcBase::MODE_DEVELOPMENT
Denotes the development mode
MODE_PRODUCTION: in file base.php, class constant ezcBase::MODE_PRODUCTION
Denotes the production mode

Letter 'o'

$originalMessage: in file exception.php, variable ezcBaseException::$originalMessage
Original message, before escaping
options.php: procedural page options.php
offsetExists: in file options.php, method ezcBaseOptions::offsetExists()
Returns if an option exists.
offsetGet: in file options.php, method ezcBaseOptions::offsetGet()
Returns an option value.
offsetSet: in file options.php, method ezcBaseOptions::offsetSet()
Set an option.
offsetUnset: in file options.php, method ezcBaseOptions::offsetUnset()
Unset an option.
os: in file features.php, method ezcBaseFeatures::os()
Returns the operating system on which PHP is running.

Letter 'p'

$packageDir: in file base.php, variable ezcBase::$packageDir
The full path to the autoload directory.
$properties: in file options.php, variable ezcBaseOptions::$properties
Container to hold the properties
property_not_found.php: procedural page property_not_found.php
property_permission.php: procedural page property_permission.php
persistable.php: procedural page persistable.php
pear.php: procedural page pear.php

Letter 'r'

$repositoryDirs: in file base.php, variable ezcBase::$repositoryDirs
Stores info with additional paths where autoload files and classes for
repository_directory.php: procedural page repository_directory.php
READ: in file property_permission.php, class constant ezcBasePropertyPermissionException::READ
Used when the property is read-only.
READ: in file file_exception.php, class constant ezcBaseFileException::READ
REMOVE: in file file_exception.php, class constant ezcBaseFileException::REMOVE
removeRecursive: in file file.php, method ezcBaseFile::removeRecursive()
Removes files and directories recursively from a file system
requireFile: in file base.php, method ezcBase::requireFile()
Tries to load the autoload array and, if loaded correctly, includes the class.

Letter 's'

$size: in file file_find_context.php, variable ezcBaseFileFindContext::$size
The total file size of all files found
setting_not_found.php: procedural page setting_not_found.php
setting_value.php: procedural page setting_value.php
struct.php: procedural page struct.php
setCallback: in file init.php, method ezcBaseInit::setCallback()
Adds the classname $callbackClassname as callback for the identifier $identifier.
setOptions: in file base.php, method ezcBase::setOptions()
Associates an option object with this static class.
setPackageDir: in file base.php, method ezcBase::setPackageDir()
Figures out the base path of the eZ Components installation.
setRunMode: in file base.php, method ezcBase::setRunMode()
Sets the development mode to the one specified.
setState: in file persistable.php, method ezcBasePersistable::setState()
Accepts an array containing data for one or more of the class' properties.
setWorkingDirectory: in file base.php, method ezcBase::setWorkingDirectory()
Sets the current working directory to $directory.
supportsLink: in file features.php, method ezcBaseFeatures::supportsLink()
Determines if hardlinks are supported.
supportsSymLink: in file features.php, method ezcBaseFeatures::supportsSymLink()
Determines if symlinks are supported.
supportsUserId: in file features.php, method ezcBaseFeatures::supportsUserId()
Determines if posix uids are supported.

Letter 't'

$type: in file repository_directory.php, variable ezcBaseRepositoryDirectory::$type
The $type is one of the two TYPE_* constants defined in this class.
tarball.php: procedural page tarball.php
TYPE_EXTERNAL: in file repository_directory.php, class constant ezcBaseRepositoryDirectory::TYPE_EXTERNAL
Specifies that the entry is for an external (user defined) repository.
TYPE_INTERNAL: in file repository_directory.php, class constant ezcBaseRepositoryDirectory::TYPE_INTERNAL
Specifies that the entry is for the eZ Components repository.

Letter 'v'

value.php: procedural page value.php

Letter 'w'

whatever.php: procedural page whatever.php
walkRecursive: in file file.php, method ezcBaseFile::walkRecursive()
Walks files and directories recursively on a file system
WRITE: in file file_exception.php, class constant ezcBaseFileException::WRITE
WRITE: in file property_permission.php, class constant ezcBasePropertyPermissionException::WRITE
Used when the property is write-only.

Documentation generated by phpDocumentor 1.4.3