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.
	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.
	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.
static	import ($archiveName, &$packageName, $dbAvailable=true, $repositoryID=false)
	Imports a package from a gzip compressed tarball file.
static	isValidName ($packageName, &$transformedPackageName=null)
	Checks if a package name is valid.
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.
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)

Detailed Description

Maintains eZ Publish packages.

Definition at line 19 of file ezpackage.php.

Member Function Documentation

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

Definition at line 484 of file ezpackage.php.

Referenced by parseDOMTree().

eZPackage::appendDependency	(	$	dependencySection,
		$	parameters
	)

Appends a new dependency item to the section $dependencySection.

Parameters:

$dependencySection	Can be one of `provides`, `requires`, `obsoletes`, `conflicts`
$parameters	A list of data specific to the dependency type.

Definition at line 751 of file ezpackage.php.

Referenced by appendProvides(), and parseDependencyTree().

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

Definition at line 460 of file ezpackage.php.

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`
	)

Definition at line 663 of file ezpackage.php.

Referenced by parseDOMTree().

eZPackage::appendGroup ( $ name )

Definition at line 478 of file ezpackage.php.

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

Definition at line 876 of file ezpackage.php.

Referenced by parseInstallTree().

eZPackage::appendMaintainer	(	$	name,
		$	email,
		$	role = `false`
	)

Definition at line 453 of file ezpackage.php.

Referenced by parseDOMTree().

eZPackage::appendProvides	(	$	type,
		$	name,
		$	value,
		$	parameters = `false`
	)

Appends a new provides dependency.

Note:: This function is only a convenience function to the general appendDependency() function.

Definition at line 734 of file ezpackage.php.

eZPackage::appendSimpleFile	(	$	key,
		$	filepath
	)

Append File to package assosiated with key. The file will be available during installation using the same key.

Parameters:

key
file	path

Definition at line 2831 of file ezpackage.php.

static eZPackage::applyStorageFilePermissions ( $ filename ) [static]

Applies the storage file permissions specified in site.ini to the file $filename

Definition at line 1230 of file ezpackage.php.

Referenced by storeDOM(), and storeString().

eZPackage::attribute ( $ attributeName )

Returns:: the value of the attribute named $attributeName.

Definition at line 230 of file ezpackage.php.

Referenced by canUsePackagePolicyFunction(), domStructure(), exportName(), exportToArchive(), fileItemPath(), and path().

eZPackage::attributes ( )

Returns:: the attributes for this package.

Definition at line 176 of file ezpackage.php.

Referenced by hasAttribute().

static eZPackage::cacheDirectory ( ) [static]

Returns:: the name of the cache directory for cached package data.

Definition at line 1511 of file ezpackage.php.

Referenced by fetch(), fetchFromCache(), fetchPackages(), and storePackageFile().

eZPackage::canExport ( )

Definition at line 307 of file ezpackage.php.

Referenced by attribute().

eZPackage::canImport ( )

Definition at line 312 of file ezpackage.php.

Referenced by attribute().

eZPackage::canInstall ( )

Definition at line 317 of file ezpackage.php.

Referenced by attribute().

eZPackage::canRead ( )

Definition at line 302 of file ezpackage.php.

Referenced by attribute().

eZPackage::canUsePackagePolicyFunction ( $ functionName )

Definition at line 322 of file ezpackage.php.

Referenced by canExport(), canImport(), canInstall(), and canRead().

static eZPackage::canUsePolicyFunction ( $ functionName ) [static]

Definition at line 291 of file ezpackage.php.

Referenced by eZPackageFunctionCollection\canCreate(), eZPackageFunctionCollection\canEdit(), eZPackageFunctionCollection\canExport(), eZPackageFunctionCollection\canImport(), eZPackageFunctionCollection\canInstall(), eZPackageFunctionCollection\canList(), eZPackageFunctionCollection\canRead(), and eZPackageFunctionCollection\canRemove().

static eZPackage::create	(	$	name,
		$	parameters = `array()`,
		$	repositoryPath = `false`,
		$	repositoryID = `false`
	)		`[static]`

Parameters:

$repositoryID The id (string) of the repository to create the package in. If false it will use the local repository.

Definition at line 158 of file ezpackage.php.

Referenced by appendDocument(), and eZPackageCreationHandler\createPackage().

eZPackage::createDependencyText	(	$	cli,
		$	dependencyItem,
		$	dependencySection
	)

Definition at line 766 of file ezpackage.php.

eZPackage::createDependencyTree	(	&$	dependenciesNode,
		$	dependencyType,
		$	list
	)

Creates dependency xml elements as child of $dependenciesNode. The dependency elements are take from $list.

Parameters:

$dependencyType Is either 'provide', 'require', 'obsolete' or 'conflict'

Definition at line 2767 of file ezpackage.php.

Referenced by domStructure().

eZPackage::createInstallTree	(	$	installNode,
		$	dom,
		$	list,
		$	installType
	)		`[private]`

Creates xml elements as children of the main node $installNode. The install elements are taken from $list.

Parameters:

$installType Is either 'install' or 'uninstall'

Definition at line 2725 of file ezpackage.php.

Referenced by domStructure().

eZPackage::currentRepositoryInformation ( )

Returns:: the current repository information for the package, this will contain information of where the package was found. See packageRepositories too see what the information will contain.

Note:: The return information can be null in some cases when the package is not properly initialized.

Definition at line 1672 of file ezpackage.php.

Referenced by attribute(), currentRepositoryPath(), and fileItemPath().

eZPackage::currentRepositoryPath ( )

Returns:: the path to the current repository.

Definition at line 1461 of file ezpackage.php.

Referenced by path().

eZPackage::defaultLanguageMap ( )

Definition at line 3051 of file ezpackage.php.

static eZPackage::definitionFilename ( ) [static]

Returns:: the name of the package definition file.

Definition at line 1520 of file ezpackage.php.

Referenced by fetch(), fetchPackages(), import(), and storePackageFile().

eZPackage::dependencyItems	(	$	dependencySection,
		$	parameters = `false`
	)

Returns:: an array with dependency items which match the specified criterias.

Definition at line 799 of file ezpackage.php.

eZPackage::dependencyOperatorText ( $ dependencyItem )

Definition at line 761 of file ezpackage.php.

Referenced by createDependencyText().

static eZPackage::documentDirectory ( ) [static]

Returns:: the name of the documents directory for cached package data.

Definition at line 1529 of file ezpackage.php.

Referenced by appendDocument(), exportToArchive(), and eZPackageOperator\modify().

& eZPackage::domStructure ( )

Returns:: the dom document of the package.

Definition at line 2291 of file ezpackage.php.

Referenced by storeToFile(), and toString().

eZPackage::exportName ( )

Returns:: the file name for an exported archive of the current package

Definition at line 1213 of file ezpackage.php.

eZPackage::exportToArchive ( $ archivePath )

Exports the package as a gzip compressed tarball to the directory $archivePath

Definition at line 1039 of file ezpackage.php.

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

Constructor

Definition at line 34 of file ezpackage.php.

Referenced by create(), fetchFromCache(), and fetchFromFile().

static eZPackage::fetch	(	$	packageName,
		$	packagePath = `false`,
		$	repositoryID = `false`,
		$	dbAvailable = `true`
	)		`[static]`

Tries to load the package named $packageName from the repository and returns the package object.

Parameters:

$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)

Returns:: false if no package could be found.

Definition at line 1351 of file ezpackage.php.

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.

Parameters:

$dependencyType is the name of a dependency sub-node. (ie. 'provides', 'requires' etc...)

Definition at line 1561 of file ezpackage.php.

static eZPackage::fetchDOMFromFile ( $ filename ) [static, private]

Loads the contents of the file $filename and parses it into a DOM tree. The DOM tree is returned.

Definition at line 1295 of file ezpackage.php.

Referenced by fetchFromFile(), installItem(), and uninstallItem().

static eZPackage::fetchFromCache	(	$	packagePath,
		$	packageModification,
		&$	cacheExpired
	)		`[static, private]`

Definition at line 1416 of file ezpackage.php.

Referenced by fetch(), and fetchPackages().

static eZPackage::fetchFromFile ( $ filename ) [static]

Tries to load the package definition from file $filename and create a package object from it.

Returns:: false if it could be fetched.

Definition at line 1321 of file ezpackage.php.

Referenced by fetch(), fetchPackages(), and import().

static eZPackage::fetchMaintainerRoleIDList	(	$	packageType = `false`,
		$	checkRoles = `false`
	)		`[static]`

Definition at line 364 of file ezpackage.php.

Referenced by eZPackageCreationHandler\checkPackageMaintainer(), and fetchMaintainerRoleList().

static eZPackage::fetchMaintainerRoleList	(	$	packageType = `false`,
		$	checkRoles = `false`
	)		`[static]`

Definition at line 414 of file ezpackage.php.

static eZPackage::fetchPackages	(	$	parameters = `array()`,
		$	filterArray = `array()`
	)		`[static]`

Locates all packages in the repository and returns an array with eZPackage objects.

Parameters:

parameters
filterArray

Definition at line 1683 of file ezpackage.php.

Referenced by eZStepInstaller\availableSitePackages(), eZStepSiteTemplates\display(), eZStepSitePackages\display(), eZStepSiteTypes\fetchAvailablePackages(), eZStepSiteTypes\fetchAvailableSitePackages(), and eZPackageFunctionCollection\fetchList().

eZPackage::fileCount ( )

Definition at line 653 of file ezpackage.php.

Referenced by attribute().

eZPackage::fileItemPath	(	$	fileItem,
		$	collectionName,
		$	path = `false`
	)

Definition at line 605 of file ezpackage.php.

eZPackage::fileList ( $ collectionName )

Definition at line 628 of file ezpackage.php.

Referenced by thumbnailList().

static eZPackage::filesDirectory ( ) [static]

Returns:: the name of the documents directory for cached package data.

Definition at line 1538 of file ezpackage.php.

Referenced by appendFile(), exportToArchive(), and fileItemPath().

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

Definition at line 532 of file ezpackage.php.

eZPackage::getInstallState ( )

Definition at line 2921 of file ezpackage.php.

Referenced by setInstalled().

eZPackage::getVersion ( ) [static]

Returns package version.

Combines package version number and release number.

Returns:: Package version (string).

Definition at line 2883 of file ezpackage.php.

Referenced by getInstallState(), and setInstalled().

eZPackage::groupDependencyItemsByType ( $ dependencyItems )

Definition at line 784 of file ezpackage.php.

eZPackage::hasAttribute ( $ attributeName )

Returns:: true if the attribute named $attributeName exists.

Definition at line 222 of file ezpackage.php.

static eZPackage::import	(	$	archiveName,
		&$	packageName,
		$	dbAvailable = `true`,
		$	repositoryID = `false`
	)		`[static]`

Imports a package from a gzip compressed tarball file.

Parameters:

string	$archiveName	Path to the archive file
string	$packageName	Package name
bool	$dbAvailable
bool	$repositoryID

Returns:: eZPackage The eZPackage object if successfull, or one of the STATUS_* class constants if an error occurs

Definition at line 1106 of file ezpackage.php.

Referenced by eZStepSiteTypes\downloadAndImportPackage(), downloadPackages(), and eZStepSiteTypes\uploadPackage().

eZPackage::install ( &$ installParameters )

Installs all items in the package.

Parameters:

array $installParameters

Returns:: bool true if all items installed correctly, false otherwise

Definition at line 1861 of file ezpackage.php.

eZPackage::installItem	(	$	item,
		&$	installParameters
	)

Install specified install item in package

Parameters:

Item	index
parameters

Definition at line 1806 of file ezpackage.php.

Referenced by install().

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

Returns:: an array with install items which match the specified criterias.

Definition at line 837 of file ezpackage.php.

Referenced by languageInfo(), and uninstall().

eZPackage::isInstalled ( )

Definition at line 2916 of file ezpackage.php.

Referenced by attribute(), getInstallState(), setInstalled(), and uninstall().

static eZPackage::isValidName	(	$	packageName,
		&$	transformedPackageName = `null`
	)		`[static]`

Checks if a package name is valid.

Parameters:

string	$packageName	the package name
string	$transformedPackageName	the package name, transformed to be valid

Returns:: boolean true if the package name is valid, false if not

Definition at line 3071 of file ezpackage.php.

eZPackage::languageInfo ( $ withLanguageNames = false )

Fetch info about languages for package.

Definition at line 2988 of file ezpackage.php.

Referenced by defaultLanguageMap().

static eZPackage::languageInfoFromPackageList	(	$	packageNameList,
		$	withLanguageNames = `false`
	)		`[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", ... );

Definition at line 2950 of file ezpackage.php.

Referenced by eZStepPackageLanguageOptions\init().

static eZPackage::maintainerRoleListForRoles ( ) [static]

Definition at line 427 of file ezpackage.php.

static eZPackage::maintainerRoleName ( $ roleID ) [static]

Definition at line 441 of file ezpackage.php.

Referenced by fetchMaintainerRoleList(), and maintainerRoleListForRoles().

static eZPackage::md5sum ( $ file ) [static]

Definition at line 502 of file ezpackage.php.

Referenced by appendFile().

static eZPackage::packageHandler ( $ handlerName ) [static]

Returns:: the package handler object for the handler named $handlerName.

Definition at line 2791 of file ezpackage.php.

Referenced by createDependencyText(), createDependencyTree(), createInstallTree(), eZContentClassPackageCreator\finalize(), eZExtensionPackageCreator\finalize(), eZContentObjectPackageCreator\finalize(), installItem(), languageInfo(), parseDependencyTree(), parseInstallTree(), and uninstallItem().

static eZPackage::packageRepositories ( $ parameters = array() ) [static]

Returns:: an array with repositories which can contain packages.

Each repository entry is an array with the following keys.

path The path to the repository relative from the eZ Publish installation
id Unique identifier for this repository
name Human readable string identifying this repository, the name is translatable
type What kind of repository, currently supports local or global.

Definition at line 1598 of file ezpackage.php.

Referenced by fetch(), fetchPackages(), eZPackageFunctionCollection\fetchRepositoryList(), and repositoryInformation().

eZPackage::parseDependencyTree	(	$	dependenciesList,
		$	dependencySection
	)		`[private]`

Definition at line 2233 of file ezpackage.php.

Referenced by parseDOMTree().

eZPackage::parseDOMTree ( DOMDocument $ dom ) [private]

Definition at line 1966 of file ezpackage.php.

eZPackage::parseInstallTree	(	$	installList,
		$	isInstall
	)		`[private]`

Definition at line 2263 of file ezpackage.php.

Referenced by parseDOMTree().

eZPackage::path ( )

Returns:: the full path to this package.

Definition at line 1451 of file ezpackage.php.

Referenced by appendDocument(), appendFile(), appendInstall(), appendSimpleFile(), exportToArchive(), fileStorePath(), import(), installItem(), remove(), repositoryPath(), simpleFilePath(), store(), temporaryExportPath(), temporaryImportPath(), and uninstallItem().

eZPackage::remove ( )

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

Definition at line 46 of file ezpackage.php.

static eZPackage::removeFiles ( $ path ) [static]

Recursively deletes $path

Definition at line 1028 of file ezpackage.php.

Referenced by exportToArchive(), and import().

static eZPackage::repositoryInformation ( $ repositoryID ) [static]

Returns:: information on the repository with ID $repositoryID or false if does not exist.

Definition at line 1635 of file ezpackage.php.

Referenced by systemRepositoryInformation().

static eZPackage::repositoryPath ( ) [static]

Returns:: the path to the package repository.

Definition at line 1497 of file ezpackage.php.

Referenced by downloadPackages(), eZPackage(), import(), installScriptDir(), and packageRepositories().

eZPackage::setAttribute	(	$	attributeName,
		$	attributeValue
	)

Sets the attribute named $attributeName to have the value $attributeValue.

Definition at line 200 of file ezpackage.php.

eZPackage::setCurrentRepositoryInformation ( $ information )

Sets the current repository information for the package.

See also:: currentRepositoryInformation, packageRepositories

Definition at line 1661 of file ezpackage.php.

eZPackage::setInstalled ( $ installed = true )

Sets installed/uninstalled state of the package

Parameters:

installed

Definition at line 2892 of file ezpackage.php.

Referenced by install(), remove(), and uninstall().

eZPackage::setPackager	(	$	timestamp = `false`,
		$	host = `false`,
		$	packager = `false`
	)

Sets the packager of this release.

Definition at line 920 of file ezpackage.php.

Referenced by parseDOMTree().

eZPackage::setParameters ( $ parameters = array() ) [private]

Definition at line 59 of file ezpackage.php.

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.

Parameters:

$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.