1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 <?php
namespace Alpha\View;
use Alpha\Exception\IllegalArguementException;
use Alpha\Util\Config\ConfigProvider;
use Alpha\Util\Service\ServiceFactory;
use ReflectionProperty;
/**
* A singleton class that maintains the view state in the session.
*
* @since 1.0
*
* @author John Collins <dev@alphaframework.org>
* @license http://www.opensource.org/licenses/bsd-license.php The BSD License
* @copyright Copyright (c) 2018, John Collins (founder of Alpha Framework).
* All rights reserved.
*
* <pre>
* Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the
* following conditions are met:
*
* * Redistributions of source code must retain the above
* copyright notice, this list of conditions and the
* following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other
* materials provided with the distribution.
* * Neither the name of the Alpha Framework nor the names
* of its contributors may be used to endorse or promote
* products derived from this software without specific
* prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* </pre>
*/
class ViewState
{
/**
* The name of the last selected tab by the user.
*
* @var string
*
* @since 1.0
*/
protected $selectedTab;
/**
* The amount of rows to expand the Markdown edit TextBox by.
*
* @var string
*
* @since 1.0
*/
protected $markdownTextBoxRows;
/**
* If the backend admin menu should be displayed or not.
*
* @var bool
*
* @since 2.0
*/
protected $renderAdminMenu = false;
/**
* The start position of the last pagination page by the user.
*
* @var int
*
* @since 2.0
*/
protected $selectedStart = 0;
/**
* The view state object singleton.
*
* @var \Alpha\View\ViewState
*
* @since 1.0
*/
protected static $instance;
/**
* Private constructor means the class cannot be instantiated from elsewhere.
*
* @since 1.0
*/
private function __construct()
{
}
/**
* Get the ViewState instance. Loads from $_SESSION if its not already in memory, otherwise
* a new instance will be returned with empty properties.
*
* @return \Alpha\View\ViewState
*
* @since 1.0
*/
public static function getInstance()
{
$config = ConfigProvider::getInstance();
$sessionProvider = $config->get('session.provider.name');
$session = ServiceFactory::getInstance($sessionProvider, 'Alpha\Util\Http\Session\SessionProviderInterface');
// if we don't already have the object in memory...
if (!isset(self::$instance)) {
// load from the session, otherwise return a new object
if ($session->get('ViewState') !== false) {
return unserialize($session->get('ViewState'));
} else {
self::$instance = new self();
return self::$instance;
}
} else {
return self::$instance;
}
}
/**
* Get the attribute value indicated by the key.
*
* @param string $key
*
* @throws \Alpha\Exception\IllegalArguementException
*
* @return string
*
* @since 1.0
*/
public function get($key)
{
$attribute = new ReflectionProperty(get_class($this), $key);
if ($attribute != null) {
return $this->$key;
} else {
throw new IllegalArguementException('The property ['.$key.'] does not exist on the ['.get_class($this).'] class');
}
}
/**
* Sets the attribute value indicated by the key. The ViewState instance will be serialized and saved back to the $_SESSION.
*
* @param string $key
* @param string $value
*
* @throws \Alpha\Exception\IllegalArguementException
*
* @since 1.0
*/
public function set($key, $value)
{
$config = ConfigProvider::getInstance();
$sessionProvider = $config->get('session.provider.name');
$session = ServiceFactory::getInstance($sessionProvider, 'Alpha\Util\Http\Session\SessionProviderInterface');
$attribute = new ReflectionProperty(get_class($this), $key);
if ($attribute != null) {
$this->$key = $value;
$session->set('ViewState', serialize($this));
} else {
throw new IllegalArguementException('The property ['.$key.'] does not exist on the ['.get_class($this).'] class');
}
}
}