Class yii\httpclient\Request

Inheritanceyii\httpclient\Request » yii\httpclient\Message » yii\base\Component » yii\base\BaseObject
Implementsyii\base\Configurable
Available since version2.0
Source Code https://github.com/yiisoft/yii2-httpclient/blob/master/Request.php

Request represents HTTP request.

Public Methods

Hide inherited methods

Method Description Defined By
__call() Calls the named method which is not a class method. yii\base\Component
__clone() This method is called after the object is created by cloning an existing one. yii\base\Component
__construct() Constructor. yii\base\BaseObject
__get() Returns the value of a component property. yii\base\Component
__isset() Checks if a property is set, i.e. defined and not null. yii\base\Component
__set() Sets the value of a component property. yii\base\Component
__toString() PHP magic method that returns the string representation of this object. yii\httpclient\Message
__unset() Sets a component property to be null. yii\base\Component
addContent() Adds a content part for multi-part content request. yii\httpclient\Request
addCookies() Adds more cookies to the already defined ones. yii\httpclient\Message
addData() Adds data fields to the existing ones. yii\httpclient\Request
addFile() Adds a file for upload as multi-part content. yii\httpclient\Request
addFileContent() Adds a string as a file upload. yii\httpclient\Request
addHeaders() Adds more headers to the already defined ones. yii\httpclient\Message
addOptions() Adds more options to already defined ones. yii\httpclient\Request
afterSend() This method is invoked right after this request is sent. yii\httpclient\Request
attachBehavior() Attaches a behavior to this component. yii\base\Component
attachBehaviors() Attaches a list of behaviors to the component. yii\base\Component
beforeSend() This method is invoked right before this request is sent. yii\httpclient\Request
behaviors() Returns a list of behaviors that this component should behave as. yii\base\Component
canGetProperty() Returns a value indicating whether a property can be read. yii\base\Component
canSetProperty() Returns a value indicating whether a property can be set. yii\base\Component
className() Returns the fully qualified name of this class. yii\base\BaseObject
composeHeaderLines() Composes raw header lines from $headers. yii\httpclient\Request
detachBehavior() Detaches a behavior from the component. yii\base\Component
detachBehaviors() Detaches all behaviors from the component. yii\base\Component
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component. yii\base\Component
getBehavior() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
getContent() Returns HTTP message raw content. yii\httpclient\Message
getCookies() Returns the cookie collection. yii\httpclient\Message
getData() Returns the data fields, parsed from raw content. yii\httpclient\Message
getFormat() Returns body format. yii\httpclient\Message
getFullUrl() Returns full target URL, including yii\httpclient\Client::$baseUrl as a string. yii\httpclient\Request
getHeaders() Returns the header collection. yii\httpclient\Message
getMethod() yii\httpclient\Request
getOptions() yii\httpclient\Request
getOutputFile() Gets the outputFile property yii\httpclient\Request
getUrl() Returns target URL. yii\httpclient\Request
hasContent() Checks if content with provided name exists yii\httpclient\Message
hasCookies() Checks of HTTP message contains any cookie. yii\httpclient\Message
hasEventHandlers() Returns a value indicating whether there is any handler attached to the named event. yii\base\Component
hasHeaders() Checks of HTTP message contains any header. yii\httpclient\Message
hasMethod() Returns a value indicating whether a method is defined. yii\base\Component
hasProperty() Returns a value indicating whether a property is defined for this component. yii\base\Component
init() Initializes the object. yii\base\BaseObject
off() Detaches an existing event handler from this component. yii\base\Component
on() Attaches an event handler to an event. yii\base\Component
prepare() Prepares this request instance for sending. yii\httpclient\Request
responseTime() Return the response time in seconds yii\httpclient\Request
send() Sends this request. yii\httpclient\Request
setContent() Sets the HTTP message raw content. yii\httpclient\Message
setCookies() Sets the cookies associated with HTTP message. yii\httpclient\Message
setData() Sets the data fields, which composes message content. yii\httpclient\Request
setFormat() Sets body format. yii\httpclient\Message
setFullUrl() Sets full target URL. yii\httpclient\Request
setHeaders() Sets the HTTP headers associated with HTTP message. yii\httpclient\Message
setMethod() yii\httpclient\Request
setOptions() Following options are supported: - timeout: int, the maximum number of seconds to allow request to be executed. yii\httpclient\Request
setOutputFile() Used with yii\httpclient\CurlTransport to set the file that the transfer should be written to yii\httpclient\Request
setUrl() Sets target URL. yii\httpclient\Request
toString() Returns string representation of this HTTP message. yii\httpclient\Request
trigger() Triggers an event. yii\base\Component

