Broarm\EventTickets\Reservation

Complexity

Total Complexity

28

Size/Duplication

Total Lines	241
Duplicated Lines	0 %

Coupling/Cohesion

Components	4
Dependencies	12

Importance

Changes

0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	getCMSFields()	0	17	1
A	onBeforeWrite()	0	12	3
B	onBeforeDelete()	0	22	4
A	singular_name()	0	5	1
A	isDiscarded()	0	5	2
A	getName()	0	9	2
A	getState()	0	4	1
A	calculateTotal()	0	16	3
A	changeState()	0	9	2
A	setMainContact()	0	4	1
A	createReservationCode()	0	4	1
A	fileFolder()	0	4	1
A	createFiles()	0	9	2
A	canView()	0	4	1
A	canEdit()	0	4	1
A	canDelete()	0	4	1
A	canCreate()	0	4	1

<?php
/**
 * Reservation.php
 *
 * @author Bram de Leeuw
 * Date: 09/03/17
 */

namespace Broarm\EventTickets;

use CalendarEvent;
use CalendarEvent_Controller;
use DataObject;
use Director;
use Dompdf\Dompdf;
use FieldList;
use File;
use Folder;
use GridField;
use GridFieldConfig_RecordViewer;
use HasManyList;
use ManyManyList;
use Member;
use ReadonlyField;
use SiteConfig;
use SSViewer;
use Tab;
use TabSet;
use ViewableData;

/**
 * Class Reservation
 *
 * @package Broarm\EventTickets
 *
 * @property string Status
 * @property string Title
 * @property float  Subtotal
 * @property float  Total
 * @property string Email todo determine obsolete value
 * @property string Comments
 * @property string ReservationCode
 * @property string Gateway
 *
 * @property int    EventID
 * @property int    MainContactID
 *
 * @method CalendarEvent|TicketExtension Event()
 * @method Attendee MainContact()
 * @method HasManyList Payments()
 * @method HasManyList Attendees()
 * @method ManyManyList PriceModifiers()
 */
class Reservation extends DataObject
{
    /**
     * Time to wait before deleting the discarded cart
     * Give a string that is parsable by strtotime
     *
     * @var string
     */
    private static $delete_after = '+1 week';

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

    private static $db = array(

Consider using a different property name as you override a private property of the parent class.

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

        'Status' => 'Enum("CART,PENDING,PAID,CANCELED","CART")',
        'Title' => 'Varchar(255)',
        'Subtotal' => 'Currency',
        'Total' => 'Currency',
        'Email' => 'Varchar(255)',
        'Gateway' => 'Varchar(255)',
        'Comments' => 'Text',
        'ReservationCode' => 'Varchar(255)'
    );

    private static $has_one = array(

Consider using a different property name as you override a private property of the parent class.

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

        'Event' => 'CalendarEvent',
        //'TicketFile' => 'File',

67% of this comment could be valid code. Did you maybe forget this after debugging?

        'MainContact' => 'Broarm\EventTickets\Attendee'
    );

    private static $has_many = array(

Consider using a different property name as you override a private property of the parent class.

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

        'Payments' => 'Payment',
        'Attendees' => 'Broarm\EventTickets\Attendee.Reservation'
    );

    private static $belongs_many_many = array(

Consider using a different property name as you override a private property of the parent class.

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

        'PriceModifiers' => 'Broarm\EventTickets\PriceModifier'
    );

    private static $indexes = array(

Consider using a different property name as you override a private property of the parent class.

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

        'ReservationCode' => 'unique("ReservationCode")'
    );

    private static $summary_fields = array(

Consider using a different property name as you override a private property of the parent class.

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

        'Title' => 'Customer',
        'Total.Nice' => 'Total',
        'State' => 'Status'
    );

    public function getCMSFields()

The return type could not be reliably inferred; please add a @return annotation.

    {
        $fields = new FieldList(new TabSet('Root', $mainTab = new Tab('Main')));
        $gridFieldConfig = GridFieldConfig_RecordViewer::create();
        $fields->addFieldsToTab('Root.Main', array(
            ReadonlyField::create('ReservationCode', _t('Reservation.Code', 'Code')),
            ReadonlyField::create('Title', _t('Reservation.MainContact', 'Main contact')),
            ReadonlyField::create('Gateway', _t('Reservation.Gateway', 'Gateway')),
            ReadonlyField::create('Total', _t('Reservation.Total', 'Total')),
            ReadonlyField::create('Comments', _t('Reservation.Comments', 'Comments')),
            GridField::create('Attendees', 'Attendees', $this->Attendees(), $gridFieldConfig),
            GridField::create('Payments', 'Payments', $this->Payments(), $gridFieldConfig)
        ));
        $fields->addFieldsToTab('Root.Main', array());
        $this->extend('updateCMSFields', $fields);
        return $fields;
    }

