Unpublish event

A very simple event is the unpublish event. This sets the object to unpublished. The event is placed in kernel/classes/workflowtypes/event/ezunpublish/ and the file is called ezunpublishtype.php.
kernel/classes/workflowtypes/event/ezunpublish/ezunpublishtype.php:

<?php

 

include_once( 'kernel/classes/ezworkflowtype.php' );

 

define( "EZ_WORKFLOW_TYPE_UNPUBLISH_ID", "ezunpublish" );

 

class eZUnpublishType extends eZWorkflowEventType

{

   /*!

    Constructor

   */

   function eZUnpublishType()

   {

       $this->eZWorkflowEventType( EZ_WORKFLOW_TYPE_UNPUBLISH_ID, "Unpublish" );

   }

 

   function execute( &$process, &$event )

   {

       $parameters = $process->attribute( 'parameter_list' );

       $object =& eZContentObject::fetch( $parameters['object_id'] );

       $version =& eZContentObjectVersion::fetchVersion( $parameters['version'], 

                                                         $parameters['object_id'] );

       $version->unpublish();

       return EZ_WORKFLOW_TYPE_STATUS_ACCEPTED;

   }

}

 

eZWorkflowEventType::registerType( EZ_WORKFLOW_TYPE_UNPUBLISH_ID, "ezunpublishtype" );

 

?>

In the same way as for the datatype the event inherit from a superclass (eZWorkflowEventType, placed inside kernel/classes/ezworkflowtype.php). The constructor calls the superclass with the identifier for the event and the name the event will get in the drop down in the admin interface.
The only virtual method we have to create is execute. This method is run each time the event is executed. The method takes two arguments, one is an object for the current process and the other is an object for the current event.
In the end of the file (outside the class definition) we have to register the event in the same way as for the datatype.