class VkUserSearchFilter

Класс фильтра для поиска пользователей VK.

Этот класс предоставляет fluent interface для построения параметров поиска, которые будут использоваться при вызове метода users.search API ВКонтакте.

Properties

protected array $filters

Массив параметров фильтрации.

Methods

__construct()

Конструктор класса.

setDefaults()

Устанавливает значения по умолчанию для фильтров.

setQuery(string|null $query)

Устанавливает строку поискового запроса.

setCity(int $cityId)

Устанавливает ID города для фильтрации результатов поиска.

setCount(int $count)

Устанавливает количество возвращаемых пользователей.

addFilter(string $key, mixed $value)

Добавляет произвольный фильтр к параметрам поиска.

array
getFilters()

Возвращает массив параметров для API запроса.

Details

at line 24
__construct()

Конструктор класса.

Устанавливает значения по умолчанию для фильтров.

at line 34
VkUserSearchFilter setDefaults()

Устанавливает значения по умолчанию для фильтров.

Return Value

VkUserSearchFilter

Возвращает текущий экземпляр для цепочки вызовов

at line 50
VkUserSearchFilter setQuery(string|null $query)

Устанавливает строку поискового запроса.

Parameters

string|null $query

Строка для поиска пользователей (например, "Иван Петров")

Return Value

VkUserSearchFilter

Возвращает текущий экземпляр для цепочки вызовов

at line 62
VkUserSearchFilter setCity(int $cityId)

Устанавливает ID города для фильтрации результатов поиска.

Parameters

int $cityId

ID города для поиска

Return Value

VkUserSearchFilter

Возвращает текущий экземпляр для цепочки вызовов

at line 74
VkUserSearchFilter setCount(int $count)

Устанавливает количество возвращаемых пользователей.

Parameters

int $count

Количество пользователей для возврата

Return Value

VkUserSearchFilter

Возвращает текущий экземпляр для цепочки вызовов

at line 87
VkUserSearchFilter addFilter(string $key, mixed $value)

Добавляет произвольный фильтр к параметрам поиска.

Parameters

string $key

Ключ фильтра

mixed $value

Значение фильтра

Return Value

VkUserSearchFilter

Возвращает текущий экземпляр для цепочки вызовов

at line 98
array getFilters()

Возвращает массив параметров для API запроса.

Return Value

array

Массив параметров для API запроса