class AssignOwnerNode
Same name and namespace in other branches
- 9 core/modules/node/src/Plugin/Action/AssignOwnerNode.php \Drupal\node\Plugin\Action\AssignOwnerNode
- 8.9.x core/modules/node/src/Plugin/Action/AssignOwnerNode.php \Drupal\node\Plugin\Action\AssignOwnerNode
- 10 core/modules/node/src/Plugin/Action/AssignOwnerNode.php \Drupal\node\Plugin\Action\AssignOwnerNode
- 10 core/modules/action/src/Plugin/Action/AssignOwnerNode.php \Drupal\action\Plugin\Action\AssignOwnerNode
Assigns ownership of a node to a user.
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\Action\ActionBase extends \Drupal\Core\Action\ActionInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Action\ConfigurableActionBase extends \Drupal\Component\Plugin\ConfigurableInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Plugin\PluginFormInterface uses \Drupal\Core\Plugin\ConfigurableTrait implements \Drupal\Core\Action\ActionBase
- class \Drupal\node\Plugin\Action\AssignOwnerNode extends \Drupal\Core\Plugin\ContainerFactoryPluginInterface implements \Drupal\Core\Action\ConfigurableActionBase
- class \Drupal\Core\Action\ConfigurableActionBase extends \Drupal\Component\Plugin\ConfigurableInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Plugin\PluginFormInterface uses \Drupal\Core\Plugin\ConfigurableTrait implements \Drupal\Core\Action\ActionBase
- class \Drupal\Core\Action\ActionBase extends \Drupal\Core\Action\ActionInterface 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 AssignOwnerNode
File
-
core/
modules/ node/ src/ Plugin/ Action/ AssignOwnerNode.php, line 18
Namespace
Drupal\node\Plugin\ActionView source
class AssignOwnerNode extends ConfigurableActionBase implements ContainerFactoryPluginInterface {
/**
* The database connection.
*
* @var \Drupal\Core\Database\Connection
*/
protected $connection;
/**
* Constructs a new AssignOwnerNode action.
*
* @param array $configuration
* A configuration array containing information about the plugin instance.
* @param string $plugin_id
* The plugin ID for the plugin instance.
* @param mixed $plugin_definition
* The plugin implementation definition.
* @param \Drupal\Core\Database\Connection $connection
* The database connection.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, Connection $connection) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->connection = $connection;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container->get('database'));
}
/**
* {@inheritdoc}
*/
public function execute($entity = NULL) {
/** @var \Drupal\node\NodeInterface $entity */
$entity->setOwnerId($this->configuration['owner_uid'])
->save();
}
/**
* {@inheritdoc}
*/
public function defaultConfiguration() {
return [
'owner_uid' => '',
];
}
/**
* {@inheritdoc}
*/
public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
$description = $this->t('The username of the user to which you would like to assign ownership.');
$count = $this->connection
->query("SELECT COUNT(*) FROM {users}")
->fetchField();
// Use dropdown for fewer than 200 users; textbox for more than that.
if (intval($count) < 200) {
$options = [];
$result = $this->connection
->query("SELECT [uid], [name] FROM {users_field_data} WHERE [uid] > 0 AND [default_langcode] = 1 ORDER BY [name]");
foreach ($result as $data) {
$options[$data->uid] = $data->name;
}
$form['owner_uid'] = [
'#type' => 'select',
'#title' => $this->t('Username'),
'#default_value' => $this->configuration['owner_uid'],
'#options' => $options,
'#description' => $description,
];
}
else {
$form['owner_uid'] = [
'#type' => 'entity_autocomplete',
'#title' => $this->t('Username'),
'#target_type' => 'user',
'#selection_settings' => [
'include_anonymous' => FALSE,
],
'#default_value' => User::load($this->configuration['owner_uid']),
// Validation is done in static::validateConfigurationForm().
'#validate_reference' => FALSE,
'#size' => '6',
'#maxlength' => '60',
'#description' => $description,
];
}
return $form;
}
/**
* {@inheritdoc}
*/
public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
$exists = (bool) $this->connection
->queryRange('SELECT 1 FROM {users_field_data} WHERE [uid] = :uid AND [default_langcode] = 1', 0, 1, [
':uid' => $form_state->getValue('owner_uid'),
])
->fetchField();
if (!$exists) {
$form_state->setErrorByName('owner_uid', $this->t('Enter a valid username.'));
}
}
/**
* {@inheritdoc}
*/
public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
$this->configuration['owner_uid'] = $form_state->getValue('owner_uid');
}
/**
* {@inheritdoc}
*/
public function access($object, AccountInterface $account = NULL, $return_as_object = FALSE) {
/** @var \Drupal\node\NodeInterface $object */
$result = $object->access('update', $account, TRUE)
->andIf($object->getOwner()
->access('edit', $account, TRUE));
return $return_as_object ? $result : $result->isAllowed();
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
ActionBase::executeMultiple | public | function | Executes the plugin for an array of objects. | Overrides ActionInterface::executeMultiple | 3 |
AssignOwnerNode::$connection | protected | property | The database connection. | ||
AssignOwnerNode::access | public | function | Checks object access. | Overrides ActionInterface::access | |
AssignOwnerNode::buildConfigurationForm | public | function | Form constructor. | Overrides PluginFormInterface::buildConfigurationForm | |
AssignOwnerNode::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | |
AssignOwnerNode::defaultConfiguration | public | function | Gets default configuration for this plugin. | Overrides ConfigurableTrait::defaultConfiguration | |
AssignOwnerNode::execute | public | function | Executes the plugin. | Overrides ExecutableInterface::execute | |
AssignOwnerNode::submitConfigurationForm | public | function | Form submission handler. | Overrides PluginFormInterface::submitConfigurationForm | |
AssignOwnerNode::validateConfigurationForm | public | function | Form validation handler. | Overrides ConfigurableActionBase::validateConfigurationForm | |
AssignOwnerNode::__construct | public | function | Constructs a new AssignOwnerNode action. | Overrides ConfigurableActionBase::__construct | |
ConfigurableActionBase::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | Overrides DependentPluginInterface::calculateDependencies | 1 |
ConfigurableTrait::$configuration | protected | property | Configuration information passed into the plugin. | ||
ConfigurableTrait::getConfiguration | public | function | Gets this plugin's configuration. | 3 | |
ConfigurableTrait::setConfiguration | public | function | Sets the configuration for this plugin instance. | 2 | |
PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 7 | |
PluginInspectionInterface::getPluginId | public | function | Gets the plugin ID of the plugin instance. | 3 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.