| Server IP : 49.231.201.246 / Your IP : 216.73.216.149 Web Server : Apache/2.4.18 (Ubuntu) System : Linux 246 4.4.0-210-generic #242-Ubuntu SMP Fri Apr 16 09:57:56 UTC 2021 x86_64 User : root ( 0) PHP Version : 7.0.33-0ubuntu0.16.04.16 Disable Function : exec,passthru,shell_exec,system,proc_open,popen,pcntl_exec MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : ON Directory : /var/www/html/egp/vendor/kartik-v/yii2-grid/src/ |
Upload File : |
<?php
/**
* @package yii2-grid
* @author Kartik Visweswaran <kartikv2@gmail.com>
* @copyright Copyright © Kartik Visweswaran, Krajee.com, 2014 - 2020
* @version 3.3.6
*/
namespace kartik\grid;
use Closure;
use Yii;
use yii\base\InvalidConfigException;
use yii\base\Model;
use yii\helpers\Html;
use yii\helpers\Json;
use yii\web\JsExpression;
use yii\web\View;
/**
* An ExpandRowColumn can be used to expand a row and add content in a new row below it either directly or via ajax.
*
* To add an ExpandRowColumn to the gridview, add it to the [[GridView::columns|columns]] configuration as follows:
*
* ```php
* 'columns' => [
* // ...
* [
* 'class' => ExpandRowColumn::className(),
* // you may configure additional properties here
* ],
* ]
* ```
*
* @author Kartik Visweswaran <kartikv2@gmail.com>
* @since 1.0
*/
class ExpandRowColumn extends DataColumn
{
/**
* @var integer|Closure the value of this attribute will identify the state of the current row. The following values
* are supported:
* - [[GridView::ROW_EXPANDED]] or 0: the row will be expanded by default and will display the collapse indicator.
* - [[GridView::ROW_COLLAPSED]] or 1: the row will be collapsed by default and will display the expand indicator.
* - [[GridView::ROW_NONE]] or -1: no indicator will be displayed for the row.
*
* If this is not set, `$model[$attribute]` will be used to obtain the value. If this value is evaluated as empty
* or null, it is treated as [[GridView::ROW_NONE]]. This can also be an anonymous function that returns one of
* the values above. The anonymous function should have the signature `function ($model, $key, $index, $column)`,
* where:
* - `$model`: _\yii\base\Model_, is the data model.
* - `$key`: _string|object_, is the primary key value associated with the data model.
* - `$index`: _integer_, is the zero-based index of the data model among the model array returned by [[dataProvider]].
* - `$column`: _ExpandRowColumn_, is the column object instance.
*/
public $value = GridView::ROW_NONE;
/**
* @var boolean whether to toggle the expansion/collapse by clicking on the table row. To disable row click for
* specific elements within the row you can add the CSS class `kv-disable-click` to tags/elements to disable
* the toggle functionality.
*/
public $enableRowClick = false;
/**
* @var array list of tags in the row on which row click will be disabled.
*/
public $rowClickExcludedTags = ['a', 'button', 'input'];
/**
* @var array additional data that will be passed to the ajax load function as key value pairs
*/
public $extraData = [];
/**
* @var string icon for the expand indicator. If this is not set, it will derive values automatically using the
* following rules:
* - If GridView `bootstrap` property is set to `true`, it will default to:
* - [[GridView::ICON_EXPAND]] for Bootstrap 3.x
* - [[GridView::ICON_EXPAND_BS4]] for Bootstrap 4.x
* - If GridView `bootstrap` property is set to `false`, then it will default to `+`.
*/
public $expandIcon;
/**
* @var string icon for the collapse indicator. If this is not set, it will derive values automatically using the
* following rules:
* - If GridView `bootstrap` property is set to `true`, it will default to:
* - [[GridView::ICON_COLLAPSE]] for Bootstrap 3.x
* - [[GridView::ICON_COLLAPSE_BS4]] for Bootstrap 4.x
* - If GridView `bootstrap` property is set to `false`, then it will default to `-`.
*/
public $collapseIcon;
/**
* @var string title to display on hover of expand indicator for each row.
*/
public $expandTitle;
/**
* @var string title to display on hover of collapse indicator for each row.
*/
public $collapseTitle;
/**
* @var string title to display on hover of expand indicator at header.
*/
public $expandAllTitle;
/**
* @var string title to display on hover of collapse indicator at header.
*/
public $collapseAllTitle;
/**
* @var integer default state of the header. The following values can be set:
* - [[GridView::ROW_COLLAPSED]]: Will set all rows to collapsed and display the [[expandIcon]].
* - [[GridView::ROW_EXPANDED]]: Will set all rows to expanded and display the [[collapseIcon]].
*/
public $defaultHeaderState = GridView::ROW_COLLAPSED;
/**
* @var boolean whether to enable caching of expanded row content while expanding the row using ajax triggered
* action (applicable when `detailUrl` is set). Defaults to `true`.
*/
public $enableCache = true;
/**
* @var boolean whether to allow only one row to be expanded at a time and auto collapse other expanded rows
* whenever a row is expanded. Defaults to `false`.
*/
public $expandOneOnly = false;
/**
* @var boolean allow batch expansion or batch collapse of all rows by clicking the header indicator. Defaults to
* `true`.
*/
public $allowBatchToggle = true;
/**
* @var boolean|Closure whether the expand icon indicator is disabled. Defaults to `false`. If set to `true`, one
* cannot collapse or expand the sections. This can be setup as an anonymous function having the signature:
* `function ($model, $key, $index, $column)`, where:
* - `$model`: _\yii\base\Model_, is the data model.
* - `$key`: _string|object_, is the primary key value associated with the data model.
* - `$index`: _integer_, is the zero-based index of the data model among the model array returned by [[dataProvider]].
* - `$column`: _ExpandRowColumn_, is the column object instance.
*/
public $disabled = false;
/**
* @var string|Closure the detail content (html markup) to be displayed in the expanded row. Either [[detail]]
* or [[detailUrl]] must be entered. This can be a normal html markup or an anonymous function that returns the
* markup. The anonymous function should have the signature:
* `function ($model, $key, $index, $column)`, where:
* - `$model`: _\yii\base\Model_, is the data model.
* - `$key`: _string|object_, is the primary key value associated with the data model.
* - `$index`: _integer_, is the zero-based index of the data model among the model array returned by [[dataProvider]].
* - `$column`: _ExpandRowColumn_, is the column object instance.
*/
public $detail = '';
/**
* @var string the url/action that would render the detail content via ajax. Either `detail` OR `detailUrl` must be
* entered. The ajax response must return the content/markup to render. The extension automatically passes the
* following data parameters to the server URL as POST data:
* - `expandRowKey` the key associated with the data model
* - `expandRowIndex` the zero-based index of the data model among the models array returned by
* [[GridView::dataProvider]].
* @see http://api.jquery.com/jquery.load/
*/
public $detailUrl;
/**
* @var string|JsExpression the javascript callback to execute after loading the content via ajax. Only applicable
* when detailUrl is provided.
*/
public $onDetailLoaded = '';
/**
* @var array|Closure the HTML attributes for the expanded table row. This can be an array or an anonymous function
* of the signature:
* `function ($model, $key, $index, $column)`, where:
* - `$model`: _\yii\base\Model_, is the data model.
* - `$key`: _string|object_, is the primary key value associated with the data model.
* - `$index`: _integer_, is the zero-based index of the data model among the model array returned by [[dataProvider]].
* - `$column`: _ExpandRowColumn_, is the column object instance.
*/
public $detailOptions = [];
/**
* @var string the CSS class for the detail content table row.
*/
public $detailRowCssClass;
/**
* @var string|integer the animation duration to slide up/down the detail row.
* @see http://api.jquery.com/slidedown/
*/
public $detailAnimationDuration = 'slow';
/**
* @var string the message to be shown while the detail content is loading or being rendered. Defaults to
* `<small>Loading …</small>`
*/
public $msgDetailLoading;
/**
* @var string hashed javascript variable to store grid expand row options
*/
protected $_hashVar;
/**
* @var int the current expand row column identifier
*/
protected $_colId;
/**
* Parses data for Closure and returns accordingly
*
* @param string|Closure $data the data to parse.
* @param Model $model the data model.
* @param string|object $key the key associated with the data model.
* @param integer $index the zero-based index of the data model among the models array returned by
* [[GridView::dataProvider]].
* @param ExpandRowColumn $column the column object instance.
*
* @return mixed
*/
protected static function parseData($data, $model, $key, $index, $column)
{
if ($data instanceof Closure) {
$data = call_user_func($data, $model, $key, $index, $column);
}
return $data;
}
/**
* @inheritdoc
* @throws InvalidConfigException
*/
public function init()
{
if (!isset($this->detailRowCssClass)) {
$this->detailRowCssClass = $this->grid->getCssClass(GridView::BS_TABLE_INFO);
}
if (!isset($this->msgDetailLoading)) {
$this->msgDetailLoading = Yii::t('kvgrid', '<small>Loading …</small>');
}
$this->initColumnSettings([
'hiddenFromExport' => true,
'mergeHeader' => true,
'hAlign' => GridView::ALIGN_CENTER,
'vAlign' => GridView::ALIGN_MIDDLE,
'width' => '50px',
]);
parent::init();
if (empty($this->detail) && empty($this->detailUrl)) {
throw new InvalidConfigException("Either the 'detail' or 'detailUrl' must be entered");
}
$this->format = 'raw';
$this->expandIcon = $this->getIcon('expand');
$this->collapseIcon = $this->getIcon('collapse');
$this->setProp('expandTitle', Yii::t('kvgrid', 'Expand'));
$this->setProp('collapseTitle', Yii::t('kvgrid', 'Collapse'));
$this->setProp('expandAllTitle', Yii::t('kvgrid', 'Expand All'));
$this->setProp('collapseAllTitle', Yii::t('kvgrid', 'Collapse All'));
$onDetailLoaded = $this->onDetailLoaded;
if (!empty($onDetailLoaded) && !$onDetailLoaded instanceof JsExpression) {
$onDetailLoaded = new JsExpression($onDetailLoaded);
}
if ($this->allowBatchToggle) {
$this->headerOptions['title'] = $this->expandAllTitle;
}
if ($this->allowBatchToggle && $this->defaultHeaderState === GridView::ROW_EXPANDED) {
$this->headerOptions['title'] = $this->collapseTitle;
}
$class = 'kv-expand-header-cell';
$class .= $this->allowBatchToggle ? ' kv-batch-toggle' : ' text-muted';
Html::addCssClass($this->headerOptions, $class);
$view = $this->grid->getView();
ExpandRowColumnAsset::register($view);
$clientOptions = Json::encode(
[
'gridId' => $this->grid->options['id'],
'hiddenFromExport' => $this->hiddenFromExport,
'detailUrl' => empty($this->detailUrl) ? '' : $this->detailUrl,
'onDetailLoaded' => $onDetailLoaded,
'expandIcon' => $this->expandIcon,
'collapseIcon' => $this->collapseIcon,
'expandTitle' => $this->expandTitle,
'collapseTitle' => $this->collapseTitle,
'expandAllTitle' => $this->expandAllTitle,
'collapseAllTitle' => $this->collapseAllTitle,
'rowCssClass' => $this->detailRowCssClass,
'animationDuration' => $this->detailAnimationDuration,
'expandOneOnly' => $this->expandOneOnly,
'enableRowClick' => $this->enableRowClick,
'enableCache' => $this->enableCache,
'rowClickExcludedTags' => array_map('strtoupper', $this->rowClickExcludedTags),
'collapseAll' => false,
'expandAll' => false,
'extraData' => $this->extraData,
'msgDetailLoading' => $this->msgDetailLoading
]
);
$this->_hashVar = 'kvExpandRow_' . hash('crc32', $clientOptions);
$this->_colId = $this->grid->options['id'] . '_' . $this->columnKey;
Html::addCssClass($this->contentOptions, $this->_colId);
Html::addCssClass($this->headerOptions, $this->_colId);
$view->registerJs("var {$this->_hashVar} = {$clientOptions};\n", View::POS_HEAD);
$view->registerJs("kvExpandRow({$this->_hashVar}, '{$this->_colId}');");
}
/**
* @inheritdoc
*/
public function getDataCellValue($model, $key, $index)
{
$value = parent::getDataCellValue($model, $key, $index);
/** @noinspection PhpUnusedLocalVariableInspection */
$icon = '';
if ($value === GridView::ROW_EXPANDED) {
$type = 'expanded';
$icon = $this->collapseIcon;
} elseif ($value === GridView::ROW_COLLAPSED) {
$type = 'collapsed';
$icon = $this->expandIcon;
} else {
return $value;
}
$detail = static::parseData($this->detail, $model, $key, $index, $this);
$detailOptions = static::parseData($this->detailOptions, $model, $key, $index, $this);
$disabled = static::parseData($this->disabled, $model, $key, $index, $this) ? ' kv-state-disabled' : '';
if ($this->hiddenFromExport) {
Html::addCssClass($detailOptions, 'skip-export');
}
$detailOptions['data-index'] = $index;
$detailOptions['data-key'] = GridView::parseKey($key);
Html::addCssClass($detailOptions, ['kv-expanded-row', $this->_colId]);
$content = Html::tag('div', $detail, $detailOptions);
return <<< HTML
<div class="kv-expand-row {$disabled}">
<div class="kv-expand-icon kv-state-{$type}{$disabled}">{$icon}</div>
<div class="kv-expand-detail skip-export" style="display:none;">
{$content}
</div>
</div>
HTML;
}
/**
* @inheritdoc
*/
public function renderDataCell($model, $key, $index)
{
$options = $this->fetchContentOptions($model, $key, $index);
$css = 'kv-expand-icon-cell';
$options['title'] = $this->expandTitle;
if ($this->value === GridView::ROW_EXPANDED) {
$options['title'] = $this->collapseTitle;
}
if (static::parseData($this->disabled, $model, $key, $index, $this)) {
$css .= ' kv-state-disabled';
}
Html::addCssClass($options, $css);
$this->initPjax("kvExpandRow({$this->_hashVar}, '{$this->_colId}');");
return Html::tag('td', $this->renderDataCellContent($model, $key, $index), $options);
}
/**
* Get icon indicator
*
* @param string $type one of `expand` or `collapse`
*
* @return string the icon indicator markup
* @throws InvalidConfigException
*/
protected function getIcon($type)
{
$setting = "{$type}Icon";
if (!empty($this->$setting)) {
return $this->$setting;
}
$bs = $this->grid->bootstrap;
$isBs4 = $this->grid->isBs4();
if ($type === 'expand') {
return $bs ? ($isBs4 ? GridView::ICON_EXPAND_BS4 : GridView::ICON_EXPAND) : '+';
}
if ($type === 'collapse') {
return $bs ? ($isBs4 ? GridView::ICON_COLLAPSE_BS4 : GridView::ICON_COLLAPSE) : '-';
}
return null;
}
/**
* Sets property for the object instance if not set
*
* @param string $prop the property name
* @param string $val the property value
*/
protected function setProp($prop, $val)
{
if (!isset($this->$prop)) {
$this->$prop = $val;
}
}
/**
* @inheritdoc
*/
protected function renderHeaderCellContent()
{
if ($this->header !== null) {
return parent::renderHeaderCellContent();
}
$icon = $this->expandIcon;
$css = 'kv-expand-header-icon kv-state-expanded';
if ($this->defaultHeaderState === GridView::ROW_EXPANDED) {
$icon = $this->collapseIcon;
$css = 'kv-expand-header-icon kv-state-collapsed';
}
return "<div class='{$css}'>{$icon}</div>";
}
}