Broarm\EventTickets\CheckInValidator

Complexity

Total Complexity

10

Size/Duplication

Total Lines	109
Duplicated Lines	12.84 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
B	validate()	14	54	8
A	getAttendee()	0	4	1
A	message()	0	3	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;

The property $allow_checkout is not used and could be removed.

    /**
     * @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)) {

It seems like \Broarm\EventTickets\Attendee::get()->find('TicketCode', $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?

            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')) {

This code seems to be duplicated across your project.

            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')) {

This code seems to be duplicated across your project.

            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);
    }
}