Reservation::getGatewayNice() - Code Metrics - Inspection of "changes in summary fields" - TheBnl/event-tickets - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( cf71fc...f80427 )

by Bram

created 2017-05-30 14:54 UTC

Reservation::getGatewayNice() A

↳ Parent: Reservation

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	0

<?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 SilverStripe\Omnipay\GatewayInfo;
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 day';


    private static $db = array(

        '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(

        'Event' => 'CalendarEvent',
        '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(

        'ReservationCode' => 'Reservation',
        'Title' => 'Customer',
        'Total.Nice' => 'Total',
        'State' => 'Status',
        'GatewayNice' => 'Payment method',
        'Created.Nice' => 'Date'
    );

    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('GateWayNice', _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();
            }
        }

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

        parent::onBeforeDelete();
    }

    /**
     * Gets a nice unnamespaced name
     *
     * @return string
     */
    public function singular_name()
    {
        $name = explode('\\', parent::singular_name());
        return trim(end($name));
    }

    /**
     * Returns the nice gateway title
     *
     * @return string
     */
    public function getGatewayNice() {
        return GatewayInfo::niceTitle($this->Gateway);
    }

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

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

    public function canEdit($member = null)

    {
        return $this->Event()->canEdit($member);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
    }

    public function canDelete($member = null)

    {
        return $this->Event()->canDelete($member);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
    }

    public function canCreate($member = null)

    {
        return $this->Event()->canCreate($member);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
    }
}


Push — master ( cf71fc...f80427 )

