CookieCollection
extends BaseObject
in package
implements
IteratorAggregate, ArrayAccess, Countable
CookieCollection maintains the cookies available in the current request.
For more details and usage information on CookieCollection, see the guide article on handling cookies.
Tags
Table of Contents
Interfaces
- IteratorAggregate
- ArrayAccess
- Countable
Properties
Methods
- __call() : mixed
- Calls the named method which is not a class method.
- __construct() : mixed
- Constructor.
- __get() : mixed
- Returns the value of an object property.
- __isset() : bool
- Checks if a property is set, i.e. defined and not null.
- __set() : mixed
- Sets value of an object property.
- __unset() : mixed
- Sets an object property to null.
- add() : mixed
- Adds a cookie to the collection.
- canGetProperty() : bool
- Returns a value indicating whether a property can be read.
- canSetProperty() : bool
- Returns a value indicating whether a property can be set.
- className() : string
- Returns the fully qualified name of this class.
- count() : int
- Returns the number of cookies in the collection.
- fromArray() : mixed
- Populates the cookie collection from an array.
- get() : Cookie|null
- Returns the cookie with the specified name.
- getCount() : int
- Returns the number of cookies in the collection.
- getIterator() : ArrayIterator<string, Cookie>
- Returns an iterator for traversing the cookies in the collection.
- getValue() : mixed
- Returns the value of the named cookie.
- has() : bool
- Returns whether there is a cookie with the specified name.
- hasMethod() : bool
- Returns a value indicating whether a method is defined.
- hasProperty() : bool
- Returns a value indicating whether a property is defined.
- init() : mixed
- Initializes the object.
- offsetExists() : bool
- Returns whether there is a cookie with the specified name.
- offsetGet() : Cookie|null
- Returns the cookie with the specified name.
- offsetSet() : mixed
- Adds the cookie to the collection.
- offsetUnset() : mixed
- Removes the named cookie.
- remove() : mixed
- Removes a cookie.
- removeAll() : mixed
- Removes all cookies.
- toArray() : array<string|int, Cookie>
- Returns the collection as a PHP array.
Properties
$count read-only
public
int
$count
The number of cookies in the collection.
$readOnly
public
bool
$readOnly
= false
whether this collection is read only.
$_cookies
private
array<string|int, Cookie>
$_cookies
the cookies in this collection (indexed by the cookie names)
Methods
__call()
Calls the named method which is not a class method.
public
__call(string $name, array<string|int, mixed> $params) : mixed
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.
Parameters
- $name : string
-
the method name
- $params : array<string|int, mixed>
-
method parameters
Tags
Return values
mixed —the method return value
__construct()
Constructor.
public
__construct([array<string|int, mixed> $cookies = [] ][, array<string|int, mixed> $config = [] ]) : mixed
Parameters
- $cookies : array<string|int, mixed> = []
-
the cookies that this collection initially contains. This should be an array of name-value pairs.
- $config : array<string|int, mixed> = []
-
name-value pairs that will be used to initialize the object properties
__get()
Returns the value of an object property.
public
__get(string $name) : mixed
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing $value = $object->property;.
Parameters
- $name : string
-
the property name
Tags
Return values
mixed —the property value
__isset()
Checks if a property is set, i.e. defined and not null.
public
__isset(string $name) : bool
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing isset($object->property).
Note that if the property is not defined, false will be returned.
Parameters
- $name : string
-
the property name or the event name
Tags
Return values
bool —whether the named property is set (not null).
__set()
Sets value of an object property.
public
__set(string $name, mixed $value) : mixed
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing $object->property = $value;.
Parameters
- $name : string
-
the property name or the event name
- $value : mixed
-
the property value
Tags
__unset()
Sets an object property to null.
public
__unset(string $name) : mixed
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.
Parameters
- $name : string
-
the property name
Tags
add()
Adds a cookie to the collection.
public
add(Cookie $cookie) : mixed
If there is already a cookie with the same name in the collection, it will be removed first.
Parameters
- $cookie : Cookie
-
the cookie to be added
Tags
canGetProperty()
Returns a value indicating whether a property can be read.
public
canGetProperty(string $name[, bool $checkVars = true ]) : bool
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
$checkVarsis true);
Parameters
- $name : string
-
the property name
- $checkVars : bool = true
-
whether to treat member variables as properties
Tags
Return values
bool —whether the property can be read
canSetProperty()
Returns a value indicating whether a property can be set.
public
canSetProperty(string $name[, bool $checkVars = true ]) : bool
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
$checkVarsis true);
Parameters
- $name : string
-
the property name
- $checkVars : bool = true
-
whether to treat member variables as properties
Tags
Return values
bool —whether the property can be written
className()
Returns the fully qualified name of this class.
public
static className() : string
Tags
Return values
string —the fully qualified name of this class.
count()
Returns the number of cookies in the collection.
public
count() : int
This method is required by the SPL Countable interface.
It will be implicitly called when you use count($collection).
Attributes
Return values
int —the number of cookies in the collection.
fromArray()
Populates the cookie collection from an array.
public
fromArray(array<string|int, mixed> $array) : mixed
Parameters
- $array : array<string|int, mixed>
-
the cookies to populate from
Tags
get()
Returns the cookie with the specified name.
public
get(string $name) : Cookie|null
Parameters
- $name : string
-
the cookie name
Tags
Return values
Cookie|null —the cookie with the specified name. Null if the named cookie does not exist.
getCount()
Returns the number of cookies in the collection.
public
getCount() : int
Return values
int —the number of cookies in the collection.
getIterator()
Returns an iterator for traversing the cookies in the collection.
public
getIterator() : ArrayIterator<string, Cookie>
This method is required by the SPL interface [[\IteratorAggregate]].
It will be implicitly called when you use foreach to traverse the collection.
Attributes
Return values
ArrayIterator<string, Cookie> —an iterator for traversing the cookies in the collection.
getValue()
Returns the value of the named cookie.
public
getValue(string $name[, mixed $defaultValue = null ]) : mixed
Parameters
- $name : string
-
the cookie name
- $defaultValue : mixed = null
-
the value that should be returned when the named cookie does not exist.
Tags
Return values
mixed —the value of the named cookie.
has()
Returns whether there is a cookie with the specified name.
public
has(string $name) : bool
Note that if a cookie is marked for deletion from browser or its value is an empty string, this method will return false.
Parameters
- $name : string
-
the cookie name
Tags
Return values
bool —whether the named cookie exists
hasMethod()
Returns a value indicating whether a method is defined.
public
hasMethod(string $name) : bool
The default implementation is a call to php function method_exists().
You may override this method when you implemented the php magic method __call().
Parameters
- $name : string
-
the method name
Return values
bool —whether the method is defined
hasProperty()
Returns a value indicating whether a property is defined.
public
hasProperty(string $name[, bool $checkVars = true ]) : bool
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
$checkVarsis true);
Parameters
- $name : string
-
the property name
- $checkVars : bool = true
-
whether to treat member variables as properties
Tags
Return values
bool —whether the property is defined
init()
Initializes the object.
public
init() : mixed
This method is invoked at the end of the constructor after the object is initialized with the given configuration.
offsetExists()
Returns whether there is a cookie with the specified name.
public
offsetExists(string $name) : bool
This method is required by the SPL interface [[\ArrayAccess]].
It is implicitly called when you use something like isset($collection[$name]).
Parameters
- $name : string
-
the cookie name
Attributes
Return values
bool —whether the named cookie exists
offsetGet()
Returns the cookie with the specified name.
public
offsetGet(string $name) : Cookie|null
This method is required by the SPL interface [[\ArrayAccess]].
It is implicitly called when you use something like $cookie = $collection[$name];.
This is equivalent to [[get()]].
Parameters
- $name : string
-
the cookie name
Attributes
Return values
Cookie|null —the cookie with the specified name, null if the named cookie does not exist.
offsetSet()
Adds the cookie to the collection.
public
offsetSet(string $name, Cookie $cookie) : mixed
This method is required by the SPL interface [[\ArrayAccess]].
It is implicitly called when you use something like $collection[$name] = $cookie;.
This is equivalent to [[add()]].
Parameters
- $name : string
-
the cookie name
- $cookie : Cookie
-
the cookie to be added
Attributes
offsetUnset()
Removes the named cookie.
public
offsetUnset(string $name) : mixed
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()]].
Parameters
- $name : string
-
the cookie name
Attributes
remove()
Removes a cookie.
public
remove(Cookie|string $cookie[, bool $removeFromBrowser = true ]) : mixed
If $removeFromBrowser is true, the cookie will be removed from the browser.
In this case, a cookie with outdated expiry will be added to the collection.
Parameters
- $cookie : Cookie|string
-
the cookie object or the name of the cookie to be removed.
- $removeFromBrowser : bool = true
-
whether to remove the cookie from browser
Tags
removeAll()
Removes all cookies.
public
removeAll() : mixed
Tags
toArray()
Returns the collection as a PHP array.
public
toArray() : array<string|int, Cookie>
Return values
array<string|int, Cookie> —the array representation of the collection. The array keys are cookie names, and the array values are the corresponding cookie objects.