Broarm\EventTickets\Attendee

Complexity

Total Complexity

36

Size/Duplication

Total Lines	340
Duplicated Lines	7.06 %

Coupling/Cohesion

Components	1
Dependencies	21

Importance

Changes

0

17 Methods

Rating	Name	Duplication	Size	Complexity
B	getCMSFields()	0	30	3
A	getFirstName()	8	8	2
A	getSurname()	8	8	2
A	getName()	0	10	4
A	getEmail()	8	8	2
A	onBeforeWrite()	0	12	3
A	onBeforeDelete()	0	15	3
A	getTableFields()	0	11	2
A	singular_name()	0	5	1
A	getCheckedInSummary()	0	9	2
A	generateTicketCode()	0	4	1
B	createQRCode()	0	32	4
B	createTicketFile()	0	35	3
A	canView()	0	4	1
A	canEdit()	0	4	1
A	canDelete()	0	4	1
A	canCreate()	0	4	1

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

namespace Broarm\EventTickets;

use ArrayList;
use BaconQrCode;
use CalendarEvent;
use DataObject;
use Director;
use Dompdf\Dompdf;
use FieldList;
use File;
use Folder;
use Image;
use LiteralField;
use ManyManyList;
use Member;
use ReadonlyField;
use SSViewer;
use Tab;
use TabSet;
use TextField;
use ViewableData;

/**
 * Class Attendee
 *
 * @package Broarm\EventTickets
 *
 * @property string    Title
 * @property string    FirstName
 * @property string    Surname
 * @property string    Email
 * @property string    TicketCode
 * @property boolean   TicketReceiver
 * @property boolean   CheckedIn
 * @property FieldList SavableFields    Field to be set in AttendeesField
 *
 * @property int       TicketID
 * @property int       TicketQRCodeID
 * @property int       TicketFileID
 * @property int       ReservationID
 * @property int       EventID
 * @property int       MemberID
 *
 * @method Reservation Reservation()
 * @method Ticket Ticket()
 * @method Image TicketQRCode()
 * @method File TicketFile()
 * @method Member Member()
 * @method CalendarEvent|TicketExtension Event()
 * @method ManyManyList Fields()
 */
class Attendee extends DataObject
{
    /**
     * Set this to true when you want to have a QR code that opens the check in page and validates the code.
     * The validation is only done with proper authorisation so guest cannot check themselves in by mistake.
     * By default only the ticket number is translated to an QR code. (for use with USB QR scanners)
     *
     * @var bool
     */
    private static $qr_as_link = false;

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

    private static $default_fields = array(

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

        'FirstName' => 'TextField',
        'Surname' => 'TextField',
        'Email' => 'EmailField',
    );

    private static $table_fields = array(

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

        'Title',
        'Email'
    );

    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.

        'Title' => 'Varchar(255)',
        'TicketReceiver' => 'Boolean',
        'TicketCode' => 'Varchar(255)',
        'CheckedIn' => 'Boolean'
    );

    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.

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

    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.

        'Reservation' => 'Broarm\EventTickets\Reservation',
        'Ticket' => 'Broarm\EventTickets\Ticket',
        'Event' => 'CalendarEvent',
        'Member' => 'Member',
        'TicketQRCode' => 'Image',
        'TicketFile' => 'File'
    );

    private static $many_many = array(

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

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

        'Fields' => 'Broarm\EventTickets\AttendeeExtraField'
    );

    private static $many_many_extraFields = array(

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

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

        'Fields' => array(
            'Value' => 'Varchar(255)'
        )
    );

    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' => 'Name',
        'Email' => 'Email',
        'TicketCode' => 'Ticket',
        'CheckedInSummary' => 'Checked in',
    );

    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')));
        $fields->addFieldsToTab('Root.Main', array(
            ReadonlyField::create('FirstName', _t('Attendee.FirstName', 'First name')),
            ReadonlyField::create('Surname', _t('Attendee.Surname', 'Surname')),
            ReadonlyField::create('Email', _t('Attendee.Email', 'Email')),
            ReadonlyField::create('TicketCode', _t('Attendee.Ticket', 'Ticket')),
            ReadonlyField::create('MyCheckedIn', _t('Attendee.CheckedIn', 'Checked in'), $this->dbObject('CheckedIn')->Nice())
        ));

        foreach ($this->Fields() as $field) {
            $fields->addFieldToTab(
                'Root.Main',
                ReadonlyField::create("{$field->FieldName}_Preview", $field->Title, $field->Value)
            );
        }

        if ($this->TicketFile()->exists()) {
            $fields->addFieldToTab('Root.Main', $reservationFileField = ReadonlyField::create(
                'ReservationFile',
                _t('Attendee.Reservation', 'Reservation'),
                "<a class='readonly' href='{$this->TicketFile()->Link()}' target='_blank'>Download reservation PDF</a>"
            ));
            $reservationFileField->dontEscape = true;
        }

        $this->extend('updateCMSFields', $fields);
        return $fields;
    }

    /**
     * Utility method for fetching the default field, FirstName, value
     *
     * @return string

Should the return type not be string|null?

     */
    public function getFirstName()

This method seems to be duplicated in your project.

    {
        if ($firstName = $this->Fields()->find('FieldName', 'FirstName')) {
            return (string)$firstName->getField('Value');
        }

        return null;
    }

    /**
     * Utility method for fetching the default field, Surname, value
     *
     * @return string

Should the return type not be string|null?

     */
    public function getSurname()

