silvercommerce / tax-admin

src/model/TaxCategory.php

<?php

namespace SilverCommerce\TaxAdmin\Model;

use Locale;
use SilverStripe\ORM\DB;
use SilverStripe\i18n\i18n;
use SilverStripe\ORM\DataList;
use SilverStripe\ORM\DataObject;
use SilverStripe\Security\Member;
use SilverStripe\Security\Security;
use SilverStripe\Core\Config\Config;
use SilverStripe\Forms\DropdownField;
use SilverStripe\Security\Permission;
use SilverStripe\Forms\RequiredFields;
use SilverStripe\SiteConfig\SiteConfig;
use SilverCommerce\TaxAdmin\Model\TaxRate;
use SilverStripe\Security\PermissionProvider;
use SilverStripe\Forms\GridField\GridFieldDetailForm;
use SilverStripe\Forms\GridField\GridFieldEditButton;
use SilverStripe\Forms\GridField\GridFieldDataColumns;
use SilverStripe\Forms\GridField\GridFieldAddNewButton;
use SilverStripe\Forms\GridField\GridFieldDeleteAction;
use Symbiote\GridFieldExtensions\GridFieldEditableColumns;
use Symbiote\GridFieldExtensions\GridFieldAddNewInlineButton;
use SilverStripe\Forms\GridField\GridFieldAddExistingAutocompleter;

/**
 * A tax rate can be added to a product and allows you to map a product
 * to a percentage of tax.
 *
 * If added to a product, the tax will then be added to the price
 * automatically.
 *
 * @author i-lateral (http://www.i-lateral.com)
 * @package catalogue
 */
class TaxCategory extends DataObject implements PermissionProvider
{
    
    private static $table_name = 'TaxCategory';

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

    /**
     * What location will this rate be applied based on?
     *
     * @var array
     * @config
     */
    private static $rate_locations = [

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

        'Shipping Address',
        'Billing Address',
        'Store Address'
    ];

    private static $db = [

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

        "Title" => "Varchar",
        "Default" => "Boolean"
    ];
    
    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.