Protected Methods

Hide inherited methods

Method Description Defined By
defaultFormat() Returns default format name. yii\httpclient\Message

Events

Hide inherited events

Event Type Description Defined By
EVENT_AFTER_SEND yii\httpclient\RequestEvent An event raised right after request has been sent. yii\httpclient\Request
EVENT_BEFORE_SEND yii\httpclient\RequestEvent An event raised right before sending request. yii\httpclient\Request

Property Details

Hide inherited properties

$fullUrl public property

Full target URL.

public string $fullUrl null
$method public property

Request method.

public string $method null
$options public property

Request options.

public array $options null
$outputFile public property (available since version 2.0.9)
public resource getOutputFile ( )
public $this setOutputFile ( $file )
$url public property

Target URL or URL parameters.

public string|array $url null

Method Details

Hide inherited methods

__call() public method

Defined in: yii\base\Component::__call()

Calls the named method which is not a class method.

This method will check if any attached behavior has the named method and will execute it if available.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

public mixed __call ( $name, $params )
$name string

The method name

$params array

Method parameters

return mixed

The method return value

throws yii\base\UnknownMethodException

when calling unknown method

                public function __call($name, $params)
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $object) {
        if ($object->hasMethod($name)) {
            return call_user_func_array([$object, $name], $params);
        }
    }
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

            
__clone() public method

Defined in: yii\base\Component::__clone()

This method is called after the object is created by cloning an existing one.

It removes all behaviors because they are attached to the old object.

public void __clone ( )

                public function __clone()
{
    $this->_events = [];
    $this->_eventWildcards = [];
    $this->_behaviors = null;
}

            
__construct() public method

Defined in: yii\base\BaseObject::__construct()

Constructor.

The default implementation does two things:

  • Initializes the object with the given configuration $config.
  • Call init().

If this method is overridden in a child class, it is recommended that

  • the last parameter of the constructor is a configuration array, like $config here.
  • call the parent implementation at the end of the constructor.
public void __construct ( $config = [] )
$config array

Name-value pairs that will be used to initialize the object properties

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}

            
__get() public method

Defined in: yii\base\Component::__get()

Returns the value of a component property.

This method will check in the following order and act accordingly:

  • a property defined by a getter: return the getter result
  • a property of a behavior: return the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $component->property;.

See also __set().

public mixed __get ( $name )
$name string

The property name

return mixed

The property value or the value of a behavior's property

throws yii\base\UnknownPropertyException

if the property is not defined

throws yii\base\InvalidCallException

if the property is write-only.

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        // read property, e.g. getName()
        return $this->$getter();
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name;
        }
    }
    if (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}

            
__isset() public method

Defined in: yii\base\Component::__isset()

Checks if a property is set, i.e. defined and not null.

This method will check in the following order and act accordingly:

  • a property defined by a setter: return whether the property is set
  • a property of a behavior: return whether the property is set
  • return false for non existing properties

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($component->property).

See also https://www.php.net/manual/en/function.isset.php.

public boolean __isset ( $name )
$name string

The property name or the event name

return boolean

Whether the named property is set

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name !== null;
        }
    }
    return false;
}

            
__set() public method

Defined in: yii\base\Component::__set()

Sets the value of a component property.

This method will check in the following order and act accordingly:

  • a property defined by a setter: set the property value
  • an event in the format of "on xyz": attach the handler to the event "xyz"
  • a behavior in the format of "as xyz": attach the behavior named as "xyz"
  • a property of a behavior: set the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $component->property = $value;.

See also __get().

public void __set ( $name, $value )
$name string

The property name or the event name

$value mixed

The property value

throws yii\base\UnknownPropertyException

if the property is not defined

throws yii\base\InvalidCallException

if the property is read-only.

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        // set property
        $this->$setter($value);
        return;
    } elseif (strncmp($name, 'on ', 3) === 0) {
        // on event: attach event handler
        $this->on(trim(substr($name, 3)), $value);
        return;
    } elseif (strncmp($name, 'as ', 3) === 0) {
        // as behavior: attach behavior
        $name = trim(substr($name, 3));
        $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = $value;
            return;
        }
    }
    if (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}

            
__toString() public method

Defined in: yii\httpclient\Message::__toString()

PHP magic method that returns the string representation of this object.

public string __toString ( )
return string

