eZPublish
4.5
|
Maintains eZ Publish packages. More...
Public Member Functions | |
appendChange ($person, $email, $changes, $release=false, $timestamp=null) | |
appendDependency ($dependencySection, $parameters) | |
appendDocument ($name, $mimeType=false, $os=false, $audience=false, $create=false, $data=false) | |
appendFile ($file, $type, $role, $design, $filePath, $collection, $subDirectory=null, $md5=null, $copyFile=false, $modified=null, $fileType=false, $roleValue=false, $variableName=false, $packagePath=false) | |
appendGroup ($name) | |
appendInstall ($type, $name, $os=false, $isInstall=true, $filename=false, $subdirectory=false, $parameters=false) | |
appendMaintainer ($name, $email, $role=false) | |
appendProvides ($type, $name, $value, $parameters=false) | |
appendSimpleFile ($key, $filepath) | |
attribute ($attributeName) | |
attributes () | |
canExport () | |
canImport () | |
canInstall () | |
canRead () | |
canUsePackagePolicyFunction ($functionName) | |
createDependencyText ($cli, $dependencyItem, $dependencySection) | |
createDependencyTree (&$dependenciesNode, $dependencyType, $list) | |
currentRepositoryInformation () | |
currentRepositoryPath () | |
defaultLanguageMap () | |
dependencyItems ($dependencySection, $parameters=false) | |
dependencyOperatorText ($dependencyItem) | |
& | domStructure () |
exportName () | |
exportToArchive ($archivePath) | |
eZPackage ($parameters=array(), $repositoryPath=false) | |
fetchDependentPackages ($dependencyType, &$failedList) | |
fileCount () | |
fileItemPath ($fileItem, $collectionName, $path=false) | |
fileList ($collectionName) | |
fileStorePath ($fileItem, $collectionName, $path=false, $installVariables=array()) | |
getInstallState () | |
groupDependencyItemsByType ($dependencyItems) | |
hasAttribute ($attributeName) | |
install (&$installParameters) | |
Installs all items in the package. More... | |
installItem ($item, &$installParameters) | |
installItemsList ($type=false, $os=false, $name=false, $isInstall=true) | |
isInstalled () | |
languageInfo ($withLanguageNames=false) | |
path () | |
remove () | |
Removes the package directory and all it's subfiles/directories. More... | |
setAttribute ($attributeName, $attributeValue) | |
setCurrentRepositoryInformation ($information) | |
setInstalled ($installed=true) | |
setPackager ($timestamp=false, $host=false, $packager=false) | |
setRelease ($version=false, $release=false, $timestamp=false, $licence=false, $state=false) | |
simpleFilePath ($fileKey) | |
store () | |
storePackageFile ($path, $storeCache=true) | |
storeToFile ($filename) | |
thumbnailList ($collectionName) | |
uninstall ($uninstallParameters=array()) | |
uninstallItem ($item, &$uninstallParameters) | |
Static Public Member Functions | |
static | applyStorageFilePermissions ($filename) |
static | cacheDirectory () |
static | canUsePolicyFunction ($functionName) |
static | create ($name, $parameters=array(), $repositoryPath=false, $repositoryID=false) |
static | definitionFilename () |
static | documentDirectory () |
static | fetch ($packageName, $packagePath=false, $repositoryID=false, $dbAvailable=true) |
static | fetchFromFile ($filename) |
static | fetchMaintainerRoleIDList ($packageType=false, $checkRoles=false) |
static | fetchMaintainerRoleList ($packageType=false, $checkRoles=false) |
static | fetchPackages ($parameters=array(), $filterArray=array()) |
static | filesDirectory () |
getVersion () | |
Returns package version. More... | |
static | import ($archiveName, &$packageName, $dbAvailable=true, $repositoryID=false) |
Imports a package from a gzip compressed tarball file. More... | |
static | isValidName ($packageName, &$transformedPackageName=null) |
Checks if a package name is valid. More... | |
static | languageInfoFromPackageList ($packageNameList, $withLanguageNames=false) |
static | maintainerRoleListForRoles () |
static | maintainerRoleName ($roleID) |
static | md5sum ($file) |
static | packageHandler ($handlerName) |
static | packageRepositories ($parameters=array()) |
static | removeFiles ($path) |
static | repositoryInformation ($repositoryID) |
static | repositoryPath () |
static | settingsDirectory () |
static | stateList () |
static | storeDOM ($filename, $dom) |
static | suffix () |
static | systemRepositoryInformation () |
static | temporaryExportPath () |
static | temporaryImportPath () |
static | typeList () |
static | useCache () |
Public Attributes | |
$isInstalled = false | |
$Parameters | |
All interal data. More... | |
const | CACHE_CODE_DATE = 1069339607 |
const | DEVELOPMENT = false |
const | NON_INTERACTIVE = -1 |
const | STATUS_ALREADY_EXISTS = 1 |
const | STATUS_INVALID_NAME = 2 |
const | USE_CACHE = true |
const | VERSION = '3.5.2' |
Private Member Functions | |
createInstallTree ($installNode, $dom, $list, $installType) | |
parseDependencyTree ($dependenciesList, $dependencySection) | |
parseDOMTree (DOMDocument $dom) | |
parseInstallTree ($installList, $isInstall) | |
setParameters ($parameters=array()) | |
storeCache ($directory=false) | |
toString () | |
Static Private Member Functions | |
static | fetchDOMFromFile ($filename) |
static | fetchFromCache ($packagePath, $packageModification, &$cacheExpired) |
static | simpleFilesDirectory () |
static | storeString ($filename, $data) |
Maintains eZ Publish packages.
eZPackage::appendChange | ( | $person, | |
$email, | |||
$changes, | |||
$release = false , |
|||
$timestamp = null |
|||
) |
Referenced by parseDOMTree().
eZPackage::appendDependency | ( | $dependencySection, | |
$parameters | |||
) |
Appends a new dependency item to the section $dependencySection.
$dependencySection | Can be one of provides , requires , obsoletes , conflicts |
$parameters | A list of data specific to the dependency type. |
Referenced by appendProvides(), and parseDependencyTree().
eZPackage::appendDocument | ( | $name, | |
$mimeType = false , |
|||
$os = false , |
|||
$audience = false , |
|||
$create = false , |
|||
$data = false |
|||
) |
Referenced by parseDOMTree().
eZPackage::appendFile | ( | $file, | |
$type, | |||
$role, | |||
$design, | |||
$filePath, | |||
$collection, | |||
$subDirectory = null , |
|||
$md5 = null , |
|||
$copyFile = false , |
|||
$modified = null , |
|||
$fileType = false , |
|||
$roleValue = false , |
|||
$variableName = false , |
|||
$packagePath = false |
|||
) |
Referenced by parseDOMTree().
eZPackage::appendGroup | ( | $name | ) |
eZPackage::appendInstall | ( | $type, | |
$name, | |||
$os = false , |
|||
$isInstall = true , |
|||
$filename = false , |
|||
$subdirectory = false , |
|||
$parameters = false |
|||
) |
Referenced by parseInstallTree().
eZPackage::appendMaintainer | ( | $name, | |
$email, | |||
$role = false |
|||
) |
Referenced by parseDOMTree().
eZPackage::appendProvides | ( | $type, | |
$name, | |||
$value, | |||
$parameters = false |
|||
) |
Appends a new provides
dependency.
eZPackage::appendSimpleFile | ( | $key, | |
$filepath | |||
) |
Append File to package assosiated with key. The file will be available during installation using the same key.
key | |
file | path |
|
static |
Applies the storage file permissions specified in site.ini to the file $filename
Referenced by storeDOM(), and storeString().
eZPackage::attribute | ( | $attributeName | ) |
Referenced by canUsePackagePolicyFunction(), domStructure(), exportName(), exportToArchive(), fileItemPath(), and path().
eZPackage::attributes | ( | ) |
Referenced by hasAttribute().
|
static |
Referenced by fetch(), fetchFromCache(), fetchPackages(), and storePackageFile().
eZPackage::canExport | ( | ) |
Referenced by attribute().
eZPackage::canImport | ( | ) |
Referenced by attribute().
eZPackage::canInstall | ( | ) |
Referenced by attribute().
eZPackage::canRead | ( | ) |
Referenced by attribute().
eZPackage::canUsePackagePolicyFunction | ( | $functionName | ) |
Referenced by canExport(), canImport(), canInstall(), and canRead().
|
static |
Referenced by eZPackageFunctionCollection\canCreate(), eZPackageFunctionCollection\canEdit(), eZPackageFunctionCollection\canExport(), eZPackageFunctionCollection\canImport(), eZPackageFunctionCollection\canInstall(), eZPackageFunctionCollection\canList(), eZPackageFunctionCollection\canRead(), and eZPackageFunctionCollection\canRemove().
|
static |
$repositoryID | The id (string) of the repository to create the package in. If false it will use the local repository. |
Referenced by eZPackageCreationHandler\createPackage().
eZPackage::createDependencyText | ( | $cli, | |
$dependencyItem, | |||
$dependencySection | |||
) |
eZPackage::createDependencyTree | ( | & | $dependenciesNode, |
$dependencyType, | |||
$list | |||
) |
Creates dependency xml elements as child of $dependenciesNode. The dependency elements are take from $list.
$dependencyType | Is either 'provide' , 'require' , 'obsolete' or 'conflict' |
Referenced by domStructure().
|
private |
Creates xml elements as children of the main node $installNode. The install elements are taken from $list.
$installType | Is either 'install' or 'uninstall' |
Referenced by domStructure().
eZPackage::currentRepositoryInformation | ( | ) |
null
in some cases when the package is not properly initialized. Referenced by attribute(), currentRepositoryPath(), and fileItemPath().
eZPackage::currentRepositoryPath | ( | ) |
Referenced by path().
eZPackage::defaultLanguageMap | ( | ) |
|
static |
Referenced by fetch(), fetchPackages(), import(), and storePackageFile().
eZPackage::dependencyItems | ( | $dependencySection, | |
$parameters = false |
|||
) |
eZPackage::dependencyOperatorText | ( | $dependencyItem | ) |
Referenced by createDependencyText().
|
static |
Referenced by appendDocument(), exportToArchive(), and eZPackageOperator\modify().
& eZPackage::domStructure | ( | ) |
Referenced by storeToFile(), and toString().
eZPackage::exportName | ( | ) |
eZPackage::exportToArchive | ( | $archivePath | ) |
Exports the package as a gzip compressed tarball to the directory $archivePath
eZPackage::eZPackage | ( | $parameters = array() , |
|
$repositoryPath = false |
|||
) |
Constructor
Referenced by create(), fetchFromCache(), and fetchFromFile().
|
static |
Tries to load the package named $packageName from the repository and returns the package object.
$repositoryID | Determines in which repositories the package should be searched for, if set to true it means only look in local packages, false means look in all repositories. |
$dbAvailable | Do we have a database to fetch additional package info, like installed state. (false in setup wizard) |
false
if no package could be found. Referenced by eZStepSiteTypes\display(), eZStepSiteTypes\downloadAndImportPackage(), eZStepSiteTypes\downloadDependantPackages(), downloadPackages(), eZPackageFunctionCollection\fetchDependentPackageList(), fetchDependentPackages(), eZPackageType\fetchObjectAttributeHTTPInput(), eZPackageFunctionCollection\fetchPackage(), import(), eZStepPackageLanguageOptions\init(), eZStepSiteTypes\init(), eZStepCreateSites\initializePackage(), installPackages(), languageInfoFromPackageList(), eZPackageType\objectAttributeContent(), eZStepSiteTypes\processPostData(), eZStepInstaller\selectSiteType(), and eZPackageCreationHandler\validatePackageInformation().
eZPackage::fetchDependentPackages | ( | $dependencyType, | |
& | $failedList | ||
) |
Locates all dependent packages in the repository and returns an array with eZPackage objects.
$dependencyType | is the name of a dependency sub-node. (ie. 'provides', 'requires' etc...) |
|
staticprivate |
Loads the contents of the file $filename and parses it into a DOM tree. The DOM tree is returned.
Referenced by fetchFromFile(), installItem(), and uninstallItem().
|
staticprivate |
Referenced by fetch(), and fetchPackages().
|
static |
Tries to load the package definition from file $filename and create a package object from it.
false
if it could be fetched. Referenced by fetch(), fetchPackages(), and import().
Referenced by eZPackageCreationHandler\checkPackageMaintainer(), and fetchMaintainerRoleList().
Referenced by eZPackageFunctionCollection\fetchMaintainerRoleList().
|
static |
Locates all packages in the repository and returns an array with eZPackage objects.
parameters | |
filterArray |
Referenced by eZStepInstaller\availableSitePackages(), eZStepSiteTemplates\display(), eZStepSitePackages\display(), eZStepSiteTypes\fetchAvailablePackages(), eZStepSiteTypes\fetchAvailableSitePackages(), and eZPackageFunctionCollection\fetchList().
eZPackage::fileCount | ( | ) |
Referenced by attribute().
eZPackage::fileItemPath | ( | $fileItem, | |
$collectionName, | |||
$path = false |
|||
) |
eZPackage::fileList | ( | $collectionName | ) |
Referenced by thumbnailList().
|
static |
Referenced by appendFile(), exportToArchive(), and fileItemPath().
eZPackage::fileStorePath | ( | $fileItem, | |
$collectionName, | |||
$path = false , |
|||
$installVariables = array() |
|||
) |
eZPackage::getInstallState | ( | ) |
Referenced by setInstalled().
|
static |
Returns package version.
Combines package version number and release number.
Referenced by getInstallState(), and setInstalled().
eZPackage::groupDependencyItemsByType | ( | $dependencyItems | ) |
eZPackage::hasAttribute | ( | $attributeName | ) |
true
if the attribute named $attributeName exists.
|
static |
Imports a package from a gzip compressed tarball file.
string | $archiveName | Path to the archive file |
string | $packageName | Package name |
bool | $dbAvailable | |
bool | $repositoryID |
Referenced by eZStepSiteTypes\downloadAndImportPackage(), downloadPackages(), and eZStepSiteTypes\uploadPackage().
eZPackage::install | ( | & | $installParameters | ) |
Installs all items in the package.
array | $installParameters |
eZPackage::installItem | ( | $item, | |
& | $installParameters | ||
) |
Referenced by languageInfo().
eZPackage::isInstalled | ( | ) |
Referenced by getInstallState(), setInstalled(), and uninstall().
|
static |
Checks if a package name is valid.
string | $packageName | the package name |
string | $transformedPackageName | the package name, transformed to be valid |
eZPackage::languageInfo | ( | $withLanguageNames = false | ) |
Fetch info about languages for package.
Referenced by defaultLanguageMap().
|
static |
Fetch info about languages for packages specified in $packageNameList. Return ex: array( 'eng-GB', 'rus-RU', ... ); if $withLanguageNames == true array( 'eng-GB' => "English", 'rus-RU' => "Russian", ... );
Referenced by eZStepPackageLanguageOptions\init().
|
static |
|
static |
Referenced by fetchMaintainerRoleList(), and maintainerRoleListForRoles().
|
static |
Referenced by appendFile().
|
static |
Referenced by createDependencyText(), createDependencyTree(), createInstallTree(), eZContentClassPackageCreator\finalize(), eZExtensionPackageCreator\finalize(), eZContentObjectPackageCreator\finalize(), installItem(), languageInfo(), parseDependencyTree(), parseInstallTree(), and uninstallItem().
|
static |
Each repository entry is an array with the following keys.
Referenced by fetch(), fetchPackages(), eZPackageFunctionCollection\fetchRepositoryList(), and repositoryInformation().
|
private |
Referenced by parseDOMTree().
|
private |
|
private |
Referenced by parseDOMTree().
eZPackage::path | ( | ) |
Referenced by appendDocument(), appendFile(), appendInstall(), appendSimpleFile(), exportToArchive(), installItem(), remove(), simpleFilePath(), store(), and uninstallItem().
eZPackage::remove | ( | ) |
Removes the package directory and all it's subfiles/directories.
|
static |
Recursively deletes $path
Referenced by exportToArchive(), and import().
|
static |
false
if does not exist. Referenced by systemRepositoryInformation().
|
static |
Referenced by downloadPackages(), eZPackage(), import(), installScriptDir(), and packageRepositories().
eZPackage::setAttribute | ( | $attributeName, | |
$attributeValue | |||
) |
Sets the attribute named $attributeName to have the value $attributeValue.
eZPackage::setCurrentRepositoryInformation | ( | $information | ) |
Sets the current repository information for the package.
eZPackage::setInstalled | ( | $installed = true | ) |
Sets installed/uninstalled state of the package
installed |
Referenced by install(), remove(), and uninstall().
Sets the packager of this release.
Referenced by parseDOMTree().
|
private |
Referenced by eZPackage(), and parseDOMTree().
eZPackage::setRelease | ( | $version = false , |
|
$release = false , |
|||
$timestamp = false , |
|||
$licence = false , |
|||
$state = false |
|||
) |
Sets various release information. If the value is set to false
it is not updated.
$version | The version number, eg. 1.0, 2.3.5 |
$release | The release number, usually starts at 1 and increments for updates on the same version |
$timestamp | The timestamp of the release |
$licence | The licence of the package, eg. GPL, LGPL etc. |
$state | The sate of the release, e.g alpha, beta, stable etc. |
Referenced by parseDOMTree().
|
static |
Referenced by exportToArchive().
eZPackage::simpleFilePath | ( | $fileKey | ) |
Get complete path to file by file key
file | key |
|
staticprivate |
Get local simple file path
Referenced by appendSimpleFile(), and exportToArchive().
|
static |
id
and a name
key. eZPackage::store | ( | ) |
Stores the current package in the repository.
|
private |
Stores a cached version of the package in the cache directory under the repository for the package.
Referenced by storePackageFile().
|
static |
Stores the DOM tree $dom to the file $filename.
Referenced by appendInstall(), and storeToFile().
eZPackage::storePackageFile | ( | $path, | |
$storeCache = true |
|||
) |
Stores the current package definition file to the directory $path.
Referenced by exportToArchive(), and store().
|
staticprivate |
Stores the string data $data into the file $filename.
true
if successful. Referenced by storePackageFile().
eZPackage::storeToFile | ( | $filename | ) |
Stores the current package to the file $filename.
|
static |
Referenced by exportName().
|
static |
false
if does not exist. Referenced by eZStepSiteTypes\retrieveRemotePackagesList().
|
static |
Referenced by exportToArchive().
|
static |
Referenced by import().
eZPackage::thumbnailList | ( | $collectionName | ) |
Referenced by attribute().
|
private |
Referenced by storePackageFile().
|
static |
id
and a name
key. eZPackage::uninstall | ( | $uninstallParameters = array() | ) |
Install all install items in package
eZPackage::uninstallItem | ( | $item, | |
& | $uninstallParameters | ||
) |
Referenced by uninstall().
|
static |
Referenced by fetch(), and fetchPackages().
eZPackage::$isInstalled = false |
Referenced by attribute(), and isInstalled().
eZPackage::$Parameters |
All interal data.
Referenced by fetchFromCache().
const eZPackage::CACHE_CODE_DATE = 1069339607 |
Referenced by fetchFromCache(), and storeCache().
const eZPackage::DEVELOPMENT = false |
Referenced by domStructure(), and setParameters().
const eZPackage::NON_INTERACTIVE = -1 |
const eZPackage::STATUS_ALREADY_EXISTS = 1 |
Referenced by import(), and eZStepSiteTypes\uploadPackage().
const eZPackage::STATUS_INVALID_NAME = 2 |
Referenced by eZStepSiteTypes\downloadAndImportPackage(), and import().
const eZPackage::USE_CACHE = true |
Referenced by useCache().
const eZPackage::VERSION = '3.5.2' |
Referenced by domStructure().