adulau/cakephp2-php8
1
0
Fork 0
mirror of https://github.com/kamilwylegala/cakephp2-php8.git synced 2025-01-31 09:06:17 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update docs for CookieComponent::delete().

Browse source 
Refs #2182
This commit is contained in:
mark_story 2013-10-28 23:13:17 -04:00
parent 07f4779efe
commit a753718387
1 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
lib/Cake/Controller/Component/CookieComponent.php
View file

@ -307,11 +307,17 @@ class CookieComponent extends Component {
* Delete a cookie value
*
* Optional [Name.], required key
* $this->Cookie->read('Name.key);
* $this->Cookie->delete('Name.key);
*
* You must use this method before any output is sent to the browser.
* Failure to do so will result in header already sent errors.
*
* This method will delete both the top level and 2nd level cookies set.
* For example assuming that $name = App, deleting `User` will delete
* both `App[User]` and any other cookie values like `App[User][email]`
* This is done to clean up cookie storage from before 2.4.3, where cookies
* were stored inconsistently.
*
* @param string $key Key of the value to be deleted
* @return void
* @link http://book.cakephp.org/2.0/en/core-libraries/components/cookie.html#CookieComponent::delete