Reservation::getGatewayNice() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

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 SilverStripe\Omnipay\GatewayInfo;
26			use SiteConfig;
27			use SSViewer;
28			use Tab;
29			use TabSet;
30			use ViewableData;
31
32			/**
33			* Class Reservation
34			*
35			* @package Broarm\EventTickets
36			*
37			* @property string Status
38			* @property string Title
39			* @property float Subtotal
40			* @property float Total
41			* @property string Email todo determine obsolete value
42			* @property string Comments
43			* @property string ReservationCode
44			* @property string Gateway
45			*
46			* @property int EventID
47			* @property int MainContactID
48			*
49			* @method CalendarEvent\|TicketExtension Event()
50			* @method Attendee MainContact()
51			* @method HasManyList Payments()
52			* @method HasManyList Attendees()
53			* @method ManyManyList PriceModifiers()
54			*/
55			class Reservation extends DataObject
56			{
57			/**
58			* Time to wait before deleting the discarded cart
59			* Give a string that is parsable by strtotime
60			*
61			* @var string
62			*/
63			private static $delete_after = '+1 day';
			1 ignored issue – show Unused Code introduced 2017-04-25 13:06 UTC by Report Bug Copy Issue Report The property `$delete_after` 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...
64
65			private static $db = array(
			2 ignored issues – show Comprehensibility introduced 2017-04-25 13:06 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2017-04-25 13:06 UTC by Report Bug Copy Issue Report The property `$db` 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...
66			'Status' => 'Enum("CART,PENDING,PAID,CANCELED","CART")',
67			'Title' => 'Varchar(255)',
68			'Subtotal' => 'Currency',
69			'Total' => 'Currency',
70			'Email' => 'Varchar(255)',
71			'Gateway' => 'Varchar(255)',
72			'Comments' => 'Text',
73			'ReservationCode' => 'Varchar(255)'
74			);
75
76			private static $has_one = array(
			0 ignored issues – show Comprehensibility introduced 2017-04-25 13:06 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2017-05-09 14:47 UTC by Report Bug Copy Issue Report The property `$has_one` 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...
77			'Event' => 'CalendarEvent',
78			'MainContact' => 'Broarm\EventTickets\Attendee'
79			);
80
81			private static $has_many = array(
			2 ignored issues – show Unused Code introduced 2017-04-25 13:06 UTC by Report Bug Copy Issue Report The property `$has_many` 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... Comprehensibility introduced 2017-05-24 16:47 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history...
82			'Payments' => 'Payment',
83			'Attendees' => 'Broarm\EventTickets\Attendee.Reservation'
84			);
85
86			private static $belongs_many_many = array(
			2 ignored issues – show Comprehensibility introduced 2017-05-24 16:47 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2017-05-24 16:47 UTC by Report Bug Copy Issue Report The property `$belongs_many_many` 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...
87			'PriceModifiers' => 'Broarm\EventTickets\PriceModifier'
88			);
89
90			private static $indexes = array(
			2 ignored issues – show Comprehensibility introduced 2017-04-25 13:06 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2017-04-25 13:06 UTC by Report Bug Copy Issue Report The property `$indexes` 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...
91			'ReservationCode' => 'unique("ReservationCode")'
92			);
93
94			private static $summary_fields = array(
			2 ignored issues – show Comprehensibility introduced 2017-04-25 13:06 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2017-05-24 16:47 UTC by Report Bug Copy Issue Report The property `$summary_fields` 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...
95			'ReservationCode' => 'Reservation',
96			'Title' => 'Customer',
97			'Total.Nice' => 'Total',
98			'State' => 'Status',
99			'GatewayNice' => 'Payment method',
100			'Created.Nice' => 'Date'
101			);
102
103			public function getCMSFields()
			0 ignored issues – show Documentation introduced 2017-04-25 13:06 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
104			{
105			$fields = new FieldList(new TabSet('Root', $mainTab = new Tab('Main')));
106			$gridFieldConfig = GridFieldConfig_RecordViewer::create();
107			$fields->addFieldsToTab('Root.Main', array(
108			ReadonlyField::create('ReservationCode', _t('Reservation.Code', 'Code')),
109			ReadonlyField::create('Title', _t('Reservation.MainContact', 'Main contact')),
110			ReadonlyField::create('GateWayNice', _t('Reservation.Gateway', 'Gateway')),
111			ReadonlyField::create('Total', _t('Reservation.Total', 'Total')),
112			ReadonlyField::create('Comments', _t('Reservation.Comments', 'Comments')),
113			GridField::create('Attendees', 'Attendees', $this->Attendees(), $gridFieldConfig),
114			GridField::create('Payments', 'Payments', $this->Payments(), $gridFieldConfig)
115			));
116			$fields->addFieldsToTab('Root.Main', array());
117			$this->extend('updateCMSFields', $fields);
118			return $fields;
119			}
120
121			public function onBeforeWrite()
122			{
123			// Set the title to the name of the reservation holder
124			$this->Title = $this->getName();
125
126			// Create a validation code to be used for confirmation and in the barcode
127			if ($this->exists() && empty($this->ReservationCode)) {
128			$this->ReservationCode = $this->createReservationCode();
129			}
130
131			parent::onBeforeWrite();
132			}
133
134			public function onBeforeDelete()
135			{
136			// If a reservation is deleted remove the names from the guest list
137			foreach ($this->Attendees() as $attendee) {
138			/** @var Attendee $attendee */
139			if ($attendee->exists()) {
140			$attendee->delete();
141			}
142			}
143
144			// Remove the folder
145			if ($this->fileFolder()->exists()) {
146			$this->fileFolder()->delete();
147			}
148
149			parent::onBeforeDelete();
150			}
151
152			/**
153			* Gets a nice unnamespaced name
154			*
155			* @return string
156			*/
157			public function singular_name()
158			{
159			$name = explode('\\', parent::singular_name());
160			return trim(end($name));
161			}
162
163			/**
164			* Returns the nice gateway title
165			*
166			* @return string
167			*/
168			public function getGatewayNice() {
169			return GatewayInfo::niceTitle($this->Gateway);
170			}
171
172			/**
173			* Check if the cart is still in cart state and the delete_after time period has been exceeded
174			*
175			* @return bool
176			*/
177			public function isDiscarded()
178			{
179			$deleteAfter = strtotime(self::config()->get('delete_after'), strtotime($this->Created));
180			return ($this->Status === 'CART') && (time() > $deleteAfter);
181			}
182
183			/**
184			* Get the full name
185			*
186			* @return string
			0 ignored issues – show Documentation introduced 2017-05-08 11:25 UTC by Report Bug Copy Issue Report Should the return type not be `string\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
187			*/
188			public function getName()
189			{
190			/** @var Attendee $attendee */
191			if ($this->MainContact()->exists()) {
192			return $this->MainContact()->getName();
193			} else {
194			return 'new reservation';
195			}
196			}
197
198			/**
199			* Return the translated state
200			* @return string
201			*/
202			public function getState()
203			{
204			return _t("Reservation.{$this->Status}", $this->Status);
205			}
206
207			/**
208			* Get the total by querying the sum of attendee ticket prices
209			*
210			* @return float
211			*/
212			public function calculateTotal()
213			{
214			$total = $this->Subtotal = $this->Attendees()->leftJoin(
215			'Broarm\EventTickets\Ticket',
216			'`Broarm\EventTickets\Attendee`.`TicketID` = `Broarm\EventTickets\Ticket`.`ID`'
217			)->sum('Price');
218
219			// Calculate any price modifications if added
220			if ($this->PriceModifiers()->exists()) {
221			foreach ($this->PriceModifiers() as $priceModifier) {
222			$priceModifier->updateTotal($total);
223			}
224			}
225
226			return $this->Total = $total;
227			}
228
229			/**
230			* Safely change to a state
231			*
232			* @param $state
233			*/
234			public function changeState($state)
235			{
236			$availableStates = $this->dbObject('Status')->enumValues();
237			if (in_array($state, $availableStates)) {
238			$this->Status = $state;
239			} else {
240			user_error(_t('Reservation.STATE_CHANGE_ERROR', 'Selected state is not available'));
241			}
242			}
243
244			/**
245			* Set the main contact id
246			*
247			* @param $id
248			*/
249			public function setMainContact($id) {
250			$this->MainContactID = $id;
251			$this->write();
252			}
253
254			/**
255			* Create a reservation code
256			*
257			* @return string
258			*/
259			public function createReservationCode()
260			{
261			return uniqid($this->ID);
262			}
263
264			/**
265			* Create the folder for the qr code and ticket file
266			*
267			* @return Folder\|DataObject\|null
268			*/
269			public function fileFolder()
270			{
271			return Folder::find_or_make("/event-tickets/{$this->ReservationCode}/");
272			}
273
274			/**
275			* Generate the qr codes and downloadable pdf
276			*/
277			public function createFiles()
278			{
279			$folder = $this->fileFolder();
280			/** @var Attendee $attendee */
281			foreach ($this->Attendees() as $attendee) {
282			$attendee->createQRCode($folder);
283			$attendee->createTicketFile($folder);
284			}
285			}
286
287			public function canView($member = null)
			0 ignored issues – show Documentation introduced 2017-05-08 13:13 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
288			{
289			return $this->Event()->canView($member);
290			}
291
292			public function canEdit($member = null)
			0 ignored issues – show Documentation introduced 2017-04-25 13:06 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
293			{
294			return $this->Event()->canEdit($member);
			1 ignored issue – show Bug introduced 2017-05-08 11:25 UTC by Report Bug Copy Issue Report The method `canEdit` does only exist in `Broarm\EventTickets\TicketExtension`, but not in `CalendarEvent`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
295			}
296
297			public function canDelete($member = null)
			0 ignored issues – show Documentation introduced 2017-04-25 13:06 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
298			{
299			return $this->Event()->canDelete($member);
			1 ignored issue – show Bug introduced 2017-05-08 11:25 UTC by Report Bug Copy Issue Report The method `canDelete` does only exist in `Broarm\EventTickets\TicketExtension`, but not in `CalendarEvent`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
300			}
301
302			public function canCreate($member = null)
			0 ignored issues – show Documentation introduced 2017-04-25 13:06 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
303			{
304			return $this->Event()->canCreate($member);
			1 ignored issue – show Bug introduced 2017-05-08 11:25 UTC by Report Bug Copy Issue Report The method `canCreate` does only exist in `Broarm\EventTickets\TicketExtension`, but not in `CalendarEvent`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
305			}
306			}
307

TheBnl / event-tickets

Push — master ( cf71fc...f80427 )

Reservation::getGatewayNice() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like