aleph1.co.uk Git - yaffs-website/blob - web/core/lib/Drupal/Core/Render/Element/Details.php

   1 <?php
   2
   3 namespace Drupal\Core\Render\Element;
   4
   5 use Drupal\Core\Render\Element;
   6
   7 /**
   8  * Provides a render element for a details element, similar to a fieldset.
   9  *
  10  * Fieldsets can only be used in forms, while details elements can be used
  11  * outside of forms. Users click on the title to open or close the details
  12  * element, showing or hiding the contained elements.
  13  *
  14  * Properties:
  15  * - #title: The title of the details container. Defaults to "Details".
  16  * - #open: Indicates whether the container should be open by default.
  17  *   Defaults to FALSE.
  18  *
  19  * Usage example:
  20  * @code
  21  * $form['author'] = array(
  22  *   '#type' => 'details',
  23  *   '#title' => $this->t('Author'),
  24  * );
  25  *
  26  * $form['author']['name'] = array(
  27  *   '#type' => 'textfield',
  28  *   '#title' => $this->t('Name'),
  29  * );
  30  * @endcode
  31  *
  32  * @see \Drupal\Core\Render\Element\Fieldset
  33  * @see \Drupal]Core\Render\Element\VerticalTabs
  34  *
  35  * @RenderElement("details")
  36  */
  37 class Details extends RenderElement {
  38
  39   /**
  40    * {@inheritdoc}
  41    */
  42   public function getInfo() {
  43     $class = get_class($this);
  44     return [
  45       '#open' => FALSE,
  46       '#value' => NULL,
  47       '#process' => [
  48         [$class, 'processGroup'],
  49         [$class, 'processAjaxForm'],
  50       ],
  51       '#pre_render' => [
  52         [$class, 'preRenderDetails'],
  53         [$class, 'preRenderGroup'],
  54       ],
  55       '#theme_wrappers' => ['details'],
  56     ];
  57   }
  58
  59   /**
  60    * Adds form element theming to details.
  61    *
  62    * @param $element
  63    *   An associative array containing the properties and children of the
  64    *   details.
  65    *
  66    * @return
  67    *   The modified element.
  68    */
  69   public static function preRenderDetails($element) {
  70     Element::setAttributes($element, ['id']);
  71
  72     // The .js-form-wrapper class is required for #states to treat details like
  73     // containers.
  74     static::setAttributes($element, ['js-form-wrapper', 'form-wrapper']);
  75
  76     // Collapsible details.
  77     $element['#attached']['library'][] = 'core/drupal.collapse';
  78
  79     // Open the detail if specified or if a child has an error.
  80     if (!empty($element['#open']) || !empty($element['#children_errors'])) {
  81       $element['#attributes']['open'] = 'open';
  82     }
  83
  84     // Do not render optional details elements if there are no children.
  85     if (isset($element['#parents'])) {
  86       $group = implode('][', $element['#parents']);
  87       if (!empty($element['#optional']) && !Element::getVisibleChildren($element['#groups'][$group])) {
  88         $element['#printed'] = TRUE;
  89       }
  90     }
  91
  92     return $element;
  93   }
  94
  95 }