eZFilePackageHandler Class Reference

Handles content classes in the package system. More...

Inheritance diagram for eZFilePackageHandler:

Collaboration diagram for eZFilePackageHandler:

List of all members.

Public Member Functions
	add ($packageType, $package, $cli, $parameters)
	createInstallNode ($package, $installNode, $installItem, $installType)
	designExists ($design)
	eZFilePackageHandler ()
	fileExists (&$file, &$type, &$role, &$roleValue, &$design, &$triedFiles)
	handleAddParameters ($packageType, $package, $cli, $arguments)
	handleParameters ($packageType, $package, $cli, $type, $arguments)
	iniMatch ($filePath, &$role, &$roleValue, &$file, &$triedFiles)
	install ($package, $installType, $parameters, $name, $os, $filename, $subdirectory, $content, &$installParameters, &$installData)
	parseInstallNode ($package, $installNode, &$installParameters, $isInstall)
	roleExists ($type, $role)

---

Detailed Description

Handles content classes in the package system.

Definition at line 17 of file ezfilepackagehandler.php.

---

Member Function Documentation

eZFilePackageHandler::add	(	$	packageType,
		$	package,
		$	cli,
		$	parameters
	)		[virtual]

Adds items defined in $parameters to the package $package.

Implements eZPackageHandler.

Definition at line 88 of file ezfilepackagehandler.php.

eZFilePackageHandler::createInstallNode	(	$	package,
		$	installNode,
		$	installItem,
		$	installType
	)		[virtual]

Fills in extra information on the install node $installNode which is specific to the current handler.

Parameters:

$package	The current package.
$installItem	Contains all variables for the install
$installType	The type of install, can be 'install' or 'uninstall'

Implements eZPackageHandler.

Definition at line 582 of file ezfilepackagehandler.php.

eZFilePackageHandler::designExists

(

$

design

)

Definition at line 351 of file ezfilepackagehandler.php.

Referenced by handleParameters().

eZFilePackageHandler::eZFilePackageHandler

(

)

Constructor

Definition at line 22 of file ezfilepackagehandler.php.

eZFilePackageHandler::fileExists	(	&$	file,
		&$	type,
		&$	role,
		&$	roleValue,
		&$	design,
		&$	triedFiles
	)

Definition at line 356 of file ezfilepackagehandler.php.

Referenced by handleParameters().

eZFilePackageHandler::handleAddParameters	(	$	packageType,
		$	package,
		$	cli,
		$	arguments
	)		[virtual]

Called when command line parameters must be handled by the package handler. This function must return an array with values which can easily be used in the add() function.

Parameters:

$packageType	The type that was specified when using the add command, which is either the name of this handler or an alias for it.
$package	The package object.
$cli	Command line interface object, can be used to output errors etc.
$arguments	An array with string values taken from the command line after the add command.

Implements eZPackageHandler.

Definition at line 139 of file ezfilepackagehandler.php.

eZFilePackageHandler::handleParameters	(	$	packageType,
		$	package,
		$	cli,
		$	type,
		$	arguments
	)

Definition at line 144 of file ezfilepackagehandler.php.

Referenced by handleAddParameters().

eZFilePackageHandler::iniMatch	(	$	filePath,
		&$	role,
		&$	roleValue,
		&$	file,
		&$	triedFiles
	)

Definition at line 532 of file ezfilepackagehandler.php.

Referenced by fileExists(), and handleParameters().

eZFilePackageHandler::install	(	$	package,
		$	installType,
		$	parameters,
		$	name,
		$	os,
		$	filename,
		$	subdirectory,
		$	content,
		&$	installParameters,
		&$	installData
	)		[virtual]

Installs the package item

Implements eZPackageHandler.

Definition at line 27 of file ezfilepackagehandler.php.

eZFilePackageHandler::parseInstallNode	(	$	package,
		$	installNode,
		&$	installParameters,
		$	isInstall
	)		[virtual]

Parses the XML node $installNode and fills in extra information not handled by the package parser.

Parameters:

$package	The current package.
$installParameters	Reference to an array which must be filled with specific data for the current handler.
$isInstall	Is true if this is an install node, false if it is an uninstall node

Implements eZPackageHandler.

Definition at line 587 of file ezfilepackagehandler.php.

eZFilePackageHandler::roleExists	(	$	type,
		$	role
	)

Definition at line 340 of file ezfilepackagehandler.php.

Referenced by handleParameters().

---

The documentation for this class was generated from the following file:

• ezfilepackagehandler.php