eZPublishCommunityProject(LegacyStack)  2013.6
eZPackageInstallationHandler Class Reference

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

Member Function Documentation

eZPackageInstallationHandler::attribute (   $name)

Referenced by generateStepMap(), and stepTemplate().

eZPackageInstallationHandler::attributes ( )
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.

eZPackageInstallationHandler::commitStepMethodMap ( )

Referenced by commitStep().

eZPackageInstallationHandler::customInstallHandlerInfo (   $package,
  $installItem 
)
private

Support for custom installers (stored within the package)

eZPackageInstallationHandler::eZPackageInstallationHandler (   $package,
  $type,
  $installItem,
  $name = null,
  $steps = null 
)
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.

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.

eZPackageInstallationHandler::hasAttribute (   $name)
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.

eZPackageInstallationHandler::initializeStepMethodMap ( )

Referenced by initializeStep().

static eZPackageInstallationHandler::instance (   $package,
  $handlerName,
  $installItem 
)
static
Returns
the package installation handler object for the handler named $handlerName.
Parameters
handlername'
installItem
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()
eZPackageInstallationHandler::reset ( )

Used to reset the instalation handler if needed

eZPackageInstallationHandler::rootDOMNode ( )
private
& eZPackageInstallationHandler::stepMap ( )
Returns
a process step map which has proper next/previous links, method maps and allows lookup of steps by ID.
eZPackageInstallationHandler::stepTemplate (   $package,
  $installItem,
  $step 
)
eZPackageInstallationHandler::validateAndAdvanceStep (   $package,
  $http,
  $currentStepID,
$stepMap,
$persistentData,
$errorList 
)

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.
eZPackageInstallationHandler::validateStepMethodMap ( )

Referenced by validateAndAdvanceStep().


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