0
0
Fork 0
mirror of https://github.com/nextcloud/server.git synced 2025-05-18 20:21:40 +00:00
nextcloud_server/lib/private/legacy/OC_Hook.php

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

126 lines
3.3 KiB
PHP
Raw Permalink Normal View History

2011-07-27 19:07:28 +02:00
<?php
2011-07-27 19:07:28 +02:00
/**
* SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
* SPDX-FileCopyrightText: 2016 ownCloud, Inc.
* SPDX-License-Identifier: AGPL-3.0-only
2011-07-27 19:07:28 +02:00
*/
use Psr\Log\LoggerInterface;
class OC_Hook {
public static $thrownExceptions = [];
private static $registered = [];
2011-07-27 19:07:28 +02:00
/**
* connects a function to a hook
2015-04-02 17:53:40 +02: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 02:39:11 +02:00
* @return bool
2011-07-27 19:07:28 +02:00
*
* This function makes it very easy to connect to use hooks.
*
* TODO: write example
*/
public static function connect($signalClass, $signalName, $slotClass, $slotName) {
2013-02-22 17:21:57 +01:00
// If we're trying to connect to an emitting class that isn't
2013-02-06 17:43:03 +00:00
// yet registered, register it
if (!array_key_exists($signalClass, self::$registered)) {
self::$registered[$signalClass] = [];
2011-07-27 19:07:28 +02:00
}
2013-02-22 17:21:57 +01:00
// If we're trying to connect to an emitting method that isn't
2013-02-06 17:43:03 +00:00
// yet registered, register it with the emitting class
if (!array_key_exists($signalName, self::$registered[$signalClass])) {
self::$registered[$signalClass][$signalName] = [];
2011-07-27 19:07:28 +02:00
}
2013-02-22 17:21:57 +01:00
// don't connect hooks twice
2015-04-02 17:53:40 +02:00
foreach (self::$registered[$signalClass][$signalName] as $hook) {
if ($hook['class'] === $slotClass and $hook['name'] === $slotName) {
2014-06-05 21:08:30 +02:00
return false;
}
}
2013-02-06 17:43:03 +00:00
// Connect the hook handler to the requested emitter
self::$registered[$signalClass][$signalName][] = [
'class' => $slotClass,
'name' => $slotName
];
2013-02-22 17:21:57 +01:00
2011-07-27 19:07:28 +02: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-12 23:27:36 +01:00
* @param mixed $params default: array() array with additional data
2015-01-16 18:31:15 +00:00
* @return bool true if slots exists or false if not
* @throws \OCP\HintException
* @throws \OC\ServerNotAvailableException Emits a signal. To get data from the slot use references!
2011-07-27 19:07:28 +02:00
*
* TODO: write example
*/
public static function emit($signalClass, $signalName, $params = []) {
2013-02-06 17:43:03 +00:00
// Return false if no hook handlers are listening to this
// emitting class
if (!array_key_exists($signalClass, self::$registered)) {
2011-07-27 19:07:28 +02:00
return false;
}
2013-02-22 17:21:57 +01:00
2013-02-06 17:43:03 +00:00
// Return false if no hook handlers are listening to this
// emitting method
if (!array_key_exists($signalName, self::$registered[$signalClass])) {
2011-07-27 19:07:28 +02:00
return false;
}
2013-02-22 17:21:57 +01:00
2011-07-27 19:07:28 +02:00
// Call all slots
foreach (self::$registered[$signalClass][$signalName] as $i) {
try {
call_user_func([ $i['class'], $i['name'] ], $params);
} catch (Exception $e) {
self::$thrownExceptions[] = $e;
\OCP\Server::get(LoggerInterface::class)->error($e->getMessage(), ['exception' => $e]);
if ($e instanceof \OCP\HintException) {
throw $e;
}
if ($e instanceof \OC\ServerNotAvailableException) {
2015-04-01 17:12:28 +02:00
throw $e;
}
}
2011-07-27 19:07:28 +02:00
}
return true;
}
2012-05-11 20:33:23 +02:00
/**
* clear hooks
* @param string $signalClass
* @param string $signalName
2012-05-11 20:33:23 +02:00
*/
public static function clear($signalClass = '', $signalName = '') {
if ($signalClass) {
if ($signalName) {
self::$registered[$signalClass][$signalName] = [];
2012-05-11 20:33:23 +02:00
} else {
self::$registered[$signalClass] = [];
2012-05-11 20:33:23 +02:00
}
} else {
self::$registered = [];
2012-05-11 20:33:23 +02:00
}
}
/**
* DO NOT USE!
* For unit tests ONLY!
*/
public static function getHooks() {
return self::$registered;
}
2011-07-27 19:07:28 +02:00
}