\GB_Hooks
GeniBase Hooks API class.
Synopsis
- // members
- public static array $filters = ;
- public static array $actions = ;
- public static array $merged_filters = ;
- public static array $current_filter = ;
- // methods
- public static void _call_all_hook()
- public static string|bool _build_unique_id()
- public static boolean add_filter()
- public static bool|int has_filter()
- public static mixed apply_filters()
- public static mixed apply_filters_ref_array()
- public static boolean remove_filter()
- public static bool remove_all_filters()
- public static string current_filter()
- public static string current_action()
- public static bool doing_filter()
- public static bool doing_action()
- public static bool add_action()
- public static null do_action()
- public static int did_action()
- public static null do_action_ref_array()
- public static bool|int has_action()
- public static boolean remove_action()
- public static bool remove_all_actions()
Violations
PHPMessDetector
Line | Rule | Message |
---|---|---|
233 - 267 | CyclomaticComplexity | The method has_filter() has a Cyclomatic Complexity of 10. The configured cyclomatic complexity threshold is 10. |
304 - 346 | CyclomaticComplexity | The method apply_filters() has a Cyclomatic Complexity of 10. The configured cyclomatic complexity threshold is 10. |
424 | ShortVariable | Avoid variables with short names like $r. Configured minimum length is 3. |
582 - 628 | CyclomaticComplexity | The method do_action() has a Cyclomatic Complexity of 15. The configured cyclomatic complexity threshold is 10. |
582 - 628 | NPathComplexity | The method do_action() has an NPath complexity of 1920. The configured NPath complexity threshold is 200. |
661 - 699 | CyclomaticComplexity | The method do_action_ref_array() has a Cyclomatic Complexity of 10. The configured cyclomatic complexity threshold is 10. |
Checkstyle
Line | Column | Severity | Message |
---|---|---|---|
41 | 12 | error | Visibility must be declared on property "$filters" |
46 | 12 | error | Visibility must be declared on property "$actions" |
51 | 12 | error | Visibility must be declared on property "$merged_filters" |
56 | 12 | error | Visibility must be declared on property "$current_filter" |
75 | 12 | warning | Method name "_call_all_hook" should not be prefixed with an underscore to indicate visibility |
75 | 12 | error | Method name "GB_Hooks::_call_all_hook" is not in camel caps format |
75 | 12 | error | Visibility must be declared on method "_call_all_hook" |
79 | 13 | error | Inline control structures are not allowed |
80 | 17 | error | Inline control structures are not allowed |
119 | 12 | warning | Method name "_build_unique_id" should not be prefixed with an underscore to indicate visibility |
119 | 12 | error | Method name "GB_Hooks::_build_unique_id" is not in camel caps format |
119 | 12 | error | Visibility must be declared on method "_build_unique_id" |
123 | 9 | error | Inline control structures are not allowed |
143 | 21 | error | Inline control structures are not allowed |
145 | 139 | warning | Line exceeds 120 characters; contains 139 characters |
154 | 11 | warning | Usage of ELSE IF is discouraged; use ELSEIF instead |
154 | 11 | error | Expected 1 space after ELSE keyword; newline found |
154 | 15 | error | Whitespace found at end of line |
155 | 13 | error | Line indented incorrectly; expected 8 spaces, found 12 |
158 | 13 | error | Line indented incorrectly; expected 8 spaces, found 12 |
206 | 12 | error | Method name "GB_Hooks::add_filter" is not in camel caps format |
206 | 12 | error | Visibility must be declared on method "add_filter" |
233 | 12 | error | Method name "GB_Hooks::has_filter" is not in camel caps format |
233 | 12 | error | Visibility must be declared on method "has_filter" |
251 | 13 | error | Inline control structures are not allowed |
255 | 9 | error | Inline control structures are not allowed |
258 | 9 | error | Inline control structures are not allowed |
262 | 13 | error | Inline control structures are not allowed |
304 | 12 | error | Method name "GB_Hooks::apply_filters" is not in camel caps format |
304 | 12 | error | Visibility must be declared on method "apply_filters" |
316 | 13 | error | Inline control structures are not allowed |
321 | 9 | error | Inline control structures are not allowed |
332 | 9 | error | Inline control structures are not allowed |
336 | 13 | error | Inline control structures are not allowed |
337 | 17 | error | Line indented incorrectly; expected 12 spaces, found 16 |
339 | 122 | warning | Line exceeds 120 characters; contains 122 characters |
340 | 17 | error | Line indented incorrectly; expected 12 spaces, found 16 |
362 | 12 | error | Method name "GB_Hooks::apply_filters_ref_array" is not in camel caps format |
362 | 12 | error | Visibility must be declared on method "apply_filters_ref_array" |
372 | 13 | error | Inline control structures are not allowed |
377 | 9 | error | Inline control structures are not allowed |
389 | 13 | error | Inline control structures are not allowed |
390 | 17 | error | Inline control structures are not allowed |
391 | 124 | warning | Line exceeds 120 characters; contains 124 characters |
420 | 12 | error | Method name "GB_Hooks::remove_filter" is not in camel caps format |
420 | 12 | error | Visibility must be declared on method "remove_filter" |
428 | 13 | error | Inline control structures are not allowed |
431 | 13 | error | Inline control structures are not allowed |
451 | 12 | error | Method name "GB_Hooks::remove_all_filters" is not in camel caps format |
451 | 12 | error | Visibility must be declared on method "remove_all_filters" |
454 | 13 | error | Inline control structures are not allowed |
456 | 13 | error | Inline control structures are not allowed |
460 | 9 | error | Inline control structures are not allowed |
473 | 12 | error | Method name "GB_Hooks::current_filter" is not in camel caps format |
473 | 12 | error | Visibility must be declared on method "current_filter" |
485 | 12 | error | Method name "GB_Hooks::current_action" is not in camel caps format |
485 | 12 | error | Visibility must be declared on method "current_action" |
511 | 12 | error | Method name "GB_Hooks::doing_filter" is not in camel caps format |
511 | 12 | error | Visibility must be declared on method "doing_filter" |
513 | 9 | error | Inline control structures are not allowed |
529 | 12 | error | Method name "GB_Hooks::doing_action" is not in camel caps format |
529 | 12 | error | Visibility must be declared on method "doing_action" |
558 | 12 | error | Method name "GB_Hooks::add_action" is not in camel caps format |
558 | 12 | error | Visibility must be declared on method "add_action" |
582 | 12 | error | Method name "GB_Hooks::do_action" is not in camel caps format |
582 | 12 | error | Visibility must be declared on method "do_action" |
584 | 9 | error | Inline control structures are not allowed |
586 | 9 | error | Expected 1 space after ELSE keyword; newline found |
586 | 9 | error | Inline control structures are not allowed |
597 | 13 | error | Inline control structures are not allowed |
602 | 9 | error | Inline control structures are not allowed |
606 | 9 | error | Inline control structures are not allowed |
608 | 9 | error | Expected 1 space after ELSE keyword; newline found |
608 | 9 | error | Inline control structures are not allowed |
610 | 9 | error | Inline control structures are not allowed |
622 | 13 | error | Inline control structures are not allowed |
623 | 17 | error | Inline control structures are not allowed |
639 | 12 | error | Method name "GB_Hooks::did_action" is not in camel caps format |
639 | 12 | error | Visibility must be declared on method "did_action" |
641 | 9 | error | Inline control structures are not allowed |
661 | 12 | error | Method name "GB_Hooks::do_action_ref_array" is not in camel caps format |
661 | 12 | error | Visibility must be declared on method "do_action_ref_array" |
663 | 9 | error | Inline control structures are not allowed |
665 | 9 | error | Expected 1 space after ELSE keyword; newline found |
665 | 9 | error | Inline control structures are not allowed |
676 | 13 | error | Inline control structures are not allowed |
681 | 9 | error | Inline control structures are not allowed |
693 | 13 | error | Inline control structures are not allowed |
694 | 17 | error | Inline control structures are not allowed |
719 | 12 | error | Method name "GB_Hooks::has_action" is not in camel caps format |
719 | 12 | error | Visibility must be declared on method "has_action" |
741 | 12 | error | Method name "GB_Hooks::remove_action" is not in camel caps format |
741 | 12 | error | Visibility must be declared on method "remove_action" |
757 | 12 | error | Method name "GB_Hooks::remove_all_actions" is not in camel caps format |
757 | 12 | error | Visibility must be declared on method "remove_all_actions" |
Members
public
-
$actions
Increments the amount of times action was triggered. -
$current_filter
Stores the list of current filters with the current one last. -
$filters
A multidimensional array of all hooks and the callbacks hooked to them. -
$merged_filters
Tracks the tags that need to be merged for later.
Methods
public
- _build_unique_id() — Build Unique ID for storage and retrieval.
- _call_all_hook() — Call the 'all' hook, which will process the functions hooked into it.
- add_action() — Hooks a function on to a specific action.
- add_filter() — Hook a function or method to a specific filter action.
- apply_filters() — Call the functions added to a filter hook.
- apply_filters_ref_array() — Execute functions hooked on a specific filter hook, specifying arguments in an array.
- current_action() — Retrieve the name of the current action.
- current_filter() — Retrieve the name of the current filter or action.
- did_action() — Retrieve the number of times an action is fired.
- do_action() — Execute functions hooked on a specific action hook.
- do_action_ref_array() — Execute functions hooked on a specific action hook, specifying arguments in an array.
- doing_action() — Retrieve the name of an action currently being processed.
- doing_filter() — Retrieve the name of a filter currently being processed.
- has_action() — Check if any action has been registered for a hook.
- has_filter() — Check if any filter has been registered for a hook.
- remove_action() — Removes a function from a specified action hook.
- remove_all_actions() — Remove all of the hooks from an action.
- remove_all_filters() — Remove all of the hooks from a filter.
- remove_filter() — Removes a function from a specified filter hook.
History
-
2017-05-16T19:52:59+00:00 (commit #fd0a296)
Author: Limych (andrey@khrolenok.ru) / Commiter: Limych (andrey@khrolenok.ru)
PSR-2 applied
-
2016-01-25T17:45:50+00:00 (commit #97e2af2)
Author: Limych (andrey@khrolenok.ru) / Commiter: Limych (andrey@khrolenok.ru)
Pre v.3.0
-
2015-03-28T21:15:41+00:00 (commit #158813e)
Author: Калёнов Денис Михайлович (a-KaDeMi-k@yandex.ru) / Commiter: Калёнов Денис Михайлович (a-KaDeMi-k@yandex.ru)
ję v2
-
2015-03-25T23:49:58+00:00 (commit #23ca894)
Author: Limych (andrey@khrolenok.ru) / Commiter: Limych (andrey@khrolenok.ru)
#23: Написать автоматические тесты для всей системы https://github.com/Limych/GeniBase/issues/issue/23
-
2015-03-25T21:34:13+00:00 (commit #4a7821b)
Author: Limych (andrey@khrolenok.ru) / Commiter: Limych (andrey@khrolenok.ru)
Hooks API incapsulated to static class.