| @@ -8,129 +8,142 @@ | ||
| 8 | 8 | */ |
| 9 | 9 | |
| 10 | 10 | namespace MainWP\Dashboard; |
| 11 | 11 | |
| 12 | +// Exit if accessed directly. | |
| 13 | +if ( ! defined( 'ABSPATH' ) ) { | |
| 14 | + exit; | |
| 15 | +} | |
| 16 | + | |
| 12 | 17 | /** |
| 13 | 18 | * Class MainWP_Cache |
| 14 | 19 | * |
| 15 | 20 | * @package MainWP\Dashboard |
| 16 | 21 | */ |
| 17 | -class MainWP_Cache { | |
| 22 | +class MainWP_Cache { // phpcs:ignore Generic.Classes.OpeningBraceSameLine.ContentAfterBrace -- NOSONAR. | |
| 18 | 23 | |
| 19 | - /** | |
| 20 | - * Method init_session() | |
| 21 | - * | |
| 22 | - * Start session. | |
| 23 | - */ | |
| 24 | - public static function init_session() { | |
| 25 | - if ( PHP_SESSION_NONE === session_status() ) { | |
| 26 | - session_start(); | |
| 27 | - } | |
| 28 | - } | |
| 24 | + /** | |
| 25 | + * Method init_session() | |
| 26 | + * | |
| 27 | + * Start session. | |
| 28 | + */ | |
| 29 | + public static function init_session() { | |
| 30 | + if ( PHP_SESSION_NONE === session_status() ) { | |
| 31 | + session_start(); | |
| 32 | + } | |
| 33 | + } | |
| 29 | 34 | |
| 30 | - /** | |
| 31 | - * Method init_cache() | |
| 32 | - * | |
| 33 | - * Set session variables. | |
| 34 | - * | |
| 35 | - * @param mixed $page Page information. | |
| 36 | - */ | |
| 37 | - public static function init_cache( $page ) { | |
| 38 | - $_SESSION[ 'MainWP' . $page . 'Search' ] = ''; | |
| 39 | - $_SESSION[ 'MainWP' . $page . 'SearchContext' ] = ''; | |
| 40 | - $_SESSION[ 'MainWP' . $page . 'SearchResult' ] = ''; | |
| 41 | - } | |
| 35 | + /** | |
| 36 | + * Method init_session() | |
| 37 | + * | |
| 38 | + * Start session. | |
| 39 | + */ | |
| 40 | + public static function is_session_disable() { | |
| 41 | + return ! function_exists( 'session_start' ) || ! function_exists( 'session_status' ) || PHP_SESSION_DISABLED === session_status(); | |
| 42 | + } | |
| 42 | 43 | |
| 43 | - /** | |
| 44 | - * Method add_context() | |
| 45 | - * | |
| 46 | - * Set time & search context. | |
| 47 | - * | |
| 48 | - * @param mixed $page Page information. | |
| 49 | - * @param array $context Search context. | |
| 50 | - */ | |
| 51 | - public static function add_context( $page, $context ) { | |
| 52 | - if ( ! is_array( $context ) ) { | |
| 53 | - $context = array(); | |
| 54 | - } | |
| 44 | + /** | |
| 45 | + * Method init_cache() | |
| 46 | + * | |
| 47 | + * Set session variables. | |
| 48 | + * | |
| 49 | + * @param mixed $page Page information. | |
| 50 | + */ | |
| 51 | + public static function init_cache( $page ) { | |
| 52 | + $_SESSION[ 'MainWP' . $page . 'Search' ] = ''; | |
| 53 | + $_SESSION[ 'MainWP' . $page . 'SearchContext' ] = ''; | |
| 54 | + $_SESSION[ 'MainWP' . $page . 'SearchResult' ] = ''; | |
| 55 | + } | |
| 55 | 56 | |
| 56 | - $context['time'] = time(); | |
| 57 | - $_SESSION[ 'MainWP' . $page . 'SearchContext' ] = $context; | |
| 58 | - } | |
| 57 | + /** | |
| 58 | + * Method add_context() | |
| 59 | + * | |
| 60 | + * Set time & search context. | |
| 61 | + * | |
| 62 | + * @param mixed $page Page information. | |
| 63 | + * @param array $context Search context. | |
| 64 | + */ | |
| 65 | + public static function add_context( $page, $context ) { | |
| 66 | + if ( ! is_array( $context ) ) { | |
| 67 | + $context = array(); | |
| 68 | + } | |
| 59 | 69 | |
| 60 | - /** | |
| 61 | - * Method add_body() | |
| 62 | - * | |
| 63 | - * Set search body session variable. | |
| 64 | - * | |
| 65 | - * @param string $page Page information.. | |
| 66 | - * @param mixed $body Search body. | |
| 67 | - */ | |
| 68 | - public static function add_body( $page, $body ) { | |
| 69 | - $_SESSION[ 'MainWP' . $page . 'Search' ] .= $body; | |
| 70 | - } | |
| 70 | + $context['time'] = time(); | |
| 71 | + $_SESSION[ 'MainWP' . $page . 'SearchContext' ] = $context; | |
| 72 | + } | |
| 71 | 73 | |
| 72 | - /** | |
| 73 | - * Method get_cached_context() | |
| 74 | - * | |
| 75 | - * Grab any cached searches. | |
| 76 | - * | |
| 77 | - * @param mixed $page Page information. | |
| 78 | - * | |
| 79 | - * @return array $cachedSearch Cached search array. | |
| 80 | - */ | |
| 81 | - public static function get_cached_context( $page ) { | |
| 82 | - $cachedSearch = ( isset( $_SESSION[ 'MainWP' . $page . 'SearchContext' ] ) && is_array( $_SESSION[ 'MainWP' . $page . 'SearchContext' ] ) ? $_SESSION[ 'MainWP' . $page . 'SearchContext' ] : null ); //phpcs:ignore -- ok. | |
| 74 | + /** | |
| 75 | + * Method add_body() | |
| 76 | + * | |
| 77 | + * Set search body session variable. | |
| 78 | + * | |
| 79 | + * @param string $page Page information.. | |
| 80 | + * @param mixed $body Search body. | |
| 81 | + */ | |
| 82 | + public static function add_body( $page, $body ) { | |
| 83 | + $_SESSION[ 'MainWP' . $page . 'Search' ] .= $body; | |
| 84 | + } | |
| 83 | 85 | |
| 84 | - if ( null !== $cachedSearch ) { | |
| 85 | - if ( ( time() - ( 2 * 60 * 60 ) ) > $cachedSearch['time'] ) { | |
| 86 | - unset( $_SESSION[ 'MainWP' . $page . 'SearchContext' ] ); | |
| 87 | - unset( $_SESSION[ 'MainWP' . $page . 'Search' ] ); | |
| 88 | - unset( $_SESSION[ 'MainWP' . $page . 'SearchResult' ] ); | |
| 89 | - $cachedSearch = null; | |
| 90 | - } | |
| 91 | - } | |
| 92 | - if ( null !== $cachedSearch && isset( $cachedSearch['status'] ) ) { | |
| 93 | - $cachedSearch['status'] = explode( ',', $cachedSearch['status'] ); | |
| 94 | - } | |
| 86 | + /** | |
| 87 | + * Method get_cached_context() | |
| 88 | + * | |
| 89 | + * Grab any cached searches. | |
| 90 | + * | |
| 91 | + * @param mixed $page Page information. | |
| 92 | + * | |
| 93 | + * @return array $cachedSearch Cached search array. | |
| 94 | + */ | |
| 95 | + public static function get_cached_context( $page ) { | |
| 96 | + $cachedSearch = ( isset( $_SESSION[ 'MainWP' . $page . 'SearchContext' ] ) && is_array( $_SESSION[ 'MainWP' . $page . 'SearchContext' ] ) ? $_SESSION[ 'MainWP' . $page . 'SearchContext' ] : null ); //phpcs:ignore -- ok. | |
| 95 | 97 | |
| 96 | - return $cachedSearch; | |
| 97 | - } | |
| 98 | + if ( null !== $cachedSearch && ( ( time() - ( 2 * 60 * 60 ) ) > $cachedSearch['time'] ) ) { | |
| 99 | + unset( $_SESSION[ 'MainWP' . $page . 'SearchContext' ] ); | |
| 100 | + unset( $_SESSION[ 'MainWP' . $page . 'Search' ] ); | |
| 101 | + unset( $_SESSION[ 'MainWP' . $page . 'SearchResult' ] ); | |
| 102 | + $cachedSearch = null; | |
| 103 | + } | |
| 98 | 104 | |
| 99 | - /** | |
| 100 | - * Method echo_body() | |
| 101 | - * | |
| 102 | - * Grab & echo cached search body. | |
| 103 | - * | |
| 104 | - * @param mixed $page Page information. | |
| 105 | - */ | |
| 106 | - public static function echo_body( $page ) { | |
| 107 | - if ( isset( $_SESSION[ 'MainWP' . $page . 'Search' ] ) ) { | |
| 108 | - echo $_SESSION[ 'MainWP' . $page . 'Search' ]; // phpcs:ignore WordPress.Security.EscapeOutput,WordPress.Security.ValidatedSanitizedInput.InputNotSanitized | |
| 109 | - } | |
| 110 | - } | |
| 105 | + if ( null !== $cachedSearch && isset( $cachedSearch['status'] ) ) { | |
| 106 | + $cachedSearch['status'] = explode( ',', $cachedSearch['status'] ); | |
| 107 | + } | |
| 111 | 108 | |
| 112 | - /** | |
| 113 | - * Method add_result() | |
| 114 | - * | |
| 115 | - * Grab search results & store them in session. | |
| 116 | - * | |
| 117 | - * @param mixed $page Page information. | |
| 118 | - * @param mixed $result Search results. | |
| 119 | - */ | |
| 120 | - public static function add_result( $page, $result ) { | |
| 121 | - $_SESSION[ 'MainWP' . $page . 'SearchResult' ] = $result; | |
| 122 | - } | |
| 109 | + return $cachedSearch; | |
| 110 | + } | |
| 123 | 111 | |
| 124 | - /** | |
| 125 | - * Method get_cached_result() | |
| 126 | - * | |
| 127 | - * Grab cached search results. | |
| 128 | - * | |
| 129 | - * @param mixed $page Page information. | |
| 130 | - */ | |
| 131 | - public static function get_cached_result( $page ) { | |
| 132 | - if ( isset( $_SESSION[ 'MainWP' . $page . 'SearchResult' ] ) ) { | |
| 133 | - return $_SESSION[ 'MainWP' . $page . 'SearchResult' ]; // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized,WordPress.Security.NonceVerification.Recommended | |
| 134 | - } | |
| 135 | - } | |
| 112 | + /** | |
| 113 | + * Method echo_body() | |
| 114 | + * | |
| 115 | + * Grab & echo cached search body. | |
| 116 | + * | |
| 117 | + * @param mixed $page Page information. | |
| 118 | + */ | |
| 119 | + public static function echo_body( $page ) { | |
| 120 | + if ( isset( $_SESSION[ 'MainWP' . $page . 'Search' ] ) ) { | |
| 121 | + echo $_SESSION[ 'MainWP' . $page . 'Search' ]; // phpcs:ignore WordPress.Security.EscapeOutput,WordPress.Security.ValidatedSanitizedInput.InputNotSanitized | |
| 122 | + } | |
| 123 | + } | |
| 124 | + | |
| 125 | + /** | |
| 126 | + * Method add_result() | |
| 127 | + * | |
| 128 | + * Grab search results & store them in session. | |
| 129 | + * | |
| 130 | + * @param mixed $page Page information. | |
| 131 | + * @param mixed $result Search results. | |
| 132 | + */ | |
| 133 | + public static function add_result( $page, $result ) { | |
| 134 | + $_SESSION[ 'MainWP' . $page . 'SearchResult' ] = $result; | |
| 135 | + } | |
| 136 | + | |
| 137 | + /** | |
| 138 | + * Method get_cached_result() | |
| 139 | + * | |
| 140 | + * Grab cached search results. | |
| 141 | + * | |
| 142 | + * @param mixed $page Page information. | |
| 143 | + */ | |
| 144 | + public static function get_cached_result( $page ) { | |
| 145 | + if ( isset( $_SESSION[ 'MainWP' . $page . 'SearchResult' ] ) ) { | |
| 146 | + return $_SESSION[ 'MainWP' . $page . 'SearchResult' ]; // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized,WordPress.Security.NonceVerification.Recommended | |
| 147 | + } | |
| 148 | + } | |
| 136 | 149 | } |