1. class
  2. App
  3. \
  4. Filters
  5. \
  6. VkSearchFilter

VkSearchFilter

class VkSearchFilter

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

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

Methods

VkSearchFilter
setQuery(string|null $query)

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

VkSearchFilter
setCity(int $cityId)

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

array
toArray()

Преобразует параметры фильтра в массив для API запроса.

Details

at line 26
VkSearchFilter setQuery(string|null $query)

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

Parameters

string|null $query

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

Return Value

VkSearchFilter

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

at line 41
VkSearchFilter setCity(int $cityId)

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

Parameters

int $cityId

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

Return Value

VkSearchFilter

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

at line 56
array toArray()

Преобразует параметры фильтра в массив для API запроса.

Добавляет обязательные параметры запроса:

  • fields: дополнительные поля профилей пользователей
  • count: количество возвращаемых пользователей

Return Value

array

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