class Node in Search and Replace Scanner 8

Class Node.

Plugin annotation


@Scanner(
  id = "scanner_node",
  type = "node",
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\scanner\Plugin\ScannerPluginBase implements ScannerPluginInterface uses StringTranslationTrait
  - class \Drupal\scanner\Plugin\Scanner\Entity
    class \Drupal\scanner\Plugin\Scanner\Node uses StringTranslationTrait

Expanded class hierarchy of Node

File

src/Plugin/Scanner/Node.php, line 17

Namespace

Drupal\scanner\Plugin\Scanner

View source

class Node extends Entity {
  use StringTranslationTrait;

  /**
   * {@inheritdoc}
   */
  public function search($field, array $values) {
    $title_collect = [];

    // $field will be string composed of entity type, bundle name, and field
    // name delimited by ':' characters.
    list($entityType, $bundle, $fieldname) = explode(':', $field);
    $query = \Drupal::entityQuery($entityType);
    $query
      ->condition('type', $bundle, '=');
    if ($values['published']) {
      $query
        ->condition('status', 1);
    }
    $conditionVals = parent::buildCondition($values['search'], $values['mode'], $values['wholeword'], $values['regex'], $values['preceded'], $values['followed']);
    if ($values['language'] !== 'all') {
      $query
        ->condition('langcode', $values['language'], '=');
      $query
        ->condition($fieldname, $conditionVals['condition'], $conditionVals['operator'], $values['language']);
    }
    else {
      $query
        ->condition($fieldname, $conditionVals['condition'], $conditionVals['operator']);
    }
    $entities = $query
      ->execute();

    // Iterate over matched entities (nodes) to extract information that will
    // be rendered in the results.
    foreach ($entities as $id) {
      $node = CoreNode::load($id);
      $nodeField = $node
        ->get($fieldname);
      $fieldType = $nodeField
        ->getFieldDefinition()
        ->getType();
      if (in_array($fieldType, [
        'text_with_summary',
        'text',
        'text_long',
      ])) {
        $fieldValue = $nodeField
          ->getValue()[0];
        $title_collect[$id]['title'] = $node
          ->getTitle();

        // Find all instances of the term we're looking for.
        preg_match_all($conditionVals['phpRegex'], $fieldValue['value'], $matches, PREG_OFFSET_CAPTURE);
        $newValues = [];

        // Build an array of strings which are displayed in the results.
        foreach ($matches[0] as $v) {

          // The offset of the matched term(s) in the field's text.
          $start = $v[1];
          if ($values['preceded'] !== '') {

            // Bolding won't work if starting position is in the middle of a
            // word (non-word bounded searches), therefore move the start
            // position back as many character as there are in the 'preceded'
            // text.
            $start -= strlen($values['preceded']);
          }

          // Extract part of the text which include the search term plus six
          // "words" following it. After finding the string, bold the search
          // term.
          $replaced = preg_replace($conditionVals['phpRegex'], "<strong>{$v[0]}</strong>", preg_split("/\\s+/", substr($fieldValue['value'], $start), 6));
          if (count($replaced) > 1) {

            // The final index contains the remainder of the text, which we
            // don't care about so we discard it.
            array_pop($replaced);
          }
          $newValues[] = implode(' ', $replaced);
        }
        $title_collect[$id]['field'] = $newValues;
      }
      elseif ($fieldType == 'string') {
        $title_collect[$id]['title'] = $node
          ->getTitle();
        preg_match($conditionVals['phpRegex'], $nodeField
          ->getString(), $matches, PREG_OFFSET_CAPTURE);
        $match = $matches[0][0];
        $replaced = preg_replace($conditionVals['phpRegex'], "<strong>{$match}</strong>", $nodeField
          ->getString());
        $title_collect[$id]['field'] = [
          $replaced,
        ];
      }
    }
    return $title_collect;
  }

  /**
   * {@inheritdoc}
   */
  public function replace($field, array $values, array $undo_data) {
    $data = $undo_data;
    if (!is_array($data)) {
      $data = [];
    }
    list($entityType, $bundle, $fieldname) = explode(':', $field);
    $query = \Drupal::entityQuery($entityType);
    $query
      ->condition('type', $bundle);
    if ($values['published']) {
      $query
        ->condition('status', 1);
    }
    $conditionVals = parent::buildCondition($values['search'], $values['mode'], $values['wholeword'], $values['regex'], $values['preceded'], $values['followed']);
    if ($values['language'] !== 'all') {
      $query
        ->condition($fieldname, $conditionVals['condition'], $conditionVals['operator'], $values['language']);
    }
    else {
      $query
        ->condition($fieldname, $conditionVals['condition'], $conditionVals['operator']);
    }
    $entities = $query
      ->execute();
    foreach ($entities as $id) {
      $node = CoreNode::load($id);
      $nodeField = $node
        ->get($fieldname);
      $fieldType = $nodeField
        ->getFieldDefinition()
        ->getType();
      if (in_array($fieldType, [
        'text_with_summary',
        'text',
        'text_long',
      ])) {
        if ($values['language'] === 'all') {
          $other_languages = AdminHelper::getAllEnabledLanguages();
          foreach ($other_languages as $langcode => $languageName) {
            if ($node
              ->hasTranslation($langcode)) {
              $node = $node
                ->getTranslation($langcode);
              $nodeField = $node
                ->get($fieldname);
            }
            $fieldValue = $nodeField
              ->getValue()[0];

            // Replace the search term with the replace term.
            $fieldValue['value'] = preg_replace($conditionVals['phpRegex'], $values['replace'], $fieldValue['value']);
            $node->{$fieldname} = $fieldValue;
          }

          // This check prevents the creation of multiple revisions if more than
          // one field of the same node has been modified.
          if (!isset($data["node:{$id}"]['new_vid'])) {
            $data["node:{$id}"]['old_vid'] = $node->vid
              ->getString();

            // Crete a new revision so that we can have the option of undoing it
            // later on.
            $node
              ->setNewRevision(TRUE);
            $node->revision_log = $this
              ->t('Replaced %search with %replace via Scanner Search and Replace module.', [
              '%search' => $values['search'],
              '%replace' => $values['replace'],
            ]);
          }
        }
        else {
          $requested_lang = $values['language'];
          if ($node
            ->hasTranslation($requested_lang)) {
            $node = $node
              ->getTranslation($requested_lang);
            $nodeField = $node
              ->get($fieldname);
          }
          $fieldValue = $nodeField
            ->getValue()[0];

          // Replace the search term with the replace term.
          $fieldValue['value'] = preg_replace($conditionVals['phpRegex'], $values['replace'], $fieldValue['value']);
          $node->{$fieldname} = $fieldValue;

          // This check prevents the creation of multiple revisions if more than
          // one field of the same node has been modified.
          if (!isset($data["node:{$id}"]['new_vid'])) {
            $data["node:{$id}"]['old_vid'] = $node->vid
              ->getString();

            // Crete a new revision so that we can have the option of undoing it
            // later on.
            $node
              ->setNewRevision(TRUE);
            $node->revision_log = $this
              ->t('Replaced %search with %replace via Scanner Search and Replace module.', [
              '%search' => $values['search'],
              '%replace' => $values['replace'],
            ]);
          }
        }

        // Save the updated node.
        $node
          ->save();

        // Fetch the new revision id.
        $data["node:{$id}"]['new_vid'] = $node->vid
          ->getString();
      }
      elseif ($fieldType == 'string') {
        if (!isset($data["node:{$id}"]['new_vid'])) {
          if ($values['language'] === 'all') {
            $all_languages = AdminHelper::getAllEnabledLanguages();
            foreach ($all_languages as $langcode => $languageName) {
              if ($node
                ->hasTranslation($langcode)) {
                $node = $node
                  ->getTranslation($langcode);
                $nodeField = $node
                  ->get($fieldname);
              }
              $fieldValue = preg_replace($conditionVals['phpRegex'], $values['replace'], $nodeField
                ->getString());
              $node->{$fieldname} = $fieldValue;
            }
            $data["node:{$id}"]['old_vid'] = $node->vid
              ->getString();
            $node
              ->setNewRevision(TRUE);
            $node->revision_log = $this
              ->t('Replaced %search with %replace via Scanner Search and Replace module.', [
              '%search' => $values['search'],
              '%replace' => $values['replace'],
            ]);
          }
          else {
            $requested_lang = $values['language'];
            if ($node
              ->hasTranslation($requested_lang)) {

              // $nodeField = $nodeField->getTranslation($requested_lang);
              $node = $node
                ->getTranslation($requested_lang);
              $nodeField = $node
                ->get($fieldname);
            }
            $fieldValue = preg_replace($conditionVals['phpRegex'], $values['replace'], $nodeField
              ->getString());
            $node->{$fieldname} = $fieldValue;
            $data["node:{$id}"]['old_vid'] = $node->vid
              ->getString();
            $node
              ->setNewRevision(TRUE);
            $node->revision_log = $this
              ->t('Replaced %search with %replace via Scanner Search and Replace module.', [
              '%search' => $values['search'],
              '%replace' => $values['replace'],
            ]);
          }
        }
        $node
          ->save();
        $data["node:{$id}"]['new_vid'] = $node->vid
          ->getString();
      }
    }
    return $data;
  }

  /**
   * {@inheritdoc}
   */
  public function undo(array $data) {
    $revision = \Drupal::entityTypeManager()
      ->getStorage('node')
      ->loadRevision($data['old_vid']);
    $revision
      ->setNewRevision(TRUE);
    $revision->revision_log = $this
      ->t('Copy of the revision from %date via Search and Replace Undo', [
      '%date' => \Drupal::service('date.formatter')
        ->format($revision
        ->getRevisionCreationTime()),
    ]);
    $revision
      ->isDefaultRevision(TRUE);
    $revision
      ->save();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Entity::$scannerRegexChars	protected	property	The scanner regular expression.
Entity::buildCondition	protected	function	Helper function to "build" the proper query condition.
Node::replace	public	function	Performs the replace operation for the given string/expression. Overrides Entity::replace
Node::search	public	function	Performs the serach operation for the given string/expression. Overrides Entity::search
Node::undo	public	function	Undo the replace operation by reverting entities to a previous revision. Overrides Entity::undo
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.
ScannerPluginBase::$scannerManager	protected	property	The scanner plugin manager.
ScannerPluginBase::$tempStore	protected	property	The temp store we use to store form values.
ScannerPluginBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ScannerPluginBase::__construct	public	function	Constructs a ScannerPluginBase object. Overrides PluginBase::__construct
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
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.

You are here

class Node in Search and Replace Scanner 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation