|
1
|
|
|
<?php |
|
2
|
|
|
/** |
|
3
|
|
|
* @company MTE Telecom, Ltd. |
|
4
|
|
|
* @author Roman Malashin <[email protected]> |
|
5
|
|
|
*/ |
|
6
|
|
|
|
|
7
|
|
|
namespace Nnx\DataGrid\Column; |
|
8
|
|
|
|
|
9
|
|
|
use Nnx\DataGrid\Column\Header\HeaderInterface; |
|
10
|
|
|
use Nnx\DataGrid\Mutator\MutatorInterface; |
|
11
|
|
|
use Traversable; |
|
12
|
|
|
|
|
13
|
|
|
/** |
|
14
|
|
|
* Interface ColumnInterface |
|
15
|
|
|
* @package Nnx\DataGrid\Column |
|
16
|
|
|
*/ |
|
17
|
|
|
interface ColumnInterface |
|
18
|
|
|
{ |
|
19
|
|
|
/** |
|
20
|
|
|
* Устанавливает имя колонки по которому в дальнейшем будут маппиться данные |
|
21
|
|
|
* @param string $name |
|
22
|
|
|
* @return $this |
|
23
|
|
|
*/ |
|
24
|
|
|
public function setName($name); |
|
25
|
|
|
|
|
26
|
|
|
/** |
|
27
|
|
|
* Возвращает имя колонки |
|
28
|
|
|
* @return string |
|
29
|
|
|
*/ |
|
30
|
|
|
public function getName(); |
|
31
|
|
|
|
|
32
|
|
|
/** |
|
33
|
|
|
* Устанавливает заголовок для колонки |
|
34
|
|
|
* @param HeaderInterface | array | Traversable $header |
|
35
|
|
|
* @return $this |
|
36
|
|
|
*/ |
|
37
|
|
|
public function setHeader($header); |
|
38
|
|
|
|
|
39
|
|
|
/** |
|
40
|
|
|
* Возвращает объект заголовка для колонки |
|
41
|
|
|
* @return HeaderInterface |
|
42
|
|
|
*/ |
|
43
|
|
|
public function getHeader(); |
|
44
|
|
|
|
|
45
|
|
|
/** |
|
46
|
|
|
* Устанавливает путь до шаблона строки |
|
47
|
|
|
* @param string $template |
|
48
|
|
|
* @return $this |
|
49
|
|
|
*/ |
|
50
|
|
|
public function setTemplate($template); |
|
51
|
|
|
|
|
52
|
|
|
/** |
|
53
|
|
|
* Возвраащет путь до шаблона |
|
54
|
|
|
* @return string |
|
55
|
|
|
*/ |
|
56
|
|
|
public function getTemplate(); |
|
57
|
|
|
|
|
58
|
|
|
/** |
|
59
|
|
|
* Опции и настройки колонки |
|
60
|
|
|
* @param array $options |
|
61
|
|
|
* @return $this |
|
62
|
|
|
*/ |
|
63
|
|
|
public function setOptions(array $options = []); |
|
64
|
|
|
|
|
65
|
|
|
/** |
|
66
|
|
|
* Возвращает опции колонки |
|
67
|
|
|
* @return array |
|
68
|
|
|
*/ |
|
69
|
|
|
public function getOptions(); |
|
70
|
|
|
|
|
71
|
|
|
/** |
|
72
|
|
|
* Аттрибут колонки |
|
73
|
|
|
* @param string $name |
|
74
|
|
|
* @param mixed $value |
|
75
|
|
|
* @return $this |
|
76
|
|
|
*/ |
|
77
|
|
|
public function setAttribute($name, $value); |
|
78
|
|
|
|
|
79
|
|
|
/** |
|
80
|
|
|
* Аттрибуты колонки |
|
81
|
|
|
* @param array $attributes |
|
82
|
|
|
* @return $this |
|
83
|
|
|
*/ |
|
84
|
|
|
public function setAttributes(array $attributes = []); |
|
85
|
|
|
|
|
86
|
|
|
/** |
|
87
|
|
|
* Возвращает атрибут колонки |
|
88
|
|
|
* @param $name |
|
89
|
|
|
* @return mixed|null |
|
90
|
|
|
*/ |
|
91
|
|
|
public function getAttribute($name); |
|
92
|
|
|
|
|
93
|
|
|
/** |
|
94
|
|
|
* Возвращает атрибуты колонки |
|
95
|
|
|
* @return array |
|
96
|
|
|
*/ |
|
97
|
|
|
public function getAttributes(); |
|
98
|
|
|
|
|
99
|
|
|
/** |
|
100
|
|
|
* Возвращает параметр по которому сортируются колонки |
|
101
|
|
|
* @return int |
|
102
|
|
|
*/ |
|
103
|
|
|
public function getOrder(); |
|
104
|
|
|
|
|
105
|
|
|
/** |
|
106
|
|
|
* Устанавливает параметр для сортировки колонок |
|
107
|
|
|
* @param int $order |
|
108
|
|
|
* @return $this |
|
109
|
|
|
*/ |
|
110
|
|
|
public function setOrder($order); |
|
111
|
|
|
|
|
112
|
|
|
/** |
|
113
|
|
|
* Флаг сообщающий можно ли сортировать по колонке |
|
114
|
|
|
* @return bool |
|
115
|
|
|
*/ |
|
116
|
|
|
public function getSortable(); |
|
117
|
|
|
|
|
118
|
|
|
/** |
|
119
|
|
|
* Устанавливает флаг информирующий можно сортировать или нет по колонке |
|
120
|
|
|
* @param bool $sortable |
|
121
|
|
|
* @return $this |
|
122
|
|
|
*/ |
|
123
|
|
|
public function setSortable($sortable); |
|
124
|
|
|
|
|
125
|
|
|
/** |
|
126
|
|
|
* @param array|Traversable $mutators |
|
127
|
|
|
* @return mixed |
|
128
|
|
|
*/ |
|
129
|
|
|
public function setMutators($mutators); |
|
130
|
|
|
|
|
131
|
|
|
/** |
|
132
|
|
|
* @return array|Traversable |
|
133
|
|
|
*/ |
|
134
|
|
|
public function getMutators(); |
|
135
|
|
|
|
|
136
|
|
|
/** |
|
137
|
|
|
* Добавляет мутьатор для ячеек данных |
|
138
|
|
|
* @param MutatorInterface $mutator |
|
139
|
|
|
* @return mixed |
|
140
|
|
|
*/ |
|
141
|
|
|
public function addMutator(MutatorInterface $mutator); |
|
142
|
|
|
|
|
143
|
|
|
/** |
|
144
|
|
|
* Возвращает массив наименований мутаторов которые по дефолту вызываются для колонки |
|
145
|
|
|
* @return array|Traversable |
|
146
|
|
|
*/ |
|
147
|
|
|
public function getInvokableMutators(); |
|
148
|
|
|
|
|
149
|
|
|
/** |
|
150
|
|
|
* Устанавливает массив наименований мутаторов |
|
151
|
|
|
* @param array|Traversable $invokableMutators |
|
152
|
|
|
* @return $this |
|
153
|
|
|
*/ |
|
154
|
|
|
public function setInvokableMutators($invokableMutators); |
|
155
|
|
|
} |
|
|
|
|
|
|
156
|
|
|
|
nnx-framework /
data-grid
This check marks files that end in a newline character, i.e. an empy line.