Класс yii\httpclient\Message

Все классы | Свойства | Методы

Наследование	yii\httpclient\Message » yii\base\Component » yii\base\Object
Реализует	yii\base\Configurable
Подклассы	yii\httpclient\Request, yii\httpclient\Response
Доступна с версии	2.0
Исходный код	https://github.com/yiisoft/yii2-httpclient/blob/master/Message.php

Message представляет базовый HTTP-запрос.

Общедоступные свойства

Свойство	Тип	Описание	Определено в
$behaviors	yii\base\Behavior[]	Список поведений, прикрепленных к этому компоненту	yii\base\Component
$client	yii\httpclient\Client	Экземпляр клиента-владельца.	yii\httpclient\Message
$content	string	Необработанное содержимое.	yii\httpclient\Message
$cookies	yii\web\CookieCollection\|yii\web\Cookie[]\|array	Коллекция файлов cookie или список файлов cookie.	yii\httpclient\Message
$data	mixed	Поля данных содержимого.	yii\httpclient\Message
$format	string	Имя формата тела.	yii\httpclient\Message
$headers	array\|yii\web\HeaderCollection	Коллекция заголовков или список заголовков в формате: [имяЗаголовка => значениеЗаголовка]	yii\httpclient\Message

Общедоступные методы

Метод	Описание	Определено в
__call()	Вызывает именованный метод, который не является методом класса.	yii\base\Component
__clone()	Этот метод вызывается после создания объекта путем клонирования существующего.	yii\base\Component
__construct()	Конструктор.	yii\base\Object
__get()	Возвращает значение свойства компонента.	yii\base\Component
__isset()	Проверяет, установлено ли свойство, т.е. определено и не равно null.	yii\base\Component
__set()	Устанавливает значение свойства компонента.	yii\base\Component
__toString()	Магический метод PHP, возвращающий строковое представление этого объекта.	yii\httpclient\Message
__unset()	Устанавливает свойство компонента в null.	yii\base\Component
addCookies()	Добавляет дополнительные куки к уже определённым.	yii\httpclient\Message
addData()	Добавляет поля данных к существующим.	yii\httpclient\Message
addHeaders()	Добавляет дополнительные заголовки к уже определённым.	yii\httpclient\Message
attachBehavior()	Присоединяет поведение к данному компоненту.	yii\base\Component
attachBehaviors()	Присоединяет список поведений к компоненту.	yii\base\Component
behaviors()	Возвращает список поведений, по которым должен действовать этот компонент.	yii\base\Component
canGetProperty()	Возвращает значение, указывающее, можно ли прочитать свойство.	yii\base\Component
canSetProperty()	Возвращает значение, указывающее, можно ли установить свойство.	yii\base\Component
className()	Возвращает полное имя этого класса.	yii\base\Object
composeHeaderLines()	Компонует строки заголовков из $headers.	yii\httpclient\Message
detachBehavior()	Отсоединяет поведение от компонента.	yii\base\Component
detachBehaviors()	Отсоединяет все поведения от компонента.	yii\base\Component
ensureBehaviors()	Убеждается, что поведения, объявленные в behaviors(), присоединены к этому компоненту.	yii\base\Component
getBehavior()	Возвращает объект именованного поведения.	yii\base\Component
getBehaviors()	Возвращает все присоединённые к этому компоненту поведения.	yii\base\Component
getContent()	Возвращает исходное содержимое HTTP-сообщения.	yii\httpclient\Message
getCookies()	Возвращает коллекцию куки.	yii\httpclient\Message
getData()	Возвращает поля данных, распарсенные из исходного содержимого.	yii\httpclient\Message
getFormat()	Возвращает формат тела.	yii\httpclient\Message
getHeaders()	Возвращает коллекцию заголовков.	yii\httpclient\Message
hasCookies()	Проверяет, содержит ли HTTP-сообщение какие-либо куки.	yii\httpclient\Message
hasEventHandlers()	Возвращает значение, указывающее, есть ли обработчик, прикреплённый к указанному событию.	yii\base\Component
hasHeaders()	Проверяет, содержит ли HTTP-сообщение какие-либо заголовки.	yii\httpclient\Message
hasMethod()	Возвращает значение, указывающее, определён ли метод.	yii\base\Component
hasProperty()	Возвращает значение, указывающее, определено ли свойство для данного компонента.	yii\base\Component
init()	Инициализирует объект.	yii\base\Object
off()	Отсоединяет существующий обработчик событий от этого компонента.	yii\base\Component
on()	Присоединяет обработчик событий к событию.	yii\base\Component
setContent()	Устанавливает исходное содержимое HTTP-сообщения.	yii\httpclient\Message
setCookies()	Устанавливает куки, связанные с HTTP-сообщением.	yii\httpclient\Message
setData()	Устанавливает поля данных, которые составляют содержимое сообщения.	yii\httpclient\Message
setFormat()	Устанавливает формат тела.	yii\httpclient\Message
setHeaders()	Устанавливает заголовки HTTP, связанные с HTTP-сообщением.	yii\httpclient\Message
toString()	Возвращает строковое представление этого HTTP-сообщения.	yii\httpclient\Message
trigger()	Вызывает событие.	yii\base\Component

