MomentPresenter - Code Metrics - Inspection of "Fixed typos" - gitaminhq/Gitamin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#76)

by Phecho

created 2015-12-11 13:38 UTC

MomentPresenter A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	82
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	4
Bugs	2	Features	1

Metric	Value
wmc	16
c	4
b	2
f	1
lcom	1
cbo	3
dl	0
loc	82
rs	10

6 Methods

Rating	Name	Size	Complexity
A	formattedData()	4	1
A	formattedTarget()	10	4
B	actionName()	15	5
A	icon()	12	4
A	created_at_iso()	4	1
A	toArray()	7	1

<?php

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

namespace Gitamin\Presenters;

use Gitamin\Facades\Setting;
use Gitamin\Models\Comment;
use Gitamin\Models\Issue;
use Gitamin\Models\Moment;
use Gitamin\Models\Project;
use Gitamin\Presenters\Traits\TimestampsTrait;
use GrahamCampbell\Markdown\Facades\Markdown;
use Jenssegers\Date\Date;

class MomentPresenter extends AbstractPresenter
{
    use TimestampsTrait;

    /**
     * Renders the message from Markdown into HTML.
     *
     * @return string
     */
    public function formattedData()
    {
        return Markdown::convertToHtml($this->wrappedObject->data);
    }

    public function formattedTarget()
    {
        if ($this->wrappedObject->target instanceof Comment) {
            return Markdown::convertToHtml($this->wrappedObject->target->message);
<?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.");
        }
    }

}
        } elseif ($this->wrappedObject->target instanceof Issue) {
            return Markdown::convertToHtml($this->wrappedObject->target->description);
<?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.");
        }
    }

}
        } elseif ($this->wrappedObject->target instanceof Project) {
            return Markdown::convertToHtml($this->wrappedObject->target->description);
<?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 the moment action summary.
     *
     * @return string
     */
    protected function actionName()
    {
        switch ($this->wrappedObject->action) {
            case Moment::CREATED:
                return trans('gitamin.moments.created');
            case Moment::UPDATED:
                return trans('gitamin.moments.updated');
            case Moment::CLOSED:
                return trans('gitamin.moments.closed');
            case Moment::COMMENTED:
                return trans('gitamin.moments.commented');
            default:
                return 'Unknow';
        }
    }

    public function icon()
    {
        if ($this->wrappedObject->target instanceof Project) {
            return 'fa fa-cubes';
        } elseif ($this->wrappedObject->target instanceof Comment) {
            return 'fa fa-comments-o';
        } elseif ($this->wrappedObject->target instanceof Issue) {
            return 'fa fa-exclamation-circle';
        } else {
            return 'fa fa-code-fork';
        }
    }

    /**
     * Present formatted date time.
     *
     * @return string
     */
    public function created_at_iso()
    {
        return $this->wrappedObject->created_at->setTimezone($this->setting->get('app_timezone'))->toISO8601String();
    }

    /**
     * Convert presented moment to an array.
     *
     * @return array
     */
    public function toArray()
    {
        return [
            'summary'        => $this->summary(),
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            'created_at_iso' => $this->created_at_iso(),
        ];
    }
}


1			<?php
2
3			/*
4			* This file is part of Gitamin.
5			*
6			* Copyright (C) 2015-2016 The Gitamin 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 Gitamin\Presenters;
13
14			use Gitamin\Facades\Setting;
15			use Gitamin\Models\Comment;
16			use Gitamin\Models\Issue;
17			use Gitamin\Models\Moment;
18			use Gitamin\Models\Project;
19			use Gitamin\Presenters\Traits\TimestampsTrait;
20			use GrahamCampbell\Markdown\Facades\Markdown;
21			use Jenssegers\Date\Date;
22
23			class MomentPresenter extends AbstractPresenter
24			{
25			use TimestampsTrait;
26
27			/**
28			* Renders the message from Markdown into HTML.
29			*
30			* @return string
31			*/
32			public function formattedData()
33			{
34			return Markdown::convertToHtml($this->wrappedObject->data);
35			}
36
37			public function formattedTarget()
38			{
39			if ($this->wrappedObject->target instanceof Comment) {
40			return Markdown::convertToHtml($this->wrappedObject->target->message);
			0 ignored issues – show Documentation introduced 2015-12-10 13:31 UTC by Report Bug Copy Issue Report The property `message` does not exist on `object<Gitamin\Models\Comment>`. 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...
41			} elseif ($this->wrappedObject->target instanceof Issue) {
42			return Markdown::convertToHtml($this->wrappedObject->target->description);
			0 ignored issues – show Documentation introduced 2015-12-10 13:31 UTC by Report Bug Copy Issue Report The property `description` does not exist on `object<Gitamin\Models\Issue>`. 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...
43			} elseif ($this->wrappedObject->target instanceof Project) {
44			return Markdown::convertToHtml($this->wrappedObject->target->description);
			0 ignored issues – show Documentation introduced 2015-12-11 13:44 UTC by Report Bug Copy Issue Report The property `description` does not exist on `object<Gitamin\Models\Project>`. 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...
45			}
46			}
47
48			/**
49			* Get the moment action summary.
50			*
51			* @return string
52			*/
53			protected function actionName()
54			{
55			switch ($this->wrappedObject->action) {
56			case Moment::CREATED:
57			return trans('gitamin.moments.created');
58			case Moment::UPDATED:
59			return trans('gitamin.moments.updated');
60			case Moment::CLOSED:
61			return trans('gitamin.moments.closed');
62			case Moment::COMMENTED:
63			return trans('gitamin.moments.commented');
64			default:
65			return 'Unknow';
66			}
67			}
68
69			public function icon()
70			{
71			if ($this->wrappedObject->target instanceof Project) {
72			return 'fa fa-cubes';
73			} elseif ($this->wrappedObject->target instanceof Comment) {
74			return 'fa fa-comments-o';
75			} elseif ($this->wrappedObject->target instanceof Issue) {
76			return 'fa fa-exclamation-circle';
77			} else {
78			return 'fa fa-code-fork';
79			}
80			}
81
82			/**
83			* Present formatted date time.
84			*
85			* @return string
86			*/
87			public function created_at_iso()
88			{
89			return $this->wrappedObject->created_at->setTimezone($this->setting->get('app_timezone'))->toISO8601String();
90			}
91
92			/**
93			* Convert presented moment to an array.
94			*
95			* @return array
96			*/
97			public function toArray()
98			{
99			return [
100			'summary' => $this->summary(),
			0 ignored issues – show Documentation Bug introduced 2015-12-10 13:31 UTC by Report Bug Copy Issue Report The method `summary` does not exist on `object<Gitamin\Presenters\MomentPresenter>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
101			'created_at_iso' => $this->created_at_iso(),
102			];
103			}
104			}
105

gitaminhq / Gitamin

Pull Request — master (#76)

MomentPresenter A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

6 Methods

Duplication Side-by-Side

Filter issues like