class ChannelFormController in Courier 2.x

Controller for channels.

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\courier\Controller\ChannelFormController implements ContainerInjectionInterface uses CourierTokenElementTrait

File

src/Controller/ChannelFormController.php, line 20

Namespace

Drupal\courier\Controller

class ChannelFormController extends ControllerBase implements ContainerInjectionInterface {
  use CourierTokenElementTrait;

  /**
   * Gets the template form for a channel in a template collection.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   * @param \Drupal\courier\TemplateCollectionInterface $courier_template_collection
   *   A template collection entity.
   * @param \Drupal\Core\Entity\ContentEntityTypeInterface $courier_channel
   *   Entity type definition for the channel.
   *
   * @return array|\Drupal\Core\Ajax\AjaxResponse
   *   A render array for regular requests, or AjaxResponse if called by ajax.
   */
  public function template(Request $request, TemplateCollectionInterface $courier_template_collection, ContentEntityTypeInterface $courier_channel) {
    $template_collection = $courier_template_collection;
    $render = \Drupal::formBuilder()
      ->getForm(TemplateEditForm::class, $template_collection, $courier_channel);
    if ($request->request
      ->get('js')) {
      $selector = '.template_collection[template_collection=' . $template_collection
        ->id() . '] .editor.' . $courier_channel
        ->id();
      $response = new AjaxResponse();
      $response
        ->addCommand(new HtmlCommand($selector, $render))
        ->addCommand(new PrependCommand($selector, [
        '#type' => 'status_messages',
      ]))
        ->addCommand(new CourierTemplate($template_collection
        ->id(), $courier_channel
        ->id(), 'open'));
      return $response;
    }
    return $render;
  }

  /**
   * Get tokens for a template collection.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request.
   * @param \Drupal\courier\TemplateCollectionInterface $courier_template_collection
   *   A template collection entity.
   *
   * @return \Drupal\Core\Ajax\AjaxResponse
   *   A AJAX response object.
   */
  public function tokens(Request $request, TemplateCollectionInterface $courier_template_collection) {
    $template_collection = $courier_template_collection;
    $render['tokens'] = [
      '#type' => 'container',
    ];
    $render['tokens']['list'] = $this
      ->templateCollectionTokenElement($template_collection);
    if ($request->request
      ->get('js')) {
      $selector = '.template_collection[template_collection=' . $template_collection
        ->id() . '] .properties_container';
      $response = new AjaxResponse();
      $response
        ->addCommand(new HtmlCommand($selector, $render));
      return $response;
    }
    return $render;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ChannelFormController::template	public	function	Gets the template form for a channel in a template collection.
ChannelFormController::tokens	public	function	Get tokens for a template collection.
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::$entityTypeManager	protected	property	The entity type 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::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	46
ControllerBase::currentUser	protected	function	Returns the current user.	1
ControllerBase::entityFormBuilder	protected	function	Retrieves the entity form builder.
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.
ControllerBase::state	protected	function	Returns the state storage service.
CourierTokenElementTrait::courierTokenElement	public	function	Render a token element.
CourierTokenElementTrait::templateCollectionTokenElement	public	function	Render a token element for a template collection.
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.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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.	4
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.