eZ Publish Community Project (Legacy Stack) 2013.4
Class

eZPackage

class eZPackage

Constants

VERSION

DEVELOPMENT

USE_CACHE

CACHE_CODE_DATE

STATUS_ALREADY_EXISTS

STATUS_INVALID_NAME

NON_INTERACTIVE

Properties

$isInstalled
$Parameters

Methods

eZPackage($parameters = array(), $repositoryPath = false)

remove()

Removes the package directory and all it's subfiles/directories.

setParameters($parameters = array())

attributes()

setAttribute($attributeName, $attributeValue)

hasAttribute($attributeName)

attribute($attributeName)

canRead()

canExport()

canImport()

canInstall()

canUsePackagePolicyFunction($functionName)

appendMaintainer($name, $email, $role = false)

appendDocument($name, $mimeType = false, $os = false, $audience = false, $create = false, $data = false)

appendGroup($name)

appendChange($person, $email, $changes, $release = false, $timestamp = null)

fileStorePath($fileItem, $collectionName, $path = false, $installVariables = array())

fileItemPath($fileItem, $collectionName, $path = false)

fileList($collectionName)

thumbnailList($collectionName)

fileCount()

appendFile($file, $type, $role, $design, $filePath, $collection, $subDirectory = null, $md5 = null, $copyFile = false, $modified = null, $fileType = false, $roleValue = false, $variableName = false, $packagePath = false)

appendProvides($type, $name, $value, $parameters = false)

appendDependency($dependencySection, $parameters)

dependencyOperatorText($dependencyItem)

createDependencyText($cli, $dependencyItem, $dependencySection)

groupDependencyItemsByType($dependencyItems)

dependencyItems($dependencySection, $parameters = false)

installItemsList($type = false, $os = false, $name = false, $isInstall = true)

appendInstall($type, $name, $os = false, $isInstall = true, $filename = false, $subdirectory = false, $parameters = false)

setPackager($timestamp = false, $host = false, $packager = false)

setRelease($version = false, $release = false, $timestamp = false, $licence = false, $state = false)

toString()

storeCache($directory = false)

store()

storePackageFile($path, $storeCache = true)

exportToArchive($archivePath)

exportName()

storeToFile($filename)

path()

currentRepositoryPath()

fetchDependentPackages($dependencyType, $failedList)

setCurrentRepositoryInformation($information)

currentRepositoryInformation()

installItem($item, $installParameters)

bool install(array $installParameters)

Installs all items in the package

uninstallItem($item, $uninstallParameters)

uninstall($uninstallParameters = array())

parseDOMTree(DOMDocument $dom)

parseDependencyTree($dependenciesList, $dependencySection)

parseInstallTree($installList, $isInstall)

domStructure()

createInstallTree($installNode, $dom, $list, $installType)

createDependencyTree($dependenciesNode, $dependencyType, $list)

appendSimpleFile($key, $filepath)

simpleFilePath($fileKey)

getVersion()

Returns package version.

setInstalled($installed = true)

isInstalled()

getInstallState()

languageInfo($withLanguageNames = false)

defaultLanguageMap()

Details

at line 34
public eZPackage($parameters = array(), $repositoryPath = false)

Parameters

$parameters
$repositoryPath

at line 46
public remove()

Removes the package directory and all it's subfiles/directories.

at line 59
public setParameters($parameters = array())

Parameters

$parameters

at line 176
public attributes()

at line 200
public setAttribute($attributeName, $attributeValue)

Parameters

$attributeName
$attributeValue

at line 222
public hasAttribute($attributeName)

Parameters

$attributeName

at line 230
public attribute($attributeName)

Parameters

$attributeName

at line 302
public canRead()

at line 307
public canExport()

at line 312
public canImport()

at line 317
public canInstall()

at line 322
public canUsePackagePolicyFunction($functionName)

Parameters

$functionName

at line 453
public appendMaintainer($name, $email, $role = false)

Parameters

$name
$email
$role

at line 460
public appendDocument($name, $mimeType = false, $os = false, $audience = false, $create = false, $data = false)

Parameters

$name
$mimeType
$os
$audience
$create
$data

at line 478
public appendGroup($name)

Parameters

$name

at line 484
public appendChange($person, $email, $changes, $release = false, $timestamp = null)

Parameters

$person
$email
$changes
$release
$timestamp

at line 532
public fileStorePath($fileItem, $collectionName, $path = false, $installVariables = array())