The string representation of this object.

                public function __toString()
{
    // __toString cannot throw exception
    // use trigger_error to bypass this limitation
    try {
        return $this->toString();
    } catch (\Exception $e) {
        ErrorHandler::convertExceptionToError($e);
        return '';
    }
}

            
__unset() public method

Defined in: yii\base\Component::__unset()

Sets a component property to be null.

This method will check in the following order and act accordingly:

  • a property defined by a setter: set the property value to be null
  • a property of a behavior: set the property value to be null

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($component->property).

See also https://www.php.net/manual/en/function.unset.php.

public void __unset ( $name )
$name string

The property name

throws yii\base\InvalidCallException

if the property is read only.

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = null;
            return;
        }
    }
    throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}

            
addContent() public method

Adds a content part for multi-part content request.

public $this addContent ( $name, $content, $options = [] )
$name string

Part (form input) name.

$content string

Content.

$options array

Content part options, valid options are:

  • contentType - string, part content type
  • fileName - string, name of the uploading file
  • mimeType - string, part content type in case of file uploading
return $this

Self reference.

                public function addContent($name, $content, $options = [])
{
    $multiPartContent = $this->getContent();
    if (!is_array($multiPartContent)) {
        $multiPartContent = [];
    }
    $options['content'] = $content;
    $alias = $this->generateContentAlias($name);
    $this->addAliasToContentMap($name, $alias);
    $multiPartContent[$alias] = $options;
    $this->setContent($multiPartContent);
    return $this;
}

            
addCookies() public method

Defined in: yii\httpclient\Message::addCookies()

Adds more cookies to the already defined ones.

public $this addCookies ( array $cookies )
$cookies yii\web\Cookie[]|array

Additional cookies.

return $this

Self reference.

                public function addCookies(array $cookies)
{
    $cookieCollection = $this->getCookies();
    foreach ($cookies as $cookie) {
        if (!is_object($cookie)) {
            $cookie = new Cookie($cookie);
        }
        $cookieCollection->add($cookie);
    }
    return $this;
}

            
addData() public method (available since version 2.0.1)

Adds data fields to the existing ones.

public $this addData ( $data )
$data array

Additional content data fields.

return $this

Self reference.

                public function addData($data)
{
    if ($this->isPrepared) {
        $this->setContent(null);
        $this->isPrepared = false;
    }
    return parent::addData($data);
}

            
addFile() public method

Adds a file for upload as multi-part content.

See also addContent().

public $this addFile ( $name, $fileName, $options = [] )
$name string

Part (form input) name

$fileName string

Full name of the source file.

$options array

Content part options, valid options are:

  • fileName - string, base name of the uploading file, if not set it base name of the source file will be used.
  • mimeType - string, file mime type, if not set it will be determine automatically from source file.
throws yii\base\InvalidConfigException

                public function addFile($name, $fileName, $options = [])
{
    $content = file_get_contents($fileName);
    if (!isset($options['mimeType'])) {
        $options['mimeType'] = FileHelper::getMimeType($fileName);
    }
    if (!isset($options['fileName'])) {
        $options['fileName'] = basename($fileName);
    }
    return $this->addContent($name, $content, $options);
}

            
addFileContent() public method

Adds a string as a file upload.

See also addContent().

public $this addFileContent ( $name, $content, $options = [] )
$name string

Part (form input) name

$content string

File content.

$options array

Content part options, valid options are:

  • fileName - string, base name of the uploading file.
  • mimeType - string, file mime type, if not set it 'application/octet-stream' will be used.

                public function addFileContent($name, $content, $options = [])
{
    if (!isset($options['mimeType'])) {
        $options['mimeType'] = 'application/octet-stream';
    }
    if (!isset($options['fileName'])) {
        $options['fileName'] = $name . '.dat';
    }
    return $this->addContent($name, $content, $options);
}

            
addHeaders() public method

Defined in: yii\httpclient\Message::addHeaders()

Adds more headers to the already defined ones.

public $this addHeaders ( array $headers )
$headers array

Additional headers in format: [headerName => headerValue]

return $this

Self reference.

                public function addHeaders(array $headers)
{
    $headerCollection = $this->getHeaders();
    foreach ($headers as $name => $value) {
        $headerCollection->add($name, $value);
    }
    return $this;
}

            
addOptions() public method

Adds more options to already defined ones.

Please refer to setOptions() on how to specify options.

public $this addOptions ( array $options )
$options array

Additional options

return $this

