Symfony Profiler

<?php
/**
* Pimcore
*
* This source file is available under two different licenses:
* - GNU General Public License version 3 (GPLv3)
* - Pimcore Commercial License (PCL)
* Full copyright and license information is available in
* LICENSE.md which is distributed with this source code.
*
* @copyright Copyright (c) Pimcore GmbH (http://www.pimcore.org)
* @license http://www.pimcore.org/license GPLv3 and PCL
*/
namespace Pimcore\Bundle\EcommerceFrameworkBundle\Model;
use Pimcore\Bundle\EcommerceFrameworkBundle\AvailabilitySystem\AvailabilityInterface;
use Pimcore\Bundle\EcommerceFrameworkBundle\AvailabilitySystem\AvailabilitySystemInterface;
use Pimcore\Bundle\EcommerceFrameworkBundle\Exception\UnsupportedException;
use Pimcore\Bundle\EcommerceFrameworkBundle\Factory;
use Pimcore\Bundle\EcommerceFrameworkBundle\PriceSystem\PriceInfoInterface;
use Pimcore\Bundle\EcommerceFrameworkBundle\PriceSystem\PriceInterface;
use Pimcore\Bundle\EcommerceFrameworkBundle\PriceSystem\PriceSystemInterface;
use Pimcore\Model\DataObject\Concrete;
/**
* Abstract base class for pimcore objects who should be used as products in the online shop framework
*/
class AbstractProduct extends Concrete implements ProductInterface, IndexableInterface, CheckoutableInterface
{
// =============================================
// IndexableInterface Methods
// =============================================
/**
* defines if product is included into the product index. If false, product doesn't appear in product index.
*
* @return bool
*/
public function getOSDoIndexProduct(): bool
{
return true;
}
/**
* returns if product is active.
* there should either be a attribute in pro product object or
* it should be overwritten in mapped sub classes of product classes in case of multiple criteria for product active state
*
* @param bool $inProductList
*
* @throws UnsupportedException
*
* @return bool
*/
public function isActive(bool $inProductList = false): bool
{
throw new UnsupportedException('isActive is not supported for ' . get_class($this));
}
/**
* defines the name of the price system for this product.
* there should either be a attribute in pro product object or
* it should be overwritten in mapped sub classes of product classes
*
* @throws UnsupportedException
*
* @return string|null
*/
public function getPriceSystemName(): ?string
{
throw new UnsupportedException('getPriceSystemName is not supported for ' . get_class($this));
}
/**
* returns product type for product index (either object or variant).
* by default it returns type of object, but it may be overwritten if necessary.
*
* @return string|null
*/
public function getOSIndexType(): ?string
{
return $this->getType();
}
/**
* returns parent id for product index.
* by default it returns id of parent object, but it may be overwritten if necessary.
*
* @return int|null
*/
public function getOSParentId()
{
return $this->getParentId();
}
/**
* returns array of categories.
* has to be overwritten either in pimcore object or mapped sub class.
*
* @throws UnsupportedException
*
* @return array|null
*/
public function getCategories(): ?array
{
throw new UnsupportedException('getCategories is not supported for ' . get_class($this));
}
// =============================================
// CheckoutableInterface Methods
// =============================================
/**
* called by default CommitOrderProcessor to get the product name to store it in the order item
* should be overwritten in mapped sub classes of product classes
*
* @throws UnsupportedException
*
* @return string|null
*/
public function getOSName(): ?string
{
throw new UnsupportedException('getOSName is not supported for ' . get_class($this));
}
/**
* called by default CommitOrderProcessor to get the product number to store it in the order item
* should be overwritten in mapped sub classes of product classes
*
* @throws UnsupportedException
*
* @return string|null
*/
public function getOSProductNumber(): ?string
{
throw new UnsupportedException('getOSProductNumber is not supported for ' . get_class($this));
}
/**
* defines the name of the availability system for this product.
* there should either be a attribute in pro product object or
* it should be overwritten in mapped sub classes of product classes
*
* @return string|null
*/
public function getAvailabilitySystemName(): ?string
{
return 'default';
}
/**
* checks if product is bookable
* default implementation checks if there is a price available and of the product is active.
* may be overwritten in subclasses for additional logic
*
* @param int $quantityScale
*
* @return bool
*/
public function getOSIsBookable($quantityScale = 1): bool
{
$price = $this->getOSPrice($quantityScale);
return !empty($price) && $this->isActive();
}
/**
* returns instance of price system implementation based on result of getPriceSystemName()
*
* @return PriceSystemInterface|null
*/
public function getPriceSystemImplementation(): ?PriceSystemInterface
{
return Factory::getInstance()->getPriceSystem($this->getPriceSystemName());
}
/**
* returns instance of availability system implementation based on result of getAvailabilitySystemName()
*
* @return AvailabilitySystemInterface|null
*/
public function getAvailabilitySystemImplementation(): ?AvailabilitySystemInterface
{
return Factory::getInstance()->getAvailabilitySystem($this->getAvailabilitySystemName());
}
/**
* returns price for given quantity scale
*
* @param int $quantityScale
*
* @return PriceInterface|null
*/
public function getOSPrice($quantityScale = 1): ?PriceInterface
{
return $this->getOSPriceInfo($quantityScale)->getPrice();
}
/**
* returns price info for given quantity scale.
* price info might contain price and additional information for prices like discounts, ...
*
* @param int $quantityScale
*
* @return PriceInfoInterface|null
*/
public function getOSPriceInfo($quantityScale = 1): ?PriceInfoInterface
{
return $this->getPriceSystemImplementation()->getPriceInfo($this, $quantityScale);
}
/**
* returns availability info based on given quantity
*
* @param int $quantity
*
* @return AvailabilityInterface|null
*/
public function getOSAvailabilityInfo($quantity = null): ?AvailabilityInterface
{
return $this->getAvailabilitySystemImplementation()->getAvailabilityInfo($this, $quantity);
}
}

vendor/pimcore/pimcore/bundles/EcommerceFrameworkBundle/Model/AbstractProduct.php line 196