CheckInValidator::message() - Code Metrics - Inspection of "moved ticket validation logic to seprate class" - TheBnl/event-tickets - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( aa36ec...9b8ce8 )

by Bram

created 2017-06-14 15:19 UTC

CheckInValidator::message() A

↳ Parent: CheckInValidator

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	1

<?php

namespace Broarm\EventTickets;

use Object;

/**
 * CheckInValidator.php
 *
 * @author Bram de Leeuw
 * Date: 14/06/2017
 */
class CheckInValidator extends Object
{
    const MESSAGE_NO_CODE = 'MESSAGE_NO_CODE';
    const MESSAGE_CODE_NOT_FOUND = 'MESSAGE_CODE_NOT_FOUND';
    const MESSAGE_TICKET_CANCELLED = 'MESSAGE_TICKET_CANCELLED';
    const MESSAGE_ALREADY_CHECKED_IN = 'MESSAGE_ALREADY_CHECKED_IN';
    const MESSAGE_CHECK_OUT_SUCCESS = 'MESSAGE_CHECK_OUT_SUCCESS';
    const MESSAGE_CHECK_IN_SUCCESS = 'MESSAGE_CHECK_IN_SUCCESS';

    const MESSAGE_TYPE_GOOD = 'Good';
    const MESSAGE_TYPE_WARNING = 'Warning';
    const MESSAGE_TYPE_BAD = 'Bad';

    /**
     * Allow people to check in and out
     *
     * @config
     * @var bool
     */
    private static $allow_checkout = false;


    /**
     * @var Attendee
     */
    protected $attendee = null;

    /**
     * Validate the given ticket code
     *
     * @param null|string $ticketCode
     *
     * @return array
     */
    public function validate($ticketCode = null) {

        // Check if a code is given to the validator
        if (!isset($ticketCode)) {
            return array(
                'Code' => self::MESSAGE_NO_CODE,
                'Message' => self::message(self::MESSAGE_NO_CODE),
                'Type' => self::MESSAGE_TYPE_BAD
            );
        }

        // Check if a ticket exists with the given ticket code
        if (!$this->attendee = Attendee::get()->find('TicketCode', $ticketCode)) {
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
            return array(
                'Code' => self::MESSAGE_CODE_NOT_FOUND,
                'Message' => self::message(self::MESSAGE_CODE_NOT_FOUND),
                'Type' => self::MESSAGE_TYPE_BAD
            );
        }

        // Check if the reservation is not canceled
        if (!(bool)$this->attendee->Event()->getGuestList()->find('ID', $this->attendee->ID)) {
            return array(
                'Code' => self::MESSAGE_TICKET_CANCELLED,
                'Message' => self::message(self::MESSAGE_TICKET_CANCELLED),
                'Type' => self::MESSAGE_TYPE_BAD
            );
        }

        // Check if the ticket is already checked in and not allowed to check out
        elseif ((bool)$this->attendee->CheckedIn && !(bool)self::config()->get('allow_checkout')) {

            return array(
                'Code' => self::MESSAGE_ALREADY_CHECKED_IN,
                'Message' => self::message(self::MESSAGE_ALREADY_CHECKED_IN),
                'Type' => self::MESSAGE_TYPE_BAD
            );
        }

        // Successfully checked out
        elseif ((bool)$this->attendee->CheckedIn && (bool)self::config()->get('allow_checkout')) {

            return array(
                'Code' => self::MESSAGE_CHECK_OUT_SUCCESS,
                'Message' => self::message(self::MESSAGE_CHECK_OUT_SUCCESS),
                'Type' => self::MESSAGE_TYPE_WARNING
            );
        }

        // Successfully checked in
        else return array(
            'Code' => self::MESSAGE_CHECK_IN_SUCCESS,
            'Message' => self::message(self::MESSAGE_CHECK_IN_SUCCESS),
            'Type' => self::MESSAGE_TYPE_GOOD
        );
    }

    /**
     * Get the attendee instance
     *
     * @return Attendee
     */
    public function getAttendee()
    {
        return $this->attendee;
    }

    /**
     * Translate the given type to a readable message
     *
     * @param $message string
     *
     * @return string
     */
    private static function message($message) {
        return _t("CheckInValidator.$message", $message);
    }
}

