Concierge::takeReservation() - Code Metrics - Inspection of "Fix scenario pre-conditions" - timegridio/concierge - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3cd0a8...94a3ce )

by Ariel

created 2016-02-05 18:40 UTC

Concierge::takeReservation() B

↳ Parent: Concierge

Complexity

Conditions	5
Paths	9

Size

Total Lines	51
Code Lines	31

Duplication

Lines	0
Ratio	0 %

Importance

Changes	9
Bugs	1	Features	2

Metric	Value
c	9
b	1
f	2
dl	0
loc	51
rs	8.6588
cc	5
eloc	31
nc	9
nop	1

How to fix Long Method

<?php

namespace Timegridio\Concierge;

use Carbon\Carbon;
use Timegridio\Concierge\Booking\Strategies\BookingStrategy;
use Timegridio\Concierge\Calendar\Calendar;
use Timegridio\Concierge\Exceptions\DuplicatedAppointmentException;
use Timegridio\Concierge\Models\Appointment;
use Timegridio\Concierge\Models\Business;
use Timegridio\Concierge\Models\Service;

/*******************************************************************************
 * Concierge Service Layer
 *     High level booking manager
 ******************************************************************************/
class Concierge extends Workspace
{
    protected $calendar = null;

    protected $booking = null;

    protected function calendar()
    {
        if ($this->calendar === null) {
            $this->calendar = new Calendar($this->business->strategy, $this->business->vacancies(), $this->business->timezone);
        }

        return $this->calendar;
    }

    protected function booking()
    {
        if ($this->booking === null) {
            $this->booking = new BookingStrategy($this->business->strategy);
        }

        return $this->booking;
    }

    public function takeReservation(array $request)
    {
        $issuer = $request['issuer'];
        $service = $request['service'];
        $contact = $request['contact'];
        $comments = $request['comments'];

        $vacancies = $this->calendar()
                          ->forService($service->id)
                          ->forDate($request['date'])
                          ->atTime($request['time'])
                          ->find();

        if ($vacancies->count() == 0) {
            // Log failure feedback message
            return false;
        }

        if ($vacancies->count() > 1) {
            // Log unexpected behavior message
            $vacancy = $vacancies->first();
        }

        if ($vacancies->count() == 1) {
            $vacancy = $vacancies->first();
        }

        $startAt = $this->makeDateTimeUTC($request['date'], $request['time'], $request['timezone']);
        $finishAt = $startAt->copy()->addMinutes($service->duration);

        $appointment = $this->generateAppointment(
            $issuer,
            $this->business->id,
            $contact->id,
            $service->id,
            $startAt,
            $finishAt,
            $comments
        );

        /* Should be moved inside generateAppointment() */
        if ($appointment->duplicates()) {
            throw new DuplicatedAppointmentException;
        }

        /* Should be moved inside generateAppointment() */
        $appointment->vacancy()->associate($vacancy);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
        $appointment->save();

        return $appointment;
    }

    protected function generateAppointment($issuerId, $businessId, $contactId, $serviceId, Carbon $startAt, Carbon $finishAt, $comments = null)
    {
        $appointment = new Appointment();

        $appointment->doReserve();
        $appointment->setStartAtAttribute($startAt);
        $appointment->setFinishAtAttribute($finishAt);
        $appointment->business()->associate($businessId);
        $appointment->issuer()->associate($issuerId);
        $appointment->contact()->associate($contactId);
        $appointment->service()->associate($serviceId);
        $appointment->comments = $comments;
<?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.");
        }
    }

}
        $appointment->doHash();

        return $appointment;
    }

    protected function makeDateTime($date, $time, $timezone = null)
    {
        return Carbon::parse("{$date} {$time} {$timezone}");
    }

    protected function makeDateTimeUTC($date, $time, $timezone = null)
    {
        return $this->makeDateTime($date, $time, $timezone)->timezone('UTC');
    }
}


