Клиент
класс Client расширяет Client
Клиент имитирует браузер и отправляет запросы к объекту ядра.
Методы
| __construct(HttpKernelInterface $kernel, array $server = array(), History $history = null, CookieJar $cookieJar = null) Конструктор. | ||
| followRedirects(bool $followRedirect = true) Устанавливает, следует ли автоматически перенаправления или нет. | из Client | |
| bool | isFollowingRedirects() Возвращает, следует ли клиент автоматически перенаправления или нет. | из Client |
| setMaxRedirects(int $maxRedirects) Устанавливает максимальное количество запросов, которые может следовать робот. | из Client | |
| int | getMaxRedirects() Возвращает максимальное количество запросов, которые может следовать робот. | из Client |
| insulate(bool $insulated = true) Устанавливает флаг изоляции. | из Client | |
| setServerParameters(array $server) Устанавливает параметры сервера. | из Client | |
| setServerParameter(string $key, string $value) Устанавливает отдельный параметр сервера. | из Client | |
| string | getServerParameter(string $key, string $default = '') Получает отдельный параметр сервера для указанного ключа. | из Client |
| History | getHistory() Возвращает экземпляр History. | из Client |
| CookieJar | getCookieJar() Возвращает экземпляр CookieJar. | из Client |
| Crawler|null | getCrawler() Возвращает текущий экземпляр Crawler. | из Client |
| Response|null | getInternalResponse() Возвращает текущий экземпляр Response BrowserKit. | из Client |
| object|null | getResponse() Возвращает текущий экземпляр ответа источника. | из Client |
| Request|null | getInternalRequest() Возвращает текущий экземпляр Request BrowserKit. | из Client |
| object|null | getRequest() Возвращает текущий экземпляр Request источника. | из Client |
| Crawler | click(Link $link) Нажимает на заданную ссылку. | из Client |
| Crawler | submit(Form $form, array $values = array()) Отправляет форму. | из Client |
| Crawler | request(string $method, string $uri, array $parameters = array(), array $files = array(), array $server = array(), string $content = null, bool $changeHistory = true) Выполняет запрос к URI. | из Client |
| Crawler | back() Возвращается назад в истории браузера. | из Client |
| Crawler | forward() Переходит вперед в истории браузера. | из Client |
| Crawler | reload() Перезагружает текущий браузер. | из Client |
| Crawler | followRedirect() Следовать перенаправлениям? | из Client |
| restart() Перезапускает клиент. | из Client | |
| ContainerInterface|null | getContainer() Возвращает контейнер. | |
| KernelInterface | getKernel() Возвращает ядро. | |
| Profile | getProfile() Получает профиль, связанный с текущим ответом. | |
| enableProfiler() Включает профайлер для следующего запроса. | ||
| disableReboot() Отключает перезапуск ядра между запросами. | ||
| enableReboot() Включает перезапуск ядра между запросами. |
Подробности
__construct(HttpKernelInterface $kernel, array $server = array(), History $history = null, CookieJar $cookieJar = null)
Конструктор.
Параметры
| HttpKernelInterface | $kernel | Экземпляр HttpKernel |
| array | $server | Параметры сервера (аналогичны $_SERVER) |
| History | $history | Экземпляр History для хранения истории браузера |
| CookieJar | $cookieJar | Экземпляр CookieJar для хранения файлов cookie |
followRedirects(bool $followRedirect = true)
Устанавливает, следует ли автоматически перенаправлять.
Параметры
| bool | $followRedirect | Следовать ли перенаправлениям |
bool isFollowingRedirects()
Возвращает, следует ли клиент автоматически перенаправлениям.
Значение возврата
| bool |
setMaxRedirects(int $maxRedirects)
Устанавливает максимальное количество запросов, которые может отслеживать робот.
Параметры
| int | $maxRedirects |
int getMaxRedirects()
Возвращает максимальное количество запросов, которые может отслеживать робот.
Значение возврата
| int |
insulate(bool $insulated = true)
Устанавливает флаг изоляции.
Параметры
| bool | $insulated | Производить ли изоляцию запросов |
Исключения
| RuntimeException | При отсутствии компоненты Symfony Process |
setServerParameters(array $server)
Устанавливает параметры сервера.
Параметры
| array | $server | Массив параметров сервера |
setServerParameter(string $key, string $value)
Устанавливает отдельный параметр сервера.
Параметры
| string | $key | Ключ параметра |
| string | $value | Значение параметра |
string getServerParameter(string $key, string $default = '')
Получает отдельный параметр сервера по указанному ключу.
Параметры
| string | $key | Ключ параметра для получения |
| string | $default | Значение по умолчанию, если ключ не определен |
Значение возврата
| string | Значение параметра |
History getHistory()
Возвращает экземпляр History.
Значение возврата
| History | Экземпляр History |
CookieJar getCookieJar()
Возвращает экземпляр CookieJar.
Значение возврата
| CookieJar | Экземпляр CookieJar |
Crawler|null getCrawler()
Возвращает текущий экземпляр Crawler.
Значение возврата
| Crawler|null | Экземпляр Crawler |
Response|null getInternalResponse()
Возвращает текущий экземпляр ответа BrowserKit.
Значение возврата
| Response|null | Экземпляр ответа BrowserKit |
object|null getResponse()
Возвращает текущий исходный экземпляр ответа.
Исходный ответ — экземпляр ответа, возвращаемый кодом, обрабатывающим запросы.
Значение возврата
| object|null | Экземпляр ответа |
Request|null getInternalRequest()
Возвращает текущий экземпляр запроса BrowserKit.
Значение возврата
| Request|null | Экземпляр запроса BrowserKit |
object|null getRequest()
Возвращает текущий исходный экземпляр запроса.
Исходный запрос — экземпляр запроса, отправляемый коду, обрабатывающему запросы.
Значение возврата
| object|null | Экземпляр запроса |
Crawler click(Link $link)
Нажимает на указанную ссылку.
Параметры
| Link | $link | Экземпляр Link |
Значение возврата
| Crawler |
Crawler submit(Form $form, array $values = array())
Отправляет форму.
Параметры
| Form | $form | Экземпляр Form |
| array | $values | Массив значений полей формы |
Значение возврата
| Crawler |
Crawler request(string $method, string $uri, array $parameters = array(), array $files = array(), array $server = array(), string $content = null, bool $changeHistory = true)
Выполняет запрос к URI.
Параметры
| string | $method | Метод запроса |
| string | $uri | URI для получения |
| array | $parameters | Параметры запроса |
| array | $files | Файлы |
| array | $server | Параметры сервера (HTTP-заголовки указаны с префиксом HTTP_ как в PHP) |
| string | $content | Необработанные данные тела |
| bool | $changeHistory | Обновлять ли историю (используется только внутренне для функций back(), forward() и reload()) |
Значение возврата
| Crawler |
Crawler back()
Возвращается на предыдущую страницу в истории браузера.
Значение возврата
| Crawler |
Crawler forward()
Переходит к следующей странице в истории браузера.
Значение возврата
| Crawler |
Crawler reload()
Перезагружает текущий браузер.
Значение возврата
| Crawler |
Crawler followRedirect()
Следовать ли перенаправлению?
Значение возврата
| Crawler |
Исключения
| LogicException | Если запрос не был перенаправлением |
restart()
Перезапускает клиента.
Очищает историю и все файлы cookie.
ContainerInterface|null getContainer()
Возвращает контейнер.
Значение возврата
| ContainerInterface|null | Возвращает null, когда ядро было остановлено или еще не запущено. |
KernelInterface getKernel()
Возвращает ядро.
Значение возврата
| KernelInterface |
Profile getProfile()
Получает профиль, связанный с текущим ответом.
Значение возврата
| Profile | Экземпляр Profile |
enableProfiler()
Включает профайлер для следующего запроса.
Если профайлер уже включен, вызов этого метода ничего не делает.
disableReboot()
Отключает перезагрузку ядра между запросами.
По умолчанию клиент перезагружает ядро для каждого запроса. Этот метод позволяет сохранить то же ядро между запросами.
enableReboot()
Включает перезагрузку ядра между запросами.
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.2/Symfony/Bundle/FrameworkBundle/Client.html