Защищенные методы

Метод	Описание	Определено в
defaultFormat()	Возвращает имя формата по умолчанию.	yii\httpclient\Message

Подробное описание свойств

$client общедоступное свойство

Экземпляр объекта клиента.

public yii\httpclient\Client $client = null

$content общедоступное свойство

Исходное содержимое.

public string getContent ( )
public $this setContent ( $content )

$cookies общедоступное свойство

Коллекция куки или список куки.

public yii\web\CookieCollection|yii\web\Cookie[] getCookies ( )
public $this setCookies ( $cookies )

$data общедоступное свойство

Поля данных содержимого.

public mixed getData ( )
public $this setData ( $data )

$format общедоступное свойство

Имя формата тела.

public string getFormat ( )
public $this setFormat ( $format )

$headers общедоступное свойство

Коллекция заголовков или список заголовков в формате: [имяЗаголовка => значениеЗаголовка]

public yii\web\HeaderCollection getHeaders ( )
public $this setHeaders ( $headers )

Подробное описание методов

__toString() public method

PHP магический метод, возвращающий строковое представление этого объекта.

public string __toString ( )
return	string	Строковое представление этого объекта.

addCookies() public method

Добавляет дополнительные куки к уже определённым.

public $this addCookies ( array $cookies )
$cookies	yii\web\Cookie[]\|array	Дополнительные куки.
return	$this	Ссылка на себя.

addData() public method (доступно с версии 2.0.1)

Добавляет поля данных к существующим.

public $this addData ( $data )
$data	array	Дополнительные поля данных контента.
return	$this	Ссылка на себя.

addHeaders() public method

Добавляет дополнительные заголовки к уже определённым.

public $this addHeaders ( array $headers )
$headers	array	Дополнительные заголовки в формате: [имя_заголовка => значение_заголовка]
return	$this	Ссылка на себя.

composeHeaderLines() public method

Формирует строчки заголовков из $headers.

Каждая строчка будет строкой в формате: 'имя_заголовка: значение'.

public array composeHeaderLines ( )
return	array	Строчки заголовков.

defaultFormat() protected method

Возвращает имя формата по умолчанию.

protected string defaultFormat ( )
return	string	Имя формата по умолчанию.

getContent() public method

Возвращает исходное содержимое HTTP-сообщения.

public string getContent ( )
return	string	Исходное тело.

getCookies() public method

Возвращает коллекцию куки.

Коллекция куки содержит куки, связанные с HTTP-сообщением.

public yii\web\CookieCollection\|yii\web\Cookie[] getCookies ( )
return	yii\web\CookieCollection\|yii\web\Cookie[]	Коллекция куки.

getData() public method

Возвращает поля данных, распарсенные из исходного содержимого.

public mixed getData ( )
return	mixed	Поля данных контента.

getFormat() public method

Возвращает формат тела.

public string getFormat ( )
return	string	Имя формата тела.

getHeaders() public method

Возвращает коллекцию заголовков.

Коллекция заголовков содержит заголовки HTTP, связанные с HTTP-сообщением.

public yii\web\HeaderCollection getHeaders ( )
return	yii\web\HeaderCollection	Коллекция заголовков

hasCookies() public method

Проверяет, содержит ли HTTP-сообщение какие-либо куки.

Используя этот метод, вы можете проверить наличие куки, не создавая экземпляр yii\web\CookieCollection.

public boolean hasCookies ( )
return	boolean	Содержит ли сообщение куки.

hasHeaders() public method

Проверяет, содержит ли HTTP-сообщение какие-либо заголовки.

Используя этот метод, вы можете проверить наличие заголовков, не создавая экземпляр yii\web\HeaderCollection.

public boolean hasHeaders ( )
return	boolean	Содержит ли сообщение заголовки.

setContent() public method

Устанавливает исходное содержимое HTTP-сообщения.

public $this setContent ( $content )
$content	string	Исходное содержимое.
return	$this	Ссылка на себя.

setCookies() public method

Устанавливает куки, связанные с HTTP-сообщением.

public $this setCookies ( $cookies )
$cookies	yii\web\CookieCollection\|yii\web\Cookie[]\|array	Коллекция куки или список куки.
return	$this	Ссылка на себя.

setData() public method

Устанавливает поля данных, составляющие содержимое сообщения.

public $this setData ( $data )
$data	mixed	Поля данных контента.
return	$this	Ссылка на себя.

setFormat() public method

Устанавливает формат тела.

public $this setFormat ( $format )
$format	string	Имя формата тела.
return	$this	Ссылка на себя.

setHeaders() public method

Устанавливает заголовки HTTP, связанные с HTTP-сообщением.

public $this setHeaders ( $headers )
$headers	array\|yii\web\HeaderCollection	Коллекция заголовков или список заголовков в формате: [имя_заголовка => значение_заголовка]
return	$this	Ссылка на себя.

toString() public method

Возвращает строковое представление этого HTTP-сообщения.

public string toString ( )
return	string	Строковое представление этого HTTP-сообщения.

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-httpclient-message.html