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

Adding doc strings

Browse source 
git-svn-id: https://svn.cakephp.org/repo/branches/1.2.x.x@3877 3807eeeb-6ff5-0310-8944-8be069107fe0
This commit is contained in:
dho 2006-11-19 15:03:46 +00:00
parent 8b88865c29
commit 38a606d2a2
1 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
cake/libs/controller/components/session.php
View file

@ -61,7 +61,7 @@ class SessionComponent extends Object{
$this->plugin = $controller->plugin; $this->plugin = $controller->plugin;
} }
/** /**
* Enter description here... * Writes a variable to the session.
* *
* Use like this. $this->Session->write('Controller.sessKey', 'session value'); * Use like this. $this->Session->write('Controller.sessKey', 'session value');
* *
@ -79,7 +79,7 @@ class SessionComponent extends Object{
return $this->CakeSession->writeSessionVar($name, $value); return $this->CakeSession->writeSessionVar($name, $value);
} }
/** /**
* Enter description here... * Reads a variable from the session.
* *
* Use like this. $this->Session->read('Controller.sessKey'); * Use like this. $this->Session->read('Controller.sessKey');
* Calling the method without a param will return all session vars * Calling the method without a param will return all session vars
@ -91,7 +91,7 @@ class SessionComponent extends Object{
return $this->CakeSession->readSessionVar($name); return $this->CakeSession->readSessionVar($name);
} }
/** /**
* Enter description here... * Removes a variable from the session.
* *
* Use like this. $this->Session->del('Controller.sessKey'); * Use like this. $this->Session->del('Controller.sessKey');
* *
@ -102,7 +102,8 @@ class SessionComponent extends Object{
return $this->CakeSession->delSessionVar($name); return $this->CakeSession->delSessionVar($name);
} }
/** /**
* Enter description here... * Identical to del().
*
* @param unknown_type $name * @param unknown_type $name
* @return unknown * @return unknown
*/ */
@ -110,7 +111,7 @@ class SessionComponent extends Object{
return $this->del($name); return $this->del($name);
} }
/** /**
* Enter description here... * Checks whether the variable is set in the session.
* *
* Use like this. $this->Session->check('Controller.sessKey'); * Use like this. $this->Session->check('Controller.sessKey');
* *
@ -179,7 +180,7 @@ class SessionComponent extends Object{
} }
} }
/** /**
* Enter description here... * Renews session.
* *
* Use like this. $this->Session->renew(); * Use like this. $this->Session->renew();
* This will renew sessions * This will renew sessions
@ -190,7 +191,7 @@ class SessionComponent extends Object{
$this->CakeSession->renew(); $this->CakeSession->renew();
} }
/** /**
* Enter description here... * Checks whether the session is valid.
* *
* Use like this. $this->Session->valid(); * Use like this. $this->Session->valid();
* This will return true if session is valid * This will return true if session is valid
@ -202,7 +203,7 @@ class SessionComponent extends Object{
return $this->CakeSession->isValid(); return $this->CakeSession->isValid();
} }
/** /**
* Enter description here... * Destroys session.
* *
* Use like this. $this->Session->destroy(); * Use like this. $this->Session->destroy();
* Used to destroy Sessions * Used to destroy Sessions