Reservation - Code Metrics - Inspection of "added tax modiefier" - TheBnl/event-tickets - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( dead21...224450 )

by Bram
created 2017-05-01 13:16 UTC
Reservation B

↳ Parent: Project
Complexity

Total Complexity
Size/Duplication

Total Lines	309
Duplicated Lines	0 %
Coupling/Cohesion

Components	3
Dependencies	17
Importance

Changes
Metric	Value
wmc	33
lcom	3
cbo	17
dl	0
loc	309
rs	7.3857
c	0
b	0
f	0
19 Methods

Rating	Name	Size	Complexity
A	canView()	4	1
A	canEdit()	4	1
A	canDelete()	4	1
A	canCreate()	4	1
A	getCMSFields()	23	1
A	onBeforeWrite()	12	3
B	onBeforeDelete()	22	5
A	singular_name()	5	1
A	isDiscarded()	5	2
A	getName()	9	2
A	getState()	4	1
A	calculateTotal()	16	3
A	changeState()	9	2
A	setMainContact()	4	1
A	createReservationCode()	4	1
A	fileFolder()	4	1
A	createFiles()	11	2
B	createTicketFile()	35	3
A	getViewableData()	11	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  Total
 * @property string FirstName
 * @property string Surname
 * @property string Email
 * @property string Comments
 * @property string ReservationCode
 * @property string Gateway
 *
 * @property int    EventID
 * @property int    TicketFileID
 * @property int    MainContactID
 *
 * @method File TicketFile
 * @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';


    private static $db = array(

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

    private static $has_one = array(

        'Event' => 'CalendarEvent',
        'TicketFile' => 'File',
        'MainContact' => 'Broarm\EventTickets\Attendee'
    );

    private static $has_many = array(

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

    private static $belongs_many_many = array(

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

    private static $indexes = array(

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

    private static $summary_fields = array(

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

    public function getCMSFields()

    {
        $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')),
            $reservationFileField = ReadonlyField::create(
                'ReservationFile',
                _t('Attendee.Reservation', 'Reservation'),
                "<a class='readonly' href='{$this->TicketFile()->Link()}' target='_blank'>Download reservation PDF</a>"

            ),
            GridField::create('Attendees', 'Attendees', $this->Attendees(), $gridFieldConfig),
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            GridField::create('Payments', 'Payments', $this->Payments(), $gridFieldConfig)
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        ));
        $reservationFileField->dontEscape = true;
        $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) {
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            /** @var Attendee $attendee */
            if ($attendee->exists()) {
                $attendee->delete();
            }
        }

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

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

        }

        // 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
     */
    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->Attendees()->leftJoin(
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            'Broarm\EventTickets\Ticket',
            '`Broarm\EventTickets\Attendee`.`TicketID` = `Broarm\EventTickets\Ticket`.`ID`'
        )->sum('Price');
        
        // Calculate any price modifications if added
        if ($this->PriceModifiers()->exists()) {
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            foreach ($this->PriceModifiers() as $priceModifier) {
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
                $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 = $folder = $this->fileFolder();
        /** @var Attendee $attendee */
        foreach ($this->Attendees() as $attendee) {
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            $attendee->createQRCode($folder);
        }

        // Create a pdf with the newly create QR codes
        $this->createTicketFile($folder);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * Create a Printable ticket file
     *
     * @param Folder $folder
     *
     * @return File
     */
    private function createTicketFile(Folder $folder)
    {
        // Find or make a folder
        $relativeFilePath = "/{$folder->Filename}{$this->ReservationCode}.pdf";
        $absoluteFilePath = Director::baseFolder() . $relativeFilePath;

        if (!$file = File::get()->find('Filename', $relativeFilePath)) {
            $file = File::create();
            $file->ParentID = $folder->ID;
            $file->OwnerID = (Member::currentUser()) ? Member::currentUser()->ID : 0;
            $file->Title = $this->ReservationCode;
            $file->setFilename($relativeFilePath);
            $file->write();
        }

        // Set the template and parse the data
        $template = new SSViewer('PrintableTicket');
        $html = $template->process($this->getViewableData());

        // Create a DomPDF instance
        $domPDF = new Dompdf();
        $domPDF->loadHtml($html);
        $domPDF->setPaper('A4');
        $domPDF->getOptions()->setDpi(250);
        $domPDF->render();

        // Save the pdf stream as a file
        file_put_contents($absoluteFilePath, $domPDF->output());

        // Attach the ticket file to the Attendee
        $this->TicketFileID = $file->ID;
        $this->write();

        return $file;
    }

    /**
     * Get a viewable data object for this reservation
     * For use in the Email and print template
     *
     * @return ViewableData
     */
    public function getViewableData()
    {
        $config = SiteConfig::current_site_config();
        $data = $this->Me();
        $data->CurrentDate = $this->Event()->getController()->CurrentDate();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        //$calendarController = new CalendarEvent_Controller($this->Event());

        //$data->CurrentDate = $calendarController->CurrentDate();

        $data->Logo = $config->TicketLogo();
        $this->extend('updateViewableData', $data);
        return $data;
    }

    public function canView($member = null)

    {
        return $this->Event()->canView($member);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
    }

    public function canEdit($member = null)

    {
        return $this->Event()->canEdit($member);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
    }

    public function canDelete($member = null)

    {
        return $this->Event()->canDelete($member);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
    }

    public function canCreate($member = null)

    {
        return $this->Event()->canCreate($member);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
    }
}

1			<?php
2			/**
3			* Reservation.php
4			*
5			* @author Bram de Leeuw
6			* Date: 09/03/17
7			*/
8
9			namespace Broarm\EventTickets;
10
11			use CalendarEvent;
12			use CalendarEvent_Controller;
13			use DataObject;
14			use Director;
15			use Dompdf\Dompdf;
16			use FieldList;
17			use File;
18			use Folder;
19			use GridField;
20			use GridFieldConfig_RecordViewer;
21			use HasManyList;
22			use ManyManyList;
23			use Member;
24			use ReadonlyField;
25			use SiteConfig;
26			use SSViewer;
27			use Tab;
28			use TabSet;
29			use ViewableData;
30
31			/**
32			* Class Reservation
33			*
34			* @package Broarm\EventTickets
35			*
36			* @property string Status
37			* @property string Title
38			* @property float Total
39			* @property string FirstName
40			* @property string Surname
TheBnl / event-tickets

Push — master ( dead21...224450 )

Reservation B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

19 Methods

Duplication Side-by-Side

Filter issues like
