class DataListItemRemove

Provides a 'Remove item from list' action.

@todo Add access callback information from Drupal 7.

Plugin annotation

@RulesAction(
  id = "rules_list_item_remove",
  label = @Translation("Remove item from list"),
  category = @Translation("Data"),
  context_definitions = {
    "list" = @ContextDefinition("list",
      label = @Translation("List"),
      description = @Translation("The data list from which an item is to be removed."),
      assignment_restriction = "selector"
    ),
    "item" = @ContextDefinition("any",
      label = @Translation("Item"),
      description = @Translation("Item to remove.")
    ),
  }
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
    • class \Drupal\rules\Core\RulesActionBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\rules\Core\RulesActionInterface uses \Drupal\Core\Plugin\ContextAwarePluginTrait, \Drupal\rules\Context\ContextProviderTrait, \Drupal\rules\Core\ExecutablePluginTrait, \Drupal\rules\Core\ConfigurationAccessControlTrait
      • class \Drupal\rules\Plugin\RulesAction\DataListItemRemove extends \Drupal\rules\Core\RulesActionBase

Expanded class hierarchy of DataListItemRemove

File

src/Plugin/RulesAction/DataListItemRemove.php, line 29

Namespace

class DataListItemRemove extends RulesActionBase {
    
    /**
     * Removes an item from a list.
     *
     * @param array $list
     *   An array to remove an item from.
     * @param mixed $item
     *   An item to remove from the array.
     */
    protected function doExecute(array $list, $item) {
        foreach (array_keys($list, $item) as $key) {
            unset($list[$key]);
        }
        $this->setContextValue('list', $list);
    }

}

Members