eZPublish  4.5
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, &$installData)
 
 parseInstallNode ($package, $installNode, &$installParameters, $isInstall)
 
 roleExists ($type, $role)
 
- Public Member Functions inherited from eZPackageHandler
 createDependencyNode ($package, &$dependencyNode, $dependencyItem, $dependencySection)
 
 createDependencyText ($package, $dependencyItem, $dependencySection)
 
 explainInstallItem ($package, $installItem, $requestedInfo=array())
 
 extractInstallContent ()
 
 eZPackageHandler ($handlerType, $parameters=array())
 
 handlerType ()
 
 isErrorElement ($elementID, &$installParameters)
 
 parseDependencyNode ($package, &$dependencyNode, &$dependencyParameters, $dependencySection)
 
 reset ()
 
 uninstall ($package, $installType, $parameters, $name, $os, $filename, $subdirectory, $content, &$installParameters, &$installData)
 

Additional Inherited Members

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

Detailed Description

Handles content classes in the package system.

Member Function Documentation

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

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

Implements eZPackageHandler.

eZFilePackageHandler::createInstallNode (   $package,
  $installNode,
  $installItem,
  $installType 
)
virtual

Fills in extra information on the install node $installNode which is specific to the current handler.

Parameters
$packageThe current package.
$installItemContains all variables for the install
$installTypeThe type of install, can be 'install' or 'uninstall'

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,
$installData 
)
virtual

Installs the package item

Implements eZPackageHandler.

eZFilePackageHandler::parseInstallNode (   $package,
  $installNode,
$installParameters,
  $isInstall 
)
virtual

Parses the XML node $installNode and fills in extra information not handled by the package parser.

Parameters
$packageThe current package.
$installParametersReference to an array which must be filled with specific data for the current handler.
$isInstallIs true if this is an install node, false if it is an uninstall node

Implements eZPackageHandler.

eZFilePackageHandler::roleExists (   $type,
  $role 
)

Referenced by handleParameters().


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