Parameters

$fileItem
$collectionName
$path
$installVariables

at line 605
public fileItemPath($fileItem, $collectionName, $path = false)

Parameters

$fileItem
$collectionName
$path

at line 628
public fileList($collectionName)

Parameters

$collectionName

at line 636
public thumbnailList($collectionName)

Parameters

$collectionName

at line 653
public fileCount()

at line 663
public appendFile($file, $type, $role, $design, $filePath, $collection, $subDirectory = null, $md5 = null, $copyFile = false, $modified = null, $fileType = false, $roleValue = false, $variableName = false, $packagePath = false)

Parameters

$file
$type
$role
$design
$filePath
$collection
$subDirectory
$md5
$copyFile
$modified
$fileType
$roleValue
$variableName
$packagePath

at line 734
public appendProvides($type, $name, $value, $parameters = false)

Parameters

$type
$name
$value
$parameters

at line 751
public appendDependency($dependencySection, $parameters)

Parameters

$dependencySection
$parameters

at line 761
public dependencyOperatorText($dependencyItem)

Parameters

$dependencyItem

at line 766
public createDependencyText($cli, $dependencyItem, $dependencySection)

Parameters

$cli
$dependencyItem
$dependencySection

at line 784
public groupDependencyItemsByType($dependencyItems)

Parameters

$dependencyItems

at line 799
public dependencyItems($dependencySection, $parameters = false)

Parameters

$dependencySection
$parameters

at line 837
public installItemsList($type = false, $os = false, $name = false, $isInstall = true)

Parameters

$type
$os
$name
$isInstall

at line 876
public appendInstall($type, $name, $os = false, $isInstall = true, $filename = false, $subdirectory = false, $parameters = false)

Parameters

$type
$name
$os
$isInstall
$filename
$subdirectory
$parameters

at line 920
public setPackager($timestamp = false, $host = false, $packager = false)

Parameters

$timestamp
$host
$packager

at line 938
public setRelease($version = false, $release = false, $timestamp = false, $licence = false, $state = false)

Parameters

$version
$release
$timestamp
$licence
$state

at line 967
public toString()

at line 979
public storeCache($directory = false)

Parameters

$directory

at line 1000
public store()

at line 1009
public storePackageFile($path, $storeCache = true)

Parameters

$path
$storeCache

at line 1039
public exportToArchive($archivePath)

Parameters

$archivePath

at line 1213
public exportName()

at line 1221
public storeToFile($filename)

Parameters

$filename

at line 1451
public path()

at line 1461
public currentRepositoryPath()

at line 1561
public fetchDependentPackages($dependencyType, $failedList)

Parameters

$dependencyType
$failedList

at line 1661
public setCurrentRepositoryInformation($information)

Parameters

$information

at line 1672
public currentRepositoryInformation()

at line 1806
public installItem($item, $installParameters)

Parameters

$item
$installParameters

at line 1861
public bool install(array $installParameters)

Installs all items in the package

Parameters

array $installParameters

Return Value

bool true if all items installed correctly, false otherwise

at line 1881
public uninstallItem($item, $uninstallParameters)

Parameters

$item
$uninstallParameters

at line 1939
public uninstall($uninstallParameters = array())

Parameters

$uninstallParameters

at line 1966
public parseDOMTree(DOMDocument $dom)

Parameters

DOMDocument $dom

at line 2233
public parseDependencyTree($dependenciesList, $dependencySection)

Parameters

$dependenciesList
$dependencySection

at line 2263
public parseInstallTree($installList, $isInstall)

Parameters

$installList
$isInstall

at line 2291
public domStructure()

at line 2725
public createInstallTree($installNode, $dom, $list, $installType)

Parameters

$installNode
$dom
$list
$installType

at line 2767
public createDependencyTree($dependenciesNode, $dependencyType, $list)

Parameters

$dependenciesNode
$dependencyType
$list

at line 2831
public appendSimpleFile($key, $filepath)

Parameters

$key
$filepath

at line 2861
public simpleFilePath($fileKey)

Parameters

$fileKey

at line 2883
public getVersion()

Returns package version.

Combines package version number and release number.

\static \return Package version (string).

at line 2892
public setInstalled($installed = true)

Parameters

$installed

at line 2916
public isInstalled()

at line 2921
public getInstallState()

at line 2988
public languageInfo($withLanguageNames = false)

Parameters

$withLanguageNames

at line 3051
public defaultLanguageMap()