src/Model/Shop/Ticket/TicketProduct.php line 43

Open in your IDE?
  1. <?php
  3. /**
  4.  * Created by Elements.at New Media Solutions GmbH
  5.  *
  6.  */
  8. namespace App\Model\Shop\Ticket;
  10. use App\Model\Shop\CancelableInterface;
  11. use App\Model\Shop\OrderItem;
  12. use App\Model\Traits\SkidataTrait;
  13. use App\Model\Type\ForwardingStateType;
  14. use App\Model\Type\PoolType;
  15. use App\Model\Type\TenantType;
  16. use Carbon\Carbon;
  17. use Elements\Bundle\SkidataTicketingSwebBundle\Model\Constant\ValidityUnit;
  18. use Elements\Bundle\SkidataTicketingSwebBundle\Skidata\Sweb\Client\SalesChannel\Enum\PermissionStatusEnum;
  19. use Elements\Bundle\SkidataTicketingSwebBundle\Skidata\Sweb\Client\SalesChannel\Enum\SalesStatusEnum;
  20. use Elements\Bundle\TicketShopFrameworkBundle\Model\DataObject\PriceGroupInterface;
  21. use Elements\Bundle\TicketShopFrameworkBundle\Model\DataObject\TicketProduct as TSF_TicketProduct;
  22. use Elements\Bundle\TicketShopFrameworkBundle\Model\Shop\Product\PriceGroupAwareProduct;
  23. use Pimcore;
  24. use Pimcore\Logger;
  25. use Pimcore\Model\DataObject\Objectbrick\Data\TpB2bArData;
  26. use Pimcore\Model\DataObject\Objectbrick\Data\TpMarketplaceArData;
  27. use Pimcore\Model\DataObject\Objectbrick\Data\TpTradeArData;
  28. use Pimcore\Model\DataObject\TicketMetaProduct;
  29. use Pimcore\Model\DataObject\TicketshopTicketAdditional;
  30. use Throwable;
  32. /**
  33.  * Class TicketProduct
  34.  *
  35.  * @package App\Model\Shop\Ticketing
  36.  *
  37.  * @method TicketConsumerCategory|null getTicketConsumerCategory()
  38.  * @method ShopTicketCatalog|null getCatalogObject()
  39.  * @method TicketProduct getReference()
  40.  * @method TicketConsumerCategory[]|null getConsumerCategories()
  41.  *
  42.  */
  43. class TicketProduct extends TSF_TicketProduct implements CancelableInterface
  44. {
  45.     use SkidataTrait;
  47.     const PRODUCT_TYPE = 'ticket';
  49.     const SHOP_SYSTEM_NAME = 'ticket';
  51.     protected function getShopSystemName(): string
  52.     {
  53.         return TicketProduct::SHOP_SYSTEM_NAME;
  54.     }
  56.     /**
  57.      * defines the name of the price system for this product.
  58.      * there should either be a attribute in pro product object or
  59.      * it should be overwritten in mapped sub classes of product classes
  60.      *
  61.      * @return string
  62.      */
  63.     public function getPriceSystemName(): ?string
  64.     {
  65.         return $this->getShopSystemName();
  66.     }
  68.     /**
  69.      * defines the name of the availability system for this product.
  70.      * there should either be a attribute in pro product object or
  71.      * it should be overwritten in mapped sub classes of product classes
  72.      *
  73.      * @return string
  74.      */
  75.     public function getAvailabilitySystemName(): ?string
  76.     {
  77.         return 'default';
  78.     }
  80.     public function getOrderCatalog(): ?ShopTicketCatalog
  81.     {
  82.         // load unpublished objects too to display catalog infos in backend attask #419238 - storno-thema
  83.         Pimcore\Model\DataObject\AbstractObject::setHideUnpublished(false);
  84.         $orderCatalog = $this->getCatalogObject();
  85.         Pimcore\Model\DataObject\AbstractObject::setHideUnpublished(true);
  87.         return $orderCatalog;
  88.     }
  90.     /**
  91.      * Checks if TicketProduct is bookable
  92.      */
  93.     public function isBookable(int $quantity = 1): bool
  94.     {
  95.         if (!\Pimcore::inDebugMode() && $this->deactivateSkidataRequests()) {
  96.             return false;
  97.         }
  99.         $skidataProduct = $this->getSkidataProduct();
  100.         if (null === $skidataProduct) {
  101.             return false;
  102.         }
  104.         if ($this->getOnlyToday()) {
  105.             if (Carbon::now()->lt(Carbon::now()->setTime(12, 10, 0, 0))) {
  106.                 return false;
  107.             }
  108.         }
  110.         return $skidataProduct->getActive() && $this->getReference()->isPublished();
  111.     }
  113.     public function isSingleRide(): bool
  114.     {
  115.         return (bool)$this->getSingleRideTicket();
  116.     }
  118.     public function isCancelable(OrderItem $orderItem = null): bool
  119.     {
  120.         if ($orderItem) {
  121.             $currentAdminUser = \Pimcore\Tool\Admin::getCurrentUser();
  122.             $skidataBrick = $orderItem->getSkidataBrick();
  123.             // can not cancel if cancelled in Skidata - except for special users
  124.             if ($orderItem->isCanceledInSkidata() && !$currentAdminUser?->isAllowed('shop_backend_cancel_cancelled_in_skidata')) {
  125.                 return false;
  126.             }
  127.             // can cancel always if not submitted !
  128.             if (!$skidataBrick || $skidataBrick->getTransmisssionState() == ForwardingStateType::ERROR || $skidataBrick->getTransmisssionState() == null) {
  129.                 return true;
  130.             }
  132.             if (!$this->isCancelableInSkidata($orderItem)) {
  133.                 return false;
  134.             }
  136.             if (!$this->isSeasonTicket()) {
  137.                 if ($validityBrick = $orderItem->getCustomized()->getOrderItemCustomizedValidityRange()) {
  138.                     // do not allow cancellation in between validity -> enhance to allow until 7 o clock if needed
  139.                     // this logic shouldn't be applied for seasonal tickets (attask #414766)
  140.                     // Root Cause for this: the Consumed State is only synced once a day ( at around 23:50)  so we can not rely on that -> hence  during validity cancellation is locked -> if not consumed it can be cancelled after validity again.
  141.                     if (Carbon::now()->between($validityBrick->getStartDate(), $validityBrick->getEndDate())) {
  142.                         return false;
  143.                     }
  144.                 }
  145.             }
  146.         }
  148.         return true;
  149.     }
  151.     public function isCancelableInSkidata(OrderItem $orderItem): bool
  152.     {
  153.         $skidataBrick = $orderItem->getSkidataBrick();
  155.         if ($skidataBrick) {
  156.             /**
  157.              * Ein "TicketOrderItem" ist stornierbar falls sämtliche TicketItems:
  158.              * 1.) die Permission noch nicht "consumed" ist
  159.              * 2.) das TicketItem selbst stornierbar ist, entspricht folgendener Abfrage
  160.              * Booked ( BOOKED oder BOOKED_AND_REJECTED oder  BOOKED_AND_TRANSFERRED )
  161.              * ! reserved => wieder stornierbar ( #642504 / #624984)
  162.              *
  163.              * wenn bereits in Skidata storniert => cancel im Pimcore erlaubt (Pimcore-Storno, Rückerstattung datatrans)
  164.              */
  165.             $salesStatus = $skidataBrick->getSkiDataSalesStatus();
  166.             $cancelableSalesStates = array_merge(SalesStatusEnum::getBookedSalesStates(), SalesStatusEnum::getCanceledSalesStates());
  168.             $cancelableSalesStates[] = SalesStatusEnum::Reserved;
  169.             if (!in_array($salesStatus, $cancelableSalesStates)) {
  170.                 return false;
  171.             }
  173.             $permissionStatus = $skidataBrick->getSkiDataPermissionStatus();
  175.             // not cancelable anymore if they are on this  states !
  176.             if (in_array($permissionStatus, [PermissionStatusEnum::Consumed, PermissionStatusEnum::Blocked])) {
  177.                 return false;
  178.             }
  180.             if ($skidataBrick->getSkiDataPermissionConsumed()) {
  181.                 return false;
  182.             }
  183.         }
  185.         return true;
  186.     }
  188.     public function getMetaProduct(): TicketMetaProduct|false
  189.     {
  190.         $listing = new TicketMetaProduct\Listing();
  191.         $listing->addConditionParam("find_in_set({$this->getId()}, relatedTo)");
  193.         return $listing->current();
  194.     }
  196.     public function getInsuranceMetaProduct(): TicketshopTicketAdditional|false
  197.     {
  198.         $listing = new TicketshopTicketAdditional\Listing();
  199.         $listing->addConditionParam("find_in_set({$this->getId()}, products)");
  201.         return $listing->current();
  202.     }
  204.     /**
  205.      * @param Carbon|null $startDate
  206.      *
  207.      * @return Carbon|null
  208.      */
  209.     public function getTicketEndDate(Carbon $startDate = null): ?Carbon
  210.     {
  211.         $duration = null;
  212.         $catalog = $this->getCatalogObject();
  214.         if ($startDate == null) {
  215.             $startDate = $this->getTicketStartDate();
  216.         }
  218.         if ($catalog && $catalog->getIsAnnualCatalog()) {
  219.             $yearlyDate = clone $startDate;
  221.             return $yearlyDate->addYear();
  222.         } elseif ($this->isSeasonTicket() && $catalog) {
  223.             return $catalog->getCurrentDateRangeEndDate();
  224.         }
  226.         if ($this->getValidityUnit() == ValidityUnit::DAY) {
  227.             $duration = $this->getValidityValue() - 1; // substract 1 as we use StartOfDay and EndOfDay hence 1 Day is always on the same days
  228.         } else {
  229.             //todo - Saisonkarten, Punktekarten? Stundenkarten?
  230.         }
  231.         //  sanity checks that it is at least 0 !! no negative numbers
  232.         if ($duration < 0) {
  233.             $duration = 0;
  234.         }
  236.         return $startDate ? $startDate->copy()->addDays($duration)->endOfDay() : null;
  237.     }
  239.     public function isSkidataBookableFor(TicketConsumerCategory $consumerCategory): bool
  240.     {
  241.         if ($this->getSkidataProduct() && !empty($this->getSkidataProduct()->getConsumerCategories())) {
  242.             $skidataConsumer = $consumerCategory->getSkidataConsumerForSkidataProduct($this->getSkidataProduct());
  243.             if ($skidataConsumer) {
  244.                 return true;
  245.             }
  247.         }
  249.         return false;
  250.     }
  252.     public function getTicketPool(): string
  253.     {
  255.         $skiDataProduct = $this->getReference()->getSkidataProduct();
  256.         if ($skiDataProduct == null) {
  257.             return PoolType::UNASSIGNED;
  258.         }
  259.         $pool = $skiDataProduct->getValidPoolName() ?? PoolType::UNASSIGNED;
  260.         if (!PoolType::isValid($pool)) {
  261.             $pool = PoolType::UNKNOWN;
  263.         }
  265.         return $pool;
  266.     }
  268.     public function getOrCreateCloneWithPriceGroup(PriceGroupInterface $priceGroup): PriceGroupAwareProduct
  269.     {
  270.         if (!$priceGroup instanceof TicketConsumerCategory) {
  271.             throw new \InvalidArgumentException('PriceGroup must be instance of TicketConsumerCategory');
  272.         }
  274.         /** @phpstan-ignore-next-line */
  275.         return $this->getReference()->getOrCreateOrderableObject($priceGroup,
  276.             $this->getTicketStartDate(),
  277.             $this->getAcquisitionType(),
  278.             $this->getCatalogObject());
  279.     }
  281.     public function getAllowedAcquisitionTypes()
  282.     {
  283.         return $this->getSpecialDataForTenant('getAllowedAcquisitionTypes');
  284.     }
  286.     public function getRequiresAuthorization()
  287.     {
  288.         return $this->getSpecialDataForTenant('getRequiresAuthorization');
  289.     }
  291.     public function getDefaultAcquisitionType()
  292.     {
  293.         return $this->getSpecialDataForTenant('getDefaultAcquisitionType');
  294.     }
  296.     public function getIsDepotTicket()
  297.     {
  298.         return $this->getSpecialDataForTenant('getIsDepotTicket');
  299.     }
  301.     public function getBirthdayRequired()
  302.     {
  303.         return $this->getSpecialDataForTenant('getBirthdayRequired');
  304.     }
  306.     public function getRequirementsPerConsumerCategory()
  307.     {
  308.         return $this->getSpecialDataForTenant('getRequirementsPerConsumerCategory');
  309.     }
  311.     public function getAcquisitionType(): ?string
  312.     {
  313.         return $this->getSpecialDataForTenant('getAcquisitionType');
  314.     }
  316.     public function getRequirements(): ?array
  317.     {
  318.         return $this->getSpecialDataForTenant('getRequirements');
  319.     }
  321.     public function getOrCreateTpTradeArDataBrick(): TpTradeArData
  322.     {
  323.         $brick = $this->getAcquisitionRequirementsOverride();
  324.         if (!$data = $brick->getTpTradeArData()) {
  325.             $data = new TpTradeArData($this);
  326.             $data->setFieldname('acquisitionRequirementsOverride');
  327.             $brick->setTpTradeArData($data);
  328.         }
  330.         return $data;
  331.     }
  333.     public function getOrCreateTpMarketplaceArDataBrick(): TpMarketplaceArData
  334.     {
  335.         $brick = $this->getAcquisitionRequirementsOverride();
  336.         if (!$data = $brick->getTpMarketplaceArData()) {
  337.             $data = new TpMarketplaceArData($this);
  338.             $data->setFieldname('acquisitionRequirementsOverride');
  339.             $brick->setTpMarketplaceArData($data);
  340.         }
  342.         return $data;
  343.     }
  345.     public function getOrCreateTpB2bArDataBrick(): TpB2bArData
  346.     {
  347.         $brick = $this->getAcquisitionRequirementsOverride();
  348.         if (!$data = $brick->getTpB2bArData()) {
  349.             $data = new TpB2bArData($this);
  350.             $data->setFieldname('acquisitionRequirementsOverride');
  351.             $brick->setTpB2bArData($data);
  352.         }
  354.         return $data;
  355.     }
  357.     private function getSpecialDataForTenant(string $name): mixed
  358.     {
  359.         try {
  360.             if (!\Pimcore::inAdmin()) {
  361.                 $factory = Pimcore\Bundle\EcommerceFrameworkBundle\Factory::getInstance();
  362.                 if ($factory->getEnvironment()->getCurrentCheckoutTenant() === TenantType::TOUR_OPERATOR) {
  363.                     if ($data = $this->getOrCreateTpTradeArDataBrick()->$name()) {
  364.                         return $data;
  365.                     }
  366.                 }
  368.                 if ($factory->getEnvironment()->getCurrentCheckoutTenant() === TenantType::B2B) {
  369.                     if ($data = $this->getOrCreateTpB2bArDataBrick()->$name()) {
  370.                         return $data;
  371.                     }
  372.                 }
  374.                 if ($factory->getEnvironment()->getCurrentCheckoutTenant() === TenantType::MARKETPLACE) {
  375.                     if ($data = $this->getOrCreateTpMarketplaceArDataBrick()->$name()) {
  376.                         return $data;
  377.                     }
  378.                 }
  379.             }
  380.         } catch (Throwable $e) {
  381.             Logger::error($e);
  382.         }
  384.         return parent::$name();
  385.     }
  386. }