SessionHelper.php
112 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Session Management Helper Class. |
| 4 | * |
| 5 | * @package Tutor\Helper |
| 6 | * @author Themeum <support@themeum.com> |
| 7 | * @link https://themeum.com |
| 8 | * @since 2.1.9 |
| 9 | */ |
| 10 | |
| 11 | namespace Tutor\Helpers; |
| 12 | |
| 13 | /** |
| 14 | * SessionHelper class |
| 15 | * |
| 16 | * @since 2.1.9 |
| 17 | */ |
| 18 | class SessionHelper { |
| 19 | /** |
| 20 | * Start the session if no session ID exist. |
| 21 | * |
| 22 | * @since 2.1.9 |
| 23 | * |
| 24 | * @return void |
| 25 | */ |
| 26 | private function start_session() { |
| 27 | if ( ! session_id() ) { |
| 28 | session_start(); |
| 29 | } |
| 30 | } |
| 31 | |
| 32 | /** |
| 33 | * Get session data by a key. |
| 34 | * |
| 35 | * @since 2.1.9 |
| 36 | * |
| 37 | * @param string $key session key. |
| 38 | * @param mixed $default default data if key not exist in session. |
| 39 | * |
| 40 | * @return mixed |
| 41 | */ |
| 42 | public static function get( $key, $default = null ) { |
| 43 | ( new self() )->start_session(); |
| 44 | |
| 45 | if ( isset( $_SESSION[ $key ] ) ) { |
| 46 | return maybe_unserialize( $_SESSION[ $key ] ); |
| 47 | } else { |
| 48 | return $default; |
| 49 | } |
| 50 | } |
| 51 | |
| 52 | /** |
| 53 | * Set data in specific session key. |
| 54 | * |
| 55 | * @since 2.1.9 |
| 56 | * |
| 57 | * @param string $key session key. |
| 58 | * @param mixed $value value. |
| 59 | * |
| 60 | * @return void |
| 61 | */ |
| 62 | public static function set( $key, $value ) { |
| 63 | ( new self() )->start_session(); |
| 64 | |
| 65 | $_SESSION[ $key ] = maybe_serialize( $value ); |
| 66 | } |
| 67 | |
| 68 | /** |
| 69 | * Unset a specific session key. |
| 70 | * |
| 71 | * @since 2.1.9 |
| 72 | * |
| 73 | * @param string $key session key. |
| 74 | * |
| 75 | * @return bool |
| 76 | */ |
| 77 | public static function unset( $key ) { |
| 78 | ( new self() )->start_session(); |
| 79 | |
| 80 | if ( isset( $_SESSION[ $key ] ) ) { |
| 81 | unset( $_SESSION[ $key ] ); |
| 82 | return true; |
| 83 | } else { |
| 84 | return false; |
| 85 | } |
| 86 | } |
| 87 | |
| 88 | /** |
| 89 | * Reset all session keys without reset the session ID. |
| 90 | * |
| 91 | * @since 2.1.9 |
| 92 | * |
| 93 | * @return void |
| 94 | */ |
| 95 | public static function reset() { |
| 96 | ( new self() )->start_session(); |
| 97 | session_unset(); |
| 98 | } |
| 99 | |
| 100 | /** |
| 101 | * Destroy session data. |
| 102 | * |
| 103 | * @since 2.1.9 |
| 104 | * |
| 105 | * @return void |
| 106 | */ |
| 107 | public static function destroy() { |
| 108 | ( new self() )->start_session(); |
| 109 | session_destroy(); |
| 110 | } |
| 111 | } |
| 112 |