Event::advise_after() - Code Metrics - splitbrain/dokuwiki - Measure and Improve Code Quality continuously with Scrutinizer

Event::advise_after() A
last analyzed 2021-06-08 18:02 UTC

↳ Parent: Event

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
nc	2
nop	0
dl	0
loc	13
rs	9.8333
c	0
b	0
f	0

<?php
// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps

namespace dokuwiki\Extension;

use dokuwiki\Logger;

/**
 * The Action plugin event
 */
class Event
{
    /** @var string READONLY  event name, objects must register against this name to see the event */
    public $name = '';
    /** @var mixed|null READWRITE data relevant to the event, no standardised format, refer to event docs */
    public $data = null;
    /**
     * @var mixed|null READWRITE the results of the event action, only relevant in "_AFTER" advise
     *                 event handlers may modify this if they are preventing the default action
     *                 to provide the after event handlers with event results
     */
    public $result = null;
    /** @var bool READONLY  if true, event handlers can prevent the events default action */
    public $canPreventDefault = true;

    /** @var bool whether or not to carry out the default action associated with the event */
    protected $runDefault = true;
    /** @var bool whether or not to continue propagating the event to other handlers */
    protected $mayContinue = true;

    /**
     * event constructor
     *
     * @param string $name
     * @param mixed $data
     */
    public function __construct($name, &$data)
    {

        $this->name = $name;
        $this->data =& $data;
    }

    /**
     * @return string
     */
    public function __toString()
    {
        return $this->name;
    }

    /**
     * advise all registered BEFORE handlers of this event
     *
     * if these methods are used by functions outside of this object, they must
     * properly handle correct processing of any default action and issue an
     * advise_after() signal. e.g.
     *    $evt = new dokuwiki\Plugin\Doku_Event(name, data);
     *    if ($evt->advise_before(canPreventDefault) {
     *      // default action code block
     *    }
     *    $evt->advise_after();
     *    unset($evt);
     *
     * @param bool $enablePreventDefault
     * @return bool results of processing the event, usually $this->runDefault
     */
    public function advise_before($enablePreventDefault = true)
    {
        global $EVENT_HANDLER;

        $this->canPreventDefault = $enablePreventDefault;
        if ($EVENT_HANDLER !== null) {
            $EVENT_HANDLER->process_event($this, 'BEFORE');
        } else {
            Logger::getInstance(Logger::LOG_DEBUG)
                  ->log($this->name . ':BEFORE event triggered before event system was initialized');
        }

        return (!$enablePreventDefault || $this->runDefault);
    }

    /**
     * advise all registered AFTER handlers of this event
     *
     * @param bool $enablePreventDefault
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @see advise_before() for details
     */
    public function advise_after()
    {
        global $EVENT_HANDLER;

        $this->mayContinue = true;

        if ($EVENT_HANDLER !== null) {
            $EVENT_HANDLER->process_event($this, 'AFTER');
        } else {
            Logger::getInstance(Logger::LOG_DEBUG)->
                log($this->name . ':AFTER event triggered before event system was initialized');
        }
    }

    /**
     * trigger
     *
     * - advise all registered (<event>_BEFORE) handlers that this event is about to take place
     * - carry out the default action using $this->data based on $enablePrevent and
     *   $this->_default, all of which may have been modified by the event handlers.
     * - advise all registered (<event>_AFTER) handlers that the event has taken place
     *
     * @param null|callable $action
     * @param bool $enablePrevent
     * @return  mixed $event->results
     *          the value set by any <event>_before or <event> handlers if the default action is prevented
     *          or the results of the default action (as modified by <event>_after handlers)
     *          or NULL no action took place and no handler modified the value
     */
    public function trigger($action = null, $enablePrevent = true)
    {

        if (!is_callable($action)) {
            $enablePrevent = false;
            if ($action !== null) {
                trigger_error(
                    'The default action of ' . $this .
                    ' is not null but also not callable. Maybe the method is not public?',
                    E_USER_WARNING
                );
            }
        }

        if ($this->advise_before($enablePrevent) && is_callable($action)) {
            $this->result = call_user_func_array($action, [&$this->data]);
        }

        $this->advise_after();

        return $this->result;
    }

