eZPublishCommunityProject(LegacyStack)  2013.5
eZInstallScriptPackageHandler Class Reference

Empty handler to support package custom install scripts. More...

+ Inheritance diagram for eZInstallScriptPackageHandler:
+ Collaboration diagram for eZInstallScriptPackageHandler:

Public Member Functions

 add ($packageType, $package, $cli, $parameters)
 
 explainInstallItem ($package, $installItem, $requestedInfo=array())
 
 eZInstallScriptPackageHandler ()
 
 handleAddParameters ($packageType, $package, $cli, $arguments)
 
 install ($package, $installType, $parameters, $name, $os, $filename, $subdirectory, $content, &$installParameters, &$installData)
 
 uninstall ($package, $installType, $parameters, $name, $os, $filename, $subdirectory, $content, &$installParameters, &$installData)
 
- Public Member Functions inherited from eZPackageHandler
 createDependencyNode ($package, &$dependencyNode, $dependencyItem, $dependencySection)
 
 createDependencyText ($package, $dependencyItem, $dependencySection)
 
 createInstallNode ($package, $installNode, $installItem, $installType)
 
 extractInstallContent ()
 
 eZPackageHandler ($handlerType, $parameters=array())
 
 handlerType ()
 
 isErrorElement ($elementID, &$installParameters)
 
 parseDependencyNode ($package, &$dependencyNode, &$dependencyParameters, $dependencySection)
 
 parseInstallNode ($package, $installNode, &$installParameters, $isInstall)
 
 reset ()
 

Additional Inherited Members

- Static Public Member Functions inherited from eZPackageHandler
static errorChoosenAction ($errorCode, &$installParameters, $description, $handlerType, $resetError=true)
 

Detailed Description

Empty handler to support package custom install scripts.

Member Function Documentation

eZInstallScriptPackageHandler::add (   $packageType,
  $package,
  $cli,
  $parameters 
)
virtual

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

Implements eZPackageHandler.

eZInstallScriptPackageHandler::explainInstallItem (   $package,
  $installItem,
  $requestedInfo = array() 
)
virtual

Returns an explanation for the extension install item.

Implements eZPackageHandler.

eZInstallScriptPackageHandler::eZInstallScriptPackageHandler ( )

Constructor

eZInstallScriptPackageHandler::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
$packageTypeThe type that was specified when using the add command, which is either the name of this handler or an alias for it.
$packageThe package object.
$cliCommand line interface object, can be used to output errors etc.
$argumentsAn array with string values taken from the command line after the add command.

Implements eZPackageHandler.

eZInstallScriptPackageHandler::install (   $package,
  $installType,
  $parameters,
  $name,
  $os,
  $filename,
  $subdirectory,
  $content,
$installParameters,
$installData 
)
virtual

Do nothing

Implements eZPackageHandler.

eZInstallScriptPackageHandler::uninstall (   $package,
  $installType,
  $parameters,
  $name,
  $os,
  $filename,
  $subdirectory,
  $content,
$installParameters,
$installData 
)
virtual

Do nothing

Implements eZPackageHandler.


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