eZ Publish  [4.2]
eZExtensionPackageHandler Class Reference

Handles extenstions in the package system. More...

+ Inheritance diagram for eZExtensionPackageHandler:
+ Collaboration diagram for eZExtensionPackageHandler:

List of all members.

Public Member Functions

 add ($packageType, $package, $cli, $parameters)
 explainInstallItem ($package, $installItem, $requestedInfo=array())
 eZExtensionPackageHandler ()
 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)

Static Public Member Functions

static addExtension ($package, $extensionName)

Public Attributes

 $Package = null
const ACTION_REPLACE = 1
const ACTION_SKIP = 2
const ERROR_EXISTS = 1

Detailed Description

Handles extenstions in the package system.

Definition at line 40 of file ezextensionpackagehandler.php.


Member Function Documentation

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

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

Implements eZPackageHandler.

Definition at line 203 of file ezextensionpackagehandler.php.

static eZExtensionPackageHandler::addExtension ( package,
extensionName 
) [static]

Definition at line 212 of file ezextensionpackagehandler.php.

Referenced by add().

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

Returns an explanation for the extension install item.

Implements eZPackageHandler.

Definition at line 59 of file ezextensionpackagehandler.php.

eZExtensionPackageHandler::eZExtensionPackageHandler ( )

Constructor

Definition at line 50 of file ezextensionpackagehandler.php.

eZExtensionPackageHandler::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 259 of file ezextensionpackagehandler.php.

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

Copy extension from the package to extension repository.

Implements eZPackageHandler.

Definition at line 125 of file ezextensionpackagehandler.php.

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

Uninstalls extensions.

Implements eZPackageHandler.

Definition at line 86 of file ezextensionpackagehandler.php.


Member Data Documentation

eZExtensionPackageHandler::$Package = null

Definition at line 284 of file ezextensionpackagehandler.php.


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