class CommentSelection in Comment Permissions 8

Overrides CommentSelection plugin.

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginBase implements ConfigurableInterface, ConfigurablePluginInterface, DependentPluginInterface, SelectionInterface
    class \Drupal\Core\Entity\Plugin\EntityReferenceSelection\DefaultSelection implements SelectionWithAutocreateInterface, ContainerFactoryPluginInterface uses DeprecatedServicePropertyTrait
    class \Drupal\comment\Plugin\EntityReferenceSelection\CommentSelection
    class \Drupal\comment_perm\Plugin\EntityReferenceSelection\CommentSelection uses CommentAccessTrait

Expanded class hierarchy of CommentSelection

File

src/Plugin/EntityReferenceSelection/CommentSelection.php, line 12

Namespace

Drupal\comment_perm\Plugin\EntityReferenceSelection

View source

class CommentSelection extends CommentSelectionBase {
  use CommentAccessTrait;

  /**
   * {@inheritdoc}
   */
  protected function buildEntityQuery($match = NULL, $match_operator = 'CONTAINS') {
    $query = parent::buildEntityQuery($match, $match_operator);

    // Adding the 'comment_access' tag is sadly insufficient for comments:
    // core requires us to also know about the concept of 'published' and
    // 'unpublished'.
    if ($this
      ->userHasAdminPerm()) {

      // Add specific tag to alter query later and remove status condition.
      $query
        ->addTag('comment_perm_access');
    }
    else {
      $query
        ->condition('status', CommentInterface::PUBLISHED);
    }
    return $query;
  }

  /**
   * {@inheritdoc}
   */
  public function validateReferenceableNewEntities(array $entities) {

    // Default selection validation by bundle.
    $entities = array_filter($entities, function ($entity) {
      $target_bundles = $this
        ->getConfiguration()['target_bundles'];
      if (isset($target_bundles)) {
        return in_array($entity
          ->bundle(), $target_bundles);
      }
      return TRUE;
    });

    // Mirror the conditions checked in buildEntityQuery().
    if (!$this
      ->userHasAdminPerm()) {
      $entities = array_filter($entities, function ($comment) {

        /** @var \Drupal\comment\CommentInterface $comment */
        return $comment
          ->isPublished();
      });
    }
    return $entities;
  }

  /**
   * Determine if current use has admin role for at least one comment type.
   *
   * @return bool
   *   TRUE user has administration role, FALSE otherwise.
   */
  protected function userHasAdminPerm() {
    $is_admin = FALSE;
    foreach ($this
      ->getConfiguration()['target_bundles'] as $comment_type) {
      if ($this
        ->accessAdministerComment($this->currentUser, $comment_type)) {
        $is_admin = TRUE;
      }
    }
    return $is_admin;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CommentAccessTrait::accessAdministerComment	public	function	Check if user has access to administer comments.
CommentAccessTrait::accessAdministerCommentType	public	function	Check if user has access to administer comment type.
CommentAccessTrait::accessComment	public	function	Check if user has access to comments.
CommentAccessTrait::accessEditOwnComment	public	function	Check if user has access to edit own comment.
CommentAccessTrait::accessPostComment	public	function	Check if user has access to comments.
CommentAccessTrait::accessSkipCommentApproval	public	function	Check if user has access to skip comment approval.
CommentAccessTrait::noAccessAdministerComment	public	function	Check if user doesn't have access to administer comments.
CommentSelection::buildEntityQuery	protected	function	Builds an EntityQuery to get referenceable entities. Overrides CommentSelection::buildEntityQuery
CommentSelection::createNewEntity	public	function	Creates a new entity object that can be used as a valid reference. Overrides DefaultSelection::createNewEntity
CommentSelection::entityQueryAlter	public	function	Allows the selection to alter the SelectQuery generated by EntityFieldQuery. Overrides SelectionPluginBase::entityQueryAlter
CommentSelection::userHasAdminPerm	protected	function	Determine if current use has admin role for at least one comment type.
CommentSelection::validateReferenceableNewEntities	public	function	Validates which newly created entities can be referenced. Overrides CommentSelection::validateReferenceableNewEntities
DefaultSelection::$currentUser	protected	property	The current user.
DefaultSelection::$deprecatedProperties	protected	property
DefaultSelection::$entityFieldManager	protected	property	The entity field manager service.
DefaultSelection::$entityRepository	protected	property	The entity repository.
DefaultSelection::$entityTypeBundleInfo	public	property	Entity type bundle info service.
DefaultSelection::$entityTypeManager	protected	property	The entity type manager service.
DefaultSelection::$moduleHandler	protected	property	The module handler service.
DefaultSelection::buildConfigurationForm	public	function	Form constructor. Overrides SelectionPluginBase::buildConfigurationForm	3
DefaultSelection::countReferenceableEntities	public	function	Counts entities that are referenceable. Overrides SelectionInterface::countReferenceableEntities	2
DefaultSelection::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	2
DefaultSelection::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides SelectionPluginBase::defaultConfiguration	3
DefaultSelection::elementValidateFilter	public static	function	Form element validation handler; Filters the #value property of an element.
DefaultSelection::getReferenceableEntities	public	function	Gets the list of referenceable entities. Overrides SelectionInterface::getReferenceableEntities	3
DefaultSelection::reAlterQuery	protected	function	Helper method: Passes a query to the alteration system again.
DefaultSelection::validateConfigurationForm	public	function	Form validation handler. Overrides SelectionPluginBase::validateConfigurationForm
DefaultSelection::validateReferenceableEntities	public	function	Validates which existing entities can be referenced. Overrides SelectionInterface::validateReferenceableEntities
DefaultSelection::__construct	public	function	Constructs a new DefaultSelection object. Overrides SelectionPluginBase::__construct	1
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.
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::$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.
SelectionPluginBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
SelectionPluginBase::ensureBackwardCompatibilityConfiguration	protected	function	Ensures a backward compatibility level configuration.
SelectionPluginBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
SelectionPluginBase::resolveBackwardCompatibilityConfiguration	protected	function	Moves the backward compatibility level configurations in the right place.
SelectionPluginBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
SelectionPluginBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
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 CommentSelection in Comment Permissions 8

Hierarchy

File

Namespace

Members

API Navigation