class StockLevelProcessor in Commerce Stock 8

Processor used by the StockLevel field.

Hierarchy

• class \Drupal\Core\TypedData\TypedData implements PluginInspectionInterface, TypedDataInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
  • class \Drupal\commerce_stock_field\StockLevelProcessor

File

modules/field/src/StockLevelProcessor.php, line 10

Namespace

Drupal\commerce_stock_field

class StockLevelProcessor extends TypedData {

  /**
   * Whether the stock level have already been computed or not.
   *
   * @var bool
   */
  protected $valueComputed = FALSE;

  /**
   * Cached processed level.
   *
   * @var float|null
   */
  protected $processedLevel = NULL;

  /**
   * {@inheritdoc}
   */
  public function getValue() {
    $this
      ->ensureComputedValue();
    return $this->processedLevel;
  }

  /**
   * {@inheritdoc}
   */
  public function setValue($value, $notify = TRUE) {
    if (is_null($value)) {
      return;
    }
    $this->processedLevel = $value;

    // Make sure that subsequent getter calls do not try to compute the
    // stock level again.
    $this->valueComputed = TRUE;
  }

  /**
   * Get the current stock level.
   */
  protected function computeValue() {
    $entity = $this
      ->getParent()
      ->getEntity();

    /** @var \Drupal\commerce_stock\StockServiceManager $stockServiceManager */
    $stockServiceManager = \Drupal::service('commerce_stock.service_manager');
    $level = $stockServiceManager
      ->getStockLevel($entity);
    $this->processedLevel = $level;
  }

  /**
   * Ensures that the stock level is only computed once.
   */
  protected function ensureComputedValue() {
    if ($this->valueComputed === FALSE) {
      $this
        ->computeValue();
      $this->valueComputed = TRUE;
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
StockLevelProcessor::$processedLevel	protected	property	Cached processed level.
StockLevelProcessor::$valueComputed	protected	property	Whether the stock level have already been computed or not.
StockLevelProcessor::computeValue	protected	function	Get the current stock level.
StockLevelProcessor::ensureComputedValue	protected	function	Ensures that the stock level is only computed once.
StockLevelProcessor::getValue	public	function	Gets the data value. Overrides TypedData::getValue
StockLevelProcessor::setValue	public	function	Sets the data value. Overrides TypedData::setValue
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
TypedData::$definition	protected	property	The data definition.	1
TypedData::$name	protected	property	The property name.
TypedData::$parent	protected	property	The parent typed data object.
TypedData::applyDefaultValue	public	function	Applies the default value. Overrides TypedDataInterface::applyDefaultValue	3
TypedData::createInstance	public static	function	Constructs a TypedData object given its definition and context. Overrides TypedDataInterface::createInstance
TypedData::getConstraints	public	function	Gets a list of validation constraints. Overrides TypedDataInterface::getConstraints	9
TypedData::getDataDefinition	public	function	Gets the data definition. Overrides TypedDataInterface::getDataDefinition
TypedData::getName	public	function	Returns the name of a property or item. Overrides TypedDataInterface::getName
TypedData::getParent	public	function	Returns the parent data structure; i.e. either complex data or a list. Overrides TypedDataInterface::getParent
TypedData::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
TypedData::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
TypedData::getPropertyPath	public	function	Returns the property path of the data. Overrides TypedDataInterface::getPropertyPath
TypedData::getRoot	public	function	Returns the root of the typed data tree. Overrides TypedDataInterface::getRoot
TypedData::getString	public	function	Returns a string representation of the data. Overrides TypedDataInterface::getString	6
TypedData::setContext	public	function	Sets the context of a property or item via a context aware parent. Overrides TypedDataInterface::setContext
TypedData::validate	public	function	Validates the currently set data value. Overrides TypedDataInterface::validate
TypedData::__construct	public	function	Constructs a TypedData object given its definition and context.	3
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager	public	function	Gets the typed data manager.	2
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	2