class FileSelection
Same name and namespace in other branches
- 11.x core/modules/file/src/Plugin/EntityReferenceSelection/FileSelection.php \Drupal\file\Plugin\EntityReferenceSelection\FileSelection
Provides specific access control for the file entity type.
Plugin annotation
@EntityReferenceSelection(
id = "default:file",
label = @Translation("File selection"),
entity_types = {"file"},
group = "default",
weight = 1
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
- class \Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginBase extends \Drupal\Core\Entity\EntityReferenceSelection\SelectionInterface, \Drupal\Component\Plugin\ConfigurableInterface, \Drupal\Component\Plugin\DependentPluginInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Entity\Plugin\EntityReferenceSelection\DefaultSelection extends \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\Core\Entity\EntityReferenceSelection\SelectionWithAutocreateInterface implements \Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginBase
- class \Drupal\file\Plugin\EntityReferenceSelection\FileSelection implements \Drupal\Core\Entity\Plugin\EntityReferenceSelection\DefaultSelection
- class \Drupal\Core\Entity\Plugin\EntityReferenceSelection\DefaultSelection extends \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\Core\Entity\EntityReferenceSelection\SelectionWithAutocreateInterface implements \Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginBase
- class \Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginBase extends \Drupal\Core\Entity\EntityReferenceSelection\SelectionInterface, \Drupal\Component\Plugin\ConfigurableInterface, \Drupal\Component\Plugin\DependentPluginInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of FileSelection
File
-
core/
modules/ file/ src/ Plugin/ EntityReferenceSelection/ FileSelection.php, line 19
Namespace
Drupal\file\Plugin\EntityReferenceSelectionView source
class FileSelection extends DefaultSelection {
/**
* {@inheritdoc}
*/
protected function buildEntityQuery($match = NULL, $match_operator = 'CONTAINS') {
$query = parent::buildEntityQuery($match, $match_operator);
// Allow referencing :
// - files with status "permanent"
// - or files uploaded by the current user (since newly uploaded files only
// become "permanent" after the containing entity gets validated and
// saved.)
$query->condition($query->orConditionGroup()
->condition('status', FileInterface::STATUS_PERMANENT)
->condition('uid', $this->currentUser
->id()));
return $query;
}
/**
* {@inheritdoc}
*/
public function createNewEntity($entity_type_id, $bundle, $label, $uid) {
$file = parent::createNewEntity($entity_type_id, $bundle, $label, $uid);
// In order to create a referenceable file, it needs to have a "permanent"
// status.
/** @var \Drupal\file\FileInterface $file */
$file->setPermanent();
return $file;
}
/**
* {@inheritdoc}
*/
public function validateReferenceableNewEntities(array $entities) {
$entities = parent::validateReferenceableNewEntities($entities);
$entities = array_filter($entities, function ($file) {
/** @var \Drupal\file\FileInterface $file */
return $file->isPermanent() || $file->getOwnerId() === $this->currentUser
->id();
});
return $entities;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
DefaultSelection::$currentUser | protected | property | The current user. | ||
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 | |||
DefaultSelection::countReferenceableEntities | public | function | |||
DefaultSelection::create | public static | function | |||
DefaultSelection::defaultConfiguration | public | function | |||
DefaultSelection::elementValidateFilter | public static | function | Form element validation handler; Filters the #value property of an element. | ||
DefaultSelection::getReferenceableEntities | public | function | |||
DefaultSelection::reAlterQuery | protected | function | Helper method: Passes a query to the alteration system again. | ||
DefaultSelection::validateConfigurationForm | public | function | |||
DefaultSelection::validateReferenceableEntities | public | function | |||
DefaultSelection::__construct | public | function | Constructs a new DefaultSelection object. | ||
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 | |||
DependencySerializationTrait::__wakeup | public | function | #[\ReturnTypeWillChange] | ||
FileSelection::buildEntityQuery | protected | function | Builds an EntityQuery to get referenceable entities. | Overrides DefaultSelection::buildEntityQuery | |
FileSelection::createNewEntity | public | function | Creates a new entity object that can be used as a valid reference. | Overrides DefaultSelection::createNewEntity | |
FileSelection::validateReferenceableNewEntities | public | function | Validates which newly created entities can be referenced. | Overrides DefaultSelection::validateReferenceableNewEntities | |
MessengerTrait::$messenger | protected | property | The messenger. | 7 | |
MessengerTrait::$messenger | protected | property | The messenger. | 7 | |
MessengerTrait::messenger | public | function | Gets the messenger. | 7 | |
MessengerTrait::messenger | public | function | Gets the messenger. | 7 | |
MessengerTrait::setMessenger | public | function | Sets the messenger. | ||
PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | ||
PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. | ||
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 | |||
PluginBase::getDerivativeId | public | function | |||
PluginBase::getPluginDefinition | public | function | 1 | ||
PluginBase::getPluginDefinition | public | function | 1 | ||
PluginBase::getPluginId | public | function | |||
PluginBase::isConfigurable | public | function | Determines if the plugin is configurable. | ||
SelectionPluginBase::calculateDependencies | public | function | |||
SelectionPluginBase::entityQueryAlter | public | function | |||
SelectionPluginBase::getConfiguration | public | function | |||
SelectionPluginBase::setConfiguration | public | function | |||
SelectionPluginBase::submitConfigurationForm | public | function | |||
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | ||
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. | ||
StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.