AppointmentPresenter::timeFormat() - Code Metrics - Inspection of "Update requirement PHP version" - timegridio/concierge - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d4c79f...007fb6 )

by Ariel

created 2016-03-10 01:08 UTC

AppointmentPresenter::timeFormat() A

↳ Parent: AppointmentPresenter

Complexity

Conditions	2
Paths	2

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
cc	2
eloc	2
nc	2
nop	0
crap	2

<?php

namespace Timegridio\Concierge\Presenters;

use JsonLd\Context;
use McCool\LaravelAutoPresenter\BasePresenter;
use Timegridio\Concierge\Models\Appointment;

class AppointmentPresenter extends BasePresenter
{
    public function __construct(Appointment $resource)
    {
        $this->wrappedObject = $resource;
    }

    public function code()
    {
        $length = $this->wrappedObject->business->pref('appointment_code_length');

        return strtoupper(substr($this->wrappedObject->hash, 0, $length));
    }

    public function date($format = 'Y-m-d')
    {
        // Translated text for friendly date should not be resposibility of this class

        // if ($this->wrappedObject->start_at->isToday()) {

        //     return studly_case(trans('Concierge::appointments.text.today'));

        // }

        // if ($this->wrappedObject->start_at->isTomorrow()) {

        //     return studly_case(trans('Concierge::appointments.text.tomorrow'));

        // }

        $dateFormat = $this->dateFormat($format);

        return $this->wrappedObject
                    ->start_at
                    ->timezone($this->wrappedObject->business->timezone)
                    ->format($dateFormat);
    }

    public function time()
    {
        $timeFormat = $this->timeFormat();

        return $this->wrappedObject
                    ->start_at
                    ->timezone($this->wrappedObject->business->timezone)
                    ->format($timeFormat);
    }

    public function arriveAt()
    {
        $timeFormat = $this->timeFormat();

        if (!$this->wrappedObject->business->pref('appointment_flexible_arrival')) {
            return ['at' => $this->time];
<?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.");
        }
    }

}
        }

        $fromTime = $this->wrappedObject
                         ->vacancy
                         ->start_at
                         ->timezone($this->wrappedObject->business->timezone)
                         ->format($timeFormat);

        $toTime = $this->wrappedObject
                       ->vacancy
                       ->finish_at
                       ->timezone($this->wrappedObject->business->timezone)
                       ->format($timeFormat);

        return ['from' => $fromTime, 'to' => $toTime];
    }

    public function finishTime()
    {
        $timeFormat = $this->timeFormat();

        return $this->wrappedObject
                    ->finish_at
                    ->timezone($this->wrappedObject->business->timezone)
                    ->format($timeFormat);
    }

    public function phone()
    {
        return $this->wrappedObject->business->phone;
    }

    public function location()
    {
        return $this->wrappedObject->business->postal_address;
    }

    public function statusLetter()
    {
        return substr(trans('appointments.status.'.$this->wrappedObject->statusLabel), 0, 1);
    }

    public function status()
    {
        return trans('appointments.status.'.$this->wrappedObject->statusLabel);
    }

    public function statusToCssClass()
    {
        switch ($this->wrappedObject->status) {
            case Appointment::STATUS_ANNULATED:
                return 'danger';
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
            case Appointment::STATUS_CONFIRMED:
                return 'success';
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
            case Appointment::STATUS_RESERVED:
                return 'warning';
                break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
            case Appointment::STATUS_SERVED:
            default:
                return 'default';
        }
    }

    public function panel()
    {
        return view('widgets.appointment.panel._body', ['appointment' => $this, 'user' => auth()->user()])->render();
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
    }

    public function row()
    {
        return view('widgets.appointment.row._body', ['appointment' => $this, 'user' => auth()->user()])->render();
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
    }

    public function jsonLd()
    {
        $attributes = [
            'name'         => $this->wrappedObject->business->name,
            'description'  => $this->wrappedObject->service->description,
            'telephone'    => $this->wrappedObject->business->phone,
            'startDate'    => $this->wrappedObject->start_at->toIso8601String(),
            'url'          => '#',
            'location'     => [
                'name'    => $this->wrappedObject->business->name,
                'address' => [
                    'streetAddress'   => $this->wrappedObject->business->postal_address,
                ],
            ],
        ];

        return Context::create('event', $attributes);
    }

    protected function timeFormat()
    {
        return $this->wrappedObject->business->pref('time_format') ?: 'h:i a';
    }

    protected function dateFormat($defaultFormat = 'Y-m-d')
    {
        return $this->wrappedObject->business->pref('date_format') ?: $defaultFormat;
    }
}


