class UnpublishByKeywordComment

Unpublishes a comment containing certain keywords.

Plugin annotation


@Action(
  id = "comment_unpublish_by_keyword_action",
  label = @Translation("Unpublish comment containing keyword(s)"),
  type = "comment"
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements PluginInspectionInterface
- class \Drupal\Core\Plugin\ContainerFactoryPluginBase implements ContainerFactoryPluginInterface
  - class \Drupal\Core\Action\ActionBase implements ActionInterface
    class \Drupal\Core\Action\ConfigurableActionBase implements ConfigurableActionInterface
    class \Drupal\comment\Plugin\Action\UnpublishByKeywordComment

Expanded class hierarchy of UnpublishByKeywordComment

File

drupal/core/modules/comment/lib/Drupal/comment/Plugin/Action/UnpublishByKeywordComment.php, line 23: Contains \Drupal\comment\Plugin\Action\UnpublishByKeywordComment.

Namespace

Drupal\comment\Plugin\Action

View source

class UnpublishByKeywordComment extends ConfigurableActionBase {

  /**
   * {@inheritdoc}
   */
  public function execute($comment = NULL) {
    $build = comment_view($comment);
    $text = drupal_render($build);
    foreach ($this->configuration['keywords'] as $keyword) {
      if (strpos($text, $keyword) !== FALSE) {
        $comment->status->value = COMMENT_NOT_PUBLISHED;
        $comment
          ->save();
        break;
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function getDefaultConfiguration() {
    return array(
      'keywords' => array(),
    );
  }

  /**
   * {@inheritdoc}
   */
  public function form(array $form, array &$form_state) {
    $form['keywords'] = array(
      '#title' => t('Keywords'),
      '#type' => 'textarea',
      '#description' => t('The comment 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' => drupal_implode_tags($this->configuration['keywords']),
    );
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submit(array &$form, array &$form_state) {
    $this->configuration['keywords'] = drupal_explode_tags($form_state['values']['keywords']);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ActionBase::executeMultiple	public	function	Executes the plugin for an array of objects. Overrides ActionInterface::executeMultiple	2
ConfigurableActionBase::getConfiguration	public	function	Returns this plugin's configuration. Overrides ConfigurableActionInterface::getConfiguration
ConfigurableActionBase::validate	public	function	Form validation handler. Overrides ConfigurableActionInterface::validate	2
ConfigurableActionBase::__construct	public	function	Constructs a Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct	3
ContainerFactoryPluginBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	11
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::getPluginDefinition	public	function	Returns the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId	public	function	Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
UnpublishByKeywordComment::execute	public	function	Executes the plugin. Overrides ExecutableInterface::execute
UnpublishByKeywordComment::form	public	function	Form constructor. Overrides ConfigurableActionInterface::form
UnpublishByKeywordComment::getDefaultConfiguration	protected	function	Returns default configuration for this action. Overrides ConfigurableActionBase::getDefaultConfiguration
UnpublishByKeywordComment::submit	public	function	Form submission handler. Overrides ConfigurableActionInterface::submit

Main menu

Search Drupal 8.x

API Navigation

class UnpublishByKeywordComment

Plugin annotation

Hierarchy

File

Namespace

Members

Main menu

You are here

Search Drupal 8.x

API Navigation

class UnpublishByKeywordComment

Plugin annotation

Hierarchy

File

Namespace

Members