Self reference.

                public function addOptions(array $options)
{
    // `array_merge()` will produce invalid result for cURL options,
    // while `ArrayHelper::merge()` is unable to override cURL options
    foreach ($options as $key => $value) {
        if (is_array($value) && isset($this->_options[$key])) {
            $value = ArrayHelper::merge($this->_options[$key], $value);
        }
        $this->_options[$key] = $value;
    }
    return $this;
}

            
afterSend() public method (available since version 2.0.1)

This method is invoked right after this request is sent.

The method will invoke yii\httpclient\Client::afterSend() and trigger the EVENT_AFTER_SEND event.

public void afterSend ( $response )
$response yii\httpclient\Response

Received response instance.

                public function afterSend($response)
{
    $this->_timeElapsed = microtime(true)-$this->_startTime;
    $this->client->afterSend($this, $response);
    $event = new RequestEvent();
    $event->request = $this;
    $event->response = $response;
    $this->trigger(self::EVENT_AFTER_SEND, $event);
}

            
attachBehavior() public method

Defined in: yii\base\Component::attachBehavior()

Attaches a behavior to this component.

This method will create the behavior object based on the given configuration. After that, the behavior object will be attached to this component by calling the yii\base\Behavior::attach() method.

See also detachBehavior().

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name string

The name of the behavior.

$behavior string|array|yii\base\Behavior

The behavior configuration. This can be one of the following:

return yii\base\Behavior

The behavior object

                public function attachBehavior($name, $behavior)
{
    $this->ensureBehaviors();
    return $this->attachBehaviorInternal($name, $behavior);
}

            
attachBehaviors() public method

Defined in: yii\base\Component::attachBehaviors()

Attaches a list of behaviors to the component.

Each behavior is indexed by its name and should be a yii\base\Behavior object, a string specifying the behavior class, or an configuration array for creating the behavior.

See also attachBehavior().

public void attachBehaviors ( $behaviors )
$behaviors array

List of behaviors to be attached to the component

                public function attachBehaviors($behaviors)
{
    $this->ensureBehaviors();
    foreach ($behaviors as $name => $behavior) {
        $this->attachBehaviorInternal($name, $behavior);
    }
}

            
beforeSend() public method (available since version 2.0.1)

This method is invoked right before this request is sent.

The method will invoke yii\httpclient\Client::beforeSend() and trigger the EVENT_BEFORE_SEND event.

public void beforeSend ( )

                public function beforeSend()
{
    $this->client->beforeSend($this);
    $event = new RequestEvent();
    $event->request = $this;
    $this->trigger(self::EVENT_BEFORE_SEND, $event);
    $this->_startTime = microtime(true);
}

            
behaviors() public method

Defined in: yii\base\Component::behaviors()

Returns a list of behaviors that this component should behave as.

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

Note that a behavior class must extend from yii\base\Behavior. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using getBehavior() or be detached using detachBehavior(). Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

public array behaviors ( )
return array

The behavior configurations.

                public function behaviors()
{
    return [];
}

            
canGetProperty() public method

Defined in: yii\base\Component::canGetProperty()

Returns a value indicating whether a property can be read.

A property can be read if:

  • the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
  • an attached behavior has a readable property of the given name (when $checkBehaviors is true).

See also canSetProperty().

public boolean canGetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

The property name

$checkVars boolean

Whether to treat member variables as properties

$checkBehaviors boolean

Whether to treat behaviors' properties as properties of this component

return boolean

Whether the property can be read

                public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
canSetProperty() public method

Defined in: yii\base\Component::canSetProperty()

Returns a value indicating whether a property can be set.

A property can be written if:

  • the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
  • an attached behavior has a writable property of the given name (when $checkBehaviors is true).

See also canGetProperty().

public boolean canSetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

The property name

$checkVars boolean

Whether to treat member variables as properties

$checkBehaviors boolean

Whether to treat behaviors' properties as properties of this component

return boolean

Whether the property can be written

                public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
className() public static method
Deprecated since 2.0.14. On PHP >=5.5, use ::class instead.

Defined in: yii\base\BaseObject::className()

Returns the fully qualified name of this class.

public static string className ( )
return string

The fully qualified name of this class.

                public static function className()
{
    return get_called_class();
}

            
composeHeaderLines() public method

Composes raw header lines from $headers.

Each line will be a string in format: 'header-name: value'.

public array composeHeaderLines ( )
return array

Raw header lines.

                public function composeHeaderLines()
{
    $headers = parent::composeHeaderLines();
    if ($this->hasCookies()) {
        $headers[] = $this->composeCookieHeader();
    }
    return $headers;
}

            
defaultFormat() protected method