1		<?php
2
3		namespace Timegridio\Concierge\Presenters;
4
5		use JsonLd\Context;
6		use McCool\LaravelAutoPresenter\BasePresenter;
7		use Timegridio\Concierge\Models\Appointment;
8
9		class AppointmentPresenter extends BasePresenter
10		{
11	9	public function __construct(Appointment $resource)
12		{
13	9	$this->wrappedObject = $resource;
14	9	}
15
16	1	public function code()
17		{
18	1	$length = $this->wrappedObject->business->pref('appointment_code_length');
19
20	1	return strtoupper(substr($this->wrappedObject->hash, 0, $length));
21		}
22
23	1	public function date($format = 'Y-m-d')
24		{
25		// Translated text for friendly date should not be resposibility of this class
26
27		// if ($this->wrappedObject->start_at->isToday()) {
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-03-09 21:08 UTC by Report Bug Copy Issue Report `63%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
28		// return studly_case(trans('Concierge::appointments.text.today'));
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-03-09 21:08 UTC by Report Bug Copy Issue Report `64%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
29		// }
30
31		// if ($this->wrappedObject->start_at->isTomorrow()) {
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-03-09 21:08 UTC by Report Bug Copy Issue Report `63%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
32		// return studly_case(trans('Concierge::appointments.text.tomorrow'));
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-03-09 21:08 UTC by Report Bug Copy Issue Report `64%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
33		// }
34
35	1	$dateFormat = $this->dateFormat($format);
36
37	1	return $this->wrappedObject
38	1	->start_at
39	1	->timezone($this->wrappedObject->business->timezone)
40	1	->format($dateFormat);
41		}
42
43	1	public function time()
44		{
45	1	$timeFormat = $this->timeFormat();
46
47	1	return $this->wrappedObject
48	1	->start_at
49	1	->timezone($this->wrappedObject->business->timezone)
50	1	->format($timeFormat);
51		}
52
53	2	public function arriveAt()
54		{
55	2	$timeFormat = $this->timeFormat();
56
57	2	if (!$this->wrappedObject->business->pref('appointment_flexible_arrival')) {
58	1	return ['at' => $this->time];
		0 ignored issues – show Documentation introduced 2016-03-01 23:53 UTC by Report Bug Copy Issue Report The property `time` does not exist on `object<Timegridio\Concie...s\AppointmentPresenter>`. 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...
59		}
60
61	1	$fromTime = $this->wrappedObject
62	1	->vacancy
63	1	->start_at
64	1	->timezone($this->wrappedObject->business->timezone)
65	1	->format($timeFormat);
66
67	1	$toTime = $this->wrappedObject
68	1	->vacancy
69	1	->finish_at
70	1	->timezone($this->wrappedObject->business->timezone)
71	1	->format($timeFormat);
72
73	1	return ['from' => $fromTime, 'to' => $toTime];
74		}
75
76		public function finishTime()
77		{
78		$timeFormat = $this->timeFormat();
79
80		return $this->wrappedObject
81		->finish_at
82		->timezone($this->wrappedObject->business->timezone)
83		->format($timeFormat);
84		}
85
86	1	public function phone()
87		{
88	1	return $this->wrappedObject->business->phone;
89		}
90
91	1	public function location()
92		{
93	1	return $this->wrappedObject->business->postal_address;
94		}
95
96		public function statusLetter()
97		{
98		return substr(trans('appointments.status.'.$this->wrappedObject->statusLabel), 0, 1);
99		}
100
101		public function status()
102		{
103		return trans('appointments.status.'.$this->wrappedObject->statusLabel);
104		}
105
106	1	public function statusToCssClass()
107		{
108	1	switch ($this->wrappedObject->status) {
109	1	case Appointment::STATUS_ANNULATED:
110	1	return 'danger';
111		break;
		0 ignored issues – show Unused Code introduced 2016-02-03 04:24 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
112	1	case Appointment::STATUS_CONFIRMED:
113	1	return 'success';
114		break;
		0 ignored issues – show Unused Code introduced 2016-02-03 04:24 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
115	1	case Appointment::STATUS_RESERVED:
116	1	return 'warning';
117		break;
		0 ignored issues – show Unused Code introduced 2016-02-03 04:24 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
118	1	case Appointment::STATUS_SERVED:
119	1	default:
120	1	return 'default';
121		}
122		}
123
124		public function panel()
125		{
126		return view('widgets.appointment.panel._body', ['appointment' => $this, 'user' => auth()->user()])->render();
		0 ignored issues – show Bug introduced 2016-02-03 04:24 UTC by Report Bug Copy Issue Report The method `user()` does not seem to exist on `object<Illuminate\Contracts\Auth\Factory>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history... Bug introduced 2016-02-03 04:24 UTC by Report Bug Copy Issue Report The method `render` does only exist in `Illuminate\View\View`, but not in `Illuminate\Contracts\View\Factory`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
127		}
128
129		public function row()
130		{
131		return view('widgets.appointment.row._body', ['appointment' => $this, 'user' => auth()->user()])->render();
		0 ignored issues – show Bug introduced 2016-02-03 04:24 UTC by Report Bug Copy Issue Report The method `user()` does not seem to exist on `object<Illuminate\Contracts\Auth\Factory>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history... Bug introduced 2016-02-03 04:24 UTC by Report Bug Copy Issue Report The method `render` does only exist in `Illuminate\View\View`, but not in `Illuminate\Contracts\View\Factory`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
132		}
133
134	1	public function jsonLd()
135		{
136		$attributes = [
137	1	'name' => $this->wrappedObject->business->name,
138	1	'description' => $this->wrappedObject->service->description,
139	1	'telephone' => $this->wrappedObject->business->phone,
140	1	'startDate' => $this->wrappedObject->start_at->toIso8601String(),
141	1	'url' => '#',
142		'location' => [
143	1	'name' => $this->wrappedObject->business->name,
144		'address' => [
145	1	'streetAddress' => $this->wrappedObject->business->postal_address,
146	1	],
147	1	],
148	1	];
149
150	1	return Context::create('event', $attributes);
151		}
152
153	2	protected function timeFormat()
154		{
155	2	return $this->wrappedObject->business->pref('time_format') ?: 'h:i a';
156		}
157
158	1	protected function dateFormat($defaultFormat = 'Y-m-d')
159		{
160	1	return $this->wrappedObject->business->pref('date_format') ?: $defaultFormat;
161		}
162		}
163

timegridio / concierge

Push — master ( d4c79f...007fb6 )

AppointmentPresenter::timeFormat() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like