Broarm\EventTickets\PriceModifierInterface

Size/Duplication

Total Lines	25
Duplicated Lines	0 %

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
	updateTotal()	0	1	?
	getTableTitle()	0	1	?
	getTableValue()	0	1	?

<?php
/**
 * PriceModifierInterface.php
 *
 * @author Bram de Leeuw
 * Date: 06/04/17
 */

namespace Broarm\EventTickets;

interface PriceModifierInterface
{
    /**
     * Modify the given total
     *
     * @param float $total
     * @param Reservation $reservation
     */
    public function updateTotal(&$total, Reservation $reservation);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

    /**
     * Get the title for display in the summary table
     *
     * @return string
     */
    public function getTableTitle();

    /**
     * Get the modification value for display in the summary table
     * Can be a discount or an addition
     *
     * @return float
     */
    public function getTableValue();
}