Клиент
класс Client расширяет Client
Client моделирует браузер и отправляет запросы к объекту Kernel.
Свойства
| protected | $history | из Client | |
| protected | $cookieJar | из Client | |
| protected | $server | из Client | |
| protected | $internalRequest | из Client | |
| protected | $request | из Client | |
| protected | $internalResponse | из Client | |
| protected | $response | из Client | |
| protected | $crawler | из Client | |
| protected | $insulated | из Client | |
| protected | $redirect | из Client | |
| protected | $followRedirects | из Client | |
| protected | $kernel |
Методы
| __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 |
| Crawler | xmlHttpRequest(string $method, string $uri, array $parameters = array(), array $files = array(), array $server = array(), string $content = null, bool $changeHistory = true) | из Client |
| History | getHistory() Возвращает экземпляр History. | из Client |
| CookieJar | getCookieJar() Возвращает экземпляр CookieJar. | из Client |
| Crawler | getCrawler() Возвращает текущий экземпляр Crawler. | из Client |
| Response | getInternalResponse() Возвращает текущий экземпляр Response BrowserKit. | из Client |
| Response | getResponse() Экземпляр Response | |
| Request | getInternalRequest() Возвращает текущий экземпляр Request BrowserKit. | из Client |
| Request | getRequest() Экземпляр Request | |
| 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 |
| object | doRequestInProcess(object $request) Выполняет запрос в другом процессе. | из Client |
| object | doRequest(object $request) Выполняет запрос. | |
| getScript(object $request) Возвращает скрипт для выполнения, когда запрос должен быть изолирован. | ||
| object | filterRequest(Request $request) Преобразует запрос BrowserKit в запрос HttpKernel. | |
| Response | filterResponse(object $response) Преобразует ответ HttpKernel в ответ BrowserKit. | |
| Crawler|null | createCrawlerFromContent(string $uri, string $content, string $type) Создаёт Crawler. | из Client |
| Crawler | back() Возвращается назад в истории браузера. | из Client |
| Crawler | forward() Переходит вперёд в истории браузера. | из Client |
| Crawler | reload() Перезагружает текущий браузер. | из Client |
| Crawler | followRedirect() Следовать перенаправлениям? | из Client |
| restart() Перезапускает клиент. | из Client | |
| string | getAbsoluteUri(string $uri) Принимает URI и преобразует его в абсолютный, если он ещё не абсолютный. | из Client |
| Crawler | requestFromRequest(Request $request, bool $changeHistory = true) Выполняет запрос непосредственно из объекта Request. | из Client |
| catchExceptions(bool $catchExceptions) Устанавливает, следует ли перехватывать исключения, когда ядро обрабатывает запрос. | ||
| getHandleScript() | ||
| array | filterFiles(array $files) Фильтрует массив файлов. |
Подробности
__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 | Значение параметра |
Crawler xmlHttpRequest(string $method, string $uri, array $parameters = array(), array $files = array(), array $server = array(), string $content = null, bool $changeHistory = true)
Параметры
| string | $method | |
| string | $uri | |
| array | $parameters | |
| array | $files | |
| array | $server | |
| string | $content | |
| bool | $changeHistory |
Значение возврата
| Crawler |
History getHistory()
Возвращает экземпляр History.
Значение возврата
| History | Экземпляр History |
CookieJar getCookieJar()
Возвращает экземпляр CookieJar.
Значение возврата
| CookieJar | Экземпляр CookieJar |
Crawler getCrawler()
Возвращает текущий экземпляр Crawler.
Значение возврата
| Crawler | Экземпляр Crawler |
Response getInternalResponse()
Возвращает текущий экземпляр Response из BrowserKit.
Значение возврата
| Response | Экземпляр Response из BrowserKit |
Response getResponse()
Экземпляр Response
Значение возврата
| Response |
Request getInternalRequest()
Возвращает текущий экземпляр Request из BrowserKit.
Значение возврата
| Request | Экземпляр Request из BrowserKit |
Request getRequest()
Экземпляр Request
Значение возврата
| Request |
Crawler click(Link $link)
Нажимает на заданную ссылку.
Параметры
| Link | $link |
Значение возврата
| Crawler |
Crawler submit(Form $form, array $values = array())
Отправляет форму.
Параметры
| 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_) |
| string | $content | Необработанные данные тела |
| bool | $changeHistory | Обновлять ли историю (только для внутренних функций back(), forward() и reload()) |
Значение возврата
| Crawler |
protected object doRequestInProcess(object $request)
Выполняет запрос в другом процессе.
Параметры
| object | $request | Экземпляр исходного запроса |
Значение возврата
| object | Экземпляр исходного ответа |
Исключения
| RuntimeException | Если обработка возвращает код выхода |
protected object doRequest(object $request)
Выполняет запрос.
Параметры
| object | $request | Экземпляр исходного запроса |
Значение возврата
| object | Экземпляр исходного ответа |
protected getScript(object $request)
Возвращает скрипт для выполнения, когда запрос должен быть изолирован.
Параметры
| object | $request | Экземпляр исходного запроса |
protected object filterRequest(Request $request)
Преобразует запрос BrowserKit в запрос HttpKernel.
Параметры
| Запрос | $request | Запрос BrowserKit для фильтрации |
Значение возвращаемого значения
| объект | Экземпляр исходного запроса |
protected Ответ filterResponse(object $response)
Преобразует ответ HttpKernel в ответ BrowserKit.
Параметры
| объект | $response | Исходный ответ для фильтрации |
Значение возвращаемого значения
| Ответ | Экземпляр ответа BrowserKit |
protected Объект Crawler|null createCrawlerFromContent(string $uri, string $content, string $type)
Создает объект Crawler.
Этот метод возвращает null, если компонент DomCrawler недоступен.
Параметры
| строка | $uri | URI |
| строка | $content | Содержание для использования объектом Crawler |
| строка | $type | Тип содержимого |
Значение возвращаемого значения
| Объект Crawler|null |
Объект Crawler back()
Переходит назад в истории браузера.
Значение возвращаемого значения
| Объект Crawler |
Объект Crawler forward()
Переходит вперед в истории браузера.
Значение возвращаемого значения
| Объект Crawler |
Объект Crawler reload()
Перезагружает текущий браузер.
Значение возвращаемого значения
| Объект Crawler |
Объект Crawler followRedirect()
Следовать перенаправлениям?
Значение возвращаемого значения
| Объект Crawler |
Исключения
| LogicException | Если запрос не был перенаправлением |
restart()
Перезапускает клиент.
Очищает историю и все cookie.
protected строка getAbsoluteUri(string $uri)
Принимает URI и преобразует его в абсолютный, если он не является абсолютным.
Параметры
| строка | $uri | URI |
Значение возвращаемого значения
| строка | Абсолютный URI |
protected Объект Crawler requestFromRequest(Запрос $request, bool $changeHistory = true)
Выполняет запрос непосредственно из объекта Request.
Параметры
| Запрос | $request | Экземпляр Request |
| bool | $changeHistory | Обновлять историю или нет (используется только внутри для back(), forward() и reload()) |
Значение возвращаемого значения
| Объект Crawler |
catchExceptions(bool $catchExceptions)
Устанавливает, нужно ли перехватывать исключения при обработке запроса ядром.
Параметры
| bool | $catchExceptions | Перехватывать исключения |
protected getHandleScript()
protected массив filterFiles(array $files)
Фильтровать массив файлов.
Этот метод создает тестовые экземпляры UploadedFile, чтобы метод move() мог быть вызван на этих экземплярах.
Если размер файла больше разрешенного размера (из php.ini), то возвращается недопустимый UploadedFile с ошибкой, установленной в UPLOAD_ERR_INI_SIZE.
Параметры
| массив | $files |
Значение возвращаемого значения
| массив | Массив со всеми загруженными файлами, помеченными как уже перемещенные |
См. также
| UploadedFile |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/HttpKernel/Client.html