Event::trigger() - Code Metrics - Inspection of "Better callable support in Event default actions" - splitbrain/dokuwiki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — staticEventAction ( 4352f9 )

by Andreas

created 2020-01-22 12:27 UTC

Event::trigger() A

↳ Parent: Event

Complexity

Conditions	5
Paths	6

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
nc	6
nop	2
dl	0
loc	22
rs	9.2568
c	0
b	0
f	0

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

namespace dokuwiki\Extension;

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

splitbrain / dokuwiki

Push — staticEventAction ( 4352f9 )

Event::trigger() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like