        "Rates" => TaxRate::class
    ];

    private static $many_many_extraFields = [

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

        "Rates" => [
            "Location" => "Int"
        ]
    ];

    private static $summary_fields = [

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

        "Title",
        "RatesList",
        "Default"
    ];

    private static $casting = [

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

        "RatesList" => "Varchar(255)"
    ];
    
    public function getRatesList()
    {
        return implode(", ", $this->Rates()->column("Title"));

The method Rates() does not exist on SilverCommerce\TaxAdmin\Model\TaxCategory. Since you implemented __call, consider adding a @method annotation.

    }

    /**
     * Attempt to determine the relevent current tax
     * from the users location (or default store location)
     *
     * @param string $country The current ISO-3166 2 character country code
     * @param string $region A 3 character ISO-3166-2 subdivision code
     * @return TaxRate|null
     */
    public function ValidTax($country = null, $region = null)
    {
        if (empty($country)) {
            // First try and get the locale from the member
            $member = Security::getCurrentUser();

            if ($member && $member->getLocale()) {
                $country = $member->getLocale();
            }
        }

        if (empty($country)) {
            $country = i18n::get_locale();
        }

        if (strlen($country) > 2) {
            $country = Locale::getRegion($country);
        }

        $filter = [
            'Global' => 1,
            "Zones.Regions.CountryCode" => $country
        ];

        $rates = $this
            ->Rates()
            ->filterAny($filter);

        if (isset($region)) {
            $rates = $rates->filter("Zones.Regions.Code", $region);
        }

        return $rates->first();
    }
    
    public function getCMSValidator()
    {
        return RequiredFields::create([
            "Title"
        ]);
    }

    public function getCMSFields()
    {
        $site = SiteConfig::current_site_config();

        $fields = parent::getCMSFields();

        $grid = $fields->dataFieldByName("Rates");

        if ($grid) {

$grid is of type SilverStripe\Forms\FormField, thus it always evaluated to true.

            $grid->setTitle("");
            $config = $grid->getConfig();

            $add_field = new GridFieldAddExistingAutocompleter('buttons-before-right');

            if ($add_field && $site) {

$site is of type SilverStripe\SiteConfig\SiteConfig, thus it always evaluated to true.

                $dataClass = $grid->getModelClass();
                $add_field->setSearchList(
                    DataList::create($dataClass)->filter('Site.ID', $site->ID)
                );
            }

            $config
                ->removeComponentsByType(GridFieldAddNewButton::class)
                ->removeComponentsByType(GridFieldEditButton::class)
                ->removeComponentsByType(GridFieldDeleteAction::class)
                ->removeComponentsByType(GridFieldDetailForm::class)
                ->removeComponentsByType(GridFieldAddExistingAutocompleter::class)
                ->addComponent($add_field)
                ->addComponent(new GridFieldDeleteAction(true));
        }

        return $fields;
    }
    
    public function requireDefaultRecords()
    {
        // If no tax rates, setup some defaults
        if (!TaxCategory::get()->exists()) {
            $config = SiteConfig::current_site_config();

            $cat = TaxCategory::create([
                "Title" => "Standard Goods",
                "Default" => 1
            ]);
            $cat->SiteID = $config->ID;
            $cat->write();

            DB::alteration_message(
                'Standard Goods tax category created',
                'created'
            );
        }
        
        parent::requireDefaultRecords();
    }

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

        // If this is set to default, reset all other categories
        if ($this->Default && $this->Site()->exists()) {

The method Site() does not exist on SilverCommerce\TaxAdmin\Model\TaxCategory. Since you implemented __call, consider adding a @method annotation.

            foreach ($this->Site()->TaxCategories() as $cat) {
                if ($cat->ID != $this->ID && $cat->Default) {
                    $cat->Default = false;
                    $cat->write();
                }
            }
        }
    }

    public function providePermissions()
    {
        return [
            "TAXADMIN_MANAGE_CATEGORY" => [
                'name' => 'Manage Tax Categories',
                'help' => 'Allow user to create, edit and delete tax categoires',
                'category' => 'Tax',
                'sort' => 10
            ]
        ];
    }

    /**
     * Anyone can view tax categories
     *
     * @param Member $member
     * @return boolean
     */
    public function canView($member = null)
    {
        $extended = $this->extendedCan(__FUNCTION__, $member);
        
        if ($extended !== null) {
            return $extended;
        }

        return true;
    }

    /**
     * Anyone can create orders, even guest users
     *
     * @param Member $member
     * @return boolean
     */
    public function canCreate($member = null, $context = [])
    {
        $extended = $this->extendedCan(__FUNCTION__, $member, $context);
        
        if ($extended !== null) {
            return $extended;
        }
        
        if (!$member) {
            $member = Member::currentUser();

The function SilverStripe\Security\Member::currentUser() has been deprecated: 5.0.0 use Security::getCurrentUser()

        }

        if ($member && Permission::checkMember($member->ID, ["ADMIN", "TAXADMIN_MANAGE_CATEGORY"])) {
            return true;
        }

        return false;
    }

    /**
     * Only users with correct rights can edit
     *
     * @param Member $member
     * @return boolean
     */
    public function canEdit($member = null, $context = [])

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

    {
        $extended = $this->extendedCan(__FUNCTION__, $member);
        
        if ($extended !== null) {
            return $extended;
        }
        
        if (!$member) {
            $member = Member::currentUser();

The function SilverStripe\Security\Member::currentUser() has been deprecated: 5.0.0 use Security::getCurrentUser()

        }

        if ($member && Permission::checkMember($member->ID, ["ADMIN", "TAXADMIN_MANAGE_CATEGORY"])) {
            return true;
        }

        return false;
    }

    /**
     * No one should be able to delete an order once it has been created
     *
     * @param Member $member
     * @return boolean
     */
    public function canDelete($member = null, $context = [])

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

    {
        $extended = $this->extendedCan(__FUNCTION__, $member);
        
        if ($extended !== null) {
            return $extended;
        }
        
        if (!$member) {
            $member = Member::currentUser();

The function SilverStripe\Security\Member::currentUser() has been deprecated: 5.0.0 use Security::getCurrentUser()

        }

        if ($member && Permission::checkMember($member->ID, ["ADMIN", "TAXADMIN_MANAGE_CATEGORY"])) {
            return true;
        }

        return false;
    }
}