    public function onBeforeWrite()
    {
        // Set the title to the name of the reservation holder
        $this->Title = $this->getName();

        // Create a validation code to be used for confirmation and in the barcode
        if ($this->exists() && empty($this->ReservationCode)) {
            $this->ReservationCode = $this->createReservationCode();
        }

        parent::onBeforeWrite();
    }

    public function onBeforeDelete()
    {
        // If a reservation is deleted remove the names from the guest list
        foreach ($this->Attendees() as $attendee) {
            /** @var Attendee $attendee */
            if ($attendee->exists()) {
                $attendee->delete();
            }
        }

        // Make sure the ticket file is not downloadable
        //if ($this->TicketFile()->exists()) {

74% of this comment could be valid code. Did you maybe forget this after debugging?

        //    $this->TicketFile()->delete();

73% of this comment could be valid code. Did you maybe forget this after debugging?

        //}

        // Remove the folder
        if ($this->fileFolder()->exists()) {
            $this->fileFolder()->delete();
        }

        parent::onBeforeDelete();
    }

    public function singular_name()
    {
        $name = explode('\\', parent::singular_name());
        return trim(end($name));
    }

    /**
     * Check if the cart is still in cart state and the delete_after time period has been exceeded
     *
     * @return bool
     */
    public function isDiscarded()
    {
        $deleteAfter = strtotime(self::config()->get('delete_after'), strtotime($this->Created));
        return ($this->Status === 'CART') && (time() > $deleteAfter);
    }

    /**
     * Get the full name
     *
     * @return string

Should the return type not be string|null?

     */
    public function getName()
    {
        /** @var Attendee $attendee */
        if ($this->MainContact()->exists()) {
            return $this->MainContact()->getName();
        } else {
            return 'new reservation';
        }
    }

    /**
     * Return the translated state
     * @return string
     */
    public function getState()
    {
        return _t("Reservation.{$this->Status}", $this->Status);
    }

    /**
     * Get the total by querying the sum of attendee ticket prices
     *
     * @return float
     */
    public function calculateTotal()
    {
        $total = $this->Subtotal = $this->Attendees()->leftJoin(
            'Broarm\EventTickets\Ticket',
            '`Broarm\EventTickets\Attendee`.`TicketID` = `Broarm\EventTickets\Ticket`.`ID`'
        )->sum('Price');

        // Calculate any price modifications if added
        if ($this->PriceModifiers()->exists()) {
            foreach ($this->PriceModifiers() as $priceModifier) {
                $priceModifier->updateTotal($total);
            }
        }

        return $this->Total = $total;
    }

    /**
     * Safely change to a state
     *
     * @param $state
     */
    public function changeState($state)
    {
        $availableStates = $this->dbObject('Status')->enumValues();
        if (in_array($state, $availableStates)) {
            $this->Status = $state;
        } else {
            user_error(_t('Reservation.STATE_CHANGE_ERROR', 'Selected state is not available'));
        }
    }

    /**
     * Set the main contact id
     *
     * @param $id
     */
    public function setMainContact($id) {
        $this->MainContactID = $id;
        $this->write();
    }

    /**
     * Create a reservation code
     *
     * @return string
     */
    public function createReservationCode()
    {
        return uniqid($this->ID);
    }

    /**
     * Create the folder for the qr code and ticket file
     *
     * @return Folder|DataObject|null
     */
    public function fileFolder()
    {
        return Folder::find_or_make("/event-tickets/{$this->ReservationCode}/");
    }

    /**
     * Generate the qr codes and downloadable pdf
     */
    public function createFiles()
    {
        $folder = $this->fileFolder();
        /** @var Attendee $attendee */
        foreach ($this->Attendees() as $attendee) {
            $attendee->createQRCode($folder);
            $attendee->createTicketFile($folder);
        }
    }

    public function canView($member = null)

The return type could not be reliably inferred; please add a @return annotation.

    {
        return $this->Event()->canView($member);
    }

    public function canEdit($member = null)

The return type could not be reliably inferred; please add a @return annotation.

    {
        return $this->Event()->canEdit($member);

The method canEdit does only exist in Broarm\EventTickets\TicketExtension, but not in CalendarEvent.

    }

    public function canDelete($member = null)

The return type could not be reliably inferred; please add a @return annotation.

    {
        return $this->Event()->canDelete($member);

The method canDelete does only exist in Broarm\EventTickets\TicketExtension, but not in CalendarEvent.

    }

    public function canCreate($member = null)

The return type could not be reliably inferred; please add a @return annotation.

    {
        return $this->Event()->canCreate($member);

The method canCreate does only exist in Broarm\EventTickets\TicketExtension, but not in CalendarEvent.

    }
}