    /**
     * stopPropagation
     *
     * stop any further processing of the event by event handlers
     * this function does not prevent the default action taking place
     */
    public function stopPropagation()
    {
        $this->mayContinue = false;
    }

    /**
     * may the event propagate to the next handler?
     *
     * @return bool
     */
    public function mayPropagate()
    {
        return $this->mayContinue;
    }

    /**
     * preventDefault
     *
     * prevent the default action taking place
     */
    public function preventDefault()
    {
        $this->runDefault = false;
    }

    /**
     * should the default action be executed?
     *
     * @return bool
     */
    public function mayRunDefault()
    {
        return $this->runDefault;
    }

    /**
     * Convenience method to trigger an event
     *
     * Creates, triggers and destroys an event in one go
     *
     * @param string $name name for the event
     * @param mixed $data event data
     * @param callable $action (optional, default=NULL) default action, a php callback function
     * @param bool $canPreventDefault (optional, default=true) can hooks prevent the default action
     *
     * @return mixed                        the event results value after all event processing is complete
     *                                      by default this is the return value of the default action however
     *                                      it can be set or modified by event handler hooks
     */
    static public function createAndTrigger($name, &$data, $action = null, $canPreventDefault = true)
    {
        $evt = new Event($name, $data);
        return $evt->trigger($action, $canPreventDefault);
    }
}


