Skip to content

Commit a06732d

Browse files
committed
Add missing class tags and method descriptions for generated documentation
1 parent d0f8d30 commit a06732d

File tree

1 file changed

+18
-7
lines changed

1 file changed

+18
-7
lines changed

framework/web/CHttpSessionHandler.php

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,13 @@
99
*/
1010

1111
/**
12-
* SessionHandlerInterface adapter for CHttpSession.
12+
* CHttpSessionHandler is an adapter that implements SessionHandlerInterface for CHttpSession.
13+
*
1314
* Delegates all calls to CHttpSession's openSession/closeSession/etc. methods,
1415
* allowing subclasses like CDbHttpSession to work without modification.
16+
*
17+
* @package system.web
18+
* @since 1.1.32
1519
*/
1620
class CHttpSessionHandler implements SessionHandlerInterface
1721
{
@@ -21,14 +25,16 @@ class CHttpSessionHandler implements SessionHandlerInterface
2125
private $_session;
2226

2327
/**
24-
* @param CHttpSession $session
28+
* Constructor.
29+
* @param CHttpSession $session
2530
*/
2631
public function __construct(CHttpSession $session)
2732
{
2833
$this->_session=$session;
2934
}
3035

3136
/**
37+
* Initialize session.
3238
* @param string $path
3339
* @param string $name
3440
* @return bool
@@ -40,7 +46,8 @@ public function open($path, $name)
4046
}
4147

4248
/**
43-
* @return bool
49+
* Close the session.
50+
* @return bool
4451
*/
4552
#[ReturnTypeWillChange]
4653
public function close()
@@ -49,7 +56,8 @@ public function close()
4956
}
5057

5158
/**
52-
* @param string $id
59+
* Read session data.
60+
* @param string $id
5361
* @return string|false
5462
*/
5563
#[ReturnTypeWillChange]
@@ -59,7 +67,8 @@ public function read($id)
5967
}
6068

6169
/**
62-
* @param string $id
70+
* Write session data.
71+
* @param string $id
6372
* @param string $data
6473
* @return bool
6574
*/
@@ -70,7 +79,8 @@ public function write($id, $data)
7079
}
7180

7281
/**
73-
* @param string $id
82+
* Destroy a session.
83+
* @param string $id
7484
* @return bool
7585
*/
7686
#[ReturnTypeWillChange]
@@ -80,7 +90,8 @@ public function destroy($id)
8090
}
8191

8292
/**
83-
* @param int $max_lifetime
93+
* Cleanup old sessions.
94+
* @param int $max_lifetime
8495
* @return int|false
8596
*/
8697
#[ReturnTypeWillChange]

0 commit comments

Comments
 (0)