class WorkspaceSelection
Same name in other branches
- 8.9.x core/modules/workspaces/src/Plugin/EntityReferenceSelection/WorkspaceSelection.php \Drupal\workspaces\Plugin\EntityReferenceSelection\WorkspaceSelection
- 10 core/modules/workspaces/src/Plugin/EntityReferenceSelection/WorkspaceSelection.php \Drupal\workspaces\Plugin\EntityReferenceSelection\WorkspaceSelection
- 11.x core/modules/workspaces/src/Plugin/EntityReferenceSelection/WorkspaceSelection.php \Drupal\workspaces\Plugin\EntityReferenceSelection\WorkspaceSelection
Provides specific access control for the workspace entity type.
Plugin annotation
@EntityReferenceSelection(
id = "default:workspace",
label = @Translation("Workspace selection"),
entity_types = {"workspace"},
group = "default",
weight = 1
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Entity\EntityReferenceSelection\SelectionInterface, \Drupal\Component\Plugin\ConfigurableInterface, \Drupal\Component\Plugin\DependentPluginInterface
- class \Drupal\Core\Entity\Plugin\EntityReferenceSelection\DefaultSelection extends \Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\Core\Entity\EntityReferenceSelection\SelectionWithAutocreateInterface
- class \Drupal\workspaces\Plugin\EntityReferenceSelection\WorkspaceSelection extends \Drupal\Core\Entity\Plugin\EntityReferenceSelection\DefaultSelection
- class \Drupal\Core\Entity\Plugin\EntityReferenceSelection\DefaultSelection extends \Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\Core\Entity\EntityReferenceSelection\SelectionWithAutocreateInterface
- class \Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Entity\EntityReferenceSelection\SelectionInterface, \Drupal\Component\Plugin\ConfigurableInterface, \Drupal\Component\Plugin\DependentPluginInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of WorkspaceSelection
File
-
core/
modules/ workspaces/ src/ Plugin/ EntityReferenceSelection/ WorkspaceSelection.php, line 21
Namespace
Drupal\workspaces\Plugin\EntityReferenceSelectionView source
class WorkspaceSelection extends DefaultSelection {
/**
* The workspace repository service.
*
* @var \Drupal\workspaces\WorkspaceRepositoryInterface
*/
protected $workspaceRepository;
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
$instance = parent::create($container, $configuration, $plugin_id, $plugin_definition);
$instance->workspaceRepository = $container->get('workspaces.repository');
return $instance;
}
/**
* {@inheritdoc}
*/
public function defaultConfiguration() {
return [
'sort' => [
'field' => 'label',
'direction' => 'asc',
],
] + parent::defaultConfiguration();
}
/**
* {@inheritdoc}
*/
public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
$form = parent::buildConfigurationForm($form, $form_state);
// Sorting is not possible for workspaces because we always sort them by
// depth and label.
$form['sort']['#access'] = FALSE;
return $form;
}
/**
* {@inheritdoc}
*/
public function getReferenceableEntities($match = NULL, $match_operator = 'CONTAINS', $limit = 0) {
// Get all the workspace entities and sort them in tree order.
$storage = $this->entityTypeManager
->getStorage('workspace');
$workspace_tree = $this->workspaceRepository
->loadTree();
$entities = array_replace($workspace_tree, $storage->loadMultiple());
// If we need to restrict the list of workspaces by searching only a part of
// their label ($match) or by a number of results ($limit), the workspace
// tree would be mangled because it wouldn't contain all the tree items.
if ($match || $limit) {
$options = parent::getReferenceableEntities($match, $match_operator, $limit);
}
else {
$options = [];
foreach ($entities as $entity) {
$options[$entity->bundle()][$entity->id()] = str_repeat('-', $workspace_tree[$entity->id()]['depth']) . Html::escape($this->entityRepository
->getTranslationFromContext($entity)
->label());
}
}
$restricted_access_entities = [];
foreach ($options as $bundle => $bundle_options) {
foreach (array_keys($bundle_options) as $id) {
// If a user can not view a workspace, we need to prevent them from
// referencing that workspace as well as its descendants.
if (in_array($id, $restricted_access_entities) || !$entities[$id]->access('view', $this->currentUser)) {
$restricted_access_entities += $workspace_tree[$id]['descendants'];
unset($options[$bundle][$id]);
}
}
}
return $options;
}
}
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::buildEntityQuery | protected | function | Builds an EntityQuery to get referenceable entities. | 7 | |
DefaultSelection::countReferenceableEntities | public | function | Counts entities that are referenceable. | Overrides SelectionInterface::countReferenceableEntities | 3 |
DefaultSelection::createNewEntity | public | function | Creates a new entity object that can be used as a valid reference. | Overrides SelectionWithAutocreateInterface::createNewEntity | 6 |
DefaultSelection::elementValidateFilter | public static | function | Form element validation handler; Filters the #value property of an element. | ||
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::validateReferenceableNewEntities | public | function | Validates which newly created entities can be referenced. | Overrides SelectionWithAutocreateInterface::validateReferenceableNewEntities | 6 |
DefaultSelection::__construct | public | function | Constructs a new DefaultSelection object. | Overrides SelectionPluginBase::__construct | 1 |
SelectionPluginBase::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | Overrides DependentPluginInterface::calculateDependencies | |
SelectionPluginBase::entityQueryAlter | public | function | Allows the selection to alter the SelectQuery generated by EntityFieldQuery. | Overrides SelectionInterface::entityQueryAlter | 2 |
SelectionPluginBase::getConfiguration | public | function | Gets this plugin's configuration. | Overrides ConfigurableInterface::getConfiguration | |
SelectionPluginBase::setConfiguration | public | function | Sets the configuration for this plugin instance. | Overrides ConfigurableInterface::setConfiguration | |
SelectionPluginBase::submitConfigurationForm | public | function | Form submission handler. | Overrides PluginFormInterface::submitConfigurationForm | |
WorkspaceSelection::$workspaceRepository | protected | property | The workspace repository service. | ||
WorkspaceSelection::buildConfigurationForm | public | function | Form constructor. | Overrides DefaultSelection::buildConfigurationForm | |
WorkspaceSelection::create | public static | function | Creates an instance of the plugin. | Overrides DefaultSelection::create | |
WorkspaceSelection::defaultConfiguration | public | function | Gets default configuration for this plugin. | Overrides DefaultSelection::defaultConfiguration | |
WorkspaceSelection::getReferenceableEntities | public | function | Gets the list of referenceable entities. | Overrides DefaultSelection::getReferenceableEntities |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.