php/yii2
1
0
Fork 0
mirror of https://github.com/yiisoft/yii2.git synced 2025-11-23 18:18:21 +08:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
Fixes #5232 and #5231
This commit is contained in:
Nikola Kovacs
2014-09-29 13:12:06 +02:00
committed by Alexander Makarov
parent 88dabc49c2
commit b672b818ae
3 changed files with 31 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
extensions/bootstrap/CHANGELOG.md
View File

@@ -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

39
extensions/bootstrap/Collapse.php
View File

@@ -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
* // item key is the actual group header
* 'Collapsible Group Item #1' => [
* // required, the content (HTML) of the group
* 'content' => 'Anim pariatur cliche...',
* // optional the HTML attributes of the content group
* 'contentOptions' => [],
* // optional the HTML attributes of the group
* 'options' => [],
* ]
* - label: string, required, the group header label.
* - encode: boolean, optional, whether this label should be HTML-encoded. This param will override
* global `$this->encodeLabels` param.
* - content: string, required, the content (HTML) of the group
* - options: array, optional, the HTML attributes of the group
* - contentOptions: optional, the HTML attributes of the group's content
*
* ```
*/
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',

3
framework/UPGRADE.md
View File

@@ -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
-------------------------