Bitrix-D7  20.0.0
Пространство имен Bitrix\Sender\Connector

Пространства имен

 Filter
 

Структуры данных

class  Base
 
class  BaseFilter
 
class  DataCounter
 
class  Manager
 
class  Result
 

Функции

 __construct (Base $connector)
 Constructor. Подробнее...
 
 setCallback ($name, $callable)
 Set callback. Подробнее...
 
 runCallback ($name, array $arguments=[])
 
 getTitle ()
 Get filter. Подробнее...
 
 modifyFilter (array &$filter)
 Modify result view filter. Подробнее...
 
 modifyColumns (array &$columns)
 Modify result view columns. Подробнее...
 
 setNav (PageNavigation $nav=null)
 Set page navigation. Подробнее...
 
 getNav ()
 Get page navigation. Подробнее...
 
 hasNav ()
 Has page navigation. Подробнее...
 
 onFilter ()
 Callback on filter of result view. Подробнее...
 
 onDraw (array &$raw)
 Callback on draw of result view. Подробнее...
 

Переменные

Class ResultView
 
const Draw = 'draw'
 
const Filter = 'filter'
 
const FilterModifier = 'filter-modifier'
 
const ColumnModifier = 'column-modifier'
 
 $connector
 
 $callbacks
 
 $nav
 

Функции

◆ __construct()

Bitrix\Sender\Connector\__construct ( Base  $connector)

Constructor.

Аргументы
Base$connectorConnector.

См. определение в файле resultview.php строка 40

41  {
42  $this->connector = $connector;
43  }

◆ getNav()

Bitrix\Sender\Connector\getNav ( )

Get page navigation.

Возвращает
PageNavigation|null

См. определение в файле resultview.php строка 124

125  {
126  return $this->nav;
127  }

◆ getTitle()

Bitrix\Sender\Connector\getTitle ( )

Get filter.

Возвращает
string|null

См. определение в файле resultview.php строка 80

81  {
82  return $this->runCallback(self::Title) ?: $this->connector->getName();
83  }

◆ hasNav()

Bitrix\Sender\Connector\hasNav ( )

Has page navigation.

Возвращает
bool

См. определение в файле resultview.php строка 134

135  {
136  return !empty($this->nav);
137  }

◆ modifyColumns()

Bitrix\Sender\Connector\modifyColumns ( array &  $columns)

Modify result view columns.

Аргументы
array$columnscolumns.
Возвращает
void

См. определение в файле resultview.php строка 102

103  {
104  $this->runCallback(self::ColumnModifier, [&$columns]);
105  }

◆ modifyFilter()

Bitrix\Sender\Connector\modifyFilter ( array &  $filter)

Modify result view filter.

Аргументы
array$filterFilter.
Возвращает
void

См. определение в файле resultview.php строка 91

92  {
93  $this->runCallback(self::FilterModifier, [&$filter]);
94  }

◆ onDraw()

Bitrix\Sender\Connector\onDraw ( array &  $raw)

Callback on draw of result view.

Аргументы
array$rawRaw.
Возвращает
void

См. определение в файле resultview.php строка 155

156  {
157  $this->runCallback(self::Draw, [&$raw]);
158  }

◆ onFilter()

Bitrix\Sender\Connector\onFilter ( )

Callback on filter of result view.

Возвращает
void

См. определение в файле resultview.php строка 144

145  {
146  $this->runCallback(self::Filter);
147  }

◆ runCallback()

Bitrix\Sender\Connector\runCallback (   $name,
array  $arguments = [] 
)
protected

См. определение в файле resultview.php строка 65

66  {
67  if (!isset($this->callbacks[$name]))
68  {
69  return null;
70  }
71 
72  return call_user_func_array($this->callbacks[$name], $arguments);
73  }

◆ setCallback()

Bitrix\Sender\Connector\setCallback (   $name,
  $callable 
)

Set callback.

Аргументы
string$nameName.
callable$callableCallback.
Возвращает
$this
Исключения
ArgumentException

См. определение в файле resultview.php строка 53

54  {
55  if (!is_callable($callable))
56  {
57  throw new ArgumentException('Parameter `$callable` should be callable.');
58  }
59 
60  $this->callbacks[$name] = $callable;
61 
62  return $this;
63  }

◆ setNav()

Bitrix\Sender\Connector\setNav ( PageNavigation  $nav = null)

Set page navigation.

Аргументы
PageNavigation | null$navPage navigation.
Возвращает
$this

См. определение в файле resultview.php строка 113

114  {
115  $this->nav = $nav;
116  return $this;
117  }

Переменные

◆ $callbacks

$callbacks
protected

См. определение в файле resultview.php строка 30

◆ $connector

$connector
protected

См. определение в файле resultview.php строка 27

◆ $nav

$nav
protected

См. определение в файле resultview.php строка 33

◆ ColumnModifier

const ColumnModifier = 'column-modifier'

См. определение в файле resultview.php строка 24

◆ Draw

const Draw = 'draw'

См. определение в файле resultview.php строка 21

◆ Filter

const Filter = 'filter'

См. определение в файле resultview.php строка 22

◆ FilterModifier

const FilterModifier = 'filter-modifier'

См. определение в файле resultview.php строка 23

◆ ResultView

Class ResultView
Инициализатор
{
const Title = 'title'

См. определение в файле resultview.php строка 19

Bitrix\Sender\Connector\ColumnModifier
const ColumnModifier
Definition: resultview.php:24
Bitrix\Sender\Connector\$nav
$nav
Definition: resultview.php:33
Bitrix\Sender\Connector\FilterModifier
const FilterModifier
Definition: resultview.php:23
Bitrix\Sender\Connector\$connector
$connector
Definition: resultview.php:27
Bitrix\Sender\Connector\Draw
const Draw
Definition: resultview.php:21
Bitrix\Sender\Connector\Filter
const Filter
Definition: resultview.php:22
Bitrix\Sender\Connector\runCallback
runCallback($name, array $arguments=[])
Definition: resultview.php:65