Defined in: yii\httpclient\Message::defaultFormat()

Returns default format name.

protected string defaultFormat ( )
return string

Default format name.

                protected function defaultFormat()
{
    return Client::FORMAT_URLENCODED;
}

            
detachBehavior() public method

Defined in: yii\base\Component::detachBehavior()

Detaches a behavior from the component.

The behavior's yii\base\Behavior::detach() method will be invoked.

public yii\base\Behavior|null detachBehavior ( $name )
$name string

The behavior's name.

return yii\base\Behavior|null

The detached behavior. Null if the behavior does not exist.

                public function detachBehavior($name)
{
    $this->ensureBehaviors();
    if (isset($this->_behaviors[$name])) {
        $behavior = $this->_behaviors[$name];
        unset($this->_behaviors[$name]);
        $behavior->detach();
        return $behavior;
    }
    return null;
}

            
detachBehaviors() public method

Defined in: yii\base\Component::detachBehaviors()

Detaches all behaviors from the component.

public void detachBehaviors ( )

                public function detachBehaviors()
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $name => $behavior) {
        $this->detachBehavior($name);
    }
}

            
ensureBehaviors() public method

Defined in: yii\base\Component::ensureBehaviors()

Makes sure that the behaviors declared in behaviors() are attached to this component.

public void ensureBehaviors ( )

                public function ensureBehaviors()
{
    if ($this->_behaviors === null) {
        $this->_behaviors = [];
        foreach ($this->behaviors() as $name => $behavior) {
            $this->attachBehaviorInternal($name, $behavior);
        }
    }
}

            
getBehavior() public method

Defined in: yii\base\Component::getBehavior()

Returns the named behavior object.

public yii\base\Behavior|null getBehavior ( $name )
$name string

The behavior name

return yii\base\Behavior|null

The behavior object, or null if the behavior does not exist

                public function getBehavior($name)
{
    $this->ensureBehaviors();
    return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}

            
getBehaviors() public method

Defined in: yii\base\Component::getBehaviors()

Returns all behaviors attached to this component.

public yii\base\Behavior[] getBehaviors ( )
return yii\base\Behavior[]

List of behaviors attached to this component

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}

            
getContent() public method

Defined in: yii\httpclient\Message::getContent()

Returns HTTP message raw content.

public string getContent ( )
return string

Raw body.

                public function getContent()
{
    return $this->_content;
}

            
getCookies() public method

Defined in: yii\httpclient\Message::getCookies()

Returns the cookie collection.

The cookie collection contains the cookies associated with HTTP message.

public yii\web\CookieCollection|yii\web\Cookie[] getCookies ( )
return yii\web\CookieCollection|yii\web\Cookie[]

The cookie collection.

                public function getCookies()
{
    if (!is_object($this->_cookies)) {
        $cookieCollection = new CookieCollection();
        if (is_array($this->_cookies)) {
            foreach ($this->_cookies as $cookie) {
                if (!is_object($cookie)) {
                    $cookie = new Cookie($cookie);
                }
                $cookieCollection->add($cookie);
            }
        }
        $this->_cookies = $cookieCollection;
    }
    return $this->_cookies;
}

            
getData() public method

Defined in: yii\httpclient\Message::getData()

Returns the data fields, parsed from raw content.

public mixed getData ( )
return mixed

Content data fields.

                public function getData()
{
    return $this->_data;
}

            
getFormat() public method

Defined in: yii\httpclient\Message::getFormat()

Returns body format.

public string getFormat ( )
return string

Body format name.

                public function getFormat()
{
    if ($this->_format === null) {
        $this->_format = $this->defaultFormat();
    }
    return $this->_format;
}

            
getFullUrl() public method

Returns full target URL, including yii\httpclient\Client::$baseUrl as a string.

public string getFullUrl ( )
return string

Full target URL.

                public function getFullUrl()
{
    if ($this->_fullUrl === null) {
        $this->_fullUrl = $this->createFullUrl($this->getUrl());
    }
    return $this->_fullUrl;
}

            
getHeaders() public method

Defined in: yii\httpclient\Message::getHeaders()

Returns the header collection.

The header collection contains the HTTP headers associated with HTTP message.

public yii\web\HeaderCollection getHeaders ( )
return yii\web\HeaderCollection

