Skip to content

Commit

Permalink
Add @link to CookieComponent docblocks
Browse files Browse the repository at this point in the history
  • Loading branch information
shama committed Nov 23, 2011
1 parent bb51b0f commit bc0e0b5
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions lib/Cake/Controller/Component/CookieComponent.php
Expand Up @@ -198,6 +198,7 @@ public function startup($controller) {
* @param boolean $encrypt Set to true to encrypt value, false otherwise
* @param string $expires Can be either Unix timestamp, or date string
* @return void
* @link http://book.cakephp.org/2.0/en/core-libraries/components/cookie.html#CookieComponent::write
*/
public function write($key, $value = null, $encrypt = true, $expires = null) {
if (is_null($encrypt)) {
Expand Down Expand Up @@ -234,6 +235,7 @@ public function write($key, $value = null, $encrypt = true, $expires = null) {
*
* @param mixed $key Key of the value to be obtained. If none specified, obtain map key => values
* @return string or null, value for specified key
* @link http://book.cakephp.org/2.0/en/core-libraries/components/cookie.html#CookieComponent::read
*/
public function read($key = null) {
if (empty($this->_values) && isset($_COOKIE[$this->name])) {
Expand Down Expand Up @@ -269,6 +271,7 @@ public function read($key = null) {
*
* @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
*/
public function delete($key) {
if (empty($this->_values)) {
Expand Down Expand Up @@ -298,6 +301,7 @@ public function delete($key) {
* Failure to do so will result in header already sent errors.
*
* @return void
* @link http://book.cakephp.org/2.0/en/core-libraries/components/cookie.html#CookieComponent::destroy
*/
public function destroy() {
if (isset($_COOKIE[$this->name])) {
Expand Down Expand Up @@ -407,6 +411,7 @@ protected function _delete($name) {
protected function _setcookie($name, $value, $expire, $path, $domain, $secure, $httpOnly = false) {
setcookie($name, $value, $expire, $path, $domain, $secure, $httpOnly);
}

/**
* Encrypts $value using public $type method in Security class
*
Expand Down

0 comments on commit bc0e0b5

Please sign in to comment.