public function ConditionDeriver::getDerivativeDefinitions in Scheduler 2.x

Gets the definition of all derivatives of a base plugin.

Parameters

array $base_plugin_definition: The definition array of the base plugin.

Return value

array An array of full derivative definitions keyed on derivative id.

Overrides DeriverBase::getDerivativeDefinitions

See also

getDerivativeDefinition()

File

scheduler_rules_integration/src/Plugin/Condition/ConditionDeriver.php, line 65

Class

ConditionDeriver

Derives conditions for each supported entity type (except nodes).

Namespace

Drupal\scheduler_rules_integration\Plugin\Condition

Code

public function getDerivativeDefinitions($base_plugin_definition) {

  // Get all entity types supported by Scheduler plugins.
  $base_plugin_id = $base_plugin_definition['id'];
  foreach ($this->schedulerManager
    ->getPluginEntityTypes() as $entity_type_id) {

    // Node actions are the originals, and for backwards-compatibility those
    // action ids must remain the same, which can not be done using this
    // deriver. Hence the node actions are defined in the 'Legacy' classes.
    if ($entity_type_id == 'node') {
      continue;
    }
    $entity_type = $this->entityTypeManager
      ->getDefinition($entity_type_id);

    // Create a context definition object for the 'entity'. This is common
    // to all the derivatives.
    $entity_context_definition = ContextDefinition::create("entity:{$entity_type_id}")
      ->setAssignmentRestriction(ContextDefinition::ASSIGNMENT_RESTRICTION_SELECTOR)
      ->setRequired(TRUE);
    $t_args = [
      '@entity_type_label' => $entity_type
        ->getLabel(),
      '@entity_type_singular' => $entity_type
        ->getSingularLabel(),
    ];

    // Define the action label, context label and description, depending on
    // which derivative we are building.
    switch ($base_plugin_id) {
      case 'scheduler_publishing_is_enabled':
        $label = $this
          ->t('@entity_type_label type is enabled for scheduled publishing', $t_args);
        $entity_context_definition
          ->setLabel($this
          ->t('@entity_type_label', $t_args))
          ->setDescription($this
          ->t('The @entity_type_singular to check for the type being enabled for scheduled publishing.', $t_args));
        break;
      case 'scheduler_unpublishing_is_enabled':
        $label = $this
          ->t('@entity_type_label type is enabled for scheduled unpublishing', $t_args);
        $entity_context_definition
          ->setLabel($this
          ->t('@entity_type_label', $t_args))
          ->setDescription($this
          ->t('The @entity_type_singular to check for the type being enabled for scheduled unpublishing.', $t_args));
        break;
      case 'scheduler_entity_is_scheduled_for_publishing':
        $label = $this
          ->t('@entity_type_label is scheduled for publishing', $t_args);
        $entity_context_definition
          ->setLabel($this
          ->t('@entity_type_label', $t_args))
          ->setDescription($this
          ->t('The @entity_type_singular to check for having a scheduled publishing date.', $t_args));
        break;
      case 'scheduler_entity_is_scheduled_for_unpublishing':
        $label = $this
          ->t('@entity_type_label is scheduled for unpublishing', $t_args);
        $entity_context_definition
          ->setLabel($this
          ->t('@entity_type_label', $t_args))
          ->setDescription($this
          ->t('The @entity_type_singular to check for having a scheduled unpublishing date.', $t_args));
        break;
      default:
        $label = 'NOT SET for ' . $base_plugin_id;
        $entity_context_definition
          ->setLabel($label);
        break;
    }

    // Build the basic condition definition with the entity context.
    $condition_definition = [
      'label' => $label,
      'entity_type_id' => $entity_type_id,
      'category' => $entity_type
        ->getLabel() . ' (' . $this
        ->t('Scheduler') . ')',
      'context_definitions' => [
        $entity_type_id => $entity_context_definition,
      ],
    ];

    // Add the full definition to the derivatives array.
    $this->derivatives[$entity_type_id] = $condition_definition + $base_plugin_definition;
  }
  return $this->derivatives;
}