You are here

class CourierMessageController in Courier 8

Same name and namespace in other branches
  1. 2.x courier_message_composer/src/Controller/CourierMessageController.php \Drupal\courier_message_composer\Controller\CourierMessageController

Returns responses for CourierMessageController routes.

Hierarchy

Expanded class hierarchy of CourierMessageController

File

courier_message_composer/src/Controller/CourierMessageController.php, line 15

Namespace

Drupal\courier_message_composer\Controller
View source
class CourierMessageController extends ControllerBase implements ContainerInjectionInterface {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The identity channel manager.
   *
   * @var \Drupal\courier\Service\IdentityChannelManagerInterface
   */
  protected $identityChannelManager;

  /**
   * Constructs a CourierMessageController object.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\courier\Service\IdentityChannelManagerInterface $identity_channel_manager
   *   The identity channel manager.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, IdentityChannelManagerInterface $identity_channel_manager) {
    $this->entityTypeManager = $entity_type_manager;
    $this->identityChannelManager = $identity_channel_manager;
  }

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

  /**
   * Return a list of links to channels.
   */
  public function channelList() {
    $render['channels'] = [
      '#title' => $this
        ->t('Channels'),
      '#theme' => 'item_list',
      '#items' => [],
    ];
    foreach (array_keys($this->identityChannelManager
      ->getChannels()) as $channel) {
      if ($this
        ->composeAnyIdentityForChannel($channel)) {
        $definition = $this->entityTypeManager
          ->getDefinition($channel);
        $item = [];
        $item[] = [
          '#type' => 'link',
          '#title' => $definition
            ->getLabel(),
          '#url' => Url::fromRoute('courier_message_composer.compose', [
            'courier_channel' => $channel,
          ]),
        ];
        $render['channels']['#items'][] = $item;
      }
    }
    return $render;
  }

  /**
   * Determines if the current user can compose a message for any identity type.
   *
   * @param string $channel
   *   A channel entity type ID.
   *
   * @return bool
   *   If the current user can compose a message for any identity type.
   */
  protected function composeAnyIdentityForChannel($channel) {
    $channels = $this->identityChannelManager
      ->getChannels();
    if (array_key_exists($channel, $channels)) {
      foreach ($channels[$channel] as $identity) {
        $permission = "courier_message_composer compose {$channel} to {$identity}";
        if ($this
          ->currentUser()
          ->hasPermission($permission)) {
          return TRUE;
        }
      }
    }
    return FALSE;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
CourierMessageController::$entityTypeManager protected property The entity type manager. Overrides ControllerBase::$entityTypeManager
CourierMessageController::$identityChannelManager protected property The identity channel manager.
CourierMessageController::channelList public function Return a list of links to channels.
CourierMessageController::composeAnyIdentityForChannel protected function Determines if the current user can compose a message for any identity type.
CourierMessageController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
CourierMessageController::__construct public function Constructs a CourierMessageController object.
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.