This method seems to be duplicated in your project.

    {
        if ($surname = $this->Fields()->find('FieldName', 'Surname')) {
            return (string)$surname->getField('Value');
        }

        return null;
    }

    /**
     * Get the combined first and last nave for dispay on the ticket and attendee list
     *
     * @return string

Should the return type not be string|null?

     */
    public function getName()
    {
        if (!empty($this->getFirstName())) {
            return trim("{$this->getFirstName()} {$this->getSurname()}");
        } elseif ($this->Reservation()->MainContact()->exists() && $mainContact = $this->Reservation()->MainContact()) {
            return _t('Attendee.GUEST_OF', 'Guest of {name}', null, array('name' => $mainContact->getName()));

array('name' => $mainContact->getName()) is of type array<string,?,{"name":"?"}>, but the function expects a string.

        } else {
            return null;
        }
    }

    /**
     * Utility method for fetching the default field, Email, value
     *
     * @return string

Should the return type not be string|null?

     */
    public function getEmail()

This method seems to be duplicated in your project.

    {
        if ($email = $this->Fields()->find('FieldName', 'Email')) {
            return (string)$email->getField('Value');
        }

        return null;
    }

    /**
     * Set the title and ticket code before writing
     */
    public function onBeforeWrite()
    {
        // Set the title of the attendee
        $this->Title = $this->getName();

        // Generate the ticket code
        if ($this->exists() && empty($this->TicketCode)) {
            $this->TicketCode = $this->generateTicketCode();
        }

        parent::onBeforeWrite();
    }

    /**
     * Delete any stray files before deleting the object
     */
    public function onBeforeDelete()
    {
        // If an attendee is deleted from the guest list remove it's qr code
        // after deleting the code it's not validatable anymore, simply here for cleanup
        if ($this->TicketQRCode()->exists()) {
            $this->TicketQRCode()->delete();
        }

        // cleanup the ticket file
        if ($this->TicketFile()->exists()) {
            $this->TicketFile()->delete();
        }

        parent::onBeforeDelete();
    }

    /**
     * Get the table fields for this attendee
     *
     * @return ArrayList
     */
    public function getTableFields()
    {
        $fields = new ArrayList();
        foreach (self::config()->get('table_fields') as $field) {
            $data = new ViewableData();
            $data->Header = _t("Attendee.$field", $field);
            $data->Value = $this->$field;
            $fields->add($data);
        }
        return $fields;
    }

    /**
     * Get the unnamespaced singular name for display in the CMS
     *
     * @return string
     */
    public function singular_name()
    {
        $name = explode('\\', parent::singular_name());
        return trim(end($name));
    }

    /**
     * Return the checked in state for use in grid fields
     *
     * @return LiteralField
     */
    public function getCheckedInSummary()
    {
        $checkedInNice = $this->dbObject('CheckedIn')->Nice();
        $checkedIn = $this->CheckedIn
            ? "<span style='color: #3adb76;'>$checkedInNice</span>"
            : "<span style='color: #cc4b37;'>$checkedInNice</span>";

        return new LiteralField('CheckedIn', $checkedIn);
    }

    /**
     * Generate a unique ticket id
     * Serves as the base for the QR code and ticket file
     *
     * @return string
     */
    public function generateTicketCode()
    {
        return uniqid($this->ID);
    }

    /**
     * Create a QRCode for the attendee based on the Ticket code
     *
     * @param Folder $folder
     *
     * @return Image
     */
    public function createQRCode(Folder $folder)
    {
        $relativeFilePath = "/{$folder->Filename}{$this->TicketCode}.png";
        $absoluteFilePath = Director::baseFolder() . $relativeFilePath;

        if (!$image = Image::get()->find('Filename', $relativeFilePath)) {
            // Generate the QR code
            $renderer = new BaconQrCode\Renderer\Image\Png();
            $renderer->setHeight(256);
            $renderer->setWidth(256);
            $writer = new BaconQrCode\Writer($renderer);
            if (self::config()->get('qr_as_link')) {
                $writer->writeFile($this->Event()->AbsoluteLink("checkin/$this->TicketCode"), $absoluteFilePath);
            } else {
                $writer->writeFile($this->TicketCode, $absoluteFilePath);
            }

            // Store the image in an image object
            $image = Image::create();
            $image->ParentID = $folder->ID;
            $image->OwnerID = (Member::currentUser()) ? Member::currentUser()->ID : 0;
            $image->Title = $this->TicketCode;
            $image->setFilename($relativeFilePath);
            $image->write();

            // Attach the QR code to the Attendee
            $this->TicketQRCodeID = $image->ID;
            $this->write();
        }

        return $image;
    }

    /**
     * Creates a printable ticket for the attendee
     *
     * @param Folder $folder
     *
     * @return File
     */
    public function createTicketFile(Folder $folder)
    {
        // Find or make a folder
        $relativeFilePath = "/{$folder->Filename}{$this->TicketCode}.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->TicketCode;
            $file->setFilename($relativeFilePath);
            $file->write();
        }

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

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

        // Create a DomPDF instance
        $domPDF = new Dompdf();
        $domPDF->loadHtml($html);
        $domPDF->setPaper('A4');
        $domPDF->getOptions()->setDpi(150);
        $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;
    }

    public function canView($member = null)

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

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

    public function canEdit($member = null)

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

    {
        return $this->Reservation()->canEdit($member);
    }

    public function canDelete($member = null)

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

    {
        return $this->Reservation()->canDelete($member);
    }

    public function canCreate($member = null)

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

    {
        return $this->Reservation()->canCreate($member);
    }
}