The class eZPackageInstallationHandler does. More...

Inheritance diagram for eZPackageInstallationHandler:

Public Member Functions
	attribute ($name)
	attributes ()
	commitStep ($package, $http, $step, &$persistentData, $tpl)
	commitStepMethodMap ()
	eZPackageInstallationHandler ($package, $type, $installItem, $name=null, $steps=null)
	finalize ($package, $http, &$persistentData)
	generateStepMap ($package, &$persistentData)
	hasAttribute ($name)
	initializeStep ($package, $http, $step, &$persistentData, $tpl, $module)
	initializeStepMethodMap ()
	packageType ($package, &$persistentData)
	reset ()
&	stepMap ()
	stepTemplate ($package, $installItem, $step)
	validateAndAdvanceStep ($package, $http, $currentStepID, &$stepMap, &$persistentData, &$errorList)
	validateStep ($package, $http, $currentStepID, &$stepMap, &$persistentData, &$errorList)
	validateStepMethodMap ()
Static Public Member Functions
static	instance ($package, $handlerName, $installItem)
Private Member Functions
	customInstallHandlerInfo ($package, $installItem)
	rootDOMNode ()

Detailed Description

The class eZPackageInstallationHandler does.

Definition at line 18 of file ezpackageinstallationhandler.php.

Member Function Documentation

eZPackageInstallationHandler::attribute ( $ name )

Definition at line 103 of file ezpackageinstallationhandler.php.

Referenced by generateStepMap(), and stepTemplate().

eZPackageInstallationHandler::attributes ( )

Definition at line 93 of file ezpackageinstallationhandler.php.

eZPackageInstallationHandler::commitStep	(	$	package,
		$	http,
		$	step,
		&$	persistentData,
		$	tpl
	)

This is called after a step has validated it's information. It can be used to put values in the $persistentData variable for later retrieval.

Definition at line 215 of file ezpackageinstallationhandler.php.

eZPackageInstallationHandler::commitStepMethodMap ( )

Definition at line 124 of file ezpackageinstallationhandler.php.

Referenced by commitStep().

eZPackageInstallationHandler::customInstallHandlerInfo	(	$	package,
		$	installItem
	)		`[private]`

Support for custom installers (stored within the package)

Reimplemented in eZInstallScriptPackageInstaller.

Definition at line 357 of file ezpackageinstallationhandler.php.

eZPackageInstallationHandler::eZPackageInstallationHandler	(	$	package,
		$	type,
		$	installItem,
		$	name = `null`,
		$	steps = `null`
	)

Constructor

Definition at line 23 of file ezpackageinstallationhandler.php.

Referenced by eZContentObjectPackageInstaller\eZContentObjectPackageInstaller().

eZPackageInstallationHandler::finalize	(	$	package,
		$	http,
		&$	persistentData
	)

Finalizes the creation process with the gathered information. This is usually the function that creates the package and adds the proper elements.

Reimplemented in eZContentObjectPackageInstaller.

Definition at line 241 of file ezpackageinstallationhandler.php.

eZPackageInstallationHandler::generateStepMap	(	$	package,
		&$	persistentData
	)

Will go over the steps and make sure that:

The next and previous links are correct
Steps that aren't needed are removed

It will also make sure that steps can be looked up by their ID.

Definition at line 44 of file ezpackageinstallationhandler.php.

eZPackageInstallationHandler::hasAttribute ( $ name )

Definition at line 98 of file ezpackageinstallationhandler.php.

eZPackageInstallationHandler::initializeStep	(	$	package,
		$	http,
		$	step,
		&$	persistentData,
		$	tpl,
		$	module
	)

This is called the first time the step is entered (ie. not on validations) and can be used to fill in values in the $persistentData variable for use in the template or later retrieval.

Definition at line 156 of file ezpackageinstallationhandler.php.

eZPackageInstallationHandler::initializeStepMethodMap ( )

Definition at line 114 of file ezpackageinstallationhandler.php.

Referenced by initializeStep().

static eZPackageInstallationHandler::instance	(	$	package,
		$	handlerName,
		$	installItem
	)		`[static]`

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

Parameters:

handler	name'
install	Item

Definition at line 251 of file ezpackageinstallationhandler.php.

Referenced by eZContentObjectPackageInstaller\initializeSiteAccess(), and eZContentObjectPackageInstaller\initializeTopNodes().

eZPackageInstallationHandler::packageType	(	$	package,
		&$	persistentData
	)

Returns:: The package type taken from $package if the package exists, otherwise false. If the creator should have a specific package type this function should be reimplemented. See eZPackage::typeList() for more information on available types.

Note:: This function is called from createPackage and checkPackageMaintainer()

Reimplemented in eZContentObjectPackageInstaller.

Definition at line 312 of file ezpackageinstallationhandler.php.

eZPackageInstallationHandler::reset ( )

Used to reset the instalation handler if needed

Definition at line 231 of file ezpackageinstallationhandler.php.

eZPackageInstallationHandler::rootDOMNode ( ) [private]

Get root dom node of current install item.

Definition at line 325 of file ezpackageinstallationhandler.php.

Referenced by eZContentObjectPackageInstaller\initializeSiteAccess(), and eZContentObjectPackageInstaller\initializeTopNodes().

& eZPackageInstallationHandler::stepMap ( )

Returns:: a process step map which has proper next/previous links, method maps and allows lookup of steps by ID.

Definition at line 133 of file ezpackageinstallationhandler.php.

eZPackageInstallationHandler::stepTemplate	(	$	package,
		$	installItem,
		$	step
	)

Reimplemented in eZInstallScriptPackageInstaller.

Definition at line 138 of file ezpackageinstallationhandler.php.

eZPackageInstallationHandler::validateAndAdvanceStep	(	$	package,
		$	http,
		$	currentStepID,
		&$	stepMap,
		&$	persistentData,
		&$	errorList
	)

Definition at line 197 of file ezpackageinstallationhandler.php.

Referenced by validateStep().

eZPackageInstallationHandler::validateStep	(	$	package,
		$	http,
		$	currentStepID,
		&$	stepMap,
		&$	persistentData,
		&$	errorList
	)

This is called after a step is finished. Reimplement this function to validate the step values and give back errors.

Returns:: false if the next step should not be fetched (ie. errors) or true if the all is OK and the next step should be fetched. It is also possible to return a step identifier, in which case this will be the next step.

Definition at line 177 of file ezpackageinstallationhandler.php.

eZPackageInstallationHandler::validateStepMethodMap ( )

Definition at line 119 of file ezpackageinstallationhandler.php.

Referenced by validateAndAdvanceStep().

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

ezpackageinstallationhandler.php

Public Member Functions

Static Public Member Functions

Private Member Functions

Detailed Description

Member Function Documentation