You are here

Home » API reference » Synonyms 8 » SynonymsEntity.php

class SynonymsEntity in Synonyms 8

Same name in this branch
  1. 8 synonyms_views_argument_validator/src/Plugin/views/argument_validator/SynonymsEntity.php \Drupal\synonyms_views_argument_validator\Plugin\views\argument_validator\SynonymsEntity
  2. 8 synonyms_views_filter/src/Plugin/views/filter/SynonymsEntity.php \Drupal\synonyms_views_filter\Plugin\views\filter\SynonymsEntity
Same name and namespace in other branches
  1. 2.0.x modules/synonyms_views_argument_validator/src/Plugin/views/argument_validator/SynonymsEntity.php \Drupal\synonyms_views_argument_validator\Plugin\views\argument_validator\SynonymsEntity

Synonyms-friendly entity validator.

Plugin annotation


@ViewsArgumentValidator(
  id = "synonyms_entity",
  deriver = "Drupal\synonyms_views_argument_validator\Plugin\Derivative\ViewsSynonymsEntityArgumentValidator"
)

Hierarchy

Expanded class hierarchy of SynonymsEntity

File

synonyms_views_argument_validator/src/Plugin/views/argument_validator/SynonymsEntity.php, line 22

Namespace

Drupal\synonyms_views_argument_validator\Plugin\views\argument_validator
View source 
class SynonymsEntity extends Entity {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The synonyms behavior service.
   *
   * @var \Drupal\synonyms\SynonymsService\BehaviorService
   */
  protected $behaviorService;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, EntityTypeBundleInfoInterface $entity_type_bundle_info, BehaviorService $behavior_service) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $entity_type_manager, $entity_type_bundle_info);
    $this->entityTypeManager = $entity_type_manager;
    $this->behaviorService = $behavior_service;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_type.manager'), $container
      ->get('entity_type.bundle.info'), $container
      ->get('synonyms.behaviors'));
  }

  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    $form['transform'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Transform dashes in URL to spaces.'),
      '#default_value' => $this->options['transform'],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function validateArgument($argument) {
    if ($this->options['transform']) {
      $argument = str_replace('-', ' ', $argument);
    }
    $entity_type = $this->entityTypeManager
      ->getDefinition($this->definition['entity_type']);
    if ($entity_type
      ->hasKey('label') || $entity_type
      ->id() == 'user') {
      $query = $this->entityTypeManager
        ->getStorage($entity_type
        ->id())
        ->getQuery();

      // User entity type does not declare its label, while it does have one.
      $label_column = $entity_type
        ->id() == 'user' ? 'name' : $entity_type
        ->getKey('label');
      $query
        ->condition($label_column, $argument, '=');
      if ($entity_type
        ->hasKey('bundle') && !empty($this->options['bundles'])) {
        $query
          ->condition($entity_type
          ->getKey('bundle'), $this->options['bundles'], 'IN');
      }
      $result = $query
        ->execute();
      if (!empty($result)) {
        $entities = $this->entityTypeManager
          ->getStorage($entity_type
          ->id())
          ->loadMultiple($result);
        foreach ($entities as $entity) {
          if ($this
            ->validateEntity($entity)) {
            $this->argument->argument = $entity
              ->id();
            return TRUE;
          }
        }
      }
    }

    // We've fallen through with search by entity name, now it's time to search
    // by synonyms.
    $condition = new Condition('AND');
    $condition
      ->condition(SynonymsFindProviderInterface::COLUMN_SYNONYM_PLACEHOLDER, $argument, '=');
    foreach ($this->behaviorService
      ->getSynonymConfigEntities('synonyms.behavior.autocomplete', $entity_type
      ->id(), empty($this->options['bundles']) ? NULL : $this->options['bundles']) as $synonym_config) {
      foreach ($synonym_config
        ->getProviderPluginInstance()
        ->synonymsFind(clone $condition) as $synonym) {
        $entity = $this->entityTypeManager
          ->getStorage($entity_type
          ->id())
          ->load($synonym->entity_id);
        if ($this
          ->validateEntity($entity)) {
          $this->argument->argument = $entity
            ->id();
          return TRUE;
        }
      }
    }
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['transform'] = [
      'default' => FALSE,
    ];
    return $options;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ArgumentValidatorPluginBase::$argument protected property The argument handler instance associated with this plugin.
ArgumentValidatorPluginBase::access public function Determines if the administrator has the privileges to use this plugin.
ArgumentValidatorPluginBase::checkAccess protected function Blocks user input when the form is shown but we don´t have access.
ArgumentValidatorPluginBase::processSummaryArguments public function Processes the summary arguments for displaying. 1
ArgumentValidatorPluginBase::setArgument public function Sets the parent argument this plugin is associated with.
ArgumentValidatorPluginBase::validateOptionsForm public function Provides the default form for validating options. Overrides PluginBase::validateOptionsForm
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
DeprecatedServicePropertyTrait::__get public function Allows to access deprecated/removed properties.
Entity::$deprecatedProperties protected property
Entity::$entityTypeBundleInfo protected property The entity bundle info.
Entity::$multipleCapable protected property If this validator can handle multiple arguments.
Entity::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginBase::calculateDependencies 2
Entity::getContextDefinition public function Returns a context definition for this argument. Overrides ArgumentValidatorPluginBase::getContextDefinition
Entity::submitOptionsForm public function Provides the default form for submitting options. Overrides ArgumentValidatorPluginBase::submitOptionsForm 1
Entity::validateEntity protected function Validates an individual entity against class access settings. 1
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$definition public property Plugins's definition
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::$renderer protected property Stores the render API renderer. 3
PluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. 8
PluginBase::$view public property The top object of a view. 1
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::destroy public function Clears a plugin. Overrides ViewsPluginInterface::destroy 2
PluginBase::doFilterByDefinedOptions protected function Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions public function Filter out stored options depending on the defined options. Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements. Overrides ViewsPluginInterface::getAvailableGlobalTokens
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::getProvider public function Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer protected function Returns the render API renderer. 1
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form. Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced. Overrides ViewsPluginInterface::globalTokenReplace
PluginBase::INCLUDE_ENTITY constant Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED constant Include negotiated languages when listing languages.
PluginBase::init public function Initialize the plugin. Overrides ViewsPluginInterface::init 8
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::listLanguages protected function Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle public function Return the human readable name of the display. Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup public static function Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData public static function Flattens the structure of form elements. Overrides ViewsPluginInterface::preRenderFlattenData
PluginBase::query public function Add anything to the query that we might need to. Overrides ViewsPluginInterface::query 8
PluginBase::queryLanguageSubstitutions public static function Returns substitutions for Views queries for languages.
PluginBase::setOptionDefaults protected function Fills up the options of the plugin with defaults.
PluginBase::summaryTitle public function Returns the summary of the settings in the display. Overrides ViewsPluginInterface::summaryTitle 6
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions 1
PluginBase::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks 6
PluginBase::unpackOptions public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions public function Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions 8
PluginBase::validate public function Validate that the plugin is correct and can be saved. Overrides ViewsPluginInterface::validate 6
PluginBase::viewsTokenReplace protected function Replaces Views' tokens in a given string. The resulting string will be sanitized with Xss::filterAdmin. 1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT constant Query string to indicate the site default language.
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.
SynonymsEntity::$behaviorService protected property The synonyms behavior service.
SynonymsEntity::$entityTypeManager protected property The entity type manager. Overrides Entity::$entityTypeManager
SynonymsEntity::buildOptionsForm public function Provides the default form for setting options. Overrides Entity::buildOptionsForm
SynonymsEntity::create public static function Creates an instance of the plugin. Overrides Entity::create
SynonymsEntity::defineOptions protected function Retrieves the options when this is a new access control plugin. Overrides Entity::defineOptions
SynonymsEntity::validateArgument public function Performs validation for a given argument. Overrides Entity::validateArgument
SynonymsEntity::__construct public function Constructs an \Drupal\views\Plugin\views\argument_validator\Entity object. Overrides Entity::__construct
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING constant Untrusted callbacks trigger E_USER_WARNING errors.