Current File : /var/www/vinorea/src/Core/Domain/CatalogPriceRule/Command/AddCatalogPriceRuleCommand.php |
<?php
/**
* Copyright since 2007 PrestaShop SA and Contributors
* PrestaShop is an International Registered Trademark & Property of PrestaShop SA
*
* NOTICE OF LICENSE
*
* This source file is subject to the Open Software License (OSL 3.0)
* that is bundled with this package in the file LICENSE.md.
* It is also available through the world-wide-web at this URL:
* https://opensource.org/licenses/OSL-3.0
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to license@prestashop.com so we can send you a copy immediately.
*
* DISCLAIMER
*
* Do not edit or add to this file if you wish to upgrade PrestaShop to newer
* versions in the future. If you wish to customize PrestaShop for your
* needs please refer to https://devdocs.prestashop.com/ for more information.
*
* @author PrestaShop SA and Contributors <contact@prestashop.com>
* @copyright Since 2007 PrestaShop SA and Contributors
* @license https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
*/
namespace PrestaShop\PrestaShop\Core\Domain\CatalogPriceRule\Command;
use DateTime;
use Exception;
use PrestaShop\Decimal\DecimalNumber;
use PrestaShop\PrestaShop\Core\Domain\CatalogPriceRule\Exception\CatalogPriceRuleConstraintException;
use PrestaShop\PrestaShop\Core\Domain\Exception\DomainConstraintException;
use PrestaShop\PrestaShop\Core\Domain\ValueObject\Reduction;
/**
* Adds new catalog price rule with provided data
*/
class AddCatalogPriceRuleCommand
{
/**
* @var string
*/
private $name;
/**
* @var int
*/
private $shopId;
/**
* @var int
*/
private $currencyId;
/**
* @var int
*/
private $countryId;
/**
* @var int
*/
private $groupId;
/**
* @var int
*/
private $fromQuantity;
/**
* @var Reduction
*/
private $reduction;
/**
* @var bool
*/
private $includeTax;
/**
* @var DecimalNumber
*/
private $price;
/**
* @var DateTime|null
*/
private $dateTimeFrom;
/**
* @var DateTime|null
*/
private $dateTimeTo;
/**
* @param string $name
* @param int $currencyId
* @param int $countryId
* @param int $groupId
* @param int $fromQuantity
* @param string $reductionType
* @param string $reductionValue
* @param int $shopId
* @param bool $includeTax
* @param float $price
*
* @throws DomainConstraintException
*/
public function __construct(
string $name,
int $currencyId,
int $countryId,
int $groupId,
int $fromQuantity,
string $reductionType,
string $reductionValue,
int $shopId,
bool $includeTax,
float $price
) {
$this->name = $name;
$this->currencyId = $currencyId;
$this->countryId = $countryId;
$this->groupId = $groupId;
$this->fromQuantity = $fromQuantity;
$this->reduction = new Reduction($reductionType, $reductionValue);
$this->shopId = $shopId;
$this->price = new DecimalNumber((string) $price);
$this->includeTax = $includeTax;
}
/**
* @return string
*/
public function getName(): string
{
return $this->name;
}
/**
* @return int
*/
public function getShopId(): int
{
return $this->shopId;
}
/**
* @return int
*/
public function getCurrencyId(): int
{
return $this->currencyId;
}
/**
* @return int
*/
public function getCountryId(): int
{
return $this->countryId;
}
/**
* @return int
*/
public function getGroupId(): int
{
return $this->groupId;
}
/**
* @return int
*/
public function getFromQuantity(): int
{
return $this->fromQuantity;
}
/**
* @return Reduction
*/
public function getReduction(): Reduction
{
return $this->reduction;
}
/**
* @return DecimalNumber
*/
public function getPrice(): DecimalNumber
{
return $this->price;
}
/**
* @return DateTime|null
*/
public function getDateTimeFrom(): ?DateTime
{
return $this->dateTimeFrom;
}
/**
* @return DateTime|null
*/
public function getDateTimeTo(): ?DateTime
{
return $this->dateTimeTo;
}
/**
* @return bool
*/
public function isTaxIncluded(): bool
{
return $this->includeTax;
}
/**
* @param string $dateTimeFrom
*
* @throws CatalogPriceRuleConstraintException
*/
public function setDateTimeFrom(string $dateTimeFrom)
{
$this->dateTimeFrom = $this->createDateTime($dateTimeFrom);
}
/**
* @param string $dateTimeTo
*
* @throws CatalogPriceRuleConstraintException
*/
public function setDateTimeTo(string $dateTimeTo)
{
$this->dateTimeTo = $this->createDateTime($dateTimeTo);
}
/**
* @param string $dateTime
*
* @return DateTime
*
* @throws CatalogPriceRuleConstraintException
*/
private function createDateTime(string $dateTime): DateTime
{
try {
return new DateTime($dateTime);
} catch (Exception $e) {
throw new CatalogPriceRuleConstraintException('An error occured when creating DateTime object for catalog price rule', CatalogPriceRuleConstraintException::INVALID_DATETIME, $e);
}
}
}