class NodeMatcher in Linkit 8.5

Provides specific linkit matchers for the node entity type.

Plugin annotation

@Matcher(
  id = "entity:node",
  label = @Translation("Content"),
  target_entity = "node",
  provider = "node"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\linkit\MatcherBase implements ContainerFactoryPluginInterface, MatcherInterface
      • class \Drupal\linkit\ConfigurableMatcherBase implements ConfigurableMatcherInterface
        • class \Drupal\linkit\Plugin\Linkit\Matcher\EntityMatcher uses MatcherTokensTrait
          • class \Drupal\linkit\Plugin\Linkit\Matcher\NodeMatcher

File

src/Plugin/Linkit/Matcher/NodeMatcher.php, line 18

Namespace

Drupal\linkit\Plugin\Linkit\Matcher

class NodeMatcher extends EntityMatcher {

  /**
   * {@inheritdoc}
   */
  public function getSummary() {
    $summery = parent::getSummary();
    $summery[] = $this
      ->t('Include unpublished: @include_unpublished', [
      '@include_unpublished' => $this->configuration['include_unpublished'] ? $this
        ->t('Yes') : $this
        ->t('No'),
    ]);
    return $summery;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'include_unpublished' => FALSE,
    ] + parent::defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    return parent::calculateDependencies() + [
      'module' => [
        'node',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    $form['unpublished_nodes'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Unpublished nodes'),
      '#open' => TRUE,
    ];
    $form['unpublished_nodes']['include_unpublished'] = [
      '#title' => $this
        ->t('Include unpublished nodes'),
      '#type' => 'checkbox',
      '#default_value' => $this->configuration['include_unpublished'],
      '#description' => $this
        ->t('In order to see unpublished nodes, users must also have permissions to do so.'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $this->configuration['include_unpublished'] = $form_state
      ->getValue('include_unpublished');
  }

  /**
   * {@inheritdoc}
   */
  protected function buildEntityQuery($search_string) {
    $query = parent::buildEntityQuery($search_string);
    if ($this->configuration['include_unpublished'] == FALSE) {
      $query
        ->condition('status', NodeInterface::PUBLISHED);
    }
    elseif (count($this->moduleHandler
      ->getImplementations('node_grants')) === 0) {
      if ($this->currentUser
        ->hasPermission('bypass node access') || $this->currentUser
        ->hasPermission('view any unpublished content')) {

        // User can see all content, no check necessary.
      }
      elseif ($this->currentUser
        ->hasPermission('view own unpublished content')) {

        // Users with "view own unpublished content" can see only their own.
        if ($this->configuration['include_unpublished'] == TRUE) {
          $or_condition = $query
            ->orConditionGroup()
            ->condition('status', NodeInterface::PUBLISHED)
            ->condition('uid', $this->currentUser
            ->id());
          $query
            ->condition($or_condition);
        }
      }
    }
    else {

      // All other users should only get published results.
      $query
        ->condition('status', NodeInterface::PUBLISHED);
    }
    return $query;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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
EntityMatcher::$currentUser	protected	property	The current user.
EntityMatcher::$database	protected	property	The database connection.
EntityMatcher::$entityRepository	protected	property	The entity repository.
EntityMatcher::$entityTypeBundleInfo	protected	property	The entity type bundle info.
EntityMatcher::$entityTypeManager	protected	property	The entity type manager.
EntityMatcher::$moduleHandler	protected	property	The module handler service.
EntityMatcher::$substitutionManager	protected	property	The substitution manager.
EntityMatcher::$targetType	protected	property	The target entity type ID.
EntityMatcher::addQueryTags	protected	function	Adds query tags to the query.
EntityMatcher::buildDescription	protected	function	Builds the metadata string used in the suggestion.	2
EntityMatcher::buildGroup	protected	function	Builds the group string used in the suggestion.
EntityMatcher::buildLabel	protected	function	Builds the label string used in the suggestion.
EntityMatcher::buildPath	protected	function	Builds the path string used in the suggestion.	1
EntityMatcher::create	public static	function	Creates an instance of the plugin. Overrides MatcherBase::create
EntityMatcher::createSuggestion	protected	function	Creates a suggestion.
EntityMatcher::DEFAULT_LIMIT		constant	The default limit for matches.
EntityMatcher::elementValidateFilter	public static	function	Form element validation handler; Filters the #value property of an element.
EntityMatcher::execute	public	function	Executes the matcher. Overrides MatcherInterface::execute
EntityMatcher::findEntityIdByUrl	protected	function	Finds entity id from the given input.
EntityMatcher::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
EntityMatcher::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides MatcherBase::__construct
MatcherBase::$uuid	protected	property	The matcher ID.
MatcherBase::$weight	protected	property	The weight of the matcher compared to others in a matcher collection.
MatcherBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
MatcherBase::getLabel	public	function	Returns the matcher label. Overrides MatcherInterface::getLabel
MatcherBase::getUuid	public	function	Returns the unique ID representing the matcher. Overrides MatcherInterface::getUuid
MatcherBase::getWeight	public	function	Returns the weight of the matcher. Overrides MatcherInterface::getWeight
MatcherBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
MatcherBase::setWeight	public	function	Sets the weight for the matcher. Overrides MatcherInterface::setWeight
MatcherTokensTrait::getAvailableTokens	public	function	Gets all available tokens.
MatcherTokensTrait::insertTokenList	public	function	Inserts a form element with a list of available tokens.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
NodeMatcher::buildConfigurationForm	public	function	Form constructor. Overrides EntityMatcher::buildConfigurationForm
NodeMatcher::buildEntityQuery	protected	function	Builds an EntityQuery to get entities. Overrides EntityMatcher::buildEntityQuery
NodeMatcher::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides MatcherBase::calculateDependencies
NodeMatcher::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides EntityMatcher::defaultConfiguration
NodeMatcher::getSummary	public	function	Returns the summarized configuration of the matcher. Overrides EntityMatcher::getSummary
NodeMatcher::submitConfigurationForm	public	function	Form submission handler. Overrides EntityMatcher::submitConfigurationForm
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.
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.