UserEventHandler::onModelBeforeSave() - Code Metrics - CakeCMS/Community - Measure and Improve Code Quality continuously with Scrutinizer

UserEventHandler::onModelBeforeSave() A
last analyzed 2018-05-28 12:53 UTC

↳ Parent: UserEventHandler

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	5
rs	9.4285
cc	1
eloc	2
nc	1
nop	1

<?php
/**
 * CakeCMS Community
 *
 * This file is part of the of the simple cms based on CakePHP 3.
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @package     Community
 * @license     MIT
 * @copyright   MIT License http://www.opensource.org/licenses/mit-license.php
 * @link        https://github.com/CakeCMS/Community".
 * @author      Sergey Kalistratov <[email protected]>
 */

namespace Community\Event;

use Cake\Event\Event;
use JBZoo\Utils\Filter;
use Community\Notify\Email;
use Community\Model\Entity\User;
use Cake\Datasource\EntityInterface;
use Cake\Event\EventListenerInterface;

/**
 * Class UserEventHandler
 *
 * @package Community\Event
 */
class UserEventHandler implements EventListenerInterface
{

    /**
     * Returns a list of events this object is implementing.
     *
     * @return  array
     */
    public function implementedEvents()
    {
        return [
            'Model.User.afterSave'             => 'onModelAfterSave',
            'Model.User.beforeSave'            => 'onModelBeforeSave',
            'Controller.Users.successActivate' => 'onSuccessActivate'
        ];
    }

    /**
     * On success user activation profile.
     *
     * @param   Event $event
     *
     * @return  void
     */
    public function onSuccessActivate(Event $event)
    {
        /** @var User|bool $user */
        $user = $event->getData('user');
        $this->_getMailer($user)->sendActivationMessage();
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
    }

    /**
     * Global before save user data.
     *
     * @param   Event $event
     *
     * @return  void
     */
    public function onModelBeforeSave(Event $event)
    {
        /** @var User $user */
        $user = $event->getData('user');
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
    }

    /**
     * Global after save user data.
     *
     * @param   Event $event
     *
     * @return  void
     *
     * TODO : Use return when send message?
     */
    public function onModelAfterSave(Event $event)
    {
        /** @var User|bool $user */
        $user = $event->getData('user');

        if ($user instanceof EntityInterface) {
            if ($user->isNew() && Filter::bool($user->get('notify'))) {
                $this->_getMailer($user)->sendCreateMessage();
            }
        }
    }

    /**
     * Get mailer object.
     *
     * @param   EntityInterface $entity
     * @return  Email
     */
    protected function _getMailer(EntityInterface $entity)
    {
        return new Email($entity);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }
}


1			<?php
2			/**
3			* CakeCMS Community
4			*
5			* This file is part of the of the simple cms based on CakePHP 3.
6			* For the full copyright and license information, please view the LICENSE
7			* file that was distributed with this source code.
8			*
9			* @package Community
10			* @license MIT
11			* @copyright MIT License http://www.opensource.org/licenses/mit-license.php
12			* @link https://github.com/CakeCMS/Community".
13			* @author Sergey Kalistratov <[email protected]>
14			*/
15
16			namespace Community\Event;
17
18			use Cake\Event\Event;
19			use JBZoo\Utils\Filter;
20			use Community\Notify\Email;
21			use Community\Model\Entity\User;
22			use Cake\Datasource\EntityInterface;
23			use Cake\Event\EventListenerInterface;
24
25			/**
26			* Class UserEventHandler
27			*
28			* @package Community\Event
29			*/
30			class UserEventHandler implements EventListenerInterface
31			{
32
33			/**
34			* Returns a list of events this object is implementing.
35			*
36			* @return array
37			*/
38			public function implementedEvents()
39			{
40			return [
41			'Model.User.afterSave' => 'onModelAfterSave',
42			'Model.User.beforeSave' => 'onModelBeforeSave',
43			'Controller.Users.successActivate' => 'onSuccessActivate'
44			];
45			}
46
47			/**
48			* On success user activation profile.
49			*
50			* @param Event $event
51			*
52			* @return void
53			*/
54			public function onSuccessActivate(Event $event)
55			{
56			/** @var User\|bool $user */
57			$user = $event->getData('user');
58			$this->_getMailer($user)->sendActivationMessage();
			0 ignored issues – show Bug introduced 2018-03-02 11:50 UTC by Report Bug Copy Issue Report It seems like `$user` defined by `$event->getData('user')` on line `57` can also be of type `boolean`; however, `Community\Event\UserEventHandler::_getMailer()` does only seem to accept `object<Cake\Datasource\EntityInterface>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
59			}
60
61			/**
62			* Global before save user data.
63			*
64			* @param Event $event
65			*
66			* @return void
67			*/
68			public function onModelBeforeSave(Event $event)
69			{
70			/** @var User $user */
71			$user = $event->getData('user');
			0 ignored issues – show Unused Code introduced 2018-02-27 21:14 UTC by Report Bug Copy Issue Report `$user` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
72			}
73
74			/**
75			* Global after save user data.
76			*
77			* @param Event $event
78			*
79			* @return void
80			*
81			* TODO : Use return when send message?
82			*/
83			public function onModelAfterSave(Event $event)
84			{
85			/** @var User\|bool $user */
86			$user = $event->getData('user');
87
88			if ($user instanceof EntityInterface) {
89			if ($user->isNew() && Filter::bool($user->get('notify'))) {
90			$this->_getMailer($user)->sendCreateMessage();
91			}
92			}
93			}
94
95			/**
96			* Get mailer object.
97			*
98			* @param EntityInterface $entity
99			* @return Email
100			*/
101			protected function _getMailer(EntityInterface $entity)
102			{
103			return new Email($entity);
			0 ignored issues – show Documentation introduced 2018-02-27 21:14 UTC by Report Bug Copy Issue Report `$entity` is of type `object<Cake\Datasource\EntityInterface>`, but the function expects a `object<Cake\ORM\Entity>\|array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
104			}
105			}
106

CakeCMS / Community

UserEventHandler::onModelBeforeSave() A last analyzed 2018-05-28 12:53 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

UserEventHandler::onModelBeforeSave() A
last analyzed 2018-05-28 12:53 UTC