class Paragraph in Search and Replace Scanner 8

Class Paragraph.

Plugin annotation


@Scanner(
  id = "scanner_paragraph",
  type = "paragraph",
)

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\Paragraph uses StringTranslationTrait

Expanded class hierarchy of Paragraph

File

src/Plugin/Scanner/Paragraph.php, line 15

Namespace

Drupal\scanner\Plugin\Scanner

View source

class Paragraph extends Entity {
  use StringTranslationTrait;

  /**
   * {@inheritdoc}
   */
  public function search($field, array $values) {
    $title_collect = [];
    list($bundle, $fieldname) = explode(':', $field);
    $query = \Drupal::entityQuery('paragraph');
    $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();
    if (!empty($entities)) {

      // Load the paragraph(s) which match the criteria.
      $paragraphs = \Drupal::entityTypeManager()
        ->getStorage('paragraph')
        ->loadMultiple($entities);

      // Iterate over matched paragraphs to extract information that will be
      // rendered in the results.
      foreach ($paragraphs as $paragraph) {
        if (!empty($paragraph)) {

          // Load the entity the paragraph is referenced in.
          $parentEntity = $paragraph
            ->getParentEntity();
          if (!empty($parentEntity)) {
            $parentEntityType = $parentEntity
              ->getEntityTypeId();

            // In the case of nested relationships we need to find the base
            // entity.
            if ($parentEntityType != 'node') {

              // If child is only nested one level deep.
              if ($parentEntity
                ->getParentEntity()
                ->getEntityTypeId() == 'node') {
                $parentEntity = $parentEntity
                  ->getParentEntity();
              }
              else {
                while ($parentEntity
                  ->getParentEntity()
                  ->getEntityTypeId() != 'node') {
                  $parentEntity = $parentEntity
                    ->getParentEntity();
                }
              }
            }
            $id = $parentEntity
              ->id();

            // Get the value of the specified field.
            $paraField = $paragraph
              ->get($fieldname);
            $fieldType = $paraField
              ->getFieldDefinition()
              ->getType();
            if (in_array($fieldType, [
              'text_with_summary',
              'text',
              'text_long',
            ])) {

              // Get the value of the field.
              $fieldValue = $paraField
                ->getValue()[0];

              // Get the parent entity's title.
              $title_collect[$id]['title'] = $parentEntity
                ->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
              // with the searched term bolded.
              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 we move
                  // the start position back as many character as there are in
                  // the 'preceded' text.
                  $start -= strlen($values['preceded']);
                }
                $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'] = $parentEntity
                ->getTitle();
              preg_match($conditionVals['phpRegex'], $paraField
                ->getString(), $matches, PREG_OFFSET_CAPTURE);
              $match = $matches[0][0];
              $replaced = preg_replace($conditionVals['phpRegex'], "<strong>{$match}</strong>", $paraField
                ->getString());
              $title_collect[$id]['field'] = [
                $replaced,
              ];
            }
          }
        }
      }
    }
    return $title_collect;
  }

  /**
   * {@inheritdoc}
   */
  public function replace($field, array $values, array $undo_data) {
    list($entityType, $bundle, $fieldname) = explode(':', $field);
    $data = $undo_data;
    $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();
    $paragraphs = \Drupal::entityTypeManager()
      ->getStorage('paragraph')
      ->loadMultiple($entities);
    foreach ($paragraphs as $pid => $paragraph) {
      $paraField = $paragraph
        ->get($fieldname);
      $fieldType = $paraField
        ->getFieldDefinition()
        ->getType();
      if (in_array($fieldType, [
        'text_with_summary',
        'text',
        'text_long',
      ])) {
        $fieldValue = $paraField
          ->getValue()[0];
        $fieldValue['value'] = preg_replace($conditionVals['phpRegex'], $values['replace'], $fieldValue['value']);
        $paragraph->{$fieldname} = $fieldValue;
        if (!isset($data["paragraph:{$pid}"]['new_vid'])) {
          $data["paragraph:{$pid}"]['old_vid'] = $paragraph
            ->getRevisionId();

          // Create a new revision for the paragraph.
          $paragraph
            ->setNewRevision(TRUE);
        }

        // Save the paragraph with the updated field(s).
        $paragraph
          ->save();
        $data["paragraph:{$pid}"]['new_vid'] = $paragraph
          ->getRevisionId();
        $processed = $this
          ->handleParentRelationship($paragraph, $values, $data);
        if ($processed == FALSE) {

          // We couldn't handle the relationship for some reason so we move on
          // to the next paragraph.
          continue;
        }
      }
      elseif ($fieldType == 'string') {
        $fieldValue = preg_replace($conditionVals['phpRegex'], $values['replace'], $paraField
          ->getString());
        $paragraph->{$fieldname} = $fieldValue;
        if (!isset($data["paragraph:{$pid}"]['new_vid'])) {
          $data["paragraph:{$pid}"]['old_vid'] = $paragraph
            ->getRevisionId();
          $paragraph
            ->setNewRevision(TRUE);
        }
        $paragraph
          ->save();
        $data["paragraph:{$pid}"]['new_vid'] = $paragraph
          ->getRevisionId();
        $processed = $this
          ->handleParentRelationship($paragraph, $values, $data);
        if ($processed == FALSE) {

          // We couldn't handle the relationship for some reason so we move on
          // to the next paragraph.
          continue;
        }
      }
    }
    return $data;
  }

  /**
   * {@inheritdoc}
   */
  public function undo(array $data) {

    // Load the specified paragraph revision.
    $paraRevision = \Drupal::entityTypeManager()
      ->getStorage('paragraph')
      ->loadRevision($data['old_vid']);
    $paraRevision
      ->setNewRevision(TRUE);

    // Set this revision as the current/default revision.
    $paraRevision
      ->isDefaultRevision(TRUE);
    $paraRevision
      ->save();
  }

  /**
   * Helper function to handle entity reference relationships.
   *
   * @param mixed $paragraph
   *   The paragraph entity.
   * @param array $values
   *   An array containing the input values from the form.
   * @param array $data
   *   An array containing the revision id's for the entities being processed.
   *
   * @return bool
   *   A boolean which denotes whether or not we were able to process the parent
   *   entitiy(s).
   */
  protected function handleParentRelationship($paragraph, array $values, array &$data) {
    $pid = $paragraph
      ->id();
    $parentEntity = $paragraph
      ->getParentEntity();
    if (empty($parentEntity)) {
      return FALSE;
    }
    $id = $parentEntity
      ->id();
    $parentEntityType = $parentEntity
      ->getEntityTypeId();
    $isProcessed = FALSE;
    if ($parentEntityType == 'node') {
      $parentField = $paragraph
        ->get('parent_field_name')
        ->getString();
      $index = $this
        ->getMultiValueIndex($parentEntity->{$parentField}
        ->getValue(), $pid);

      // Orphaned paragraphs cause issues so we skip them (and their
      // relationships).
      if ($index < 0) {
        \Drupal::logger('scanner')
          ->notice('Unable to find the delta for this paragraph in the parent entity\'s field (id: @id).', [
          '@id' => $pid,
        ]);
        return $isProcessed;
      }
      if (!isset($data["node:{$id}"]['new_vid'])) {
        $data["node:{$id}"]['old_vid'] = $parentEntity
          ->getRevisionId();

        // Create a new revision for the parent entity.
        $parentEntity
          ->setNewRevision(TRUE);
        $parentEntity->revision_log = $this
          ->t('Replaced @search with @replace via Scanner Search and Replace module.', [
          '@search' => $values['search'],
          '@replace' => $values['replace'],
        ]);
      }

      // We need to update the parent entity as well so that it will display
      // the lastest revision.
      $parentEntity->{$parentField}
        ->set($index, [
        'target_id' => $pid,
        'target_revision_id' => $paragraph
          ->getRevisionId(),
      ]);
      $parentEntity
        ->save();
      $data["node:{$id}"]['new_vid'] = $parentEntity
        ->getRevisionId();
      $isProcessed = TRUE;
      return $isProcessed;
    }
    elseif ($parentEntityType == 'paragraph') {
      $grandParentEntity = $parentEntity
        ->getParentEntity();

      // Bail out if grandparent isn't a node, we only handle two levels of
      // nesting.
      if ($grandParentEntity
        ->getEntityTypeId() != 'node') {
        return $isProcessed;
      }
      $parentField = $paragraph
        ->get('parent_field_name')
        ->getString();
      $index = $this
        ->getMultiValueIndex($parentEntity->{$parentField}
        ->getValue(), $pid);

      // Orphaned paragraphs cause issues so we skip them (and their
      // relationships).
      if ($index < 0) {
        \Drupal::logger('scanner')
          ->notice('Unable to find the delta for this paragraph in the parent entity\'s field (id: @id).', [
          '@id' => $pid,
        ]);
        return $isProcessed;
      }

      // Handle parent entity.
      if (!isset($data["paragraph:{$id}"]['new_vid'])) {
        $data["paragraph:{$id}"]['old_vid'] = $parentEntity
          ->getRevisionId();

        // Create a new revision for the paragraph.
        $parentEntity
          ->setNewRevision(TRUE);
      }
      $parentEntity->{$parentField}
        ->set($index, [
        'target_id' => $paragraph
          ->id(),
        'target_revision_id' => $paragraph
          ->getRevisionId(),
      ]);
      $parentEntity
        ->save();
      $data["paragraph:{$id}"]['new_vid'] = $parentEntity
        ->getRevisionId();

      // Handle grandparent entity.
      $grandParentId = $grandParentEntity
        ->id();
      $grandParentField = $parentEntity
        ->get('parent_field_name')
        ->getString();
      $index = $this
        ->getMultiValueIndex($grandParentEntity->{$grandParentField}
        ->getValue(), $id);

      // Orphaned paragraphs can cause issues so we skip them.
      if ($index < 0) {
        \Drupal::logger('scanner')
          ->notice('Unable to find the delta for this paragraph in the parent entity\'s field (id: @id).', [
          '@id' => $id,
        ]);
        return $isProcessed;
      }
      if (!isset($data["node:{$grandParentId}"]['new_vid'])) {
        $data["node:{$grandParentId}"]['old_vid'] = $grandParentEntity
          ->getRevisionId();

        // Create a new revision for the paragraph.
        $grandParentEntity
          ->setNewRevision(TRUE);
        $grandParentEntity->revision_log = $this
          ->t('Replaced @search with @replace via Scanner Search and Replace module.', [
          '@search' => $values['search'],
          '@replace' => $values['replace'],
        ]);
      }
      $grandParentEntity->{$grandParentField}
        ->set($index, [
        'target_id' => $parentEntity
          ->id(),
        'target_revision_id' => $parentEntity
          ->getRevisionId(),
      ]);
      $grandParentEntity
        ->save();
      $data["node:{$grandParentId}"]['new_vid'] = $grandParentEntity
        ->getRevisionId();
      $isProcessed = TRUE;
      return $isProcessed;
    }
    else {

      // Something we didn't expect.
      return $isProcessed;
    }
  }

  /**
   * Get multiple value index.
   */
  protected function getMultiValueIndex($values, $pid) {
    foreach ($values as $key => $value) {
      if ($value['target_id'] == $pid) {
        return $key;
      }
    }
    return -1;
  }

}

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.
Paragraph::getMultiValueIndex	protected	function	Get multiple value index.
Paragraph::handleParentRelationship	protected	function	Helper function to handle entity reference relationships.
Paragraph::replace	public	function	Performs the replace operation for the given string/expression. Overrides Entity::replace
Paragraph::search	public	function	Performs the serach operation for the given string/expression. Overrides Entity::search
Paragraph::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 Paragraph in Search and Replace Scanner 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation