Spec-Zone.ru › Yii 1.1

CLinkColumn

Пакет zii.widgets.grid
Наследование класс CLinkColumn » CGridColumn » CComponent
С версии 1.1
Исходный код framework/zii/widgets/grid/CLinkColumn.php
CLinkColumn представляет собой колонку представления таблицы, которая отображает гиперссылку в каждой ячейке данных.

Свойства label и url определяют, как будет отображаться каждая гиперссылка. Свойства labelExpression и urlExpression могут использоваться вместо них, если они доступны. Кроме того, если установлено свойство imageUrl, будет отображаться ссылка на изображение.

Общедоступные свойства

Свойство Тип Описание Определено в
cssClassExpression строка PHP-выражение, которое вычисляется для каждой ячейки данных, и результат которого используется в качестве имени класса CSS для ячейки данных. CGridColumn
filterCellContent строка Возвращает содержимое ячейки фильтра. CGridColumn
filterHtmlOptions массив HTML-опции для тега ячейки фильтра. CGridColumn
footer строка Текст ячейки подвала. CGridColumn
footerCellContent строка Возвращает содержимое ячейки подвала. CGridColumn
footerHtmlOptions массив HTML-опции для тега ячейки подвала. CLinkColumn
grid CGridView Объект представления таблицы, который владеет этим столбцом. CGridColumn
hasFooter логическое Указывает, имеет ли этот столбец ячейку подвала. CGridColumn
header строка Текст ячейки заголовка. CGridColumn
headerCellContent строка Возвращает содержимое ячейки заголовка. CGridColumn
headerHtmlOptions массив HTML-опции для тега ячейки заголовка. CLinkColumn
htmlOptions массив HTML-опции для тегов ячейки данных. CLinkColumn
id строка Идентификатор этого столбца. CGridColumn
imageUrl строка URL изображения. CLinkColumn
label строка Текст метки гиперссылок в ячейках данных. CLinkColumn
labelExpression строка PHP-выражение, которое будет вычислено для каждой ячейки данных, и результат которого будет отображен как метка гиперссылки ячейки данных. CLinkColumn
linkHtmlOptions массив HTML-опции для гиперссылок. CLinkColumn
url строка URL гиперссылок в ячейках данных. CLinkColumn
urlExpression строка PHP-выражение, которое будет вычислено для каждой ячейки данных, и результат которого будет отображен как URL гиперссылки ячейки данных. CLinkColumn
visible логическое Указывает, отображается ли этот столбец. CGridColumn

Общедоступные методы

Метод Описание Определён в
__call() Вызывает метод с заданным именем, который не является методом класса. CComponent
__construct() Конструктор. CGridColumn
__get() Возвращает значение свойства, список обработчиков событий или поведение по его имени. CComponent
__isset() Проверяет, является ли значение свойства null. CComponent
__set() Устанавливает значение свойства компонента. CComponent
__unset() Устанавливает свойство компонента в null. CComponent
asa() Возвращает объект поведения с заданным именем. CComponent
attachBehavior() Прикрепляет поведение к этому компоненту. CComponent
attachBehaviors() Прикрепляет список поведений к компоненту. CComponent
attachEventHandler() Прикрепляет обработчик событий к событию. CComponent
canGetProperty() Определяет, можно ли считать свойство. CComponent
canSetProperty() Определяет, можно ли установить свойство. CComponent
detachBehavior() Открепляет поведение от компонента. CComponent
detachBehaviors() Открепляет все поведения от компонента. CComponent
detachEventHandler() Открепляет существующий обработчик событий. CComponent
disableBehavior() Отключает прикреплённое поведение. CComponent
disableBehaviors() Отключает все прикреплённые к этому компоненту поведения. CComponent
enableBehavior() Включает прикреплённое поведение. CComponent
enableBehaviors() Включает все прикреплённые к этому компоненту поведения. CComponent
evaluateExpression() Вычисляет выражение PHP или обратный вызов в контексте этого компонента. CComponent
getDataCellContent() Возвращает содержимое ячейки данных. CLinkColumn
getEventHandlers() Возвращает список прикреплённых обработчиков событий для события. CComponent
getFilterCellContent() Возвращает содержимое ячейки фильтра. CGridColumn
getFooterCellContent() Возвращает содержимое ячейки подвала. CGridColumn
getHasFooter() Возвращает значение, указывающее, содержит ли эта колонка ячейку подвала. Это определяется на основе того, установлено ли свойство footer. CGridColumn
getHeaderCellContent() Возвращает содержимое ячейки заголовка. CGridColumn
hasEvent() Определяет, определено ли событие. CComponent
hasEventHandler() Проверяет, имеет ли событие с заданным именем прикреплённые обработчики. CComponent
hasProperty() Определяет, определено ли свойство. CComponent
init() Инициализирует колонку. CGridColumn
raiseEvent() Вызывает событие. CComponent
renderDataCell() Отображает ячейку данных. CGridColumn
renderFilterCell() Отображает ячейку фильтра. CGridColumn
renderFooterCell() Отображает ячейку подвала. CGridColumn
renderHeaderCell() Отображает ячейку заголовка. CGridColumn

Защищённые методы

Метод Описание Определён в
renderDataCellContent() Отображает содержимое ячейки данных. CGridColumn
renderFilterCellContent() Отображает содержимое ячейки фильтра. CGridColumn
renderFooterCellContent() Отображает содержимое ячейки подвала. CGridColumn
renderHeaderCellContent() Отображает содержимое ячейки заголовка. CGridColumn

Подробное описание свойств

footerHtmlOptions свойство

public array $footerHtmlOptions;

атрибуты HTML для тега ячейки подвала.

headerHtmlOptions свойство

public array $headerHtmlOptions;

атрибуты HTML для тега ячейки заголовка.

htmlOptions свойство

public array $htmlOptions;

атрибуты HTML для тегов ячейки данных.

imageUrl свойство

public string $imageUrl;

URL изображения. Если он установлен, будет отображён гиперссылка на изображение.

label свойство

public string $label;

метка для гиперссылок в ячейках данных. Обратите внимание, что метка не будет кодироваться в HTML при отображении. Это свойство игнорируется, если установлено labelExpression.

См. также

  • labelExpression

labelExpression свойство

public string $labelExpression;

выражение PHP, которое будет вычисляться для каждой ячейки данных, и результат которого будет отображаться как метка гиперссылки ячейки данных. В этом выражении вы можете использовать следующие переменные:

  • $row номер строки (с нуля).
  • $data модель данных для строки.
  • $this объект столбца.
Выражение PHP будет вычислено с помощью evaluateExpression.

Выражение PHP может быть любым кодом PHP, имеющим значение. Чтобы узнать больше о том, что такое выражение, обратитесь к руководству по PHP.

linkHtmlOptions свойство

public array $linkHtmlOptions;

атрибуты HTML для гиперссылок

url свойство

public string $url;

URL гиперссылок в ячейках данных. Это свойство игнорируется, если установлено urlExpression.

См. также

  • urlExpression

urlExpression свойство

public string $urlExpression;

PHP-выражение, которое будет вычисляться для каждой ячейки данных, а его результат будет отображаться как URL гиперссылки ячеек данных. В этом выражении можно использовать следующие переменные:

  • $row номер строки (нумерация с нуля).
  • $data модель данных для строки.
  • $this объект столбца.
PHP-выражение будет вычислено с помощью evaluateExpression.

PHP-выражение может быть любым кодом PHP, имеющим значение. Чтобы узнать больше о том, что такое выражение, обратитесь к руководству PHP.

Подробное описание методов

getDataCellContent() метод (доступен с версии v1.1.16)

public string getDataCellContent(integer $row)
$row integer номер строки (нумерация с нуля)
{return} string содержимое ячейки данных.
Исходный код: framework/zii/widgets/grid/CLinkColumn.php#96 (показать)
public function getDataCellContent($row)
{
    
$data=$this->grid->dataProvider->data[$row];
    if(
$this->urlExpression!==null)
        
$url=$this->evaluateExpression($this->urlExpression,array('data'=>$data,'row'=>$row));
    else
        
$url=$this->url;
    if(
$this->labelExpression!==null)
        
$label=$this->evaluateExpression($this->labelExpression,array('data'=>$data,'row'=>$row));
    else
        
$label=$this->label;
    
$options=$this->linkHtmlOptions;
    if(
is_string($this->imageUrl))
        return 
CHtml::link(CHtml::image($this->imageUrl,$label),$url,$options);
    else
        return 
CHtml::link($label,$url,$options);
}

Возвращает содержимое ячейки данных. Этот метод отображает гиперссылку в ячейке данных.

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CLinkColumn

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API