The header collection

                public function getHeaders()
{
    if (!is_object($this->_headers)) {
        $headerCollection = new HeaderCollection();
        if (is_array($this->_headers)) {
            foreach ($this->_headers as $name => $value) {
                if (is_int($name)) {
                    // parse raw header :
                    $rawHeader = $value;
                    if (strpos($rawHeader, 'HTTP/') === 0) {
                        $parts = explode(' ', $rawHeader, 3);
                        $headerCollection->add('http-code', $parts[1]);
                    } elseif (($separatorPos = strpos($rawHeader, ':')) !== false) {
                        $name = strtolower(trim(substr($rawHeader, 0, $separatorPos)));
                        $value = trim(substr($rawHeader, $separatorPos + 1));
                        $headerCollection->add($name, $value);
                    } else {
                        $headerCollection->add('raw', $rawHeader);
                    }
                } else {
                    $headerCollection->set($name, $value);
                }
            }
        }
        $this->_headers = $headerCollection;
    }
    return $this->_headers;
}

            
getMethod() public method

public string getMethod ( )
return string

Request method

                public function getMethod()
{
    return $this->_method;
}

            
getOptions() public method

public array getOptions ( )
return array

Request options.

                public function getOptions()
{
    return $this->_options;
}

            
getOutputFile() public method (available since version 2.0.9)

Gets the outputFile property

public resource getOutputFile ( )

                public function getOutputFile()
{
    return $this->_outputFile;
}

            
getUrl() public method

Returns target URL.

public string|array|null getUrl ( )
return string|array|null

Target URL or URL parameters

                public function getUrl()
{
    return $this->_url;
}

            
hasContent() public method (available since version 2.0.10)

Defined in: yii\httpclient\Message::hasContent()

Checks if content with provided name exists

public boolean hasContent ( $key )
$key

String Name of the content parameter

                public function hasContent($key)
{
    $content = $this->getContent();
    return is_array($content) && isset($content[$key]);
}

            
hasCookies() public method

Defined in: yii\httpclient\Message::hasCookies()

Checks of HTTP message contains any cookie.

Using this method you are able to check cookie presence without instantiating yii\web\CookieCollection.

public boolean hasCookies ( )
return boolean

Whether message contains any cookie.

                public function hasCookies()
{
    if (is_object($this->_cookies)) {
        return $this->_cookies->getCount() > 0;
    }
    return !empty($this->_cookies);
}

            
hasEventHandlers() public method

Defined in: yii\base\Component::hasEventHandlers()

Returns a value indicating whether there is any handler attached to the named event.

public boolean hasEventHandlers ( $name )
$name string

The event name

return boolean

Whether there is any handler attached to the event.

                public function hasEventHandlers($name)
{
    $this->ensureBehaviors();
    if (!empty($this->_events[$name])) {
        return true;
    }
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
            return true;
        }
    }
    return Event::hasHandlers($this, $name);
}

            
hasHeaders() public method

Defined in: yii\httpclient\Message::hasHeaders()

Checks of HTTP message contains any header.

Using this method you are able to check cookie presence without instantiating yii\web\HeaderCollection.

public boolean hasHeaders ( )
return boolean

Whether message contains any header.

                public function hasHeaders()
{
    if (is_object($this->_headers)) {
        return $this->_headers->getCount() > 0;
    }
    return !empty($this->_headers);
}

            
hasMethod() public method

Defined in: yii\base\Component::hasMethod()

Returns a value indicating whether a method is defined.

A method is defined if:

  • the class has a method with the specified name
  • an attached behavior has a method with the given name (when $checkBehaviors is true).
public boolean hasMethod ( $name, $checkBehaviors true )
$name string

The property name

$checkBehaviors boolean

Whether to treat behaviors' methods as methods of this component

return boolean

Whether the method is defined

                public function hasMethod($name, $checkBehaviors = true)
{
    if (method_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->hasMethod($name)) {
                return true;
            }
        }
    }
    return false;
}

            
hasProperty() public method

Defined in: yii\base\Component::hasProperty()

Returns a value indicating whether a property is defined for this component.

A property is defined if:

  • the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
  • an attached behavior has a property of the given name (when $checkBehaviors is true).

See also:

public boolean hasProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

The property name

$checkVars boolean

Whether to treat member variables as properties

$checkBehaviors boolean

Whether to treat behaviors' properties as properties of this component

return boolean

Whether the property is defined

                public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
    return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}

            
init() public method

Defined in: yii\base\BaseObject::init()

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

public void init ( )

                public function init()
{
}

            
off() public method

Defined in: yii\base\Component::off()

Detaches an existing event handler from this component.

This method is the opposite of on().

