UnpublishByKeywordNode.php

Same filename in other branches
  1. 8.9.x core/modules/node/src/Plugin/Action/UnpublishByKeywordNode.php
  2. 10 core/modules/node/src/Plugin/Action/UnpublishByKeywordNode.php
  3. 11.x core/modules/node/src/Plugin/Action/UnpublishByKeywordNode.php
  4. 10 core/modules/action/src/Plugin/Action/UnpublishByKeywordNode.php

Namespace

Drupal\node\Plugin\Action

File

core/modules/node/src/Plugin/Action/UnpublishByKeywordNode.php

View source
<?php

namespace Drupal\node\Plugin\Action;

use Drupal\Component\Utility\Tags;
use Drupal\Core\Action\ConfigurableActionBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Session\AccountInterface;

/**
 * Unpublishes a node containing certain keywords.
 *
 * @Action(
 *   id = "node_unpublish_by_keyword_action",
 *   label = @Translation("Unpublish content containing keyword(s)"),
 *   type = "node"
 * )
 */
class UnpublishByKeywordNode extends ConfigurableActionBase {
    
    /**
     * {@inheritdoc}
     */
    public function execute($node = NULL) {
        $elements = \Drupal::entityTypeManager()->getViewBuilder('node')
            ->view(clone $node);
        $render = \Drupal::service('renderer')->render($elements);
        foreach ($this->configuration['keywords'] as $keyword) {
            if (strpos($render, $keyword) !== FALSE || strpos($node->label(), $keyword) !== FALSE) {
                $node->setUnpublished();
                $node->save();
                break;
            }
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function defaultConfiguration() {
        return [
            'keywords' => [],
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
        $form['keywords'] = [
            '#title' => $this->t('Keywords'),
            '#type' => 'textarea',
            '#description' => $this->t('The content will be unpublished if it contains any of the phrases above. Use a case-sensitive, comma-separated list of phrases. Example: funny, bungee jumping, "Company, Inc."'),
            '#default_value' => Tags::implode($this->configuration['keywords']),
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
        $this->configuration['keywords'] = Tags::explode($form_state->getValue('keywords'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function access($object, AccountInterface $account = NULL, $return_as_object = FALSE) {
        
        /** @var \Drupal\node\NodeInterface $object */
        $access = $object->access('update', $account, TRUE)
            ->andIf($object->status
            ->access('edit', $account, TRUE));
        return $return_as_object ? $access : $access->isAllowed();
    }

}

Classes

Title Deprecated Summary
UnpublishByKeywordNode Unpublishes a node containing certain keywords.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.