class TemplateCollectionList in Courier 8

Same name and namespace in other branches

2.x src/Element/TemplateCollectionList.php \Drupal\courier\Element\TemplateCollectionList

Provides a template collection list element.

Can be used outside of a form.

Plugin annotation

@FormElement("courier_template_collection_list");

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\courier\Element\TemplateCollectionList

Expanded class hierarchy of TemplateCollectionList

1 #type use of TemplateCollectionList

Settings::buildForm in courier_system/src/Form/Settings.php: Form constructor.

File

src/Element/TemplateCollectionList.php, line 18

Namespace

Drupal\courier\Element

View source

class TemplateCollectionList extends FormElement {

  /**
   * @inheritDoc
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#input' => TRUE,
      '#process' => [
        [
          $class,
          'processTemplateCollectionList',
        ],
      ],
      // Items can be any non-zero key. Forms will return this key for keys of
      // checkboxes in $form_element['checkboxes'].
      '#items' => [],
      '#checkboxes' => FALSE,
      '#attributes' => [],
      '#value' => NULL,
    ];
  }

  /**
   * Processes a template collection element.
   *
   * @param array $element
   *   An associative array containing the properties and children of the
   *   container.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   * @param array $complete_form
   *   The complete form structure.
   *
   * @return array
   *   The processed element.
   */
  public static function processTemplateCollectionList(&$element, FormStateInterface $form_state, &$complete_form) {
    $element['#tree'] = TRUE;
    $element['#attached']['library'][] = 'courier/courier.template_collection_list';
    $element['template_collection_list'] = [
      '#type' => 'container',
      '#attributes' => [
        'class' => [
          'template_collection_list',
        ],
      ],
    ];

    // Add empty checkboxes form item. This will ensure 'checkboxes' always
    // exists in $form_state values. This is only an issue if there are no
    // checkboxes rendered initially (list is empty).
    $element['checkboxes'] = [
      '#type' => 'checkboxes',
      '#options' => NULL,
    ];
    if ($element['#checkboxes']) {
      $element['template_collection_list']['#attributes']['class'][] = 'checkboxes';
    }
    $entity_type_manager = \Drupal::entityTypeManager();
    $destination = \Drupal::destination()
      ->getAsArray();

    /** @var \Drupal\courier\Service\IdentityChannelManagerInterface $icm */
    $icm = \Drupal::service('plugin.manager.identity_channel');
    $channels_all = array_keys($icm
      ->getChannels());
    foreach ($element['#items'] as $id => $setting) {

      /** @var \Drupal\courier\TemplateCollectionInterface $template_collection */
      $template_collection = $setting['#template_collection'];
      $t_args = [
        '@id' => $template_collection
          ->id(),
        '@label' => $setting['#title'],
      ];
      $element['template_collection_list'][$id] = [
        '#type' => 'container',
        '#attributes' => [
          'class' => [
            'template_collection',
          ],
          'template_collection' => $template_collection
            ->id(),
        ],
      ];
      $row =& $element['template_collection_list'][$id];
      if ($element['#checkboxes']) {
        $parents = array_merge($element['#parents'], [
          'checkboxes',
          $id,
        ]);
        $row['checkbox'] = [
          '#type' => 'checkbox',
          '#id' => Html::getUniqueId('edit-' . implode('-', $parents)),
          '#title' => t('Select Template Collection @id', $t_args),
          '#title_display' => 'hidden',
          '#parents' => $parents,
        ];
      }
      if (!empty($setting['#operations'])) {
        $row['operations']['data'] = [
          '#type' => 'operations',
          '#links' => $setting['#operations'],
        ];
      }
      $row['title']['#markup'] = '<h2>' . t('@label', $t_args) . '</h2>';
      if (isset($setting['#description'])) {
        $row['description']['#markup'] = '<p>' . $setting['#description'] . '</p>';
      }
      $row['templates'] = [
        '#type' => 'container',
        '#attributes' => [
          'class' => [
            'ui',
            'top',
            'attached',
            'menu',
            'small',
            'compact',
            'pointing',
          ],
        ],
      ];

      // Template links.
      $row['templates']['links'] = [
        '#prefix' => '<div class="item header">' . t('Messages') . ':</div>',
        '#theme' => 'item_list',
        '#items' => [],
        '#attributes' => [
          'class' => [
            'templates',
          ],
        ],
      ];
      foreach ($channels_all as $channel) {
        $url = Url::fromRoute('entity.courier_template_collection.channel')
          ->setRouteParameter('courier_template_collection', $template_collection
          ->id())
          ->setRouteParameter('courier_channel', $channel)
          ->setOption('attributes', [
          'entity_type' => $channel,
          'class' => [
            'item',
          ],
        ])
          ->setOption('query', $destination);
        $row['templates']['links']['#items'][] = new Link($entity_type_manager
          ->getDefinition($channel)
          ->getLabel(), $url);
      }
    }
    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
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.
TemplateCollectionList::getInfo	public	function	@inheritDoc Overrides ElementInterface::getInfo
TemplateCollectionList::processTemplateCollectionList	public static	function	Processes a template collection element.

You are here

class TemplateCollectionList in Courier 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation