| Current File : //var/www/prestashop/src/Core/Domain/Product/Stock/Command/UpdateProductStockInformationCommand.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)
*/
declare(strict_types=1);
namespace PrestaShop\PrestaShop\Core\Domain\Product\Stock\Command;
use DateTimeInterface;
use PrestaShop\PrestaShop\Core\Domain\Product\Pack\Exception\ProductPackConstraintException;
use PrestaShop\PrestaShop\Core\Domain\Product\Pack\ValueObject\PackStockType;
use PrestaShop\PrestaShop\Core\Domain\Product\Stock\Exception\ProductStockConstraintException;
use PrestaShop\PrestaShop\Core\Domain\Product\Stock\ValueObject\OutOfStockType;
use PrestaShop\PrestaShop\Core\Domain\Product\ValueObject\ProductId;
use PrestaShop\PrestaShop\Core\Domain\Shop\ValueObject\ShopConstraint;
/**
* Class UpdateProductStockInformationCommand update a given product stock
*/
class UpdateProductStockInformationCommand
{
/**
* @var ProductId
*/
private $productId;
/**
* @var PackStockType|null
*/
private $packStockType;
/**
* @var int|null
*/
private $deltaQuantity;
/**
* @var OutOfStockType|null
*/
private $outOfStockType;
/**
* @var int|null
*/
private $minimalQuantity;
/**
* @var string|null
*/
private $location;
/**
* @var int|null
*/
private $lowStockThreshold;
/**
* @var bool|null
*/
private $lowStockAlertEnabled;
/**
* @var string[]|null key value pairs where key is the id of language
*/
private $localizedAvailableNowLabels;
/**
* @var string[]|null key value pairs where key is the id of language
*/
private $localizedAvailableLaterLabels;
/**
* @var DateTimeInterface|null
*/
private $availableDate;
/**
* @var ShopConstraint
*/
private $shopConstraint;
/**
* @param int $productId
* @param ShopConstraint $shopConstraint
*/
public function __construct(
int $productId,
ShopConstraint $shopConstraint
) {
$this->productId = new ProductId($productId);
$this->shopConstraint = $shopConstraint;
}
/**
* @return ProductId
*/
public function getProductId(): ProductId
{
return $this->productId;
}
/**
* @return ShopConstraint
*/
public function getShopConstraint(): ShopConstraint
{
return $this->shopConstraint;
}
/**
* @return PackStockType|null
*/
public function getPackStockType(): ?PackStockType
{
return $this->packStockType;
}
/**
* @param int $packStockType
*
* @return UpdateProductStockInformationCommand
*
* @throws ProductPackConstraintException
*/
public function setPackStockType(int $packStockType): UpdateProductStockInformationCommand
{
$this->packStockType = new PackStockType($packStockType);
return $this;
}
/**
* @return int|null
*/
public function getDeltaQuantity(): ?int
{
return $this->deltaQuantity;
}
/**
* @param int $deltaQuantity
*
* @return UpdateProductStockInformationCommand
*/
public function setDeltaQuantity(int $deltaQuantity): UpdateProductStockInformationCommand
{
$this->deltaQuantity = $deltaQuantity;
return $this;
}
/**
* @return OutOfStockType|null
*/
public function getOutOfStockType(): ?OutOfStockType
{
return $this->outOfStockType;
}
/**
* @param int $outOfStockType
*
* @return $this
*
* @throws ProductStockConstraintException
*/
public function setOutOfStockType(int $outOfStockType): UpdateProductStockInformationCommand
{
$this->outOfStockType = new OutOfStockType($outOfStockType);
return $this;
}
/**
* @return int|null
*/
public function getMinimalQuantity(): ?int
{
return $this->minimalQuantity;
}
/**
* @param int $minimalQuantity
*
* @return UpdateProductStockInformationCommand
*/
public function setMinimalQuantity(int $minimalQuantity): UpdateProductStockInformationCommand
{
$this->minimalQuantity = $minimalQuantity;
return $this;
}
/**
* @return string|null
*/
public function getLocation(): ?string
{
return $this->location;
}
/**
* @param string $location
*
* @return UpdateProductStockInformationCommand
*/
public function setLocation(string $location): UpdateProductStockInformationCommand
{
$this->location = $location;
return $this;
}
/**
* @return int|null
*/
public function getLowStockThreshold(): ?int
{
return $this->lowStockThreshold;
}
/**
* @param int $lowStockThreshold
*
* @return UpdateProductStockInformationCommand
*/
public function setLowStockThreshold(int $lowStockThreshold): UpdateProductStockInformationCommand
{
$this->lowStockThreshold = $lowStockThreshold;
return $this;
}
/**
* @return bool|null
*/
public function isLowStockAlertEnabled(): ?bool
{
return $this->lowStockAlertEnabled;
}
/**
* @param bool $enabled
*
* @return UpdateProductStockInformationCommand
*/
public function setLowStockAlert(bool $enabled): UpdateProductStockInformationCommand
{
$this->lowStockAlertEnabled = $enabled;
return $this;
}
/**
* @return string[]|null
*/
public function getLocalizedAvailableNowLabels(): ?array
{
return $this->localizedAvailableNowLabels;
}
/**
* @param string[] $localizedAvailableNowLabels
*
* @return UpdateProductStockInformationCommand
*/
public function setLocalizedAvailableNowLabels(array $localizedAvailableNowLabels): UpdateProductStockInformationCommand
{
$this->localizedAvailableNowLabels = $localizedAvailableNowLabels;
return $this;
}
/**
* @return string[]|null
*/
public function getLocalizedAvailableLaterLabels(): ?array
{
return $this->localizedAvailableLaterLabels;
}
/**
* @param string[] $localizedAvailableLaterLabels
*
* @return UpdateProductStockInformationCommand
*/
public function setLocalizedAvailableLaterLabels(array $localizedAvailableLaterLabels): UpdateProductStockInformationCommand
{
$this->localizedAvailableLaterLabels = $localizedAvailableLaterLabels;
return $this;
}
/**
* @return DateTimeInterface|null
*/
public function getAvailableDate(): ?DateTimeInterface
{
return $this->availableDate;
}
/**
* @param DateTimeInterface $availableDate
*
* @return UpdateProductStockInformationCommand
*/
public function setAvailableDate(DateTimeInterface $availableDate): UpdateProductStockInformationCommand
{
$this->availableDate = $availableDate;
return $this;
}
}