SiteName.php in Search API Field Map 8.2

Namespace

Drupal\search_api_field_map\Plugin\search_api\processor

File

src/Plugin/search_api/processor/SiteName.php

<?php

namespace Drupal\search_api_field_map\Plugin\search_api\processor;

use Drupal\search_api\Datasource\DatasourceInterface;
use Drupal\search_api\Item\ItemInterface;
use Drupal\search_api\Processor\ProcessorPluginBase;
use Drupal\search_api\Processor\ProcessorProperty;
use Drupal\search_api_field_map\Plugin\search_api\processor\Property\SiteNameProperty;

/**
 * Adds the site name to the indexed data.
 *
 * @SearchApiProcessor(
 *   id = "site_name",
 *   label = @Translation("Site name"),
 *   description = @Translation("Adds the site name to the indexed data."),
 *   stages = {
 *     "add_properties" = 0,
 *   },
 *   locked = true,
 *   hidden = true,
 * )
 */
class SiteName extends ProcessorPluginBase {

  /**
   * {@inheritdoc}
   */
  public function getPropertyDefinitions(DatasourceInterface $datasource = NULL) {
    $properties = [];
    if (!$datasource) {
      $definition = [
        'label' => $this
          ->t('Site Name'),
        'description' => $this
          ->t('The name of the site from which this content originated.'),
        'type' => 'string',
        'processor_id' => $this
          ->getPluginId(),
      ];
      $properties['site_name'] = new SiteNameProperty($definition);
    }
    return $properties;
  }

  /**
   * {@inheritdoc}
   */
  public function addFieldValues(ItemInterface $item) {
    $fields = $this
      ->getFieldsHelper()
      ->filterForPropertyPath($item
      ->getFields(), NULL, 'site_name');
    foreach ($fields as $field) {

      // Default to value of the site name text field.
      $site_name = $field
        ->getConfiguration()['site_name'];

      // Check if flag to use [site:name] is set.
      $use_system_site_name = $field
        ->getConfiguration()['use_system_site_name'];
      if ($use_system_site_name) {
        $token = \Drupal::token();

        // If the token replacement produces a value, add to this item.
        if ($value = $token
          ->replace('[site:name]', [], [
          'clear' => true,
        ])) {
          $site_name = $value;
        }
      }
      $field
        ->addValue($site_name);
    }
  }

}

Classes

Name	Description
SiteName	Adds the site name to the indexed data.