1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92: 93: 94: 95: 96: 97: 98: 99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 420: 421: 422: 423: 424: 425: 426: 427: 428: 429: 430: 431: 432: 433: 434: 435: 436: 437: 438: 439: 440: 441: 442: 443: 444: 445: 446: 447: 448: 449: 450: 451: 452: 453: 454: 455: 456: 457: 458: 459: 460: 461: 462: 463: 464: 465: 466: 467: 468: 469: 470: 471: 472: 473: 474: 475: 476: 477: 478: 479: 480: 481: 482: 483: 484: 485: 486: 487: 488: 489: 490: 491: 492: 493: 494: 495: 496: 497: 498: 499: 500: 501: 502: 503: 504: 505: 506: 507: 508: 509: 510: 511: 512: 513: 514: 515: 516: 517: 518: 519: 520: 521: 522: 523: 524: 525: 526: 527: 528: 529: 530: 531: 532: 533: 534: 535: 536: 537: 538: 539: 540: 541: 542: 543: 544: 545: 546: 547: 548: 549: 550: 551: 552: 553: 554: 555: 556: 557: 558: 559: 560: 561: 562: 563: 564: 565: 566: 567: 568: 569: 570: 571: 572: 573: 574: 575: 576: 577: 578: 579: 580: 581: 582: 583: 584: 585: 586: 587: 588: 589: 590: 591: 592: 593: 594: 595: 596: 597: 598: 599: 600: 601: 602: 603: 604: 605: 606: 607: 608: 609: 610: 611: 612: 613: 614: 615: 616: 617: 618: 619: 620: 621: 622: 623: 624: 625: 626: 627: 628: 629: 630: 631: 632: 633: 634: 635: 636: 637: 638: 639: 640: 641: 642: 643: 644: 645: 646: 647: 648: 649: 650: 651: 652: 653: 654: 655: 656: 657: 658: 659: 660: 661: 662: 663: 664: 665: 666: 667: 668: 669: 670: 671: 672: 673: 674: 675: 676: 677: 678: 679: 680: 681: 682: 683: 684: 685: 686: 687: 688: 689: 690: 691: 692: 693: 694: 695: 696: 697: 698: 699: 700: <?php
namespace Core\Helpers;
/**
* Hooks is a class that manages all the hooks set throughout the framework.<br/>
* Hooks are useful to attach actions to other actions, or to alter the execution thread without
* changing the code.<br/>
*
* Hooks is based on the Wordpress <em>hooks</em> system, to allow for plugin flexibility<br/>
*
* @defaults
* The hooks included by default in the framework are:<br/>
* <br/>
* {@see \Kernel\AppKernel}:
* <code>
* ('After_Hooks_Setup', $hooks) // called right after the constructor
* ('exec_beforestart', ['controller' => $controllerName, 'action' => $action]) // just after {@see \Kernel\Router::matchRoute}
* ('permission_unallowed', [
* 'permission' => $permission,
* 'controller' => $controllerName,
* 'action' => $action]) // when it's an unauthorized request
* ('general_exception', ['e' => $e]) // when an Exception is thrown
* ('exec_afterend', ['controller' => $controllerName, 'action' => $action]) // When execution has finished
* </code>
* <br/>
* {@see \Core\ParentController}:
* <code>
* ('include_show_view', ['vars' => $this->vars]) // Called just before including the view file {@see \Core\ParentController::show}
* ('include_get_view', ['vars' => $_vars]) // Called just before including a view file {@see \Core\ParentController::get}
* ('extra_params_path', ['route' => $route]) // If extra parameters are required when creating a url {@see \Core\ParentController::path}
* </code>
* <br/>
* {@see \Core\LoginController}:
* <code>
* ('on_userauth', ['user' => $user]) // Called just after the login session has been created {@see \Core\LoginController::login}
* ('on_userdeauth', ['user' => Session::getUser()]) // Called just before destroying the login session. {@see \Core\LoginController::deauthenticateUser}
* </code>
* <br/>
* {@see \Core\ExceptionController}:
* <code>
* ('show_prod_exception', ['e' => $e]) // Called when an exception is thrown on the PROD environment {@see \Core\ExceptionController::showException}
* ('show_dev_exception', ['e' => $e]) // Called when an exception is thrown on the DEV environment {@see \Core\ExceptionController::showException}
* </code>
* {@see \Kernel\Logger}:
* <code>
* ('logger_post', $postArray) // Called before posting an error log {@see \Kernel\Logger::sendLog}
* </code>
*
* See {@see \Core\Hooks::do_action} and {@see \Core\Hooks::add_action} functions to learn how to use them
*/
class Hooks
{
protected static $hooks = null;
/**
* $filters holds list of hooks
* @access public
* @since 0.1
* @var array
*/
var $filters = array();
/**
* $merged_filters
* @var array
*/
var $merged_filters = array();
/**
* $actions
* @var array
*/
var $actions = array();
/**
* $current_filter holds the name of the current filter
* @access public
* @since 0.1
* @var array
*/
var $current_filter = array();
/**
* __construct class constructor
* @access public
* @since 0.1
*/
public function __construct($args = null)
{
$this->filters = array();
$this->merged_filters = array();
$this->actions = array();
$this->current_filter = array();
static::$hooks = $this;
}
/**
* Singleton initializer
* @return Hooks
*/
public static function init($args = null)
{
return static::$hooks ?: new self($args);
}
/**
* FILTERS
*/
/**
* add_filter Hooks a function or method to a specific filter action.
* @access public
* @since 0.1
*
* @param string $tag The name of the filter to hook the $function_to_add to.
* @param callback $function_to_add The name of the function to be called when the filter is applied.
* @param int $priority optional. Used to specify the order in which the functions associated with a particular
* action are executed (default: 10). Lower numbers correspond with earlier execution, and functions with
* the same priority are executed in the order in which they were added to the action.
* @param int $accepted_args optional. The number of arguments the function accept (default 1).
*
* @return boolean true
*/
public function add_filter($tag, $function_to_add, $priority = 10, $accepted_args = 1)
{
$idx = $this->_filter_build_unique_id($tag, $function_to_add, $priority);
$this->filters[$tag][$priority][$idx] = array('function' => $function_to_add, 'accepted_args' => $accepted_args);
unset($this->merged_filters[$tag]);
return true;
}
/**
* remove_filter Removes a function from a specified filter hook.
* @access public
* @since 0.1
*
* @param string $tag The filter hook to which the function to be removed is hooked.
* @param callback $function_to_remove The name of the function which should be removed.
* @param int $priority optional. The priority of the function (default: 10).
* @param int $accepted_args optional. The number of arguments the function accepts (default: 1).
*
* @return boolean Whether the function existed before it was removed.
*/
public function remove_filter($tag, $function_to_remove, $priority = 10)
{
$function_to_remove = $this->_filter_build_unique_id($tag, $function_to_remove, $priority);
$r = isset($this->filters[$tag][$priority][$function_to_remove]);
if (true === $r) {
unset($this->filters[$tag][$priority][$function_to_remove]);
if (empty($this->filters[$tag][$priority])) {
unset($this->filters[$tag][$priority]);
}
unset($this->merged_filters[$tag]);
}
return $r;
}
/**
* remove_all_filters Remove all of the hooks from a filter.
* @access public
* @since 0.1
*
* @param string $tag The filter to remove hooks from.
* @param int $priority The priority number to remove.
*
* @return bool True when finished.
*/
public function remove_all_filters($tag, $priority = false)
{
if (isset($this->filters[$tag])) {
if (false !== $priority && isset($this->filters[$tag][$priority])) {
unset($this->filters[$tag][$priority]);
} else {
unset($this->filters[$tag]);
}
}
if (isset($this->merged_filters[$tag])) {
unset($this->merged_filters[$tag]);
}
return true;
}
/**
* has_filter Check if any filter has been registered for a hook.
* @access public
* @since 0.1
*
* @param string $tag The name of the filter hook.
* @param callback $function_to_check optional.
*
* @return mixed If $function_to_check is omitted, returns boolean for whether the hook has anything
* registered.
* When checking a specific function, the priority of that hook is returned, or false if the function is not
* attached. When using the $function_to_check argument, this function may return a non-boolean value that
* evaluates to false
* (e.g.) 0, so use the === operator for testing the return value.
*/
public function has_filter($tag, $function_to_check = false)
{
$has = !empty($this->filters[$tag]);
if (false === $function_to_check || false == $has) {
return $has;
}
if (!$idx = $this->_filter_build_unique_id($tag, $function_to_check, false)) {
return false;
}
foreach ((array)array_keys($this->filters[$tag]) as $priority) {
if (isset($this->filters[$tag][$priority][$idx])) {
return $priority;
}
}
return false;
}
/**
* apply_filters Call the functions added to a filter hook.
* @access public
* @since 0.1
*
* @param string $tag The name of the filter hook.
* @param mixed $value The value on which the filters hooked to <tt>$tag</tt> are applied on.
* @param mixed $var,... Additional variables passed to the functions hooked to <tt>$tag</tt>.
*
* @return mixed The filtered value after all hooked functions are applied to it.
*/
public function apply_filters($tag, $value)
{
$args = array();
// Do 'all' actions first
if (isset($this->filters['all'])) {
$this->current_filter[] = $tag;
$args = func_get_args();
$this->_call_all_hook($args);
}
if (!isset($this->filters[$tag])) {
if (isset($this->filters['all'])) {
array_pop($this->current_filter);
}
return $value;
}
if (!isset($this->filters['all'])) {
$this->current_filter[] = $tag;
}
// Sort
if (!isset($this->merged_filters[$tag])) {
ksort($this->filters[$tag]);
$this->merged_filters[$tag] = true;
}
reset($this->filters[$tag]);
if (empty($args)) {
$args = func_get_args();
}
do {
foreach ((array)current($this->filters[$tag]) as $the_)
if (!is_null($the_['function'])) {
$args[1] = $value;
$value = call_user_func_array($the_['function'], array_slice($args, 1, (int)$the_['accepted_args']));
}
} while (next($this->filters[$tag]) !== false);
array_pop($this->current_filter);
return $value;
}
/**
* apply_filters_ref_array Execute functions hooked on a specific filter hook, specifying arguments in an array.
* @access public
* @since 0.1
*
* @param string $tag The name of the filter hook.
* @param array $args The arguments supplied to the functions hooked to <tt>$tag</tt>
*
* @return mixed The filtered value after all hooked functions are applied to it.
*/
public function apply_filters_ref_array($tag, $args)
{
// Do 'all' actions first
if (isset($this->filters['all'])) {
$this->current_filter[] = $tag;
$all_args = func_get_args();
$this->_call_all_hook($all_args);
}
if (!isset($this->filters[$tag])) {
if (isset($this->filters['all'])) {
array_pop($this->current_filter);
}
return $args[0];
}
if (!isset($this->filters['all'])) {
$this->current_filter[] = $tag;
}
// Sort
if (!isset($this->merged_filters[$tag])) {
ksort($this->filters[$tag]);
$this->merged_filters[$tag] = true;
}
reset($this->filters[$tag]);
do {
foreach ((array)current($this->filters[$tag]) as $the_)
if (!is_null($the_['function'])) {
$args[0] = call_user_func_array($the_['function'], array_slice($args, 0, (int)$the_['accepted_args']));
}
} while (next($this->filters[$tag]) !== false);
array_pop($this->current_filter);
return $args[0];
}
/**
* ACTIONS
*/
/**
* add_action Hooks a function on to a specific action.
* @access public
* @since 0.1
*
* @param string $tag The name of the action to which the $function_to_add is hooked.
* @param callback $function_to_add The name of the function you wish to be called.
* @param int $priority optional. Used to specify the order in which the functions associated with a particular
* action are executed (default: 10). Lower numbers correspond with earlier execution, and functions with
* the same priority are executed in the order in which they were added to the action.
* @param int $accepted_args optional. The number of arguments the function accept (default 1).
*
* @return bool|true The result of the add_filter
*/
public function add_action($tag, $function_to_add, $priority = 10, $accepted_args = 1)
{
return $this->add_filter($tag, $function_to_add, $priority, $accepted_args);
}
/**
* has_action Check if any action has been registered for a hook.
* @access public
* @since 0.1
*
* @param string $tag The name of the action hook.
* @param callback $function_to_check optional.
*
* @return mixed If $function_to_check is omitted, returns boolean for whether the hook has anything
* registered.
* When checking a specific function, the priority of that hook is returned, or false if the function is not
* attached. When using the $function_to_check argument, this function may return a non-boolean value that
* evaluates to false
* (e.g.) 0, so use the === operator for testing the return value.
*/
public function has_action($tag, $function_to_check = false)
{
return $this->has_filter($tag, $function_to_check);
}
/**
* remove_action Removes a function from a specified action hook.
* @access public
* @since 0.1
*
* @param string $tag The action hook to which the function to be removed is hooked.
* @param callback $function_to_remove The name of the function which should be removed.
* @param int $priority optional The priority of the function (default: 10).
*
* @return boolean Whether the function is removed.
*/
public function remove_action($tag, $function_to_remove, $priority = 10)
{
return $this->remove_filter($tag, $function_to_remove, $priority);
}
/**
* remove_all_actions Remove all of the hooks from an action.
* @access public
* @since 0.1
*
* @param string $tag The action to remove hooks from.
* @param int $priority The priority number to remove them from.
*
* @return bool True when finished.
*/
public function remove_all_actions($tag, $priority = false)
{
return $this->remove_all_filters($tag, $priority);
}
/**
* do_action Execute functions hooked on a specific action hook.
* @access public
* @since 0.1
*
* @param string $tag The name of the action to be executed.
* @param mixed $arg,... Optional additional arguments which are passed on to the functions hooked to the
* action.
*
* @return mixed The response of the last called action
*/
public function do_action($tag, $arg = '')
{
if (!isset($this->actions)) {
$this->actions = array();
}
if (!isset($this->actions[$tag])) {
$this->actions[$tag] = 1;
} else {
++$this->actions[$tag];
}
// Do 'all' actions first
if (isset($this->filters['all'])) {
$this->current_filter[] = $tag;
$all_args = func_get_args();
$this->_call_all_hook($all_args);
}
if (!isset($this->filters[$tag])) {
if (isset($this->filters['all'])) {
array_pop($this->current_filter);
}
return;
}
if (!isset($this->filters['all'])) {
$this->current_filter[] = $tag;
}
$args = array();
if (is_array($arg) && 1 == count($arg) && isset($arg[0]) && is_object($arg[0])) // array(&$this)
{
$args[] =& $arg[0];
} else {
$args[] = $arg;
}
for ($a = 2; $a < func_num_args(); $a++)
$args[] = func_get_arg($a);
// Sort
if (!isset($this->merged_filters[$tag])) {
ksort($this->filters[$tag]);
$this->merged_filters[$tag] = true;
}
reset($this->filters[$tag]);
do {
foreach ((array)current($this->filters[$tag]) as $the_)
if (!is_null($the_['function'])) {
$result = call_user_func_array($the_['function'], array_slice($args, 0, (int)$the_['accepted_args']));
}
} while (next($this->filters[$tag]) !== false);
array_pop($this->current_filter);
return $result;
}
/**
* do_action_ref_array Execute functions hooked on a specific action hook, specifying arguments in an array.
* @access public
* @since 0.1
*
* @param string $tag The name of the action to be executed.
* @param array $args The arguments supplied to the functions hooked to <tt>$tag</tt>
*
* @return null Will return null if $tag does not exist in $filter array
*/
public function do_action_ref_array($tag, $args)
{
if (!isset($this->actions)) {
$this->actions = array();
}
if (!isset($this->actions[$tag])) {
$this->actions[$tag] = 1;
} else {
++$this->actions[$tag];
}
// Do 'all' actions first
if (isset($this->filters['all'])) {
$this->current_filter[] = $tag;
$all_args = func_get_args();
$this->_call_all_hook($all_args);
}
if (!isset($this->filters[$tag])) {
if (isset($this->filters['all'])) {
array_pop($this->current_filter);
}
return;
}
if (!isset($this->filters['all'])) {
$this->current_filter[] = $tag;
}
// Sort
if (!isset($merged_filters[$tag])) {
ksort($this->filters[$tag]);
$merged_filters[$tag] = true;
}
reset($this->filters[$tag]);
do {
foreach ((array)current($this->filters[$tag]) as $the_)
if (!is_null($the_['function'])) {
call_user_func_array($the_['function'], array_slice($args, 0, (int)$the_['accepted_args']));
}
} while (next($this->filters[$tag]) !== false);
array_pop($this->current_filter);
}
/**
* did_action Retrieve the number of times an action is fired.
* @access public
* @since 0.1
*
* @param string $tag The name of the action hook.
*
* @return int The number of times action hook <tt>$tag</tt> is fired
*/
public function did_action($tag)
{
if (!isset($this->actions) || !isset($this->actions[$tag])) {
return 0;
}
return $this->actions[$tag];
}
/**
* HELPERS
*/
/**
* current_filter Retrieve the name of the current filter or action.
* @access public
* @since 0.1
* @return string Hook name of the current filter or action.
*/
public function current_filter()
{
return end($this->current_filter);
}
/**
* Retrieve the name of the current action.
*
* @since 0.1.2
*
* @uses current_filter()
*
* @return string Hook name of the current action.
*/
function current_action()
{
return $this->current_filter();
}
/**
* Retrieve the name of a filter currently being processed.
*
* The function current_filter() only returns the most recent filter or action
* being executed. did_action() returns true once the action is initially
* processed. This function allows detection for any filter currently being
* executed (despite not being the most recent filter to fire, in the case of
* hooks called from hook callbacks) to be verified.
*
* @since 0.1.2
*
* @see current_filter()
* @see did_action()
* @global array $wp_current_filter Current filter.
*
* @param null|string $filter Optional. Filter to check. Defaults to null, which
* checks if any filter is currently being run.
*
* @return bool Whether the filter is currently in the stack
*/
function doing_filter($filter = null)
{
if (null === $filter) {
return !empty($this->current_filter);
}
return in_array($filter, $this->current_filter);
}
/**
* Retrieve the name of an action currently being processed.
*
* @since 0.1.2
*
* @uses doing_filter()
*
* @param string|null $action Optional. Action to check. Defaults to null, which checks
* if any action is currently being run.
*
* @return bool Whether the action is currently in the stack.
*/
function doing_action($action = null)
{
return $this->doing_filter($action);
}
/**
* _filter_build_unique_id Build Unique ID for storage and retrieval.
*
* @param string $tag Used in counting how many hooks were applied
* @param callback $function Used for creating unique id
* @param int|bool $priority Used in counting how many hooks were applied. If === false and $function is an
* object reference, we return the unique id only if it already has one, false otherwise.
*
* @return string|bool Unique ID for usage as array key or false if $priority === false and $function is an
* object reference, and it does not already have a unique id.
*/
private function _filter_build_unique_id($tag, $function, $priority)
{
static $filter_id_count = 0;
if (is_string($function)) {
return $function;
}
if (is_object($function)) {
// Closures are currently implemented as objects
$function = array($function, '');
} else {
$function = (array)$function;
}
if (is_object($function[0])) {
// Object Class Calling
if (function_exists('spl_object_hash')) {
return spl_object_hash($function[0]) . $function[1];
} else {
$obj_idx = get_class($function[0]) . $function[1];
if (!isset($function[0]->filter_id)) {
if (false === $priority) {
return false;
}
$obj_idx .= isset($this->filters[$tag][$priority]) ? count((array)$this->filters[$tag][$priority]) : $filter_id_count;
$function[0]->filter_id = $filter_id_count;
++$filter_id_count;
} else {
$obj_idx .= $function[0]->filter_id;
}
return $obj_idx;
}
} else {
if (is_string($function[0])) {
// Static Calling
return $function[0] . $function[1];
}
}
}
/**
* __call_all_hook
* @access public
* @since 0.1
*
* @param (array) $args [description]
*/
public function __call_all_hook($args)
{
reset($this->filters['all']);
do {
foreach ((array)current($this->filters['all']) as $the_)
if (!is_null($the_['function'])) {
call_user_func_array($the_['function'], $args);
}
} while (next($this->filters['all']) !== false);
}
}