X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FCore%2FHook.php;h=f2fb52f5e8d6e64418ec9bff8ac58e16fbe68ef0;hb=4ff7c37f85cdedb3f033bec92228c8ef22def574;hp=959ed9fa16e3193069c9684ea75f97e927b7f4c5;hpb=1de3f186d79f3703850524c1d58c237be3eb25f3;p=friendica.git

diff --git a/src/Core/Hook.php b/src/Core/Hook.php
index 959ed9fa16..f2fb52f5e8 100644
--- a/src/Core/Hook.php
+++ b/src/Core/Hook.php
@@ -1,11 +1,27 @@
 <?php
 /**
- * @file src/Core/Hook.php
+ * @copyright Copyright (C) 2010-2022, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * 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
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
  */
+
 namespace Friendica\Core;
 
 use Friendica\App;
-use Friendica\BaseObject;
 use Friendica\Database\DBA;
 use Friendica\DI;
 use Friendica\Util\Strings;
@@ -13,7 +29,7 @@ use Friendica\Util\Strings;
 /**
  * Some functions to handle hooks
  */
-class Hook extends BaseObject
+class Hook
 {
 	/**
 	 * Array of registered hooks
@@ -33,6 +49,8 @@ class Hook extends BaseObject
 
 	/**
 	 * Load hooks
+	 *
+	 * @return void
 	 */
 	public static function loadHooks()
 	{
@@ -46,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] = [];
@@ -63,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.
 	 *
@@ -74,7 +93,7 @@ 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(DI::app()->getBasePath() . DIRECTORY_SEPARATOR, '', $file);
 
@@ -83,9 +102,7 @@ class Hook extends BaseObject
 			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]);
 	}
 
 	/**
@@ -97,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(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);
 	}
 
 	/**
@@ -116,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 = [];
 
@@ -128,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) {
@@ -163,16 +181,17 @@ 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) {
@@ -182,15 +201,16 @@ class Hook extends BaseObject
 	}
 
 	/**
-	 * @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(App $a, 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) {
@@ -204,7 +224,7 @@ class Hook extends BaseObject
 		} else {
 			// remove orphan hooks
 			$condition = ['hook' => $name, 'file' => $hook[0], 'function' => $hook[1]];
-			DBA::delete('hook', $condition, ['cascade' => false]);
+			self::delete($condition);
 		}
 	}
 
@@ -215,7 +235,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);
 
@@ -229,4 +249,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;
+	}
 }