class OrderHasProductsCondition in Ubercart 8.4

Provides 'Order has specific product(s)' condition.

Plugin annotation


@Condition(
  id = "uc_order_condition_has_products",
  label = @Translation("Check an order's products"),
  category = @Translation("Order: Product"),
  context_definitions = {
    "order" = @ContextDefinition("entity:uc_order",
      label = @Translation("Order")
    ),
    "products" = @ContextDefinition("string",
      label = @Translation("Products"),
      list_options_callback = "hasProductsOptions",
      multiple = TRUE,
      assignment_restriction = "input"
    ),
    "required" = @ContextDefinition("boolean",
      label = @Translation("Require all selected products"),
      description = @Translation("Select to require that order must contain all selected products. Otherwise, order must contain at least one of the selected products."),
      list_options_callback = "booleanOptions"
    ),
    "forbidden" = @ContextDefinition("boolean",
      label = @Translation("Forbid other products"),
      list_options_callback = "booleanOptions"
    )
  }
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
  - class \Drupal\Core\Plugin\ContextAwarePluginBase implements CacheableDependencyInterface, ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
    class \Drupal\Core\Executable\ExecutablePluginBase implements ExecutableInterface
    class \Drupal\Core\Condition\ConditionPluginBase implements ConditionInterface uses ContextAwarePluginAssignmentTrait
    class \Drupal\rules\Core\RulesConditionBase implements RulesConditionInterface uses ContextProviderTrait, ConfigurationAccessControlTrait, ExecutablePluginTrait
    class \Drupal\uc_order\Plugin\Condition\OrderConditionBase implements ContainerFactoryPluginInterface
    class \Drupal\uc_order\Plugin\Condition\OrderHasProductsCondition

Expanded class hierarchy of OrderHasProductsCondition

File

uc_order/src/Plugin/Condition/OrderHasProductsCondition.php, line 36

Namespace

Drupal\uc_order\Plugin\Condition

View source

class OrderHasProductsCondition extends OrderConditionBase {

  /**
   * {@inheritdoc}
   */
  public function summary() {
    return $this
      ->t("Check an order's products");
  }

  /**
   * Options callback.
   *
   * @return array
   *   An array of product SKUs.
   */
  public function hasProductsOptions() {
    $options = [];
    $result = $this->database
      ->query('SELECT nid FROM {uc_products}');
    foreach ($result as $row) {
      $options += uc_product_get_models($row->nid, FALSE);
    }
    asort($options);
    return $options;
  }

  /**
   * Returns a TRUE/FALSE option set for boolean types.
   *
   * @return array
   *   A TRUE/FALSE options array.
   */
  public function booleanOptions() {
    return [
      0 => $this
        ->t('False'),
      1 => $this
        ->t('True'),
    ];
  }

  /**
   * Checks that the order has the selected combination of products.
   *
   * @param \Drupal\uc_order\OrderInterface $order
   *   The order.
   * @param \Drupal\node\NodeInterface[] $products
   *   TRUE if the product is required to be in the order.
   * @param bool $required
   *   TRUE if the product is required to be in the order.
   * @param bool $forbidden
   *   TRUE if the product is forbidden to be in the order.
   *
   * @return bool
   *   TRUE if the order has the selected combination of products.
   */
  protected function doEvaluate(OrderInterface $order, array $products, $required, $forbidden) {
    $order_products = [];
    foreach ($order->products as $product) {
      $order_products[] = $product->model;
    }
    $required_products = array_intersect($products, $order_products);
    if ($required) {
      $required_check = $required_products == $products;
    }
    else {
      $required_check = (bool) count($required_products);
    }
    if ($forbidden) {
      $forbidden_products = array_diff($order_products, $products);
      $forbidden_check = (bool) count($forbidden_products);
    }
    else {
      $forbidden_check = FALSE;
    }
    return $required_check && !$forbidden_check;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConditionPluginBase::$executableManager	protected	property	The condition manager to proxy execute calls through.
ConditionPluginBase::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm	5
ConditionPluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ConditionPluginBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	5
ConditionPluginBase::execute	public	function	Executes the plugin. Overrides ExecutableInterface::execute
ConditionPluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ConditionPluginBase::isNegated	public	function	Determines whether condition result will be negated. Overrides ConditionInterface::isNegated
ConditionPluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ConditionPluginBase::setExecutableManager	public	function	Sets the executable manager class. Overrides ConditionInterface::setExecutableManager
ConditionPluginBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm	5
ConditionPluginBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
ConfigurationAccessControlTrait::checkConfigurationAccess	public	function	Checks configuration permission.
ContextAwarePluginAssignmentTrait::addContextAssignmentElement	protected	function	Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler	protected	function	Wraps the context handler.
ContextAwarePluginAssignmentTrait::t	abstract protected	function	Ensures the t() method is available.
ContextAwarePluginBase::$context	protected	property	The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated	private	property	Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::createContextFromConfiguration	protected	function	Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts	9
ContextAwarePluginBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge	7
ContextAwarePluginBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags	4
ContextAwarePluginBase::getContext	public	function	This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition	public	function	Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions	public	function	Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping	public	function	Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts	public	function	Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValues	public	function	Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext	public	function	Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping	public	function	Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue	public	function	Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts	public	function	Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__get	public	function	Implements magic __get() method.
ContextProviderTrait::$providedContext	protected	property	The data objects that are provided by this plugin.
ContextProviderTrait::getProvidedContext	public	function
ContextProviderTrait::getProvidedContextDefinition	public	function
ContextProviderTrait::getProvidedContextDefinitions	public	function
ContextProviderTrait::setProvidedValue	public	function
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
ExecutablePluginBase::getConfig	public	function	Gets all configuration values.
ExecutablePluginBase::getConfigDefinition	public	function	Gets the definition of a configuration option.
ExecutablePluginBase::getConfigDefinitions	public	function	Gets an array of definitions of available configuration options.
ExecutablePluginBase::setConfig	public	function	Sets the value of a particular configuration option.
ExecutablePluginTrait::getLabelValue	protected	function	Get the translated label from the plugin definition.
OrderConditionBase::$database	protected	property	The database service.
OrderConditionBase::compareComparisonOptions	public	function	Value comparison.
OrderConditionBase::comparisonOptions	public	function	Operator options callback.
OrderConditionBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
OrderConditionBase::__construct	public	function	Constructs an OrderConditionBase object. Overrides ConditionPluginBase::__construct
OrderHasProductsCondition::booleanOptions	public	function	Returns a TRUE/FALSE option set for boolean types.
OrderHasProductsCondition::doEvaluate	protected	function	Checks that the order has the selected combination of products.
OrderHasProductsCondition::hasProductsOptions	public	function	Options callback.
OrderHasProductsCondition::summary	public	function	Get the translated summary from the label annotation. Overrides ExecutablePluginTrait::summary
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
RulesConditionBase::assertMetadata	public	function	Asserts additional metadata for the selected data. Overrides ContextAwarePluginInterface::assertMetadata	1
RulesConditionBase::evaluate	public	function	Evaluates the condition and returns TRUE or FALSE accordingly. Overrides ConditionInterface::evaluate	5
RulesConditionBase::getContextValue	public	function	Gets the value for a defined context. Overrides ContextAwarePluginBase::getContextValue
RulesConditionBase::negate	public	function	Negates the result after evaluating this condition. Overrides RulesConditionInterface::negate
RulesConditionBase::refineContextDefinitions	public	function	Refines used and provided context definitions based upon context values. Overrides ContextAwarePluginInterface::refineContextDefinitions	1
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
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

You are here

class OrderHasProductsCondition in Ubercart 8.4

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation