You are here

Home » API reference » Workbench Access 8 » WorkbenchAccessByRoleForm.php

class WorkbenchAccessByRoleForm in Workbench Access 8

Configure Workbench Access per role.

Hierarchy

Expanded class hierarchy of WorkbenchAccessByRoleForm

1 string reference to 'WorkbenchAccessByRoleForm'
workbench_access.routing.yml in ./workbench_access.routing.yml
workbench_access.routing.yml

File

src/Form/WorkbenchAccessByRoleForm.php, line 15

Namespace

Drupal\workbench_access\Form
View source 
class WorkbenchAccessByRoleForm extends FormBase {

  /**
   * The Workbench Access manager service.
   *
   * @var \Drupal\workbench_access\WorkbenchAccessManager
   */
  protected $manager;

  /**
   * The role section storage service.
   *
   * @var \Drupal\workbench_access\RoleSectionStorageInterface
   */
  protected $roleSectionStorage;

  /**
   * Scheme.
   *
   * @var \Drupal\workbench_access\Entity\AccessSchemeInterface
   */
  protected $scheme;

  /**
   * Constructs a new WorkbenchAccessConfigForm.
   *
   * @param \Drupal\workbench_access\WorkbenchAccessManagerInterface $manager
   *   The Workbench Access hierarchy manager.
   * @param \Drupal\workbench_access\RoleSectionStorageInterface $role_section_storage
   *   The role section storage service.
   */
  public function __construct(WorkbenchAccessManagerInterface $manager, RoleSectionStorageInterface $role_section_storage) {
    $this->manager = $manager;
    $this->roleSectionStorage = $role_section_storage;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('plugin.manager.workbench_access.scheme'), $container
      ->get('workbench_access.role_section_storage'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'workbench_access_by_role';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, AccessSchemeInterface $access_scheme = NULL, $id = NULL) {
    $this->scheme = $access_scheme;
    $existing_roles = $this->roleSectionStorage
      ->getRoles($access_scheme, $id);
    $potential_roles = $this->roleSectionStorage
      ->getPotentialRolesFiltered($id);
    $form['existing_roles'] = [
      '#type' => 'value',
      '#value' => $existing_roles,
    ];
    $form['section_id'] = [
      '#type' => 'value',
      '#value' => $id,
    ];
    if (!$existing_roles) {
      $text = $this
        ->t('There are no roles assigned to the %label section.', [
        '%label' => $access_scheme
          ->label(),
      ]);
      $form['help'] = [
        '#type' => 'markup',
        '#markup' => '<p>' . $text . '</p>',
      ];
    }
    if ($potential_roles) {
      $form['roles'] = [
        '#title' => $this
          ->t('Roles for the %label section.', [
          '%label' => $access_scheme
            ->label(),
        ]),
        '#type' => 'checkboxes',
        '#options' => $potential_roles,
        '#default_value' => $existing_roles,
      ];
      $form['actions'] = [
        '#type' => 'actions',
      ];
      $form['actions']['submit'] = [
        '#type' => 'submit',
        '#value' => $this
          ->t('Submit'),
      ];
    }
    if (count($potential_roles) == count($existing_roles)) {
      $form['message'] = [
        '#type' => 'markup',
        '#markup' => '<p>' . $this
          ->t('There are no additional roles that can be added to the %label section', [
          '%label' => $access_scheme
            ->label(),
        ]) . '</p>',
      ];
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $roles = $form_state
      ->getValue('roles');
    $existing_roles = $form_state
      ->getValue('existing_roles');
    $id = $form_state
      ->getValue('section_id');
    foreach ($roles as $role_id => $value) {

      // Add role to section.
      if ($value === $role_id) {
        $this->roleSectionStorage
          ->addRole($this->scheme, $role_id, [
          $id,
        ]);
      }
      else {
        $this->roleSectionStorage
          ->removeRole($this->scheme, $role_id, [
          $id,
        ]);
      }
    }
    \Drupal::messenger()
      ->addMessage($this
      ->t('Role assignments updated.'));
  }

  /**
   * Returns a dynamic page title for the route.
   *
   * @param \Drupal\workbench_access\Entity\AccessSchemeInterface $access_scheme
   *   Access scheme.
   * @param string $id
   *   The section id.
   *
   * @return string
   *   A page title.
   */
  public function pageTitle(AccessSchemeInterface $access_scheme, $id) {
    return $this
      ->t('Roles assigned to %label', [
      '%label' => $access_scheme
        ->label(),
    ]);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.
WorkbenchAccessByRoleForm::$manager protected property The Workbench Access manager service.
WorkbenchAccessByRoleForm::$roleSectionStorage protected property The role section storage service.
WorkbenchAccessByRoleForm::$scheme protected property Scheme.
WorkbenchAccessByRoleForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
WorkbenchAccessByRoleForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
WorkbenchAccessByRoleForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
WorkbenchAccessByRoleForm::pageTitle public function Returns a dynamic page title for the route.
WorkbenchAccessByRoleForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
WorkbenchAccessByRoleForm::__construct public function Constructs a new WorkbenchAccessConfigForm.