Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://www.yiiframework.com/doc/api/2.0/yii-web-headercollection below:

HeaderCollection, yii\web\HeaderCollection | API Documentation for Yii 2.0

HeaderCollection is used by yii\web\Response to maintain the currently registered HTTP headers.

Hide inherited methods

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

Calls the named method which is not a class method.

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.

Source code

                public function __call($name, $params)
{
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

            

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.

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

Source code

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

            

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

Returns the value of an object property.

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

See also __set().

Source code

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter();
    } elseif (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);
}

            

The property name or the event name

Whether the named property is set (not null).

Source code

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    return false;
}

            

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

Sets value of an object property.

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

See also __get().

Source code

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter($value);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    } else {
        throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
    }
}

            

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

Sets an object property to null.

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

Note that if the property is not defined, this method will do nothing. If the property is read-only, it will throw an exception.

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

Source code

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
    }
}

            

Adds a new header.

If there is already a header with the same name, the new one will be appended to it instead of replacing it.

The name of the header

The value of the header

The collection object itself

Source code

                public function add($name, $value)
{
    $normalizedName = strtolower($name);
    $this->_headers[$normalizedName][] = $value;
    if (!\array_key_exists($normalizedName, $this->_originalHeaderNames)) {
        $this->_originalHeaderNames[$normalizedName] = $name;
    }
    return $this;
}

            

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

Returns a value indicating whether a property can be read.

A property is readable 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);

See also canSetProperty().

Source code

                public function canGetProperty($name, $checkVars = true)
{
    return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}

            

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

Returns a value indicating whether a property can be set.

A property is writable 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);

See also canGetProperty().

The property name

Whether to treat member variables as properties

Whether the property can be written

Source code

                public function canSetProperty($name, $checkVars = true)
{
    return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}

            

Deprecated since 2.0.14. On PHP >=5.5, use ::class instead.

Source code

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

            

Returns the number of headers in the collection.

This method is required by the SPL Countable interface. It will be implicitly called when you use count($collection).

Source code

                
public function count()
{
    return $this->getCount();
}

            

Populates the header collection from an array.

Source code

                public function fromArray(array $array)
{
    foreach ($array as $name => $value) {
        $this->set($name, $value);
    }
}

            

Returns the named header(s).

The name of the header to return

The value to return in case the named header does not exist

Whether to only return the first header of the specified name. If false, all headers of the specified name will be returned.

The named header(s). If $first is true, a string will be returned; If $first is false, an array will be returned.

Source code

                public function get($name, $default = null, $first = true)
{
    $normalizedName = strtolower($name);
    if (isset($this->_headers[$normalizedName])) {
        return $first ? reset($this->_headers[$normalizedName]) : $this->_headers[$normalizedName];
    }
    return $default;
}

            

Returns the number of headers in the collection.

Source code

                
public function getCount()
{
    return count($this->_headers);
}

            

Returns an iterator for traversing the headers in the collection.

This method is required by the SPL interface IteratorAggregate. It will be implicitly called when you use foreach to traverse the collection.

Source code

                
public function getIterator()
{
    return new \ArrayIterator($this->_headers);
}

            

Returns a value indicating whether the named header exists.

Source code

                public function has($name)
{
    return isset($this->_headers[strtolower($name)]);
}

            

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

Returns a value indicating whether a method is defined.

The default implementation is a call to php function method_exists(). You may override this method when you implemented the php magic method __call().

Source code

                public function hasMethod($name)
{
    return method_exists($this, $name);
}

            

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

Returns a value indicating whether a property is defined.

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);

See also:

• canGetProperty()
• canSetProperty()

The property name

Whether to treat member variables as properties

Whether the property is defined

Source code

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

            

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.

Source code

                public function init()
{
}

            

Returns whether there is a header with the specified name.

This method is required by the SPL interface ArrayAccess. It is implicitly called when you use something like isset($collection[$name]).

Source code

                
public function offsetExists($name)
{
    return $this->has($name);
}

            

Returns the header with the specified name.

This method is required by the SPL interface ArrayAccess. It is implicitly called when you use something like $header = $collection[$name];. This is equivalent to get().

Source code

                
public function offsetGet($name)
{
    return $this->get($name);
}

            

Adds the header to the collection.

This method is required by the SPL interface ArrayAccess. It is implicitly called when you use something like $collection[$name] = $header;. This is equivalent to add().

The header name

The header value to be added

Source code

                
public function offsetSet($name, $value)
{
    $this->set($name, $value);
}

            

Removes the named header.

This method is required by the SPL interface ArrayAccess. It is implicitly called when you use something like unset($collection[$name]). This is equivalent to remove().

Source code

                
public function offsetUnset($name)
{
    $this->remove($name);
}

            

Removes a header.

The name of the header to be removed.

The value of the removed header. Null is returned if the header does not exist.

Source code

                public function remove($name)
{
    $normalizedName = strtolower($name);
    if (isset($this->_headers[$normalizedName])) {
        $value = $this->_headers[$normalizedName];
        unset($this->_headers[$normalizedName], $this->_originalHeaderNames[$normalizedName]);
        return $value;
    }
    return null;
}

            

Removes all headers.

Source code

                public function removeAll()
{
    $this->_headers = [];
    $this->_originalHeaderNames = [];
}

            

Adds a new header.

If there is already a header with the same name, it will be replaced.

The name of the header

The value of the header

The collection object itself

Source code

                public function set($name, $value = '')
{
    $normalizedName = strtolower($name);
    $this->_headers[$normalizedName] = (array) $value;
    $this->_originalHeaderNames[$normalizedName] = $name;
    return $this;
}

            

Sets a new header only if it does not exist yet.

If there is already a header with the same name, the new one will be ignored.

Source code

                public function setDefault($name, $value)
{
    $normalizedName = strtolower($name);
    if (empty($this->_headers[$normalizedName])) {
        $this->_headers[$normalizedName][] = $value;
        $this->_originalHeaderNames[$normalizedName] = $name;
    }
    return $this;
}

            

Returns the collection as a PHP array.

The array representation of the collection. The array keys are header names, and the array values are the corresponding header values.

Source code

                public function toArray()
{
    return $this->_headers;
}

            

Returns the collection as a PHP array but instead of using normalized header names as keys (like toArray()) it uses original header names (case-sensitive).

Source code

                public function toOriginalArray()
{
    return \array_map(function ($normalizedName) {
        return $this->_headers[$normalizedName];
    }, \array_flip($this->_originalHeaderNames));
}

            

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4