1		<?php
2
3		namespace Broarm\EventTickets;
4
5		use Object;
6
7		/**
8		* CheckInValidator.php
9		*
10		* @author Bram de Leeuw
11		* Date: 14/06/2017
12		*/
13		class CheckInValidator extends Object
14		{
15		const MESSAGE_NO_CODE = 'MESSAGE_NO_CODE';
16		const MESSAGE_CODE_NOT_FOUND = 'MESSAGE_CODE_NOT_FOUND';
17		const MESSAGE_TICKET_CANCELLED = 'MESSAGE_TICKET_CANCELLED';
18		const MESSAGE_ALREADY_CHECKED_IN = 'MESSAGE_ALREADY_CHECKED_IN';
19		const MESSAGE_CHECK_OUT_SUCCESS = 'MESSAGE_CHECK_OUT_SUCCESS';
20		const MESSAGE_CHECK_IN_SUCCESS = 'MESSAGE_CHECK_IN_SUCCESS';
21
22		const MESSAGE_TYPE_GOOD = 'Good';
23		const MESSAGE_TYPE_WARNING = 'Warning';
24		const MESSAGE_TYPE_BAD = 'Bad';
25
26		/**
27		* Allow people to check in and out
28		*
29		* @config
30		* @var bool
31		*/
32		private static $allow_checkout = false;
		0 ignored issues – show Unused Code introduced 2017-05-10 15:59 UTC by Report Bug Copy Issue Report The property `$allow_checkout` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
33
34		/**
35		* @var Attendee
36		*/
37		protected $attendee = null;
38
39		/**
40		* Validate the given ticket code
41		*
42		* @param null\|string $ticketCode
43		*
44		* @return array
45		*/
46		public function validate($ticketCode = null) {
47
48		// Check if a code is given to the validator
49		if (!isset($ticketCode)) {
50		return array(
51		'Code' => self::MESSAGE_NO_CODE,
52		'Message' => self::message(self::MESSAGE_NO_CODE),
53		'Type' => self::MESSAGE_TYPE_BAD
54		);
55		}
56
57		// Check if a ticket exists with the given ticket code
58		if (!$this->attendee = Attendee::get()->find('TicketCode', $ticketCode)) {
		0 ignored issues – show Documentation Bug introduced 2017-06-14 15:21 UTC by Report Bug Copy Issue Report It seems like `\Broarm\EventTickets\Att...cketCode', $ticketCode)` can also be of type `object<DataObject>`. However, the property `$attendee` is declared as type `object<Broarm\EventTickets\Attendee>`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
59		return array(
60		'Code' => self::MESSAGE_CODE_NOT_FOUND,
61		'Message' => self::message(self::MESSAGE_CODE_NOT_FOUND),
62		'Type' => self::MESSAGE_TYPE_BAD
63		);
64		}
65
66		// Check if the reservation is not canceled
67		if (!(bool)$this->attendee->Event()->getGuestList()->find('ID', $this->attendee->ID)) {
68		return array(
69		'Code' => self::MESSAGE_TICKET_CANCELLED,
70		'Message' => self::message(self::MESSAGE_TICKET_CANCELLED),
71		'Type' => self::MESSAGE_TYPE_BAD
72		);
73		}
74
75		// Check if the ticket is already checked in and not allowed to check out
76	View Code Duplication	elseif ((bool)$this->attendee->CheckedIn && !(bool)self::config()->get('allow_checkout')) {
		0 ignored issues – show Duplication introduced 2017-06-14 15:21 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...
77		return array(
78		'Code' => self::MESSAGE_ALREADY_CHECKED_IN,
79		'Message' => self::message(self::MESSAGE_ALREADY_CHECKED_IN),
80		'Type' => self::MESSAGE_TYPE_BAD
81		);
82		}
83
84		// Successfully checked out
85	View Code Duplication	elseif ((bool)$this->attendee->CheckedIn && (bool)self::config()->get('allow_checkout')) {
		0 ignored issues – show Duplication introduced 2017-06-14 15:21 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...
86		return array(
87		'Code' => self::MESSAGE_CHECK_OUT_SUCCESS,
88		'Message' => self::message(self::MESSAGE_CHECK_OUT_SUCCESS),
89		'Type' => self::MESSAGE_TYPE_WARNING
90		);
91		}
92
93		// Successfully checked in
94		else return array(
95		'Code' => self::MESSAGE_CHECK_IN_SUCCESS,
96		'Message' => self::message(self::MESSAGE_CHECK_IN_SUCCESS),
97		'Type' => self::MESSAGE_TYPE_GOOD
98		);
99		}
100
101		/**
102		* Get the attendee instance
103		*
104		* @return Attendee
105		*/
106		public function getAttendee()
107		{
108		return $this->attendee;
109		}
110
111		/**
112		* Translate the given type to a readable message
113		*
114		* @param $message string
115		*
116		* @return string
117		*/
118		private static function message($message) {
119		return _t("CheckInValidator.$message", $message);
120		}
121		}

TheBnl / event-tickets

Push — master ( aa36ec...9b8ce8 )

CheckInValidator::message() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like