1			<?php
2			// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
3
4			namespace dokuwiki\Extension;
5
6			use dokuwiki\Logger;
7
8			/**
9			* The Action plugin event
10			*/
11			class Event
12			{
13			/** @var string READONLY event name, objects must register against this name to see the event */
14			public $name = '';
15			/** @var mixed\|null READWRITE data relevant to the event, no standardised format, refer to event docs */
16			public $data = null;
17			/**
18			* @var mixed\|null READWRITE the results of the event action, only relevant in "_AFTER" advise
19			* event handlers may modify this if they are preventing the default action
20			* to provide the after event handlers with event results
21			*/
22			public $result = null;
23			/** @var bool READONLY if true, event handlers can prevent the events default action */
24			public $canPreventDefault = true;
25
26			/** @var bool whether or not to carry out the default action associated with the event */
27			protected $runDefault = true;
28			/** @var bool whether or not to continue propagating the event to other handlers */
29			protected $mayContinue = true;
30
31			/**
32			* event constructor
33			*
34			* @param string $name
35			* @param mixed $data
36			*/
37			public function __construct($name, &$data)
38			{
39
40			$this->name = $name;
41			$this->data =& $data;
42			}
43
44			/**
45			* @return string
46			*/
47			public function __toString()
48			{
49			return $this->name;
50			}
51
52			/**
53			* advise all registered BEFORE handlers of this event
54			*
55			* if these methods are used by functions outside of this object, they must
56			* properly handle correct processing of any default action and issue an
57			* advise_after() signal. e.g.
58			* $evt = new dokuwiki\Plugin\Doku_Event(name, data);
59			* if ($evt->advise_before(canPreventDefault) {
60			* // default action code block
61			* }
62			* $evt->advise_after();
63			* unset($evt);
64			*
65			* @param bool $enablePreventDefault
66			* @return bool results of processing the event, usually $this->runDefault
67			*/
68			public function advise_before($enablePreventDefault = true)
69			{
70			global $EVENT_HANDLER;
71
72			$this->canPreventDefault = $enablePreventDefault;
73			if ($EVENT_HANDLER !== null) {
74			$EVENT_HANDLER->process_event($this, 'BEFORE');
75			} else {
76			Logger::getInstance(Logger::LOG_DEBUG)
77			->log($this->name . ':BEFORE event triggered before event system was initialized');
78			}
79
80			return (!$enablePreventDefault \|\| $this->runDefault);
81			}
82
83			/**
84			* advise all registered AFTER handlers of this event
85			*
86			* @param bool $enablePreventDefault
			0 ignored issues – show Bug introduced 2019-04-22 08:54 UTC by Report Bug Copy Issue Report There is no parameter named `$enablePreventDefault`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
87			* @see advise_before() for details
88			*/
89			public function advise_after()
90			{
91			global $EVENT_HANDLER;
92
93			$this->mayContinue = true;
94
95			if ($EVENT_HANDLER !== null) {
96			$EVENT_HANDLER->process_event($this, 'AFTER');
97			} else {
98			Logger::getInstance(Logger::LOG_DEBUG)->
99			log($this->name . ':AFTER event triggered before event system was initialized');
100			}
101			}
102
103			/**
104			* trigger
105			*
106			* - advise all registered (<event>_BEFORE) handlers that this event is about to take place
107			* - carry out the default action using $this->data based on $enablePrevent and
108			* $this->_default, all of which may have been modified by the event handlers.
109			* - advise all registered (<event>_AFTER) handlers that the event has taken place
110			*
111			* @param null\|callable $action
112			* @param bool $enablePrevent
113			* @return mixed $event->results
114			* the value set by any <event>_before or <event> handlers if the default action is prevented
115			* or the results of the default action (as modified by <event>_after handlers)
116			* or NULL no action took place and no handler modified the value
117			*/
118			public function trigger($action = null, $enablePrevent = true)
119			{
120
121			if (!is_callable($action)) {
122			$enablePrevent = false;
123			if ($action !== null) {
124			trigger_error(
125			'The default action of ' . $this .
126			' is not null but also not callable. Maybe the method is not public?',
127			E_USER_WARNING
128			);
129			}
130			}
131
132			if ($this->advise_before($enablePrevent) && is_callable($action)) {
133			$this->result = call_user_func_array($action, [&$this->data]);
134			}
135
136			$this->advise_after();
137
138			return $this->result;
139			}
140
141			/**
142			* stopPropagation
143			*
144			* stop any further processing of the event by event handlers
145			* this function does not prevent the default action taking place
146			*/
147			public function stopPropagation()
148			{
149			$this->mayContinue = false;
150			}
151
152			/**
153			* may the event propagate to the next handler?
154			*
155			* @return bool
156			*/
157			public function mayPropagate()
158			{
159			return $this->mayContinue;
160			}
161
162			/**
163			* preventDefault
164			*
165			* prevent the default action taking place
166			*/
167			public function preventDefault()
168			{
169			$this->runDefault = false;
170			}
171
172			/**
173			* should the default action be executed?
174			*
175			* @return bool
176			*/
177			public function mayRunDefault()
178			{
179			return $this->runDefault;
180			}
181
182			/**
183			* Convenience method to trigger an event
184			*
185			* Creates, triggers and destroys an event in one go
186			*
187			* @param string $name name for the event
188			* @param mixed $data event data
189			* @param callable $action (optional, default=NULL) default action, a php callback function
190			* @param bool $canPreventDefault (optional, default=true) can hooks prevent the default action
191			*
192			* @return mixed the event results value after all event processing is complete
193			* by default this is the return value of the default action however
194			* it can be set or modified by event handler hooks
195			*/
196			static public function createAndTrigger($name, &$data, $action = null, $canPreventDefault = true)
197			{
198			$evt = new Event($name, $data);
199			return $evt->trigger($action, $canPreventDefault);
200			}
201			}
202

splitbrain / dokuwiki

Event::advise_after() A last analyzed 2021-06-08 18:02 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Event::advise_after() A
last analyzed 2021-06-08 18:02 UTC