nextcloud/lib/hook.php

86 lines
2.2 KiB
PHP
Raw Normal View History

2011-07-27 21:07:28 +04:00
<?php
/**
* This class manages the hooks. It basically provides two functions: adding
* slots and emitting signals.
*/
2011-07-29 23:36:03 +04:00
class OC_Hook{
2011-07-27 21:07:28 +04:00
static private $registered = array();
/**
* @brief connects a function to a hook
2012-10-16 19:57:07 +04:00
* @param string $signalclass class name of emitter
* @param string $signalname name of signal
* @param string $slotclass class name of slot
* @param string $slotname name of slot
* @return bool
2011-07-27 21:07:28 +04:00
*
* This function makes it very easy to connect to use hooks.
*
* TODO: write example
*/
2012-10-16 19:57:07 +04:00
static public function connect( $signalclass, $signalname, $slotclass, $slotname ) {
// Create the data structure
2012-10-16 19:57:07 +04:00
if( !array_key_exists( $signalclass, self::$registered )) {
2011-07-27 21:07:28 +04:00
self::$registered[$signalclass] = array();
}
2012-10-16 19:57:07 +04:00
if( !array_key_exists( $signalname, self::$registered[$signalclass] )) {
2011-07-27 21:07:28 +04:00
self::$registered[$signalclass][$signalname] = array();
}
// register hook
self::$registered[$signalclass][$signalname][] = array(
"class" => $slotclass,
"name" => $slotname );
// No chance for failure ;-)
return true;
}
/**
2012-10-16 19:57:07 +04:00
* @brief emits a signal
* @param string $signalclass class name of emitter
* @param string $signalname name of signal
* @param array $params defautl: array() array with additional data
* @return bool, true if slots exists or false if not
2011-07-27 21:07:28 +04:00
*
* Emits a signal. To get data from the slot use references!
*
* TODO: write example
*/
2012-10-16 19:57:07 +04:00
static public function emit( $signalclass, $signalname, $params = array()) {
2011-07-27 21:07:28 +04:00
// Return false if there are no slots
2012-10-16 19:57:07 +04:00
if( !array_key_exists( $signalclass, self::$registered )) {
2011-07-27 21:07:28 +04:00
return false;
}
2012-10-16 19:57:07 +04:00
if( !array_key_exists( $signalname, self::$registered[$signalclass] )) {
2011-07-27 21:07:28 +04:00
return false;
}
// Call all slots
2012-10-16 19:57:07 +04:00
foreach( self::$registered[$signalclass][$signalname] as $i ) {
2011-07-27 21:07:28 +04:00
call_user_func( array( $i["class"], $i["name"] ), $params );
}
// return true
return true;
}
2012-05-11 22:33:23 +04:00
/**
* clear hooks
2012-10-16 19:57:07 +04:00
* @param string $signalclass
* @param string $signalname
2012-05-11 22:33:23 +04:00
*/
2012-10-16 19:57:07 +04:00
static public function clear($signalclass='', $signalname='') {
if($signalclass) {
if($signalname) {
2012-05-11 22:33:23 +04:00
self::$registered[$signalclass][$signalname]=array();
}else{
self::$registered[$signalclass]=array();
}
}else{
self::$registered=array();
}
}
2011-07-27 21:07:28 +04:00
}