\Colibri\IO\MailAddressList

Список электронных адресов

Summary

Methods
Properties
Constants
__construct()
getIterator()
Contains()
IndexOf()
Item()
Add()
Set()
Append()
InsertAt()
Delete()
DeleteAt()
Clear()
ToString()
ToArray()
Count()
First()
Last()
Join()
Sort()
Splice()
offsetSet()
offsetExists()
offsetUnset()
offsetGet()
AddRange()
No public properties found
No constants found
No protected methods found
$data
N/A
No private methods found
No private properties found
N/A

Properties

$data

$data : mixed

Данные

Type

mixed

Methods

__construct()

__construct(mixed  $data = array()) 

Конструктор Создаем ArrayList из массива или объекта или из другого ArrayList-а

Parameters

mixed $data

Contains()

Contains(mixed  $item) : boolean

Проверка наличия значения в списке

Parameters

mixed $item

Returns

boolean

IndexOf()

IndexOf(mixed  $item) : integer

Возвращает индекс по значению

Parameters

mixed $item

Returns

integer

Item()

Item(integer  $index) : \Colibri\Collections\T

Возвращает значение по идексу

Parameters

integer $index

Returns

\Colibri\Collections\T

Add()

Add(\Colibri\IO\Mail\Address  $a) : void

Добавляет адрес в список

Parameters

\Colibri\IO\Mail\Address $a

Set()

Set(integer  $index, mixed  $value) : \Colibri\Collections\T

Устанавливает значение по указанному индексу

Parameters

integer $index
mixed $value

Returns

\Colibri\Collections\T

Append()

Append(mixed  $values) : void

Добавляет значения

Parameters

mixed $values

InsertAt()

InsertAt(mixed  $value, integer  $toIndex) : void

Внедряет значение в список после индекса

Parameters

mixed $value
integer $toIndex

Delete()

Delete(mixed  $value) : \Colibri\Collections\T

Удаляет значение

Parameters

mixed $value

Returns

\Colibri\Collections\T

DeleteAt()

DeleteAt(integer  $index) : mixed

Удаляет значение по индексу

Parameters

integer $index

Returns

mixed

Clear()

Clear() : void

Очищает список

ToString()

ToString(string  $splitter = ',') : string

В строку

Parameters

string $splitter

Returns

string

ToArray()

ToArray() : array

Возвращает массив

Returns

array

Count()

Count() : integer

Возвращает количество

Returns

integer

First()

First() : mixed

Возвращает первый элемент

Returns

mixed

Last()

Last() : mixed

Возвращает последний элемент

Returns

mixed

Join()

Join() : string

Собирает все адреса в один список, разделенный запятой

Returns

string

Sort()

Sort(string  $k, mixed  $sorttype = SORT_ASC) 

Сортирует данные в массиве

Parameters

string $k
  • параметр внутри данных значения по которому нужно сортировать
mixed $sorttype
  • порядок сортировки

Splice()

Splice(integer  $start, integer  $count) : \Colibri\Collections\ArrayList

Вырезает кусок из массива и возвращает в виде ArrayList

Parameters

integer $start
  • начало
integer $count
  • количество

Returns

\Colibri\Collections\ArrayList
  • вырезанная часть массива

offsetSet()

offsetSet(integer  $offset, mixed  $value) : void

Устанавливает значение по индексу

Parameters

integer $offset
mixed $value

offsetExists()

offsetExists(integer  $offset) : boolean

Проверяет наличие значения по индексу

Parameters

integer $offset

Returns

boolean

offsetUnset()

offsetUnset(integer  $offset) : void

Удаляет значение по индексу

Parameters

integer $offset

offsetGet()

offsetGet(integer  $offset) : \Colibri\Collections\T

Возвращает значение по индексу

Parameters

integer $offset

Returns

\Colibri\Collections\T

AddRange()

AddRange(array<mixed,\Colibri\IO\Mail\Address>  $values) : void

Добавляет адреса в список

Parameters

array<mixed,\Colibri\IO\Mail\Address> $values