Path

ez components / documentation / api reference / latest / base


eZ Components latest

Base

[ Tutorial ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Element index for package Base

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

_

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

a

$autoloadArray : ezcBase
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 : ezcBaseRepositoryDirectory
in file repository_directory.php, variable ezcBaseRepositoryDirectory::$autoloadPath
    The path to the autoload files.
addClassRepository : ezcBase
in file base.php, method ezcBase::addClassRepository()
    Adds an additional class repository.
autoload : ezcBase
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.

b

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

c

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

d

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

e

$elements : ezcBaseFileFindContext
in file file_find_context.php, variable ezcBaseFileFindContext::$elements
    The list of files
$externalAutoloadArray : ezcBase
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 : ezcBaseFileException
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.
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.

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 : ezcBaseInit
in file init.php, method ezcBaseInit::fetchConfig()
    Uses the configured callback belonging to $identifier to configure the $object.
findExecutableInPath : ezcBaseFeatures
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 : ezcBaseFile
in file file.php, method ezcBaseFile::findRecursive()
    Finds files recursively on a file system
findRecursiveCallback : ezcBaseFile
in file file.php, method ezcBaseFile::findRecursiveCallback()
    This is the callback used by findRecursive to collect data.

g

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

h

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

i

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

l

loadExternalFile : ezcBase
in file base.php, method ezcBase::loadExternalFile()
    Loads, require(), the given file name from an external package.
loadFile : ezcBase
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.

m

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

o

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

p

$packageDir : ezcBase
in file base.php, variable ezcBase::$packageDir
    The full path to the autoload directory.
$properties : ezcBaseOptions
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

r

$repositoryDirs : ezcBase
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 : ezcBasePropertyPermissionException
in file property_permission.php, class constant ezcBasePropertyPermissionException::READ
    Used when the property is read-only.
READ : ezcBaseFileException
in file file_exception.php, class constant ezcBaseFileException::READ
REMOVE : ezcBaseFileException
in file file_exception.php, class constant ezcBaseFileException::REMOVE
removeRecursive : ezcBaseFile
in file file.php, method ezcBaseFile::removeRecursive()
    Removes files and directories recursively from a file system
requireFile : ezcBase
in file base.php, method ezcBase::requireFile()
    Tries to load the autoload array and, if loaded correctly, includes the class.

s

$size : ezcBaseFileFindContext
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 : ezcBaseInit
in file init.php, method ezcBaseInit::setCallback()
    Adds the classname $callbackClassname as callback for the identifier $identifier.
setOptions : ezcBase
in file base.php, method ezcBase::setOptions()
    Associates an option object with this static class.
setPackageDir : ezcBase
in file base.php, method ezcBase::setPackageDir()
    Figures out the base path of the eZ Components installation.
setRunMode : ezcBase
in file base.php, method ezcBase::setRunMode()
    Sets the development mode to the one specified.
setState : ezcBasePersistable
in file persistable.php, method ezcBasePersistable::setState()
    Accepts an array containing data for one or more of the class' properties.
setWorkingDirectory : ezcBase
in file base.php, method ezcBase::setWorkingDirectory()
    Sets the current working directory to $directory.
supportsLink : ezcBaseFeatures
in file features.php, method ezcBaseFeatures::supportsLink()
    Determines if hardlinks are supported.
supportsSymLink : ezcBaseFeatures
in file features.php, method ezcBaseFeatures::supportsSymLink()
    Determines if symlinks are supported.
supportsUserId : ezcBaseFeatures
in file features.php, method ezcBaseFeatures::supportsUserId()
    Determines if posix uids are supported.

t

$type : ezcBaseRepositoryDirectory
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 : ezcBaseRepositoryDirectory
in file repository_directory.php, class constant ezcBaseRepositoryDirectory::TYPE_EXTERNAL
    Specifies that the entry is for an external (user defined) repository.
TYPE_INTERNAL : ezcBaseRepositoryDirectory
in file repository_directory.php, class constant ezcBaseRepositoryDirectory::TYPE_INTERNAL
    Specifies that the entry is for the eZ Components repository.

v

value.php
procedural page value.php

w

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