elFinderSessionInterface.php
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * elFinder - file manager for web. |
| 5 | * Session Wrapper Interface. |
| 6 | * |
| 7 | * @package elfinder |
| 8 | * @author Naoki Sawada |
| 9 | **/ |
| 10 | |
| 11 | interface elFinderSessionInterface |
| 12 | { |
| 13 | /** |
| 14 | * Session start |
| 15 | * |
| 16 | * @return self |
| 17 | **/ |
| 18 | public function start(); |
| 19 | |
| 20 | /** |
| 21 | * Session write & close |
| 22 | * |
| 23 | * @return self |
| 24 | **/ |
| 25 | public function close(); |
| 26 | |
| 27 | /** |
| 28 | * Get session data |
| 29 | * This method must be equipped with an automatic start / close. |
| 30 | * |
| 31 | * @param string $key Target key |
| 32 | * @param mixed $empty Return value of if session target key does not exist |
| 33 | * and explicit $empty can be used as a type hint |
| 34 | * |
| 35 | * @return mixed |
| 36 | **/ |
| 37 | public function get($key, $empty = null); |
| 38 | |
| 39 | /** |
| 40 | * Set session data |
| 41 | * This method must be equipped with an automatic start / close. |
| 42 | * |
| 43 | * @param string $key Target key |
| 44 | * @param mixed $data Value |
| 45 | * |
| 46 | * @return self |
| 47 | **/ |
| 48 | public function set($key, $data); |
| 49 | |
| 50 | /** |
| 51 | * Get session data |
| 52 | * |
| 53 | * @param string $key Target key |
| 54 | * |
| 55 | * @return self |
| 56 | **/ |
| 57 | public function remove($key); |
| 58 | } |
| 59 |