silvercommerce / discounts

src/model/Discount.php

<?php

namespace SilverCommerce\Discounts\Model;

use SilverStripe\Core\Convert;
use SilverStripe\ORM\DataObject;
use SilverStripe\Security\Group;
use SilverStripe\Security\Security;
use SilverStripe\Control\Controller;
use SilverStripe\Forms\ReadonlyField;
use SilverStripe\Security\Permission;
use SilverStripe\SiteConfig\SiteConfig;
use SilverStripe\Security\PermissionProvider;
use SilverCommerce\OrdersAdmin\Model\Estimate;
use SilverCommerce\TaxAdmin\Helpers\MathsHelper;
use SilverCommerce\Discounts\Model\AppliedDiscount;
use SilverCommerce\CatalogueAdmin\Model\CatalogueCategory;

class Discount extends DataObject implements PermissionProvider
{
    private static $table_name = 'Discount';

The private property $table_name is not used, and could be removed.

    private static $db = [

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

        "Title"     => "Varchar",
        "Code"      => "Varchar(99)",
        "MinOrder"  => "Decimal",
        "Starts"    => "Date",
        "Expires"   => "Date"
    ];

    private static $has_one = [

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

        "Site"      => SiteConfig::class
    ];

    private static $many_many = [

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

        "Groups"    => Group::class,
        "Categories" => CatalogueCategory::class
    ];

    private static $casting = [

The private property $casting is not used, and could be removed.

        'I18nType'
    ];

    private static $summary_fields = [

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

        'I18nType',
        "Title",
        "Code",
        "Starts",
        "Expires"
    ];

    private static $field_labels = [

The private property $field_labels is not used, and could be removed.

        'I18nType' => 'Type'
    ];

    public function getCMSFields()
    {
        $self = $this;

        $this->beforeUpdateCMSFields(
            function ($fields) use ($self) {

The import $self is not used and could be removed.

                // Add i18n type field to field list
                $fields->addFieldToTab(
                    'Root.Main',
                    ReadonlyField::create('I18nType', $this->fieldLabel('I18nType')),
                    'Title'
                );

                $min = $fields->dataFieldByName("MinOrder");

                if ($min) {
                    $min->setDescription(
                        _t(self::class.".MinOrderPreTax", "This is the SubTotal of an order EXCLUDING vat and tax")
                    );
                }
            }
        );

        return parent::getCMSFields();
    }

    /**
     * Generate a translated type of this discount (based on it's classname)
     *
     * @return string
     */
    public function getI18nType()
    {
        return $this->i18n_singular_name();
    }

    /**
     * calculate the price reduction for this discount
     *
     * @param  Currency $value - the total/sub-total of the items this discount applies to.

The type SilverCommerce\Discounts\Model\Currency was not found. Maybe you did not declare it correctly or list all dependencies?

     * @return int
     */
    public function calculateAmount(Estimate $estimate)
    {
        return 0;
    }

    /**
     * calculate the value of a discount using an AppliedDiscount item.
     *
     * @param  AppliedDiscount $item
     * @return float
     */
    public function appliedAmount(AppliedDiscount $item)

The parameter $item is not used and could be removed.

    {
        return 0;
    }

    public function applyDiscount($estimate, $code = null)

The parameter $code is not used and could be removed.

    {
        $applied = AppliedDiscount::create();
        $applied->Code = $this->Code;
        $applied->Title = $this->Title;
        $applied->Value = $this->calculateAmount($estimate);
        $applied->EstimateID = $estimate->ID;

        $applied->write();

        $estimate->Discounts()->add($applied);
    }

    /**
     * Generate a random string that we can use for the code by default
     *
     * @return string
     */
    protected static function generateRandomString($length = 10)
    {
        $characters = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
        $string = '';

        for ($i = 0; $i < $length; $i++) {
            $string .= $characters[rand(0, strlen($characters) - 1)];
        }

        return $string;
    }

    /**
     * Set more complex default data
     */
    public function populateDefaults()
    {
        $this->setField('Code', self::generateRandomString());
    }

    public function onBeforeWrite()
    {
        parent::onBeforeWrite();

        // Ensure that the code is URL safe
        $this->Code = Convert::raw2url($this->Code);

The property Code does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

    }

    public function canView($member = null, $context = [])

The parameter $context is not used and could be removed.

    {
        $extended = $this->extendedCan('canView', $member);
        if ($extended !== null) {
            return $extended;
        }
        
        return true;
    }
    
    public function canCreate($member = null, $context = [])
    {
        $extended = $this->extendedCan('canCreate', $member);
        if ($extended !== null) {
            return $extended;
        }

        $permissions = ["ADMIN", "DISCOUNTS_CREATE"];

        if (!$member) {
            $member = Security::getCurrentUser();
        }
        
        if ($member && Permission::checkMember($member->ID, $permissions)) {
            return true;
        }

        return false;
    }

    public function canEdit($member = null, $context = [])

The parameter $context is not used and could be removed.

    {
        $extended = $this->extendedCan('canEdit', $member);
        if ($extended !== null) {
            return $extended;
        }

        $permissions = ["ADMIN", "DISCOUNTS_EDIT"];

        if (!$member) {
            $member = Security::getCurrentUser();
        }
        
        if ($member && Permission::checkMember($member->ID, $permissions)) {
            return true;
        }

        return false;
    }

    public function canDelete($member = null, $context = [])

The parameter $context is not used and could be removed.

    {
        $extended = $this->extendedCan('canDelete', $member);
        if ($extended !== null) {
            return $extended;
        }

        $permissions = ["ADMIN", "DISCOUNTS_DELETE"];

        if (!$member) {
            $member = Security::getCurrentUser();
        }
        
        if ($member && Permission::checkMember($member->ID, $permissions)) {
            return true;
        }

        return false;
    }



    public function providePermissions()
    {
        return [
            "DISCOUNTS_CREATE" => [
                'name' => 'Create Discounts',
                'help' => 'Allow user to create discounts',
                'category' => 'Discounts',
                'sort' => 88
            ],
            "DISCOUNTS_EDIT" => [
                'name' => 'Edit Discounts',
                'help' => 'Allow user to edit discounts',
                'category' => 'Discounts',
                'sort' => 87
            ],
            "DISCOUNTS_DELETE" => [
                'name' => 'Delete Discounts',
                'help' => 'Allow user to delete discounts',
                'category' => 'Discounts',
                'sort' => 86
            ]
        ];
    }
}