eZPublish  4.7
eZExtensionPackageHandler Class Reference

Handles extenstions in the package system. More...

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

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)
 
- 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 ()
 

Static Public Member Functions

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

Public Attributes

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

Detailed Description

Handles extenstions in the package system.

Member Function Documentation

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

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

Implements eZPackageHandler.

static eZExtensionPackageHandler::addExtension (   $package,
  $extensionName 
)
static

Referenced by add().

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

Returns an explanation for the extension install item.

Implements eZPackageHandler.

eZExtensionPackageHandler::eZExtensionPackageHandler ( )

Constructor

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.

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

Copy extension from the package to extension repository.

Implements eZPackageHandler.

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

Uninstalls extensions.

Implements eZPackageHandler.

Member Data Documentation

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

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