[ci skip] feature/session (#3073): Add missing method docblocks
diff --git a/system/libraries/Session/drivers/Session_redis_driver.php b/system/libraries/Session/drivers/Session_redis_driver.php
index cde587b..a0ec409 100644
--- a/system/libraries/Session/drivers/Session_redis_driver.php
+++ b/system/libraries/Session/drivers/Session_redis_driver.php
@@ -111,6 +111,15 @@
// ------------------------------------------------------------------------
+ /**
+ * Open
+ *
+ * Sanitizes save_path and initializes connection.
+ *
+ * @param string $save_path Server path
+ * @param string $name Session cookie name, unused
+ * @return bool
+ */
public function open($save_path, $name)
{
if (empty($this->_config['save_path']))
@@ -142,6 +151,14 @@
// ------------------------------------------------------------------------
+ /**
+ * Read
+ *
+ * Reads session data and acquires a lock
+ *
+ * @param string $session_id Session ID
+ * @return string Serialized session data
+ */
public function read($session_id)
{
if (isset($this->_redis) && $this->_get_lock($session_id))
@@ -157,6 +174,17 @@
return FALSE;
}
+ // ------------------------------------------------------------------------
+
+ /**
+ * Write
+ *
+ * Writes (create / update) session data
+ *
+ * @param string $session_id Session ID
+ * @param string $session_data Serialized session data
+ * @return bool
+ */
public function write($session_id, $session_data)
{
if ( ! isset($this->_redis))
@@ -197,6 +225,13 @@
// ------------------------------------------------------------------------
+ /**
+ * Close
+ *
+ * Releases locks and closes connection.
+ *
+ * @return void
+ */
public function close()
{
if (isset($this->_redis))
@@ -225,6 +260,14 @@
// ------------------------------------------------------------------------
+ /**
+ * Destroy
+ *
+ * Destroys the current session.
+ *
+ * @param string $session_id Session ID
+ * @return bool
+ */
public function destroy($session_id)
{
if (isset($this->_redis, $this->_lock_key))
@@ -242,6 +285,14 @@
// ------------------------------------------------------------------------
+ /**
+ * Garbage Collector
+ *
+ * Deletes expired sessions
+ *
+ * @param int $maxlifetime Maximum lifetime of sessions
+ * @return bool
+ */
public function gc($maxlifetime)
{
// Not necessary, Redis takes care of that.
@@ -250,6 +301,14 @@
// ------------------------------------------------------------------------
+ /**
+ * Get lock
+ *
+ * Acquires an (emulated) lock.
+ *
+ * @param string $session_id Session ID
+ * @return bool
+ */
protected function _get_lock($session_id)
{
if (isset($this->_lock_key))
@@ -309,6 +368,13 @@
// ------------------------------------------------------------------------
+ /**
+ * Release lock
+ *
+ * Releases a previously acquired lock
+ *
+ * @return bool
+ */
protected function _release_lock()
{
if (isset($this->_redis, $this->_lock_key) && $this->_lock)