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

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

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	74
Duplicated Lines	20.27 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

Metric	Value
dl	15
loc	74
rs	10
c	0
b	0
f	0
wmc	7
lcom	1
cbo	2

4 Methods

Rating	Name	Duplication	Size	Complexity
A	withFileId()	0	6	1
A	buildEvent()	15	15	2
A	buildTitleWithAuthor()	0	8	2
A	buildTitleWithoutAuthor()	0	8	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\Bus\EventBuilder;

use Jitamin\Bus\Event\GenericEvent;
use Jitamin\Bus\Event\TaskFileEvent;
use Jitamin\Model\TaskFileModel;

/**
 * Class TaskFileEventBuilder.
 */
class TaskFileEventBuilder extends BaseEventBuilder
{
    protected $fileId = 0;

    /**
     * Set fileId.
     *
     * @param int $fileId
     *
     * @return $this
     */
    public function withFileId($fileId)
    {
        $this->fileId = $fileId;

        return $this;
    }

    /**
     * Build event data.
     *
     * @return GenericEvent|null
     */
    public function buildEvent()

    {
        $file = $this->taskFileModel->getById($this->fileId);
<?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($file)) {
            $this->logger->debug(__METHOD__.': File not found');
<?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;
        }

        return new TaskFileEvent([
            'file' => $file,
            'task' => $this->taskFinderModel->getDetails($file['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.");
        }
    }

}
        ]);
    }

    /**
     * Get event title with author.
     *
     * @param string $author
     * @param string $eventName
     * @param array  $eventData
     *
     * @return string
     */
    public function buildTitleWithAuthor($author, $eventName, array $eventData)
    {
        if ($eventName === TaskFileModel::EVENT_CREATE) {
            return l('%s attached a file to the task #%d', $author, $eventData['task']['id']);
        }

        return '';
    }

    /**
     * Get event title without author.
     *
     * @param string $eventName
     * @param array  $eventData
     *
     * @return string
     */
    public function buildTitleWithoutAuthor($eventName, array $eventData)
    {
        if ($eventName === TaskFileModel::EVENT_CREATE) {
            return l('New attachment on task #%d: %s', $eventData['file']['task_id'], $eventData['file']['name']);
        }

        return '';
    }
}


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\Bus\EventBuilder;
13
14		use Jitamin\Bus\Event\GenericEvent;
15		use Jitamin\Bus\Event\TaskFileEvent;
16		use Jitamin\Model\TaskFileModel;
17
18		/**
19		* Class TaskFileEventBuilder.
20		*/
21		class TaskFileEventBuilder extends BaseEventBuilder
22		{
23		protected $fileId = 0;
24
25		/**
26		* Set fileId.
27		*
28		* @param int $fileId
29		*
30		* @return $this
31		*/
32		public function withFileId($fileId)
33		{
34		$this->fileId = $fileId;
35
36		return $this;
37		}
38
39		/**
40		* Build event data.
41		*
42		* @return GenericEvent\|null
43		*/
44	View Code Duplication	public function buildEvent()
		0 ignored issues – show Duplication introduced 2017-11-03 05:20 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
45		{
46		$file = $this->taskFileModel->getById($this->fileId);
		0 ignored issues – show Documentation introduced 2016-12-21 12:32 UTC by Report Bug Copy Issue Report The property `taskFileModel` does not exist on `object<Jitamin\Bus\Event...r\TaskFileEventBuilder>`. 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...
47
48		if (empty($file)) {
49		$this->logger->debug(__METHOD__.': File not found');
		0 ignored issues – show Documentation introduced 2016-12-21 12:32 UTC by Report Bug Copy Issue Report The property `logger` does not exist on `object<Jitamin\Bus\Event...r\TaskFileEventBuilder>`. 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...
50
51		return;
52		}
53
54		return new TaskFileEvent([
55		'file' => $file,
56		'task' => $this->taskFinderModel->getDetails($file['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\Bus\Event...r\TaskFileEventBuilder>`. 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...
57		]);
58		}
59
60		/**
61		* Get event title with author.
62		*
63		* @param string $author
64		* @param string $eventName
65		* @param array $eventData
66		*
67		* @return string
68		*/
69		public function buildTitleWithAuthor($author, $eventName, array $eventData)
70		{
71		if ($eventName === TaskFileModel::EVENT_CREATE) {
72		return l('%s attached a file to the task #%d', $author, $eventData['task']['id']);
73		}
74
75		return '';
76		}
77
78		/**
79		* Get event title without author.
80		*
81		* @param string $eventName
82		* @param array $eventData
83		*
84		* @return string
85		*/
86		public function buildTitleWithoutAuthor($eventName, array $eventData)
87		{
88		if ($eventName === TaskFileModel::EVENT_CREATE) {
89		return l('New attachment on task #%d: %s', $eventData['file']['task_id'], $eventData['file']['name']);
90		}
91
92		return '';
93		}
94		}
95

Jitamin / jitamin

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

Complexity

Size/Duplication

Coupling/Cohesion

Importance

4 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like

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