Merge pull request #329 from shama/patch-doc

Add @link to CookieComponent docblocks
This commit is contained in:
Renan Gonçalves aka renan.saddam 2011-11-23 00:58:21 -08:00
commit 0cd45d4711

View file

@ -198,6 +198,7 @@ class CookieComponent extends Component {
* @param boolean $encrypt Set to true to encrypt value, false otherwise * @param boolean $encrypt Set to true to encrypt value, false otherwise
* @param string $expires Can be either Unix timestamp, or date string * @param string $expires Can be either Unix timestamp, or date string
* @return void * @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) { public function write($key, $value = null, $encrypt = true, $expires = null) {
if (is_null($encrypt)) { if (is_null($encrypt)) {
@ -234,6 +235,7 @@ class CookieComponent extends Component {
* *
* @param mixed $key Key of the value to be obtained. If none specified, obtain map key => values * @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 * @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) { public function read($key = null) {
if (empty($this->_values) && isset($_COOKIE[$this->name])) { if (empty($this->_values) && isset($_COOKIE[$this->name])) {
@ -269,6 +271,7 @@ class CookieComponent extends Component {
* *
* @param string $key Key of the value to be deleted * @param string $key Key of the value to be deleted
* @return void * @return void
* @link http://book.cakephp.org/2.0/en/core-libraries/components/cookie.html#CookieComponent::delete
*/ */
public function delete($key) { public function delete($key) {
if (empty($this->_values)) { if (empty($this->_values)) {
@ -298,6 +301,7 @@ class CookieComponent extends Component {
* Failure to do so will result in header already sent errors. * Failure to do so will result in header already sent errors.
* *
* @return void * @return void
* @link http://book.cakephp.org/2.0/en/core-libraries/components/cookie.html#CookieComponent::destroy
*/ */
public function destroy() { public function destroy() {
if (isset($_COOKIE[$this->name])) { if (isset($_COOKIE[$this->name])) {
@ -407,6 +411,7 @@ class CookieComponent extends Component {
protected function _setcookie($name, $value, $expire, $path, $domain, $secure, $httpOnly = false) { protected function _setcookie($name, $value, $expire, $path, $domain, $secure, $httpOnly = false) {
setcookie($name, $value, $expire, $path, $domain, $secure, $httpOnly); setcookie($name, $value, $expire, $path, $domain, $secure, $httpOnly);
} }
/** /**
* Encrypts $value using public $type method in Security class * Encrypts $value using public $type method in Security class
* *