Bootstrap Collapse items property uses label element and encodes by default, like Tabs

Fixes #5232 and #5231

extensions/bootstrap/CHANGELOG.md

@@ -4,7 +4,8 @@ Yii Framework 2 bootstrap extension Change Log
 2.0.0 under development
 -----------------------
 
-- no changes in this release.
+- Chg #5231: Collapse `items` property uses `label` element instead of array key for headers (nkovacs)
+- Chg #5232: Collapse encodes headers by default (nkovacs)
 
 
 2.0.0-rc September 27, 2014

extensions/bootstrap/Collapse.php

@@ -20,13 +20,15 @@ use yii\helpers\Html;
  * echo Collapse::widget([
  *     'items' => [
  *         // equivalent to the above
- *         'Collapsible Group Item #1' => [
+ *         [
+ *             'label' => 'Collapsible Group Item #1',
  *             'content' => 'Anim pariatur cliche...',
  *             // open its content by default
  *             'contentOptions' => ['class' => 'in']
  *         ],
  *         // another group item
- *         'Collapsible Group Item #2' => [
+ *         [
+ *             'label' => 'Collapsible Group Item #1',
  *             'content' => 'Anim pariatur cliche...',
  *             'contentOptions' => [...],
  *             'options' => [...],
@@ -45,20 +47,22 @@ class Collapse extends Widget
      * @var array list of groups in the collapse widget. Each array element represents a single
      * group with the following structure:
      *
-     * ```php
+     * - label: string, required, the group header label.
-     * // item key is the actual group header
+     * - encode: boolean, optional, whether this label should be HTML-encoded. This param will override
-     * 'Collapsible Group Item #1' => [
+     *   global `$this->encodeLabels` param.
-     *     // required, the content (HTML) of the group
+     * - content: string, required, the content (HTML) of the group
-     *     'content' => 'Anim pariatur cliche...',
+     * - options: array, optional, the HTML attributes of the group
-     *     // optional the HTML attributes of the content group
+     * - contentOptions: optional, the HTML attributes of the group's content
-     *     'contentOptions' => [],
+     *
-     *     // optional the HTML attributes of the group
-     *     'options' => [],
-     * ]
      * ```
      */
     public $items = [];
 
+    /**
+     * @var boolean whether the labels for header items should be HTML-encoded.
+     */
+    public $encodeLabels = true;
+
 
     /**
      * Initializes the widget.
@@ -88,7 +92,11 @@ class Collapse extends Widget
     {
         $items = [];
         $index = 0;
-        foreach ($this->items as $header => $item) {
+        foreach ($this->items as $item) {
+            if (!isset($item['label'])) {
+                throw new InvalidConfigException("The 'label' option is required.");
+            }
+            $header = $item['label'];
             $options = ArrayHelper::getValue($item, 'options', []);
             Html::addCssClass($options, 'panel panel-default');
             $items[] = Html::tag('div', $this->renderItem($header, $item, ++$index), $options);
@@ -113,6 +121,11 @@ class Collapse extends Widget
             $options['id'] = $id;
             Html::addCssClass($options, 'panel-collapse collapse');
 
+            $encodeLabel = isset($item['encode']) ? $item['encode'] : $this->encodeLabels;
+            if ($encodeLabel) {
+                $header = Html::encode($header);
+            }
+
             $headerToggle = Html::a($header, '#' . $id, [
                     'class' => 'collapse-toggle',
                     'data-toggle' => 'collapse',

framework/UPGRADE.md

@@ -19,6 +19,9 @@ Upgrade from Yii 2.0 RC
   was possible. If your timestamps are stored in the database without a timezone identifier you have to ensure they are in UTC or
   add a timezone identifier explicitly.
   
+* `yii\bootstrap\Collapse` is now encoding labels by default. `encode` item option and global `encodeLabels` property were
+ introduced to disable it. Keys are no longer used as labels. You need to remove keys and use `label` item option instead.
+
 
 Upgrade from Yii 2.0 Beta
 -------------------------