You are here

class RolesWithAccess in Workbench Email 2.x

Same name and namespace in other branches
  1. 8 src/Plugin/RecipientType/RolesWithAccess.php \Drupal\workbench_email\Plugin\RecipientType\RolesWithAccess

Provides a recipient type for Workbench Access Sections.

Plugin annotation


@RecipientType(
  id = "roles_with_access",
  title = @Translation("Roles with access"),
  description = @Translation("Send to recipients with given role and permission to update."),
  settings = {
    "roles" = {},
  },
)

Hierarchy

Expanded class hierarchy of RolesWithAccess

File

src/Plugin/RecipientType/RolesWithAccess.php, line 26

Namespace

Drupal\workbench_email\Plugin\RecipientType
View source
class RolesWithAccess extends Role {

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $build = parent::buildConfigurationForm($form, $form_state);
    $build['roles']['#description'] = $this
      ->t('Send to all users with selected roles who have permission to update the transitioned item.');
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  public function prepareRecipients(ContentEntityInterface $entity, TemplateInterface $template) {
    $recipients = [];
    foreach ($this
      ->getRoles() as $role) {
      foreach ($this->entityTypeManager
        ->getStorage('user')
        ->loadByProperties([
        'roles' => $role,
        'status' => 1,
      ]) as $account) {
        if ($entity
          ->access('update', $account)) {
          $recipients[] = $account
            ->getEmail();
        }
      }
    }
    return $recipients;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
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 2
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.
PluginWithFormsTrait::getFormClass public function Implements \Drupal\Core\Plugin\PluginWithFormsInterface::getFormClass().
PluginWithFormsTrait::hasFormClass public function Implements \Drupal\Core\Plugin\PluginWithFormsInterface::hasFormClass().
RecipientTypeBase::$provider public property The name of the provider that owns this recipient type.
RecipientTypeBase::$settings public property An associative array containing the configured settings of this recipient type.
RecipientTypeBase::$status public property A Boolean indicating whether this recipient type is enabled.
RecipientTypeBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
RecipientTypeBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
RecipientTypeBase::getDescription public function Returns the administrative description for this recipient type plugin. Overrides RecipientTypeInterface::getDescription
RecipientTypeBase::getLabel public function Returns the administrative label for this recipient type plugin. Overrides RecipientTypeInterface::getLabel
RecipientTypeBase::isEnabled public function Checks status. Overrides RecipientTypeInterface::isEnabled
RecipientTypeBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
RecipientTypeBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
Role::$entityTypeManager protected property The entity type manager.
Role::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides RecipientTypeBase::calculateDependencies
Role::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
Role::getRoles protected function Gets value of roles.
Role::onDependencyRemoval public function Informs the plugin that a dependency of the recipient type will be deleted. Overrides RecipientTypeBase::onDependencyRemoval
Role::setRoles protected function Sets roles.
Role::submitConfigurationForm public function Form submission handler. Overrides RecipientTypeBase::submitConfigurationForm
Role::__construct public function Constructs a new Role object. Overrides RecipientTypeBase::__construct
RolesWithAccess::buildConfigurationForm public function Generates a recipient types's settings form. Overrides Role::buildConfigurationForm
RolesWithAccess::prepareRecipients public function Returns email address(s) matching this recipient type's configuration. Overrides Role::prepareRecipients
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.