eZ Publish  [4.2]
eZContentClassPackageHandler Class Reference

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

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

List of all members.

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)

Static Public Member Functions

static addClass ($package, $classID, $classIdentifier=false)
static classDOMTree ($class)

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.

Definition at line 40 of file ezcontentclasspackagehandler.php.


Member Function Documentation

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

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

Implements eZPackageHandler.

Definition at line 412 of file ezcontentclasspackagehandler.php.

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.

Definition at line 429 of file ezcontentclasspackagehandler.php.

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.

Definition at line 538 of file ezcontentclasspackagehandler.php.

Referenced by addClass().

eZContentClassPackageHandler::contentclassDirectory ( )

Definition at line 694 of file ezcontentclasspackagehandler.php.

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.

Definition at line 63 of file ezcontentclasspackagehandler.php.

eZContentClassPackageHandler::eZContentClassPackageHandler ( )

Constructor

Definition at line 53 of file ezcontentclasspackagehandler.php.

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.

Definition at line 450 of file ezcontentclasspackagehandler.php.

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

Definition at line 458 of file ezcontentclasspackagehandler.php.

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.

Definition at line 179 of file ezcontentclasspackagehandler.php.

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

Uninstalls all previously installed content classes.

Implements eZPackageHandler.

Definition at line 126 of file ezcontentclasspackagehandler.php.


Member Data Documentation

Definition at line 47 of file ezcontentclasspackagehandler.php.

Referenced by install().

Definition at line 45 of file ezcontentclasspackagehandler.php.

Referenced by install().

Definition at line 46 of file ezcontentclasspackagehandler.php.

Referenced by install().


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