Initial commit

.gitignore

@@ -0,0 +1,2 @@
+.idea
+/vendor/

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Hadi Akbarzadeh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,56 @@
+# Hooker for PHP
+
+> A simple hook system library (actions and filters) based on Symfony EventDispatcher.
+
+## 🫡 Usage
+
+### 🚀 Installation
+
+You can install the package via composer:
+
+```bash
+composer require nabeghe/hooker
+```
+
+### Examples
+
+Check the examples folder in the repositiry.
+
+#### Action
+
+```php
+require 'vendor/autoload.php';
+
+use Nabeghe\Hooker\Hooker;
+use Nabeghe\Hooker\Action;
+
+$hooker = new Hooker();
+
+$hooker->setDefaultArgToHooks('protocol', 'https://');
+
+$hooker->listen('your_custom_action_name', function (Action $action) {
+    echo $action['protocol'].$action['url'].PHP_EOL;
+}, 2);
+
+$hooker->action('your_custom_action_name', ['url' => 'https://github.com/nabeghe/hooker']);
+```
+
+#### Filter:
+
+```php
+require 'vendor/autoload.php';
+
+use Nabeghe\Hooker\Hooker;
+use Nabeghe\Hooker\Filter;
+
+$hooker = new Hooker();
+
+$hooker->listen('your_custom_action_name', function (Filter $filter) {
+    if ($filter->getValue() === null) {
+        $filter->setValue(8 + $filter['default']);
+    }
+});
+
+$value = $hooker->filter('your_custom_action_name', null, ['default' => 5]);
+echo $value; // 13
+```

composer.json

@@ -0,0 +1,24 @@
+{
+  "name": "nabeghe/hooker",
+  "description": "A simple hook system library (actions and filters) based on Symfony EventDispatcher.",
+  "type": "library",
+  "version": "0.2.0",
+  "homepage": "https://github.com/nabeghe/hooker",
+  "license": "MIT",
+  "autoload": {
+    "psr-4": {
+      "Nabeghe\\Hooker\\": "src/"
+    }
+  },
+  "authors": [
+    {
+      "name": "Hadi Akbarzadeh",
+      "email": "[email protected]",
+      "homepage": "https://elatel.ir",
+      "role": "Developer"
+    }
+  ],
+  "require": {
+    "symfony/event-dispatcher": "^7.1"
+  }
+}

examples/1-action.php

@@ -0,0 +1,30 @@
+<?php require '../vendor/autoload.php';
+
+use Nabeghe\Hooker\Hooker;
+use Nabeghe\Hooker\Action;
+
+$hooker = new Hooker();
+
+$hooker->setDefaultArgToHooks('protocol', 'https://');
+
+$hooker->listen('your_custom_action_name', function (Action $action) {
+    echo 'Priority 2: '.$action['protocol'].$action['url'].PHP_EOL;
+}, 2); // priority 2
+
+$hooker->listen('your_custom_action_name', function (Action $action) {
+    echo 'Priority 4: '.$action['protocol'].$action['url'].PHP_EOL;
+}, 4); // priority 4
+
+$hooker->listen('your_custom_action_name', function (Action $action) {
+    echo 'Priority 3: '.$action['protocol'].$action['url'].PHP_EOL;
+}, 3); // priority 3
+
+$hooker->listen('your_custom_action_name', function (Action $action) {
+    echo 'Priority 1: '.$action['protocol'].$action['url'].PHP_EOL;
+}, 1); // priority 1
+
+$hooker->listen('your_custom_action_name', function (Action $action) {
+    echo 'Priority 5: '.$action['protocol'].$action['url'].PHP_EOL;
+}, 5); // priority 5
+
+$hooker->action('your_custom_action_name', ['url' => 'https://github.com/nabeghe/hooker']);

examples/2-filter.php

@@ -0,0 +1,23 @@
+<?php require '../vendor/autoload.php';
+
+use Nabeghe\Hooker\Hooker;
+use Nabeghe\Hooker\Filter;
+
+$hooker = new Hooker();
+
+$hooker->listen('your_custom_action_name', function (Filter $filter) {
+    if ($filter->getValue() === null) {
+        $filter->setValue($filter['default']);
+    }
+});
+
+$hooker->listen('your_custom_action_name', function (Filter $filter) {
+    $filter->setValue($filter->getValue() + 2);
+});
+
+$hooker->listen('your_custom_action_name', function (Filter $filter) {
+    $filter->setValue($filter->getValue() + 3);
+});
+
+$value = $hooker->filter('your_custom_action_name', null, ['default' => 9]);
+echo $value; // 13