final class AvailabilityResult in Commerce Core 8.2

Provides a value object representing the "availability" of an order item.

Hierarchy

• class \Drupal\commerce_order\AvailabilityResult

3 files declare their use of AvailabilityResult

AvailabilityManagerTest.php in modules/order/tests/src/Unit/AvailabilityManagerTest.php

PurchasedEntityConstraintValidatorTest.php in modules/order/tests/src/Kernel/PurchasedEntityConstraintValidatorTest.php

TestAvailabilityChecker.php in modules/order/tests/modules/commerce_order_test/src/TestAvailabilityChecker.php

File

modules/order/src/AvailabilityResult.php, line 10

Namespace

Drupal\commerce_order

final class AvailabilityResult {

  /**
   * The availability result.
   *
   * @var bool|null
   */
  protected $result;

  /**
   * The availability result "reason".
   *
   * @var string|null
   */
  protected $reason;

  /**
   * Constructs a new AvailabilityResult object.
   *
   * @param bool $result
   *   The availability result, FALSE when unavailable.
   * @param string $reason
   *   (optional) The reason why an order item is unavailable.
   */
  public function __construct($result, $reason = NULL) {
    assert(is_bool($result));
    assert(is_string($reason) || is_null($reason) || $reason instanceof MarkupInterface);
    $this->result = $result;
    $this->reason = $reason;
  }

  /**
   * Creates an availability result that is "neutral".
   *
   * @return static
   */
  public static function neutral() : AvailabilityResult {
    return new static(TRUE);
  }

  /**
   * Creates an availability result that is "unavailable".
   *
   * @param string $reason
   *   (optional) The reason why an order item is unavailable.
   *
   * @return static
   */
  public static function unavailable($reason = NULL) : AvailabilityResult {
    return new static(FALSE, $reason);
  }

  /**
   * Gets the "reason".
   *
   * @return string|null
   *   The "reason" for this availability result, NULL when not provided.
   */
  public function getReason() {
    return $this->reason;
  }

  /**
   * Determines whether the availability result is "neutral".
   *
   * @return bool
   *   Whether the availability result is "neutral".
   */
  public function isNeutral() : bool {
    return $this->result === TRUE;
  }

  /**
   * Determines whether the availability result is "unavailable".
   *
   * @return bool
   *   Whether the availability is "unavailable".
   */
  public function isUnavailable() : bool {
    return $this->result === FALSE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AvailabilityResult::$reason	protected	property	The availability result "reason".
AvailabilityResult::$result	protected	property	The availability result.
AvailabilityResult::getReason	public	function	Gets the "reason".
AvailabilityResult::isNeutral	public	function	Determines whether the availability result is "neutral".
AvailabilityResult::isUnavailable	public	function	Determines whether the availability result is "unavailable".
AvailabilityResult::neutral	public static	function	Creates an availability result that is "neutral".
AvailabilityResult::unavailable	public static	function	Creates an availability result that is "unavailable".
AvailabilityResult::__construct	public	function	Constructs a new AvailabilityResult object.