eZ Publish  [4.2]
eZContentObjectEditHandler Class Reference

The class eZContentObjectEditHandler provides a framework for handling content/edit view specific things in extensions. More...

List of all members.

Public Member Functions

 eZContentObjectEditHandler ()
 fetchInput ($http, &$module, &$class, $object, &$version, $contentObjectAttributes, $editVersion, $editLanguage, $fromLanguage)
 publish ($contentObjectID, $contentObjectVersion)
 validateInput ($http, &$module, &$class, $object, &$version, $contentObjectAttributes, $editVersion, $editLanguage, $fromLanguage, $validationParameters)

Static Public Member Functions

static addStoreAction ($name)
static executeHandlerFunction ($functionName, $params)
static executeInputHandlers (&$module, &$class, $object, &$version, $contentObjectAttributes, $editVersion, $editLanguage, $fromLanguage)
static executePublish ($contentObjectID, $contentObjectVersion)
static initialize ()
static isStoreAction ()
static storeActionList ()
static validateInputHandlers (&$module, &$class, $object, &$version, $contentObjectAttributes, $editVersion, $editLanguage, $fromLanguage, $validationParameters)

Detailed Description

The class eZContentObjectEditHandler provides a framework for handling content/edit view specific things in extensions.

Definition at line 41 of file ezcontentobjectedithandler.php.


Member Function Documentation

static eZContentObjectEditHandler::addStoreAction ( name) [static]

Set custom HTTP post parameters which should trigger store acrtions.

Parameters:
HTTPpost parameter name

Definition at line 218 of file ezcontentobjectedithandler.php.

Referenced by initialize().

static eZContentObjectEditHandler::executeHandlerFunction ( functionName,
params 
) [static]

Execute handler $functionName function with given $params parameters

Definition at line 116 of file ezcontentobjectedithandler.php.

Referenced by executeInputHandlers(), executePublish(), and validateInputHandlers().

static eZContentObjectEditHandler::executeInputHandlers ( &$  module,
&$  class,
object,
&$  version,
contentObjectAttributes,
editVersion,
editLanguage,
fromLanguage 
) [static]

Calls all extension object edit input handler, and executes this the fetchInput function

Definition at line 141 of file ezcontentobjectedithandler.php.

static eZContentObjectEditHandler::executePublish ( contentObjectID,
contentObjectVersion 
) [static]

Calls all publish functions.

Definition at line 162 of file ezcontentobjectedithandler.php.

eZContentObjectEditHandler::eZContentObjectEditHandler ( )

Constructor

Definition at line 46 of file ezcontentobjectedithandler.php.

eZContentObjectEditHandler::fetchInput ( http,
&$  module,
&$  class,
object,
&$  version,
contentObjectAttributes,
editVersion,
editLanguage,
fromLanguage 
)

Override this function in the extension to handle edit input parameters.

Definition at line 53 of file ezcontentobjectedithandler.php.

static eZContentObjectEditHandler::initialize ( ) [static]

Initialize all extension input handler.

Definition at line 89 of file ezcontentobjectedithandler.php.

static eZContentObjectEditHandler::isStoreAction ( ) [static]

Check if any HTTP input trigger store action

Definition at line 231 of file ezcontentobjectedithandler.php.

eZContentObjectEditHandler::publish ( contentObjectID,
contentObjectVersion 
)

Do content object publish operations.

Definition at line 68 of file ezcontentobjectedithandler.php.

static eZContentObjectEditHandler::storeActionList ( ) [static]

Return list of HTTP postparameters which should trigger store action.

Definition at line 60 of file ezcontentobjectedithandler.php.

eZContentObjectEditHandler::validateInput ( http,
&$  module,
&$  class,
object,
&$  version,
contentObjectAttributes,
editVersion,
editLanguage,
fromLanguage,
validationParameters 
)

Override this function in the extension to handle input validation.

Result with warnings are expected in the following format: array( 'is_valid' => false, 'warnings' => array( array( 'text' => 'Input parameter <some_id> must be an integer.' ) ) );

Definition at line 78 of file ezcontentobjectedithandler.php.

static eZContentObjectEditHandler::validateInputHandlers ( &$  module,
&$  class,
object,
&$  version,
contentObjectAttributes,
editVersion,
editLanguage,
fromLanguage,
validationParameters 
) [static]

Calls all input validation functions.

Definition at line 174 of file ezcontentobjectedithandler.php.


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