Note: in case wildcard pattern is passed for event name, only the handlers registered with this wildcard will be removed, while handlers registered with plain names matching this wildcard will remain.

See also on().

public boolean off ( $name, $handler null )
$name string

Event name

$handler callable|null

The event handler to be removed. If it is null, all handlers attached to the named event will be removed.

return boolean

If a handler is found and detached

                public function off($name, $handler = null)
{
    $this->ensureBehaviors();
    if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
        return false;
    }
    if ($handler === null) {
        unset($this->_events[$name], $this->_eventWildcards[$name]);
        return true;
    }
    $removed = false;
    // plain event names
    if (isset($this->_events[$name])) {
        foreach ($this->_events[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_events[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_events[$name] = array_values($this->_events[$name]);
            return true;
        }
    }
    // wildcard event names
    if (isset($this->_eventWildcards[$name])) {
        foreach ($this->_eventWildcards[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_eventWildcards[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
            // remove empty wildcards to save future redundant regex checks:
            if (empty($this->_eventWildcards[$name])) {
                unset($this->_eventWildcards[$name]);
            }
        }
    }
    return $removed;
}

            
on() public method

Defined in: yii\base\Component::on()

Attaches an event handler to an event.

The event handler must be a valid PHP callback. The following are some examples:

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

The event handler must be defined with the following signature,

function ($event)

where $event is an yii\base\Event object which includes parameters associated with the event.

Since 2.0.14 you can specify event name as a wildcard pattern:

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

See also off().

public void on ( $name, $handler, $data null, $append true )
$name string

The event name

$handler callable

The event handler

$data mixed

The data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via yii\base\Event::$data.

$append boolean

Whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list.

                public function on($name, $handler, $data = null, $append = true)
{
    $this->ensureBehaviors();
    if (strpos($name, '*') !== false) {
        if ($append || empty($this->_eventWildcards[$name])) {
            $this->_eventWildcards[$name][] = [$handler, $data];
        } else {
            array_unshift($this->_eventWildcards[$name], [$handler, $data]);
        }
        return;
    }
    if ($append || empty($this->_events[$name])) {
        $this->_events[$name][] = [$handler, $data];
    } else {
        array_unshift($this->_events[$name], [$handler, $data]);
    }
}

            
prepare() public method

Prepares this request instance for sending.

This method should be invoked by transport before sending a request. Do not call this method unless you know what you are doing.

public $this prepare ( )
return $this

Self reference.

                public function prepare()
{
    $content = $this->getContent();
    if ($content === null) {
        $this->getFormatter()->format($this);
    } elseif (is_array($content)) {
        $this->prepareMultiPartContent($content);
    }
    $this->isPrepared = true;
    return $this;
}

            
responseTime() public method (available since version 2.0.12)

Return the response time in seconds

public float responseTime ( )
return float

The seconds elapsed from request to response

                public function responseTime()
{
    return $this->_timeElapsed;
}

            
send() public method

Sends this request.

public yii\httpclient\Response send ( )
return yii\httpclient\Response

Response instance.

throws yii\httpclient\Exception

                public function send()
{
    return $this->client->send($this);
}

            
setContent() public method

Defined in: yii\httpclient\Message::setContent()

Sets the HTTP message raw content.

public $this setContent ( $content )
$content string

Raw content.

return $this

Self reference.

                public function setContent($content)
{
    $this->_content = $content;
    return $this;
}

            
setCookies() public method

Defined in: yii\httpclient\Message::setCookies()

Sets the cookies associated with HTTP message.

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

Cookie collection or cookies list.

return $this

Self reference.

                public function setCookies($cookies)
{
    $this->_cookies = $cookies;
    return $this;
}

            
setData() public method

Sets the data fields, which composes message content.

public $this setData ( $data )
$data mixed

Content data fields.

return $this

Self reference.

                public function setData($data)
{
    if ($this->isPrepared) {
        $this->setContent(null);
        $this->isPrepared = false;
    }
    return parent::setData($data);
}

            
setFormat() public method

Defined in: yii\httpclient\Message::setFormat()

Sets body format.

public $this setFormat ( $format )
$format string

Body format name.

return $this

Self reference.

                public function setFormat($format)
{
    $this->_format = $format;
    return $this;
}

            
setFullUrl() public method (available since version 2.0.3)

Sets full target URL.

This method can be used during request formatting and preparation. Do not use it for the target URL specification, use setUrl() instead.

public $this setFullUrl ( $fullUrl )
$fullUrl string

Full target URL.

return $this

Self reference.

                public function setFullUrl($fullUrl)
{
    $this->_fullUrl = $fullUrl;
    return $this;
}

            
setHeaders() public method

Defined in: yii\httpclient\Message::setHeaders()

Sets the HTTP headers associated with HTTP message.

public $this setHeaders ( $headers )
$headers array|yii\web\HeaderCollection

Headers collection or headers list in format: [headerName => headerValue]

return $this

Self reference.

                public function setHeaders($headers)
{
    $this->_headers = $headers;
    return $this;
}

            
setMethod() public method

public $this setMethod ( $method )
$method string

Request method

return $this

Self reference.

                public function setMethod($method)
{
    $this->_method = $method;
    return $this;
}

            
setOptions() public method

Following options are supported: - timeout: int, the maximum number of seconds to allow request to be executed.

  • proxy: string, URI specifying address of proxy server. (e.g. tcp://proxy.example.com:5100).
  • userAgent: string, the contents of the "User-Agent: " header to be used in a HTTP request.
  • followLocation: bool, whether to follow any "Location: " header that the server sends as part of the HTTP header.
  • maxRedirects: int, the max number of redirects to follow.
  • protocolVersion: float|string, HTTP protocol version.
  • sslVerifyPeer: bool, whether verification of the peer's certificate should be performed.
  • sslCafile: string, location of Certificate Authority file on local filesystem which should be used with the 'sslVerifyPeer' option to authenticate the identity of the remote peer.
  • sslCapath: string, a directory that holds multiple CA certificates.

You may set options using keys, which are specific to particular transport, like [CURLOPT_VERBOSE => true] in case there is a necessity for it.

public $this setOptions ( array $options )
$options array

Request options.

return $this

Self reference.

                public function setOptions(array $options)
{
    $this->_options = $options;
    return $this;
}

            
setOutputFile() public method (available since version 2.0.9)

Used with yii\httpclient\CurlTransport to set the file that the transfer should be written to

See also \yii\httpclient\CURLOPT_FILE.

public $this setOutputFile ( $file )
$file resource
return $this

Self reference.

                public function setOutputFile($file)
{
    $this->_outputFile = $file;
    return $this;
}

            
setUrl() public method

Sets target URL.

public $this setUrl ( $url )
$url string|array

Use a string to represent a URL (e.g. http://some-domain.com, item/list), or an array to represent a URL with query parameters (e.g. ['item/list', 'param1' => 'value1']).

return $this

Self reference.

                public function setUrl($url)
{
    $this->_url = $url;
    $this->_fullUrl = null;
    return $this;
}

            
toString() public method

Returns string representation of this HTTP message.

public string toString ( )
return string

The string representation of this HTTP message.

                public function toString()
{
    if (!$this->isPrepared) {
        $this->prepare();
    }
    $result = strtoupper($this->getMethod()) . ' ' . $this->getFullUrl();
    $parentResult = parent::toString();
    if ($parentResult !== '') {
        $result .= "\n" . $parentResult;
    }
    return $result;
}

            
trigger() public method

Defined in: yii\base\Component::trigger()

Triggers an event.

This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.

public void trigger ( $name, yii\base\Event $event null )
$name string

The event name

$event yii\base\Event|null

The event instance. If not set, a default yii\base\Event object will be created.

                public function trigger($name, Event $event = null)
{
    $this->ensureBehaviors();
    $eventHandlers = [];
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (StringHelper::matchWildcard($wildcard, $name)) {
            $eventHandlers[] = $handlers;
        }
    }
    if (!empty($this->_events[$name])) {
        $eventHandlers[] = $this->_events[$name];
    }
    if (!empty($eventHandlers)) {
        $eventHandlers = call_user_func_array('array_merge', $eventHandlers);
        if ($event === null) {
            $event = new Event();
        }
        if ($event->sender === null) {
            $event->sender = $this;
        }
        $event->handled = false;
        $event->name = $name;
        foreach ($eventHandlers as $handler) {
            $event->data = $handler[1];
            call_user_func($handler[0], $event);
            // stop further handling if the event is handled
            if ($event->handled) {
                return;
            }
        }
    }
    // invoke class-level attached handlers
    Event::trigger($this, $name, $event);
}

            

Event Details

Hide inherited properties

EVENT_AFTER_SEND event of type yii\httpclient\RequestEvent

An event raised right after request has been sent.

EVENT_BEFORE_SEND event of type yii\httpclient\RequestEvent

An event raised right before sending request.