class SiteNameProperty in Search API Field Map 8

Defines a "site name" property.

Hierarchy

• class \Drupal\Core\TypedData\DataDefinition implements \Drupal\Core\TypedData\ArrayAccess, DataDefinitionInterface uses TypedDataTrait
  • class \Drupal\search_api\Processor\ProcessorProperty implements ProcessorPropertyInterface
    • class \Drupal\search_api\Processor\ConfigurablePropertyBase implements ConfigurablePropertyInterface
      • class \Drupal\search_api_field_map\Plugin\search_api\processor\Property\SiteNameProperty uses StringTranslationTrait

See also

\Drupal\search_api\Plugin\search_api\processor\SiteName

1 file declares its use of SiteNameProperty

SiteName.php in src/Plugin/search_api/processor/SiteName.php

File

src/Plugin/search_api/processor/Property/SiteNameProperty.php, line 15

Namespace

Drupal\search_api_field_map\Plugin\search_api\processor\Property

class SiteNameProperty extends ConfigurablePropertyBase {
  use StringTranslationTrait;

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'site_name' => [
        \Drupal::config('system.site')
          ->get('name'),
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(FieldInterface $field, array $form, FormStateInterface $form_state) {
    $configuration = $field
      ->getConfiguration();
    $form['#attached']['library'][] = 'search_api/drupal.search_api.admin_css';
    $form['site_name'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Site Name'),
      '#description' => $this
        ->t('The name of the site from which this content originated. This can be useful if indexing multiple sites with a single search index.'),
      '#default_value' => $configuration['site_name'],
      '#required' => TRUE,
    ];
    if ($this
      ->useDomain()) {
      $form['#tree'] = TRUE;
      $form['domain'] = [
        '#type' => 'container',
      ];
      $storage = \Drupal::service('entity_type.manager')
        ->getStorage('domain');
      $domains = $storage
        ->loadMultiple();
      foreach ($domains as $domain) {
        $form['domain'][$domain
          ->id()] = [
          '#type' => 'textfield',
          '#title' => $this
            ->t('%domain Domain Label', [
            '%domain' => $domain
              ->label(),
          ]),
          '#description' => t('Map the Domain to a custom label for search.'),
          '#default_value' => !empty($configuration['domain'][$domain
            ->id()]) ? $configuration['domain'][$domain
            ->id()] : $domain
            ->label(),
          '#required' => FALSE,
        ];
      }
      $form['site_name']['#title'] = $this
        ->t('Default site name');
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(FieldInterface $field, array &$form, FormStateInterface $form_state) {
    $values = [
      'site_name' => $form_state
        ->getValue('site_name'),
    ];
    if ($domains = $form_state
      ->getValue('domain')) {
      foreach ($domains as $id => $value) {
        $values['domain'][$id] = $value;
      }
    }
    $field
      ->setConfiguration($values);
  }

  /**
   * Whether to use the values from Domain.
   *
   * @return bool
   */
  protected function useDomain() {
    return defined('DOMAIN_ADMIN_FIELD');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurablePropertyBase::getFieldDescription	public	function	Retrieves the description for a field based on this property. Overrides ConfigurablePropertyInterface::getFieldDescription	1
ConfigurablePropertyBase::validateConfigurationForm	public	function	Validates a configuration form for a field based on this property. Overrides ConfigurablePropertyInterface::validateConfigurationForm
DataDefinition::$definition	protected	property	The array holding values for all definition keys.
DataDefinition::addConstraint	public	function	Adds a validation constraint. Overrides DataDefinitionInterface::addConstraint
DataDefinition::create	public static	function	Creates a new data definition.	5
DataDefinition::createFromDataType	public static	function	Creates a new data definition object. Overrides DataDefinitionInterface::createFromDataType	5
DataDefinition::getClass	public	function	Returns the class used for creating the typed data object. Overrides DataDefinitionInterface::getClass	1
DataDefinition::getConstraint	public	function	Returns a validation constraint. Overrides DataDefinitionInterface::getConstraint
DataDefinition::getConstraints	public	function	Returns an array of validation constraints. Overrides DataDefinitionInterface::getConstraints	1
DataDefinition::getDataType	public	function	Returns the data type of the data. Overrides DataDefinitionInterface::getDataType	2
DataDefinition::getDescription	public	function	Returns a human readable description. Overrides DataDefinitionInterface::getDescription
DataDefinition::getLabel	public	function	Returns a human readable label. Overrides DataDefinitionInterface::getLabel
DataDefinition::getSetting	public	function	Returns the value of a given setting. Overrides DataDefinitionInterface::getSetting	2
DataDefinition::getSettings	public	function	Returns the array of settings, as required by the used class. Overrides DataDefinitionInterface::getSettings	2
DataDefinition::isComputed	public	function	Determines whether the data value is computed. Overrides DataDefinitionInterface::isComputed
DataDefinition::isInternal	public	function	Determines whether the data value is internal. Overrides DataDefinitionInterface::isInternal	1
DataDefinition::isReadOnly	public	function	Determines whether the data is read-only. Overrides DataDefinitionInterface::isReadOnly
DataDefinition::isRequired	public	function	Determines whether a data value is required. Overrides DataDefinitionInterface::isRequired
DataDefinition::offsetExists	public	function	This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868.
DataDefinition::offsetGet	public	function	This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868.
DataDefinition::offsetSet	public	function	This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868.
DataDefinition::offsetUnset	public	function	This is for BC support only. @todo: Remove in https://www.drupal.org/node/1928868.
DataDefinition::setClass	public	function	Sets the class used for creating the typed data object.
DataDefinition::setComputed	public	function	Sets whether the data is computed.
DataDefinition::setConstraints	public	function	Sets an array of validation constraints.
DataDefinition::setDataType	public	function	Sets the data type.	1
DataDefinition::setDescription	public	function	Sets the human-readable description.
DataDefinition::setInternal	public	function	Sets the whether the data value should be internal.
DataDefinition::setLabel	public	function	Sets the human-readable label.
DataDefinition::setReadOnly	public	function	Sets whether the data is read-only.
DataDefinition::setRequired	public	function	Sets whether the data is required.
DataDefinition::setSetting	public	function	Sets a definition setting.	2
DataDefinition::setSettings	public	function	Sets the array of settings, as required by the used class.	2
DataDefinition::toArray	public	function	Returns all definition values as array.
DataDefinition::__construct	public	function	Constructs a new data definition object.	1
DataDefinition::__sleep	public	function		2
ProcessorProperty::getProcessorId	public	function	Retrieves the ID of the processor which defines this property. Overrides ProcessorPropertyInterface::getProcessorId
ProcessorProperty::isHidden	public	function	Determines whether this property should be hidden from the UI. Overrides ProcessorPropertyInterface::isHidden
ProcessorProperty::isList	public	function	Returns whether the data is multi-valued, i.e. a list of data items. Overrides DataDefinition::isList
SiteNameProperty::buildConfigurationForm	public	function	Constructs a configuration form for a field based on this property. Overrides ConfigurablePropertyInterface::buildConfigurationForm
SiteNameProperty::defaultConfiguration	public	function	Gets the default configuration for this property. Overrides ConfigurablePropertyBase::defaultConfiguration
SiteNameProperty::submitConfigurationForm	public	function	Submits a configuration form for a field based on this property. Overrides ConfigurablePropertyBase::submitConfigurationForm
SiteNameProperty::useDomain	protected	function	Whether to use the values from Domain.
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.
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager	public	function	Gets the typed data manager.	2
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	2