class FormModePermission in Form Mode Control 8.2

Provides dynamic permissions for the form_mode_control module.

Hierarchy

• class \Drupal\form_mode_control\FormModePermission implements ContainerInjectionInterface uses StringTranslationTrait

File

src/FormModePermission.php, line 14

Namespace

Drupal\form_mode_control

class FormModePermission implements ContainerInjectionInterface {
  use StringTranslationTrait;

  /**
   * The entity manager.
   *
   * @var \Drupal\Core\Entity\EntityManagerInterface
   */
  protected $entityManager;

  /**
   * Instantiates a new instance of this class.
   *
   * This is a factory method that returns a new instance of this class. The
   * factory should pass any needed dependencies into the constructor of this
   * class, but not the container itself. Every call to this method must return
   * a new instance of this class; that is, it may not implement a singleton.
   *
   * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
   *   The service container this instance should use.
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.manager'));
  }

  /**
   * Constructs a new FormModePermission instance.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_manager
   *   The entity manager.
   */
  public function __construct(EntityTypeManagerInterface $entity_manager) {
    $this->entityManager = $entity_manager;
  }

  /**
   * Determine all permissions that should be shown, and update config.
   *
   * @return array
   *   The permissions to show in the permissions form.
   */
  public function roleToFormMode() {

    // Initialising permissions.
    $permissions = [];

    // Load all form modes.

    /* @var \Drupal\Core\Entity\Entity\EntityFormDisplay[] $all_form_modes */
    $all_form_modes = $this->entityManager
      ->getStorage('entity_form_display')
      ->loadMultiple();

    // Load configuration.
    $configuration = \Drupal::configFactory()
      ->getEditable('form_mode_control.settings');

    // Load a copy of the configuration to determine what's unused.
    $config_purgatory = $configuration
      ->getRawData();
    foreach ($all_form_modes as $id_form_mode => $form_mode) {
      $machine_name_form_mode = explode('.', $id_form_mode);
      $entity_type = $machine_name_form_mode[0];
      $bundle = $machine_name_form_mode[1];
      $form_mode_id = $machine_name_form_mode[2];
      $permissions_key = 'use  The form mode ' . $form_mode_id . ' linked to  ' . $entity_type . ' entity( ' . $bundle . ' )';

      // Clear from the config purgatory, since this key will be processed.
      unset($config_purgatory[$permissions_key]);

      // If the form mode is disabled don't add it to the list and make sure it
      // is cleared from configuration.
      // TODO : ( && $form_mode_id != "default") voir si c'est possible.
      if ($form_mode
        ->status() == FALSE || !$form_mode_id) {
        $configuration
          ->clear($permissions_key);
        continue;
      }

      // If the form mode is activated, we add a permission linked to this
      // form mode.
      $title = $this
        ->t('Use the form mode %label_form_mode linked to %entity_type_id ( %bundle )', [
        '%label_form_mode' => $form_mode_id,
        '%entity_type_id' => form_mode_control_get_entity_type_label($entity_type),
        '%bundle' => form_mode_control_get_bundle_label($entity_type, $bundle),
      ]);

      // Saving configurations.
      $permissions[$permissions_key] = [
        'title' => $title,
      ];
      $configuration
        ->set($permissions_key, $id_form_mode);
    }

    // Purge anything left in the config purgatory.
    foreach ($config_purgatory as $key => $data) {
      $configuration
        ->clear($key);
    }
    $configuration
      ->save(TRUE);
    $permissions['access_all_form_modes'] = [
      'title' => $this
        ->t('Access all form modes'),
      'description' => $this
        ->t('To access to a form mode, you must add ?display=form_mode_searched,else a form mode default was launched by default.'),
    ];
    return $permissions;
  }

  /**
   * Clear a piece of data from this module's settings.
   *
   * @param string $data
   *   The parameter to clear.
   */
  protected function clearDataPermissions($data) {
    foreach ($data as $id => $permission) {
      if (!EntityFormDisplay::load($id)) {
        \Drupal::configFactory()
          ->getEditable('form_mode_control.settings')
          ->clear($id);
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FormModePermission::$entityManager	protected	property	The entity manager.
FormModePermission::clearDataPermissions	protected	function	Clear a piece of data from this module's settings.
FormModePermission::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create
FormModePermission::roleToFormMode	public	function	Determine all permissions that should be shown, and update config.
FormModePermission::__construct	public	function	Constructs a new FormModePermission instance.
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.