DeliveryPostageEvent::setMaximumDeliveryDate() - Code Metrics - Inspection of "Improve DeliveryPostage event to get more data (#2..." - thelia/thelia - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 973b57...8e4c63 )

unknown
created 2020-06-18 16:20 UTC
DeliveryPostageEvent::setMaximumDeliveryDate() A

↳ Parent: DeliveryPostageEvent
Complexity

Conditions	1
Paths	1
Size

Total Lines	4
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	2
c	0
b	0
f	0
dl	0
loc	4
rs	10
cc	1
nc	1
nop	1
<?php
/*************************************************************************************/
/*      This file is part of the Thelia package.                                     */
/*                                                                                   */
/*      Copyright (c) OpenStudio                                                     */
/*      email : [email protected]                                                       */
/*      web : http://www.thelia.net                                                  */
/*                                                                                   */
/*      For the full copyright and license information, please view the LICENSE.txt  */
/*      file that was distributed with this source code.                             */
/*************************************************************************************/


namespace Thelia\Core\Event\Delivery;

use Thelia\Core\Event\ActionEvent;
use Thelia\Core\Translation\Translator;
use Thelia\Model\Address;
use Thelia\Model\Cart;
use Thelia\Model\Country;
use Thelia\Model\OrderPostage;
use Thelia\Model\State;
use Thelia\Module\DeliveryModuleInterface;

/**
 * Class DeliveryPostageEvent
 * @package Thelia\Core\Event\Delivery
 * @author Julien Chanséaume <[email protected]>
 */
class DeliveryPostageEvent extends ActionEvent
{
    /** @var AbstractDeliveryModule */
filter:
    dependency_paths: ["lib/*"]
    protected $module = null;

    /** @var Cart */
    protected $cart = null;

    /** @var Address */
    protected $address = null;

    /** @var Country */
    protected $country = null;

    /** @var State */
    protected $state = null;

    /** @var bool */
    protected $validModule = false;

    /** @var OrderPostage|null */
    protected $postage = null;

    /**
     * @deprecated deprecated since version 2.4.1 use min and max deliver date instead
     * @var \DateTime|null
     */
    protected $deliveryDate = null;

    /**
     * @var \DateTime|null
     */
    protected $minimumDeliveryDate = null;

    /**
     * @var \DateTime|null
     */
    protected $maximumDeliveryDate = null;

    /**
     * @var string
     */
    protected $deliveryMode = null;

    /** @var array */
    protected $additionalData = [];

    /**
     * DeliveryPostageEvent constructor.
     * @param DeliveryModuleInterface $module
     * @param Country $country
     * @param Cart $cart
     * @param State $state
     */
    public function __construct(
        DeliveryModuleInterface $module,
        Cart $cart,
        Address $address = null,
        Country $country = null,
        State $state = null
    ) {
        $this->module = $module;

        $this->cart = $cart;
        $this->address = $address;
        $this->country = $country;
        $this->state = $state;
    }

    /**
     * @return Cart
     */
    public function getCart()
    {
        return $this->cart;
    }

    /**
     * @param Cart $cart
     */
    public function setCart($cart)
    {
        $this->cart = $cart;
        return $this;
    }

    /**
     * @return Address
     */
    public function getAddress()
    {
        return $this->address;
    }

    /**
     * @param Address $address
     */
    public function setAddress($address)
    {
        $this->address = $address;
        return $this;
    }

    /**
     * @deprecated deprecated since version 2.4.1 use min and max deliver date instead
     * @return \DateTime|null
     */
    public function getDeliveryDate()
    {
        return $this->deliveryDate;
        return /** @scrutinizer ignore-deprecated */ $this->deliveryDate;
    }

    /**
     * @deprecated deprecated since version 2.4.1 use min and max deliver date instead
     * @param \DateTime|null $deliveryDate
     */
    public function setDeliveryDate($deliveryDate)
    {
        $this->deliveryDate = $deliveryDate;
        /** @scrutinizer ignore-deprecated */ $this->deliveryDate = $deliveryDate;
        return $this;
    }

    /**
     * @return AbstractDeliveryModule
     */
    public function getModule()
    {
        return $this->module;
    }

    /**
     * @param AbstractDeliveryModule $module
     */
    public function setModule($module)
    {
        $this->module = $module;
        return $this;
    }

    /**
     * @return null|OrderPostage
     */
    public function getPostage()
    {
        return $this->postage;
    }

    /**
     * @param null|double|OrderPostage $postage
     */
    public function setPostage($postage)
    {
        $this->postage = OrderPostage::loadFromPostage($postage);
        return $this;
    }

    /**
     * @return boolean
     */
    public function isValidModule()
    {
        return $this->validModule;
    }

    /**
     * @param boolean $validModule
     */
    public function setValidModule($validModule)
    {
        $this->validModule = $validModule;
        return $this;
    }

    /**
     * @return bool
     */
    public function hasAdditionalData()
    {
        return \count($this->additionalData) > 0;
    }

    /**
     * @return array
     */
    public function getAdditionalData()
    {
        return $this->additionalData;
    }

    /**
     * @param array $additionalData
     */
    public function setAdditionalData($additionalData)
    {
        $this->additionalData = $additionalData;
        return $this;
    }

    /**
     * @param string $key the key of the additional data
     * @param mixed $value the value of the additional data
     *
     * return $this
     */
    public function addAdditionalData($key, $value)
    {
        $this->additionalData[$key] = $value;

        return $this;
    }

    /**
     * @return Country|null
     */
    public function getCountry()
    {
        return $this->getAddress() !== null ? $this->getAddress()->getCountry() : $this->country;
    }

    /**
     * @return State|null
     */
    public function getState()
    {
        return $this->getAddress() !== null ? $this->getAddress()->getState() : $this->state;
    }

    /**
     * @return mixed
     */
    public function getDeliveryMode()
    {
        return $this->deliveryMode;
    }

    /**
     * @param mixed $deliveryMode
     *
     * @return DeliveryPostageEvent
     * @throws \Exception
     */
    public function setDeliveryMode($deliveryMode)
    {
        if (!in_array($deliveryMode, ['pickup', 'delivery'])) {
            throw new \Exception(Translator::getInstance()->trans('A delivery module can only de of type pickup or delivery'));
        }

        $this->deliveryMode = $deliveryMode;
        return $this;
    }

    /**
     * @return \DateTime|null
     */
    public function getMinimumDeliveryDate()
    {
        return $this->minimumDeliveryDate;
    }

    /**
     * @param \DateTime|null $minimumDeliveryDate
     *
     * @return DeliveryPostageEvent
     */
    public function setMinimumDeliveryDate($minimumDeliveryDate)
    {
        $this->minimumDeliveryDate = $minimumDeliveryDate;
        return $this;
    }

    /**
     * @return \DateTime|null
     */
    public function getMaximumDeliveryDate()
    {
        return $this->maximumDeliveryDate;
    }

    /**
     * @param \DateTime|null $maximumDeliveryDate
     *
     * @return DeliveryPostageEvent
     */
    public function setMaximumDeliveryDate($maximumDeliveryDate)
    {
        $this->maximumDeliveryDate = $maximumDeliveryDate;
        return $this;
    }
}

thelia / thelia

Push — master ( 973b57...8e4c63 )

DeliveryPostageEvent::setMaximumDeliveryDate() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
