Current File : /home/tjamichg/cursos.tjamich.gob.mx/main/inc/lib/hook/interfaces/base/HookEventInterface.php
<?php
/* For licensing terms, see /license.txt */
/**
* This file contains all Hook interfaces and their relation.
* They are used for Hook classes.
*
* Interface HookEventInterface.
*/
interface HookEventInterface
{
/**
* Attach an HookObserver.
*
* @see http://php.net/manual/en/splsubject.attach.php
*
* @param \HookObserverInterface| $observer <p>
* The <b>HookObserver</b> to attach.
* </p>
*/
public function attach(HookObserverInterface $observer);
/**
* Detach an HookObserver.
*
* @see http://php.net/manual/en/splsubject.detach.php
*
* @param \HookObserverInterface| $observer <p>
* The <b>HookObserver</b> to detach.
* </p>
*/
public function detach(HookObserverInterface $observer);
/**
* Return the singleton instance of Hook event.
*
* @return static
*/
public static function create();
/**
* Return an array containing all data needed by the hook observer to update.
*
* @return array
*/
public function getEventData();
/**
* Set an array with data needed by hooks.
*
* @return $this
*/
public function setEventData(array $data);
/**
* Return the event name refer to where hook is used.
*
* @return string
*/
public function getEventName();
/**
* Clear all hookObservers without detach them.
*
* @return mixed
*/
public function clearAttachments();
/**
* Detach all hook observers.
*
* @return $this
*/
public function detachAll();
}
Mini Shell