MessagePermissions.php in Message UI 8

Namespace

Drupal\message_ui

File

src/MessagePermissions.php

<?php

namespace Drupal\message_ui;

use Drupal\Core\StringTranslation\StringTranslationTrait;
use Drupal\message\Entity\MessageTemplate;

/**
 * Defines a class containing permission callbacks.
 */
class MessagePermissions {
  use StringTranslationTrait;

  /**
   * Gets an array of message type permissions.
   *
   * @return array
   *   The message template permissions.
   *
   * @see \Drupal\user\PermissionHandlerInterface::getPermissions()
   */
  public function messageTemplatePermissions() {
    $perms = [];

    // Generate node permissions for all message templates.
    foreach (MessageTemplate::loadMultiple() as $template) {
      $perms += $this
        ->buildPermissions($template);
    }
    return $perms;
  }

  /**
   * Builds a standard list of message permissions for a given template.
   *
   * @param \Drupal\message\Entity\MessageTemplate $template
   *   The machine name of the message template.
   *
   * @return array
   *   An array of permission names and descriptions.
   */
  protected function buildPermissions(MessageTemplate $template) {
    $template_params = [
      '%template_name' => $template
        ->label(),
    ];
    return [
      'view ' . $template
        ->id() . ' message' => [
        'title' => $this
          ->t('%template_name: View a message instance', $template_params),
      ],
      'edit ' . $template
        ->id() . ' message' => [
        'title' => $this
          ->t('%template_name: Edit a message instance', $template_params),
      ],
      'create ' . $template
        ->id() . ' message' => [
        'title' => $this
          ->t('%template_name: Create a new message instance', $template_params),
      ],
      'delete ' . $template
        ->id() . ' message' => [
        'title' => $this
          ->t('%template_name: Delete a message instance', $template_params),
      ],
    ];
  }

}

Classes

Name	Description
MessagePermissions	Defines a class containing permission callbacks.