UXList
- class
UXList
(php\gui\UXList
) - package
gui
use php\gui\UXList;
Класс для хранения списков объектов, строк, чисел и т.д., обычно применяется только для GUI компонентов. Его особенностью является то, что он ведет себя как массив, а также позволяет навешивать различные функции-слушатели на изменения списка.
Данный класс используется например для таких свойств как:
children
(список компонентов внутри другого компонента)classes
(список css классов в виде строкstring
у всех компонентов)- и др...
Свойства
->
count
- количество элементов
Методы
- Конструктор (
new
)__construct
- создание объекта - Системные
->
count()
- количество элементов->
indexOf()
- индекс элемента->
has()
- содержит ли элемент->
add()
- добавить один элемент->
addAll()
- добавить несколько элементов->
insert()
- вставить один элемент->
insertAll()
- вставить несколько->
replace()
- заменить элемент на другой->
setAll()
- очистить и добавить несколько->
remove()
- удалить элемент->
removeByIndex()
- удалить по индексу->
clear()
- очистить->
last()
- последний элемент->
addListener()
- добавить слушателя на изменения
Свойства
count
(int)
Количество элементов в списке, если 0
- значит список пустой.
Методы
__construct()
Конструктор не имеет параметров.
$list = new UXList();
count()
count(): int
Возвращает количество элементов в списке.
indexOf()
indexOf(mixed $element): int
Возвращает индекс элемента в списке, -1
если элемент не был найден.
has()
has(mixed $element): bool
Возвращает true
если элемент есть в списке, иначе false
. Аналогично выражению $list->indexOf($element) != -1
.
add()
add(mixed $element)
Добавляет новый элемент в список.
addAll()
addAll(array $elements)
Добавляет в список сразу несколько элементов из массива.
insert()
insert(int $index, mixed $element)
Вставляет новый элемент в список после элемента под индексом $index
, если передать 0
в качестве индекса, то элемент будет вставлен в начало списка.
insertAll()
insertAll(int $index, array $elements)
Метод подобен методу insert()
, только вместо одно элемента вставляет сразу несколько из массива.
replace()
replace(mixed $element, mixed $newElement)
Меняет элемент на новый элемент. Если элемент $element
не был найден в списке, замены не происходит.
setAll()
setAll(array $elements)
Очищает весь список и заполняет его новыми элементами $elements
.
remove()
remove(mixed $element)
Ищет элемент в списке и удаляет его, если он был найден. Обратите внимание, что метод удаляет элемент не по индексу, для удаления по индексу, см. другой метод removeByIndex()
.
removeByIndex()
removeByIndex(int $index)
Удаляет элемент из списка по индексу, индексация элементов начинается с нуля, а не с единицы.
clear()
Очищает список от всех элементов. См. также метод setAll()
.
last()
last(): mixed
Возвращает последний элемент списка, если список пустой, то вернет null
.
addListener()
addListener(callable $callback)
Добавляет функцию-слушателя, которая будет вызываться при любом изменении списка.