eZPublish  3.9
eZFilePackageHandler Class Reference

Handles content classes in the package system. More...

+ Inheritance diagram for eZFilePackageHandler:
+ Collaboration diagram for eZFilePackageHandler:

Public Member Functions

 add ($packageType, &$package, &$cli, $parameters)
 
 createInstallNode (&$package, &$installNode, $installItem, $installType)
 
 designExists ($design)
 
 eZFilePackageHandler ()
 
 fileExists (&$file, &$type, &$role, &$roleValue, &$design, &$triedFiles)
 
 handleAddParameters ($packageType, &$package, &$cli, $arguments)
 
 handleParameters ($packageType, &$package, &$cli, $type, $arguments)
 
 iniMatch ($filePath, &$role, &$roleValue, &$file)
 
 install (&$package, $installType, $parameters, $name, $os, $filename, $subdirectory, &$content, $installParameters)
 
 parseInstallNode (&$package, &$installNode, &$installParameters, $isInstall)
 
 roleExists ($type, $role)
 
- Public Member Functions inherited from eZPackageHandler
 add ($packageType, &$package, $parameters)
 
 createDependencyNode (&$package, &$dependencyNode, $dependencyItem, $dependencySection)
 
 createDependencyText (&$package, $dependencyItem, $dependencySection)
 
 errorChoosenAction ($errorCode, &$installParameters, $description=false, $handlerType=false, $resetError=true)
 
 explainInstallItem (&$package, $installItem)
 
 extractInstallContent ()
 
 eZPackageHandler ($handlerType, $parameters=array())
 
 handlerType ()
 
 install (&$package, $installType, $parameters, $name, $os, $filename, $subdirectory, &$content, &$installParameters, &$installData)
 
 isErrorElement ($elementID, &$installParameters)
 
 parseDependencyNode (&$package, &$dependencyNode, &$dependencyParameters, $dependencySection)
 
 reset ()
 
 uninstall (&$package, $installType, $parameters, $name, $os, $filename, $subdirectory, $installParameters, &$installData)
 

Detailed Description

Handles content classes in the package system.

Member Function Documentation

eZFilePackageHandler::add (   $packageType,
$package,
$cli,
  $parameters 
)
eZFilePackageHandler::createInstallNode ( $package,
$installNode,
  $installItem,
  $installType 
)
virtual

Implements eZPackageHandler.

eZFilePackageHandler::designExists (   $design)

Referenced by handleParameters().

eZFilePackageHandler::eZFilePackageHandler ( )

Constructor

eZFilePackageHandler::fileExists ( $file,
$type,
$role,
$roleValue,
$design,
$triedFiles 
)

Referenced by handleParameters().

eZFilePackageHandler::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.

eZFilePackageHandler::handleParameters (   $packageType,
$package,
$cli,
  $type,
  $arguments 
)

Referenced by handleAddParameters().

eZFilePackageHandler::iniMatch (   $filePath,
$role,
$roleValue,
$file 
)

Referenced by fileExists(), and handleParameters().

eZFilePackageHandler::install ( $package,
  $installType,
  $parameters,
  $name,
  $os,
  $filename,
  $subdirectory,
$content,
  $installParameters 
)
eZFilePackageHandler::parseInstallNode ( $package,
$installNode,
$installParameters,
  $isInstall 
)
virtual

Implements eZPackageHandler.

eZFilePackageHandler::roleExists (   $type,
  $role 
)

Referenced by handleParameters().


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