X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FCore%2FHook.php;h=3167464a790da9f46d5261e2bbf5ffcbabdd3678;hb=f6fda5840dd073e80db9f6ee7ec41f95624256b1;hp=5caa54319429df3ff4a81668a7517ca59c02549b;hpb=1de3960e267a8d298348fbca18cf1be1f6a20f7a;p=friendica.git diff --git a/src/Core/Hook.php b/src/Core/Hook.php index 5caa543194..3167464a79 100644 --- a/src/Core/Hook.php +++ b/src/Core/Hook.php @@ -1,18 +1,35 @@ . + * */ + namespace Friendica\Core; use Friendica\App; -use Friendica\BaseObject; use Friendica\Database\DBA; +use Friendica\DI; use Friendica\Util\Strings; /** * Some functions to handle hooks */ -class Hook extends BaseObject +class Hook { /** * Array of registered hooks @@ -32,6 +49,8 @@ class Hook extends BaseObject /** * Load hooks + * + * @return void */ public static function loadHooks() { @@ -45,15 +64,16 @@ class Hook extends BaseObject } /** - * @brief Adds a new hook to the hooks array. + * Adds a new hook to the hooks array. * * This function is meant to be called by modules on each page load as it works after loadHooks has been called. * * @param string $hook * @param string $file * @param string $function + * @return void */ - public static function add($hook, $file, $function) + public static function add(string $hook, string $file, string $function) { if (!array_key_exists($hook, self::$hooks)) { self::$hooks[$hook] = []; @@ -62,7 +82,7 @@ class Hook extends BaseObject } /** - * @brief Registers a hook. + * Registers a hook. * * This function is meant to be called once when an addon is enabled for example as it doesn't add to the current hooks. * @@ -73,18 +93,16 @@ class Hook extends BaseObject * @return mixed|bool * @throws \Friendica\Network\HTTPException\InternalServerErrorException */ - public static function register($hook, $file, $function, $priority = 0) + public static function register(string $hook, string $file, string $function, int $priority = 0) { - $file = str_replace(self::getApp()->getBasePath() . DIRECTORY_SEPARATOR, '', $file); + $file = str_replace(DI::app()->getBasePath() . DIRECTORY_SEPARATOR, '', $file); $condition = ['hook' => $hook, 'file' => $file, 'function' => $function]; if (DBA::exists('hook', $condition)) { return true; } - $result = DBA::insert('hook', ['hook' => $hook, 'file' => $file, 'function' => $function, 'priority' => $priority]); - - return $result; + return self::insert(['hook' => $hook, 'file' => $file, 'function' => $function, 'priority' => $priority]); } /** @@ -96,17 +114,17 @@ class Hook extends BaseObject * @return boolean * @throws \Friendica\Network\HTTPException\InternalServerErrorException */ - public static function unregister($hook, $file, $function) + public static function unregister(string $hook, string $file, string $function): bool { - $relative_file = str_replace(self::getApp()->getBasePath() . DIRECTORY_SEPARATOR, '', $file); + $relative_file = str_replace(DI::app()->getBasePath() . DIRECTORY_SEPARATOR, '', $file); // This here is only needed for fixing a problem that existed on the develop branch $condition = ['hook' => $hook, 'file' => $file, 'function' => $function]; - DBA::delete('hook', $condition); + self::delete($condition); $condition = ['hook' => $hook, 'file' => $relative_file, 'function' => $function]; - $result = DBA::delete('hook', $condition); - return $result; + + return self::delete($condition); } /** @@ -115,7 +133,7 @@ class Hook extends BaseObject * @param string $name Name of the hook * @return array */ - public static function getByName($name) + public static function getByName(string $name): array { $return = []; @@ -127,16 +145,17 @@ class Hook extends BaseObject } /** - * @brief Forks a hook. + * Forks a hook. * * Use this function when you want to fork a hook via the worker. * * @param integer $priority of the hook * @param string $name of the hook to call * @param mixed $data to transmit to the callback handler + * @return void * @throws \Friendica\Network\HTTPException\InternalServerErrorException */ - public static function fork($priority, $name, $data = null) + public static function fork(int $priority, string $name, $data = null) { if (array_key_exists($name, self::$hooks)) { foreach (self::$hooks[$name] as $hook) { @@ -148,7 +167,7 @@ class Hook extends BaseObject if ($hook[0] != $fork_hook[0]) { continue; } - self::callSingle(self::getApp(), 'hook_fork', $fork_hook, $hookdata); + self::callSingle('hook_fork', $fork_hook, $hookdata); } if (!$hookdata['execute']) { @@ -162,48 +181,49 @@ class Hook extends BaseObject } /** - * @brief Calls a hook. + * Calls a hook. * * Use this function when you want to be able to allow a hook to manipulate * the provided data. * * @param string $name of the hook to call * @param string|array &$data to transmit to the callback handler + * @return void * @throws \Friendica\Network\HTTPException\InternalServerErrorException */ - public static function callAll($name, &$data = null) + public static function callAll(string $name, &$data = null) { if (array_key_exists($name, self::$hooks)) { foreach (self::$hooks[$name] as $hook) { - self::callSingle(self::getApp(), $name, $hook, $data); + self::callSingle($name, $hook, $data); } } } /** - * @brief Calls a single hook. + * Calls a single hook. * - * @param App $a * @param string $name of the hook to call * @param array $hook Hook data * @param string|array &$data to transmit to the callback handler + * @return void * @throws \Friendica\Network\HTTPException\InternalServerErrorException */ - public static function callSingle(App $a, $name, $hook, &$data = null) + public static function callSingle(string $name, array $hook, &$data = null) { // Don't run a theme's hook if the user isn't using the theme - if (strpos($hook[0], 'view/theme/') !== false && strpos($hook[0], 'view/theme/' . $a->getCurrentTheme()) === false) { + if (strpos($hook[0], 'view/theme/') !== false && strpos($hook[0], 'view/theme/' . DI::app()->getCurrentTheme()) === false) { return; } @include_once($hook[0]); if (function_exists($hook[1])) { $func = $hook[1]; - $func($a, $data); + $func($data); } else { // remove orphan hooks $condition = ['hook' => $name, 'file' => $hook[0], 'function' => $hook[1]]; - DBA::delete('hook', $condition, ['cascade' => false]); + self::delete($condition); } } @@ -214,7 +234,7 @@ class Hook extends BaseObject * @param string $name Name of the addon * @return boolean */ - public static function isAddonApp($name) + public static function isAddonApp(string $name): bool { $name = Strings::sanitizeFilePathItem($name); @@ -228,4 +248,44 @@ class Hook extends BaseObject return false; } + + /** + * Deletes one or more hook records + * + * We have to clear the cached routerDispatchData because addons can provide routes + * + * @param array $condition + * @return bool + * @throws \Exception + */ + public static function delete(array $condition): bool + { + $result = DBA::delete('hook', $condition); + + if ($result) { + DI::cache()->delete('routerDispatchData'); + } + + return $result; + } + + /** + * Inserts a hook record + * + * We have to clear the cached routerDispatchData because addons can provide routes + * + * @param array $condition + * @return bool + * @throws \Exception + */ + private static function insert(array $condition): bool + { + $result = DBA::insert('hook', $condition); + + if ($result) { + DI::cache()->delete('routerDispatchData'); + } + + return $result; + } }