eZPublish  4.4
eZContentClassPackageHandler Class Reference

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

+ Inheritance diagram for eZContentClassPackageHandler:
+ Collaboration diagram for eZContentClassPackageHandler:

Public Member Functions

 add ($packageType, $package, $cli, $parameters)
 
 contentclassDirectory ()
 
 explainInstallItem ($package, $installItem, $requestedInfo=array( 'name', 'identifier', 'description', 'language_info'))
 
 eZContentClassPackageHandler ()
 
 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 addClass ($package, $classID, $classIdentifier=false)
 
static classDOMTree ($class)
 
- Static Public Member Functions inherited from eZPackageHandler
static errorChoosenAction ($errorCode, &$installParameters, $description, $handlerType, $resetError=true)
 

Public Attributes

const ACTION_DELETE = 4
 
const ACTION_NEW = 3
 
const ACTION_REPLACE = 1
 
const ACTION_SKIP = 2
 
const ERROR_EXISTS = 1
 
const ERROR_HAS_OBJECTS = 101
 

Private Member Functions

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

Detailed Description

Handles content classes in the package system.

Member Function Documentation

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

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

Implements eZPackageHandler.

static eZContentClassPackageHandler::addClass (   $package,
  $classID,
  $classIdentifier = false 
)
static

Adds the content class with ID $classID to the package. If $classIdentifier is false then it will be fetched from the class.

Referenced by add(), and eZContentObjectPackageHandler\generatePackage().

static eZContentClassPackageHandler::classDOMTree (   $class)
static

Creates the DOM tree for the content class $class and returns the root node.

Referenced by addClass().

eZContentClassPackageHandler::contentclassDirectory ( )
eZContentClassPackageHandler::explainInstallItem (   $package,
  $installItem,
  $requestedInfo = array( 'name', 'identifier', 'description', 'language_info' ) 
)
virtual

Returns an explanation for the content class install item. Use $requestedInfo to request portion of info.

Implements eZPackageHandler.

eZContentClassPackageHandler::eZContentClassPackageHandler ( )

Constructor

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

eZContentClassPackageHandler::handleParameters (   $packageType,
  $package,
  $cli,
  $type,
  $arguments 
)
private

Referenced by handleAddParameters().

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

Creates a new contentclass as defined in the xml structure.

Implements eZPackageHandler.

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

Uninstalls all previously installed content classes.

Implements eZPackageHandler.

Member Data Documentation

const eZContentClassPackageHandler::ACTION_DELETE = 4
const eZContentClassPackageHandler::ACTION_NEW = 3
const eZContentClassPackageHandler::ACTION_REPLACE = 1
const eZContentClassPackageHandler::ACTION_SKIP = 2
const eZContentClassPackageHandler::ERROR_EXISTS = 1
const eZContentClassPackageHandler::ERROR_HAS_OBJECTS = 101

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