Клиент
класс 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 | из 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 |
| 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() Возвращает текущий экземпляр ответа BrowserKit. | из Client |
| Response | getResponse() Экземпляр Response | из Client |
| Request | getInternalRequest() Возвращает текущий экземпляр запроса BrowserKit. | из Client |
| Request | 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 |
| object | doRequestInProcess(object $request) Выполняет запрос в другом процессе. | |
| object | doRequest(object $request) Выполняет запрос. | |
| getScript(object $request) Возвращает скрипт для выполнения, когда запрос должен быть изолирован. | ||
| object | filterRequest(Request $request) Преобразует запрос BrowserKit в запрос HttpKernel. | из Client |
| Response | filterResponse(object $response) Преобразует ответ HttpKernel в ответ BrowserKit. | из Client |
| 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) Устанавливает, нужно ли перехватывать исключения при обработке запроса ядром. | from Client | |
| getHandleScript() | from Client | |
| array | filterFiles(array $files) Фильтровать массив файлов. | from Client |
| ContainerInterface|null | getContainer() Возвращает контейнер. | |
| KernelInterface | getKernel() Возвращает ядро. | |
| Profile|false | 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 | Значение параметра |
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)
Возвращает скрипт для выполнения, когда запрос должен быть изолирован.
Предполагается, что загрузчик автозагрузки называется 'autoload.php' и что он хранится в той же директории, что и ядро (так происходит в случае Symfony Standard Edition). Если это не так, создайте свой собственный клиент и переопределите этот метод.
Параметры
| объект | $request | Экземпляр исходного запроса |
protected объект filterRequest(Request $request)
Преобразует запрос BrowserKit в запрос HttpKernel.
Параметры
| Request | $request | Запрос BrowserKit для фильтрации |
Значение возврата
| объект | Экземпляр исходного запроса |
protected Response filterResponse(объект $response)
Преобразует ответ HttpKernel в ответ BrowserKit.
Параметры
| объект | $response | Исходный ответ для фильтрации |
Значение возврата
| Response | Экземпляр ответа BrowserKit |
protected Crawler|null createCrawlerFromContent(string $uri, string $content, string $type)
Создаёт обходчик.
Этот метод возвращает null, если компонент DomCrawler недоступен.
Параметры
| string | $uri | URI |
| string | $content | Содержание для использования обходчиком |
| string | $type | Тип контента |
Значение возврата
| Crawler|null |
Crawler back()
Возвращается на предыдущую страницу в истории браузера.
Значение возврата
| Crawler |
Crawler forward()
Переходит вперёд в истории браузера.
Значение возврата
| Crawler |
Crawler reload()
Перезагружает текущий браузер.
Значение возврата
| Crawler |
Crawler followRedirect()
Следовать редиректам?
Значение возврата
| Crawler |
Исключения
| LogicException | Если запрос не был редиректом |
restart()
Перезапускает клиент.
Очищает историю и все куки.
protected string getAbsoluteUri(string $uri)
Принимает URI и преобразует его в абсолютный, если он не является абсолютным.
Параметры
| string | $uri | URI |
Значение возврата
| string | Абсолютный URI |
protected Crawler requestFromRequest(Request $request, bool $changeHistory = true)
Делает запрос непосредственно из объекта Request.
Параметры
| Request | $request | Объект Request |
| bool | $changeHistory | Обновлять историю или нет (используется только внутри для back(), forward() и reload()) |
Значение возврата
| Crawler |
catchExceptions(bool $catchExceptions)
Устанавливает, нужно ли перехватывать исключения при обработке запроса ядром.
Параметры
| bool | $catchExceptions | Перехватывать исключения или нет |
protected getHandleScript()
protected array filterFiles(array $files)
Фильтры массив файлов.
Этот метод создаёт тестовые экземпляры UploadedFile, чтобы метод move() можно было вызвать на этих экземплярах.
Если размер файла больше разрешённого размера (из php.ini), возвращается недопустимый UploadedFile с ошибкой, установленной на UPLOAD_ERR_INI_SIZE.
Параметры
| array | $files |
Значение возврата
| array | Массив со всеми загруженными файлами, помеченными как уже перемещённые |
См. также
| UploadedFile |
ContainerInterface|null getContainer()
Возвращает контейнер.
Значение возврата
| ContainerInterface|null | Возвращает null, когда ядро было остановлено или ещё не запущено |
KernelInterface getKernel()
Возвращает ядро.
Значение возврата
| KernelInterface |
Profile|false getProfile()
Получает профиль, связанный с текущим ответом.
Значение возврата
| Profile|false | Экземпляр Profile |
enableProfiler()
Включает профайлер для следующего запроса.
Если профайлер уже включен, вызов этого метода ничего не делает.
disableReboot()
Отключает перезагрузку ядра между запросами.
По умолчанию, клиент перезапускает ядро для каждого запроса. Этот метод позволяет сохранить то же ядро между запросами.
enableReboot()
Включает перезагрузку ядра между запросами.
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Bundle/FrameworkBundle/Client.html