php/yii2
1
0
Fork 0
mirror of https://github.com/yiisoft/yii2.git synced 2025-11-07 00:18:25 +08:00
Code Issues Packages Projects Releases Wiki Activity

phpdoc improvements

Browse Source
This commit is contained in:
Carsten Brandt
2014-10-23 00:25:41 +02:00
parent 49961c4896
commit ab9afd74df
1 changed files with 13 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
framework/web/Session.php
View File

@ -229,6 +229,8 @@ class Session extends Component implements \IteratorAggregate, \ArrayAccess, \Co
} }
/** /**
* Gets the session ID.
* This is a wrapper for [PHP session_id()](http://php.net/manual/en/function.session-id.php).
* @return string the current session ID * @return string the current session ID
*/ */
public function getId() public function getId()
@ -237,6 +239,8 @@ class Session extends Component implements \IteratorAggregate, \ArrayAccess, \Co
} }
/** /**
* Sets the session ID.
* This is a wrapper for [PHP session_id()](http://php.net/manual/en/function.session-id.php).
* @param string $value the session ID for the current session * @param string $value the session ID for the current session
*/ */
public function setId($value) public function setId($value)
@ -257,6 +261,8 @@ class Session extends Component implements \IteratorAggregate, \ArrayAccess, \Co
} }
/** /**
* Gets the name of the current session.
* This is a wrapper for [PHP session_name()](http://php.net/manual/en/function.session-name.php).
* @return string the current session name * @return string the current session name
*/ */
public function getName() public function getName()
@ -265,6 +271,8 @@ class Session extends Component implements \IteratorAggregate, \ArrayAccess, \Co
} }
/** /**
* Sets the name for the current session.
* This is a wrapper for [PHP session_name()](http://php.net/manual/en/function.session-name.php).
* @param string $value the session name for the current session, must be an alphanumeric string. * @param string $value the session name for the current session, must be an alphanumeric string.
* It defaults to "PHPSESSID". * It defaults to "PHPSESSID".
*/ */
@ -274,6 +282,8 @@ class Session extends Component implements \IteratorAggregate, \ArrayAccess, \Co
} }
/** /**
* Gets the current session save path.
* This is a wrapper for [PHP session_save_path()](http://php.net/manual/en/function.session-save-path.php).
* @return string the current session save path, defaults to '/tmp'. * @return string the current session save path, defaults to '/tmp'.
*/ */
public function getSavePath() public function getSavePath()
@ -282,6 +292,8 @@ class Session extends Component implements \IteratorAggregate, \ArrayAccess, \Co
} }
/** /**
* Sets the current session save path.
* This is a wrapper for [PHP session_save_path()](http://php.net/manual/en/function.session-save-path.php).
* @param string $value the current session save path. This can be either a directory name or a path alias. * @param string $value the current session save path. This can be either a directory name or a path alias.
* @throws InvalidParamException if the path is not a valid directory * @throws InvalidParamException if the path is not a valid directory
*/ */
@ -297,7 +309,7 @@ class Session extends Component implements \IteratorAggregate, \ArrayAccess, \Co
/** /**
* @return array the session cookie parameters. * @return array the session cookie parameters.
* @see http://us2.php.net/manual/en/function.session-get-cookie-params.php * @see http://php.net/manual/en/function.session-get-cookie-params.php
*/ */
public function getCookieParams() public function getCookieParams()
{ {