Path

ez components / documentation / api reference / 2007.1.1 / base


eZ Components 2007.1.1

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 ] [ x ] [ y ] [ _ ]

_

__autoload
in file ezc_bootstrap.php, function __autoload()
    Implements the __autoload mechanism for PHP - which can only be done once per request.
__construct : ezcBasePropertyPermissionException
in file property_permission.php, method ezcBasePropertyPermissionException::__construct()
    Constructs a new ezcPropertyPermissionException for the property $name.
__construct : ezcBasePropertyNotFoundException
in file property_not_found.php, method ezcBasePropertyNotFoundException::__construct()
    Constructs a new ezcBasePropertyNotFoundException 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 : ezcBaseSettingNotFoundException
in file setting_not_found.php, method ezcBaseSettingNotFoundException::__construct()
    Constructs a new ezcBaseSettingNotFoundException for $settingName.
__construct : ezcBaseSettingValueException
in file setting_value.php, method ezcBaseSettingValueException::__construct()
    Constructs a new ezcBaseConfigException
__construct : ezcBaseOptions
in file options.php, method ezcBaseOptions::__construct()
    Construct a new options object.
__construct : ezcBaseValueException
in file value.php, method ezcBaseValueException::__construct()
    Constructs a new ezcBaseValueException on the $name variable.
__construct : ezcBaseInvalidParentClassException
in file invalid_parent_class.php, method ezcBaseInvalidParentClassException::__construct()
    Constructs an ezcBaseInvalidParentClassException for custom class $customClass
__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 : ezcBaseFileIoException
in file file_io.php, method ezcBaseFileIoException::__construct()
    Constructs a new ezcBaseFileIoException for the file $path.
__construct : ezcBaseFileNotFoundException
in file file_not_found.php, method ezcBaseFileNotFoundException::__construct()
    Constructs a new ezcBaseFileNotFoundException.
__construct : ezcBaseInitCallbackConfiguredException
in file init_callback_configured.php, method ezcBaseInitCallbackConfiguredException::__construct()
    Constructs a new ezcBaseInitCallbackConfiguredException.
__construct : ezcBaseFilePermissionException
in file file_permission.php, method ezcBaseFilePermissionException::__construct()
    Constructs a new ezcPropertyPermissionException for the property $name.
__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.
__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

configuration_initializer.php
procedural page configuration_initializer.php
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()
    Sets the options for the writer.

d

double_class_repository_prefix.php
procedural page double_class_repository_prefix.php

e

$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
ezc_bootstrap.php
procedural page ezc_bootstrap.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.
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.
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.
ezcBaseFileException
in file file_exception.php, class ezcBaseFileException
    ezcBaseFileException is the exception from which all file related exceptions inherit.
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.
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.
ezcBaseOptions
in file options.php, class ezcBaseOptions
    Base options class for all eZ 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.
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

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
features.php
procedural page features.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 to the specified filename based on the os.

g

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.
getRepositoryDirectories : ezcBase
in file base.php, method ezcBase::getRepositoryDirectories()
    Return the list of directories that contain class repositories.

h

CHANGE : ezcBaseFileException
in file file_exception.php, class constant ezcBaseFileException::CHANGE
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

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

merge : ezcBaseOptions
in file options.php, method ezcBaseOptions::merge()
    Merge an array into the actual options object.

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

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
requireFile : ezcBase
in file base.php, method ezcBase::requireFile()
    Tries to load the autoload array and, if loaded correctly, includes the class.
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.

s

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()
    Returns the path to the autoload directory. The path depends on the installation of the ezComponents. The SVN version has different paths than the PEAR installed version. (For now).
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.

v

value.php
procedural page value.php

w

whatever.php
procedural page whatever.php

x

EXECUTE : ezcBaseFileException
in file file_exception.php, class constant ezcBaseFileException::EXECUTE

y

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.
Last updated: Wed, 28 Nov 2007