nextcloud/lib/private/hook.php

149 lines
4.2 KiB
PHP
Raw Normal View History

2011-07-27 21:07:28 +04:00
<?php
/**
2015-03-26 13:44:34 +03:00
* @author Bart Visscher <bartv@thisnet.nl>
* @author Jakob Sack <mail@jakobsack.de>
* @author Morris Jobke <hey@morrisjobke.de>
* @author Robin Appelman <icewind@owncloud.com>
* @author Robin McCorkell <rmccorkell@karoshi.org.uk>
* @author Sam Tuke <mail@samtuke.com>
* @author Thomas Müller <thomas.mueller@tmit.eu>
* @author Vincent Petry <pvince81@owncloud.com>
*
* @copyright Copyright (c) 2015, ownCloud, Inc.
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
2011-07-27 21:07:28 +04:00
*/
2011-07-29 23:36:03 +04:00
class OC_Hook{
public static $thrownExceptions = [];
2011-07-27 21:07:28 +04:00
static private $registered = array();
/**
* connects a function to a hook
2015-04-02 18:53:40 +03:00
*
* @param string $signalClass class name of emitter
* @param string $signalName name of signal
* @param string|object $slotClass class name of slot
* @param string $slotName name of slot
2012-09-23 04:39:11 +04:00
* @return bool
2011-07-27 21:07:28 +04:00
*
* This function makes it very easy to connect to use hooks.
*
* TODO: write example
*/
2015-04-02 18:53:40 +03:00
static public function connect($signalClass, $signalName, $slotClass, $slotName ) {
2013-02-22 20:21:57 +04:00
// If we're trying to connect to an emitting class that isn't
2013-02-06 21:43:03 +04:00
// yet registered, register it
2015-04-02 18:53:40 +03:00
if( !array_key_exists($signalClass, self::$registered )) {
self::$registered[$signalClass] = array();
2011-07-27 21:07:28 +04:00
}
2013-02-22 20:21:57 +04:00
// If we're trying to connect to an emitting method that isn't
2013-02-06 21:43:03 +04:00
// yet registered, register it with the emitting class
2015-04-02 18:53:40 +03:00
if( !array_key_exists( $signalName, self::$registered[$signalClass] )) {
self::$registered[$signalClass][$signalName] = array();
2011-07-27 21:07:28 +04:00
}
2013-02-22 20:21:57 +04:00
2014-06-05 23:08:30 +04:00
// dont connect hooks twice
2015-04-02 18:53:40 +03:00
foreach (self::$registered[$signalClass][$signalName] as $hook) {
if ($hook['class'] === $slotClass and $hook['name'] === $slotName) {
2014-06-05 23:08:30 +04:00
return false;
}
}
2013-02-06 21:43:03 +04:00
// Connect the hook handler to the requested emitter
2015-04-02 18:53:40 +03:00
self::$registered[$signalClass][$signalName][] = array(
"class" => $slotClass,
"name" => $slotName
2013-02-10 01:44:11 +04:00
);
2013-02-22 20:21:57 +04:00
2011-07-27 21:07:28 +04:00
// No chance for failure ;-)
return true;
}
/**
* emits a signal
*
* @param string $signalClass class name of emitter
* @param string $signalName name of signal
2014-05-13 02:27:36 +04:00
* @param mixed $params default: array() array with additional data
2015-01-16 21:31:15 +03:00
* @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
*/
static public function emit($signalClass, $signalName, $params = array()) {
2013-02-22 20:21:57 +04:00
2013-02-06 21:43:03 +04:00
// Return false if no hook handlers are listening to this
// emitting class
if( !array_key_exists($signalClass, self::$registered )) {
2011-07-27 21:07:28 +04:00
return false;
}
2013-02-22 20:21:57 +04:00
2013-02-06 21:43:03 +04:00
// Return false if no hook handlers are listening to this
// emitting method
if( !array_key_exists( $signalName, self::$registered[$signalClass] )) {
2011-07-27 21:07:28 +04:00
return false;
}
2013-02-22 20:21:57 +04:00
2011-07-27 21:07:28 +04:00
// Call all slots
foreach( self::$registered[$signalClass][$signalName] as $i ) {
try {
call_user_func( array( $i["class"], $i["name"] ), $params );
} catch (Exception $e){
self::$thrownExceptions[] = $e;
$class = $i["class"];
if (is_object($i["class"])) {
$class = get_class($i["class"]);
}
$message = $e->getMessage();
if (empty($message)) {
$message = get_class($e);
}
2013-02-11 20:44:02 +04:00
OC_Log::write('hook',
'error while running hook (' . $class . '::' . $i["name"] . '): ' . $message,
2013-02-11 20:44:02 +04:00
OC_Log::ERROR);
}
2011-07-27 21:07:28 +04:00
}
// return true
return true;
}
2012-05-11 22:33:23 +04:00
/**
* clear hooks
2012-09-23 04:39:11 +04:00
* @param string $signalclass
* @param string $signalname
2012-05-11 22:33:23 +04:00
*/
2012-09-07 17:22:01 +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();
}
}
/**
* DO NOT USE!
* For unit tests ONLY!
*/
static public function getHooks() {
return self::$registered;
}
2011-07-27 21:07:28 +04:00
}