1			<?php
2
3			namespace Timegridio\Concierge;
4
5			use Carbon\Carbon;
6			use Timegridio\Concierge\Booking\Strategies\BookingStrategy;
7			use Timegridio\Concierge\Calendar\Calendar;
8			use Timegridio\Concierge\Exceptions\DuplicatedAppointmentException;
9			use Timegridio\Concierge\Models\Appointment;
10			use Timegridio\Concierge\Models\Business;
11			use Timegridio\Concierge\Models\Service;
12
13			/*******************************************************************************
14			* Concierge Service Layer
15			* High level booking manager
16			******************************************************************************/
17			class Concierge extends Workspace
18			{
19			protected $calendar = null;
20
21			protected $booking = null;
22
23			protected function calendar()
24			{
25			if ($this->calendar === null) {
26			$this->calendar = new Calendar($this->business->strategy, $this->business->vacancies(), $this->business->timezone);
27			}
28
29			return $this->calendar;
30			}
31
32			protected function booking()
33			{
34			if ($this->booking === null) {
35			$this->booking = new BookingStrategy($this->business->strategy);
36			}
37
38			return $this->booking;
39			}
40
41			public function takeReservation(array $request)
42			{
43			$issuer = $request['issuer'];
44			$service = $request['service'];
45			$contact = $request['contact'];
46			$comments = $request['comments'];
47
48			$vacancies = $this->calendar()
49			->forService($service->id)
50			->forDate($request['date'])
51			->atTime($request['time'])
52			->find();
53
54			if ($vacancies->count() == 0) {
55			// Log failure feedback message
56			return false;
57			}
58
59			if ($vacancies->count() > 1) {
60			// Log unexpected behavior message
61			$vacancy = $vacancies->first();
62			}
63
64			if ($vacancies->count() == 1) {
65			$vacancy = $vacancies->first();
66			}
67
68			$startAt = $this->makeDateTimeUTC($request['date'], $request['time'], $request['timezone']);
69			$finishAt = $startAt->copy()->addMinutes($service->duration);
70
71			$appointment = $this->generateAppointment(
72			$issuer,
73			$this->business->id,
74			$contact->id,
75			$service->id,
76			$startAt,
77			$finishAt,
78			$comments
79			);
80
81			/* Should be moved inside generateAppointment() */
82			if ($appointment->duplicates()) {
83			throw new DuplicatedAppointmentException;
84			}
85
86			/* Should be moved inside generateAppointment() */
87			$appointment->vacancy()->associate($vacancy);
			0 ignored issues – show Bug introduced 2016-02-05 10:34 UTC by Report Bug Copy Issue Report The variable `$vacancy` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
88			$appointment->save();
89
90			return $appointment;
91			}
92
93			protected function generateAppointment($issuerId, $businessId, $contactId, $serviceId, Carbon $startAt, Carbon $finishAt, $comments = null)
94			{
95			$appointment = new Appointment();
96
97			$appointment->doReserve();
98			$appointment->setStartAtAttribute($startAt);
99			$appointment->setFinishAtAttribute($finishAt);
100			$appointment->business()->associate($businessId);
101			$appointment->issuer()->associate($issuerId);
102			$appointment->contact()->associate($contactId);
103			$appointment->service()->associate($serviceId);
104			$appointment->comments = $comments;
			0 ignored issues – show Documentation introduced 2016-02-05 18:46 UTC by Report Bug Copy Issue Report The property `comments` does not exist on `object<Timegridio\Concierge\Models\Appointment>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write 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."); } } } Since the property has write access only, you can use the @property-write 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...
105			$appointment->doHash();
106
107			return $appointment;
108			}
109
110			protected function makeDateTime($date, $time, $timezone = null)
111			{
112			return Carbon::parse("{$date} {$time} {$timezone}");
113			}
114
115			protected function makeDateTimeUTC($date, $time, $timezone = null)
116			{
117			return $this->makeDateTime($date, $time, $timezone)->timezone('UTC');
118			}
119			}
120

timegridio / concierge

Push — master ( 3cd0a8...94a3ce )

Concierge::takeReservation() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like