TaskEmailNoActivity - Code Metrics - Jitamin/jitamin - Measure and Improve Code Quality continuously with Scrutinizer

TaskEmailNoActivity A
last analyzed 2017-12-27 06:16 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	108
Duplicated Lines	6.48 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes

Metric	Value
dl	7
loc	108
rs	10
c	0
b	0
f	0
wmc	11
lcom	0
cbo	1

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getDescription()	0	4	1
A	getCompatibleEvents()	0	6	1
A	getActionRequiredParameters()	0	8	1
A	getEventRequiredParameters()	0	4	1
A	hasRequiredCondition()	0	4	1
A	doAction()	7	18	4
A	sendEmail()	0	13	2

How to fix Duplicated Code

<?php

/*
 * This file is part of Jitamin.
 *
 * Copyright (C) Jitamin Team
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Jitamin\Action;

use Jitamin\Model\TaskModel;

/**
 * Email a task with no activity.
 */
class TaskEmailNoActivity extends Base
{
    /**
     * Get automatic action description.
     *
     * @return string
     */
    public function getDescription()
    {
        return t('Send email when there is no activity on a task');
    }

    /**
     * Get the list of compatible events.
     *
     * @return array
     */
    public function getCompatibleEvents()
    {
        return [
            TaskModel::EVENT_DAILY_CRONJOB,
        ];
    }

    /**
     * Get the required parameter for the action (defined by the user).
     *
     * @return array
     */
    public function getActionRequiredParameters()
    {
        return [
            'user_id'  => t('User that will receive the email'),
            'subject'  => t('Email subject'),
            'duration' => t('Duration in days'),
        ];
    }

    /**
     * Get the required parameter for the event.
     *
     * @return string[]
     */
    public function getEventRequiredParameters()
    {
        return ['tasks'];
    }

    /**
     * Check if the event data meet the action condition.
     *
     * @param array $data Event data dictionary
     *
     * @return bool
     */
    public function hasRequiredCondition(array $data)
    {
        return count($data['tasks']) > 0;
    }

    /**
     * Execute the action (move the task to another column).
     *
     * @param array $data Event data dictionary
     *
     * @return bool True if the action was executed or false when not executed
     */
    public function doAction(array $data)
    {
        $results = [];
        $max = $this->getParam('duration') * 86400;
        $user = $this->userModel->getById($this->getParam('user_id'));
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        if (!empty($user['email'])) {
            foreach ($data['tasks'] as $task) {

                $duration = time() - $task['date_modification'];

                if ($duration > $max) {
                    $results[] = $this->sendEmail($task['id'], $user);
                }
            }
        }

        return in_array(true, $results, true);
    }

    /**
     * Send email.
     *
     * @param int   $task_id
     * @param array $user
     *
     * @return bool
     */
    private function sendEmail($task_id, array $user)
    {
        $task = $this->taskFinderModel->getDetails($task_id);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        $this->emailClient->send(
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $user['email'],
            $user['name'] ?: $user['username'],
            $this->getParam('subject'),
            $this->template->render('notification/task_create', ['task' => $task, 'application_url' => $this->settingModel->get('application_url')])
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        );

        return true;
    }
}


1		<?php
2
3		/*
4		* This file is part of Jitamin.
5		*
6		* Copyright (C) Jitamin Team
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace Jitamin\Action;
13
14		use Jitamin\Model\TaskModel;
15
16		/**
17		* Email a task with no activity.
18		*/
19		class TaskEmailNoActivity extends Base
20		{
21		/**
22		* Get automatic action description.
23		*
24		* @return string
25		*/
26		public function getDescription()
27		{
28		return t('Send email when there is no activity on a task');
29		}
30
31		/**
32		* Get the list of compatible events.
33		*
34		* @return array
35		*/
36		public function getCompatibleEvents()
37		{
38		return [
39		TaskModel::EVENT_DAILY_CRONJOB,
40		];
41		}
42
43		/**
44		* Get the required parameter for the action (defined by the user).
45		*
46		* @return array
47		*/
48		public function getActionRequiredParameters()
49		{
50		return [
51		'user_id' => t('User that will receive the email'),
52		'subject' => t('Email subject'),
53		'duration' => t('Duration in days'),
54		];
55		}
56
57		/**
58		* Get the required parameter for the event.
59		*
60		* @return string[]
61		*/
62		public function getEventRequiredParameters()
63		{
64		return ['tasks'];
65		}
66
67		/**
68		* Check if the event data meet the action condition.
69		*
70		* @param array $data Event data dictionary
71		*
72		* @return bool
73		*/
74		public function hasRequiredCondition(array $data)
75		{
76		return count($data['tasks']) > 0;
77		}
78
79		/**
80		* Execute the action (move the task to another column).
81		*
82		* @param array $data Event data dictionary
83		*
84		* @return bool True if the action was executed or false when not executed
85		*/
86		public function doAction(array $data)
87		{
88		$results = [];
89		$max = $this->getParam('duration') * 86400;
90		$user = $this->userModel->getById($this->getParam('user_id'));
		0 ignored issues – show Documentation introduced 2016-12-21 12:32 UTC by Report Bug Copy Issue Report The property `userModel` does not exist on `object<Jitamin\Action\TaskEmailNoActivity>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
91
92		if (!empty($user['email'])) {
93	View Code Duplication	foreach ($data['tasks'] as $task) {
		0 ignored issues – show Duplication introduced 2016-12-21 12:32 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
94		$duration = time() - $task['date_modification'];
95
96		if ($duration > $max) {
97		$results[] = $this->sendEmail($task['id'], $user);
98		}
99		}
100		}
101
102		return in_array(true, $results, true);
103		}
104
105		/**
106		* Send email.
107		*
108		* @param int $task_id
109		* @param array $user
110		*
111		* @return bool
112		*/
113		private function sendEmail($task_id, array $user)
114		{
115		$task = $this->taskFinderModel->getDetails($task_id);
		0 ignored issues – show Documentation introduced 2016-12-21 12:32 UTC by Report Bug Copy Issue Report The property `taskFinderModel` does not exist on `object<Jitamin\Action\TaskEmailNoActivity>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
116
117		$this->emailClient->send(
		0 ignored issues – show Documentation introduced 2016-12-21 12:32 UTC by Report Bug Copy Issue Report The property `emailClient` does not exist on `object<Jitamin\Action\TaskEmailNoActivity>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
118		$user['email'],
119		$user['name'] ?: $user['username'],
120		$this->getParam('subject'),
121		$this->template->render('notification/task_create', ['task' => $task, 'application_url' => $this->settingModel->get('application_url')])
		0 ignored issues – show Documentation introduced 2016-12-21 12:32 UTC by Report Bug Copy Issue Report The property `template` does not exist on `object<Jitamin\Action\TaskEmailNoActivity>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text / class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history... Documentation introduced 2016-12-21 12:32 UTC by Report Bug Copy Issue Report The property `settingModel` does not exist on `object<Jitamin\Action\TaskEmailNoActivity>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /* * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
122		);
123
124		return true;
125		}
126		}
127

Jitamin / jitamin

TaskEmailNoActivity A last analyzed 2017-12-27 06:16 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

7 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like

TaskEmailNoActivity A
last analyzed 2017-12-27 06:16 UTC