eZ Publish  [4.2]
eZInstallScriptPackageHandler Class Reference

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

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

List of all members.

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)

Detailed Description

Empty handler to support package custom install scripts.

Definition at line 41 of file ezinstallscriptpackagehandler.php.


Member Function Documentation

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

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

Implements eZPackageHandler.

Definition at line 96 of file ezinstallscriptpackagehandler.php.

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

Returns an explanation for the extension install item.

Implements eZPackageHandler.

Definition at line 55 of file ezinstallscriptpackagehandler.php.

eZInstallScriptPackageHandler::eZInstallScriptPackageHandler ( )

Constructor

Definition at line 46 of file ezinstallscriptpackagehandler.php.

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.

Definition at line 118 of file ezinstallscriptpackagehandler.php.

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

Do nothing

Implements eZPackageHandler.

Definition at line 88 of file ezinstallscriptpackagehandler.php.

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

Do nothing

Implements eZPackageHandler.

Definition at line 77 of file ezinstallscriptpackagehandler.php.


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