class SimpleAccessGroups in Simple Access 8.3

Simple access groups element.

Plugin annotation

@FormElement("simple_access_groups");

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
    class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
    class \Drupal\simple_access\Element\SimpleAccessGroups

Expanded class hierarchy of SimpleAccessGroups

2 #type uses of SimpleAccessGroups

SimpleAccessProfileBaseForm::form in src/Form/SimpleAccessProfileBaseForm.php: Gets the actual form array to be built.
simple_access_form in ./simple_access.module: Simple Access form.

File

src/Element/SimpleAccessGroups.php, line 16

Namespace

Drupal\simple_access\Element

View source

class SimpleAccessGroups extends FormElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class_name = get_class($this);
    $element = [
      'wrapper' => [
        '#input' => FALSE,
      ],
      '#default_value' => [],
      '#tree' => TRUE,
      '#process' => [
        [
          $class_name,
          'processSimpleAccessGroups',
        ],
      ],
      '#pre_render' => [
        [
          $class_name,
          'preRenderSimpleAccessGroups',
        ],
      ],
      '#override_privilege' => FALSE,
      '#node_type' => '',
    ];
    return $element;
  }

  /**
   * Build the simple_aqccess_groups element.
   */
  public static function processSimpleAccessGroups(&$element, FormStateInterface $form_state, &$complete_form) {
    $groups = SimpleAccessGroup::loadMultiple();
    uasort($groups, [
      SimpleAccessGroup::class,
      'sort',
    ]);
    $config = \Drupal::config('simple_access.settings');
    $element['#default_value'] = is_array($element['#default_value']) ? $element['#default_value'] : [];
    $element['wrapper'] = isset($element['wrapper']) ? $element['wrapper'] : [];
    $element['wrapper'] += [
      '#type' => 'table',
    ];
    $element['wrapper']['#header'] = [
      t('Groups'),
    ];
    foreach (array_filter($config
      ->get('display')) as $item) {
      $element['wrapper']['#header'][] = Unicode::ucfirst($item);
    }

    /** @var \Drupal\simple_access\Entity\SimpleAccessGroup $group */
    foreach ($groups as $group) {
      $element['wrapper'][$group
        ->id()] = isset($element['wrapper'][$group
        ->id()]) ? $element['wrapper'][$group
        ->id()] : [];
      $element['wrapper'][$group
        ->id()] += [
        '#parents' => array_merge($element['#parents'], [
          $group
            ->id(),
        ]),
      ];
      $privilege = $element['#override_privilege'] || $group
        ->canManageAccess($element['#node_type']);
      $element['#default_value'][$group
        ->id()] = is_array($element['#default_value'][$group
        ->id()]) ? $element['#default_value'][$group
        ->id()] : [];
      $element['#default_value'][$group
        ->id()] += [
        'view' => 0,
        'update' => 0,
        'delete' => 0,
      ];
      $element['wrapper'][$group
        ->id()]['#access'] = $privilege;
      $element['wrapper'][$group
        ->id()]['name'] = [
        '#markup' => $group
          ->label(),
        '#access' => $privilege,
      ];
      $element['wrapper'][$group
        ->id()]['view'] = [
        '#type' => 'checkbox',
        '#default_value' => $element['#default_value'][$group
          ->id()]['view'],
        '#access' => $privilege && $config
          ->get('display.view'),
      ];
      $element['wrapper'][$group
        ->id()]['update'] = [
        '#type' => 'checkbox',
        '#default_value' => $element['#default_value'][$group
          ->id()]['update'],
        '#access' => $privilege && $config
          ->get('display.update'),
      ];
      $element['wrapper'][$group
        ->id()]['delete'] = [
        '#type' => 'checkbox',
        '#default_value' => $element['#default_value'][$group
          ->id()]['delete'],
        '#access' => $privilege && $config
          ->get('display.delete'),
      ];
    }
    return $element;
  }

  /**
   * Move all values aside which are not accessible so not to be included.
   */
  public static function preRenderSimpleAccessGroups($element) {
    foreach (Element::children($element['wrapper']) as $group) {
      if (isset($element['wrapper'][$group]['#access']) && !$element['wrapper'][$group]['#access']) {
        $element['no_access'][$group] = $element['wrapper'][$group];
        unset($element['wrapper'][$group]);
      }
      else {
        foreach (Element::children($element['wrapper'][$group]) as $access_type) {
          if (isset($element['wrapper'][$group][$access_type]['#access']) && !$element['wrapper'][$group][$access_type]['#access']) {
            $element['no_access'][$group][$access_type] = $element['wrapper'][$group][$access_type];
            unset($element['wrapper'][$group][$access_type]);
          }
        }
      }
    }
    return $element;
  }

}

Members

Name	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
FormElement::processAutocomplete	public static	function	Adds autocomplete functionality to elements.
FormElement::processPattern	public static	function	#process callback for #pattern form element property.
FormElement::validatePattern	public static	function	#element_validate callback for #pattern form element property.
FormElement::valueCallback	public static	function	Determines how user input is mapped to an element's #value property. Overrides FormElementInterface::valueCallback	15
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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	3
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
RenderElement::preRenderAjaxForm	public static	function	Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup	public static	function	Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm	public static	function	Form element processing handler for the #ajax form property.	1
RenderElement::processGroup	public static	function	Arranges elements into groups.
RenderElement::setAttributes	public static	function	Sets a form element's class attribute. Overrides ElementInterface::setAttributes
SimpleAccessGroups::getInfo	public	function	Returns the element properties for this element. Overrides ElementInterface::getInfo
SimpleAccessGroups::preRenderSimpleAccessGroups	public static	function	Move all values aside which are not accessible so not to be included.
SimpleAccessGroups::processSimpleAccessGroups	public static	function	Build the simple_aqccess_groups element.
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.

You are here

class SimpleAccessGroups in Simple Access 8.3

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation