From ab9afd74dfec05daa1db8dfed926f32034f7d5e4 Mon Sep 17 00:00:00 2001
From: Carsten Brandt <mail@cebe.cc>
Date: Thu, 23 Oct 2014 00:25:41 +0200
Subject: [PATCH] phpdoc improvements
---
framework/web/Session.php | 14 +++++++++++++-
1 file changed, 13 insertions(+), 1 deletion(-)
diff --git a/framework/web/Session.php b/framework/web/Session.php
index 7a77eab..424e232 100644
--- a/framework/web/Session.php
+++ b/framework/web/Session.php
@@ -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
*/
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
*/
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
*/
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.
* 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'.
*/
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.
* @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.
- * @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()
{
--
libgit2 0.27.1