Gecko [ ifk.uw.edu.pl ]

Name	Size	Permission
ActiveControls	[ DIR ]	drwxr-xr-x
JuiControls	[ DIR ]	drwxr-xr-x
WebControls	[ DIR ]	drwxr-xr-x
IBindable.php	527 B	-rw-r--r--
IBroadcastEventReceiver.php	941 B	-rw-r--r--
IButtonControl.php	2.5 KB	-rw-r--r--
INamingContainer.php	467 B	-rw-r--r--
IPageStatePersister.php	888 B	-rw-r--r--
IPostBackDataHandler.php	1.28 KB	-rw-r--r--
IPostBackEventHandler.php	830 B	-rw-r--r--
IRenderable.php	618 B	-rw-r--r--
ISurroundable.php	887 B	-rw-r--r--
ITemplate.php	761 B	-rw-r--r--
ITheme.php	621 B	-rw-r--r--
IValidatable.php	830 B	-rw-r--r--
IValidator.php	1.13 KB	-rw-r--r--
TBroadcastEventParameter.php	1.49 KB	-rw-r--r--
TCachePageStatePersister.php	6.17 KB	-rw-r--r--
TClientScriptManager.php	27.57 KB	-rw-r--r--
TClientSideOptions.php	2.24 KB	-rw-r--r--
TCommandEventParameter.php	1.26 KB	-rw-r--r--
TCompositeControl.php	950 B	-rw-r--r--
TCompositeLiteral.php	2.87 KB	-rw-r--r--
TControl.php	55.29 KB	-rw-r--r--
TControlAdapter.php	3.67 KB	-rw-r--r--
TControlCollection.php	2.47 KB	-rw-r--r--
TEmptyControlCollection.php	1.24 KB	-rw-r--r--
TEventContent.php	1.38 KB	-rw-r--r--
TForm.php	4.45 KB	-rw-r--r--
THtmlWriter.php	5.32 KB	-rw-r--r--
TPage.php	35.57 KB	-rw-r--r--
TPageStateFormatter.php	2.69 KB	-rw-r--r--
TPageStatePersister.php	1.66 KB	-rw-r--r--
TSessionPageStatePersister.php	3.93 KB	-rw-r--r--
TSkinTemplate.php	1.38 KB	-rw-r--r--
TTemplate.php	35.29 KB	-rw-r--r--
TTemplateControl.php	9.48 KB	-rw-r--r--
TTemplateControlInheritable.ph...	3.38 KB	-rw-r--r--
TTemplateManager.php	4.2 KB	-rw-r--r--
TTheme.php	10.8 KB	-rw-r--r--
TThemeManager.php	5.6 KB	-rw-r--r--

Code Editor : TCachePageStatePersister.php

<?php
/**
 * TCachePageStatePersister class file
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @link https://github.com/pradosoft/prado
 * @license https://github.com/pradosoft/prado/blob/master/LICENSE
 */

namespace Prado\Web\UI;

use Prado\Caching\ICache;
use Prado\Prado;
use Prado\Exceptions\TConfigurationException;
use Prado\Exceptions\THttpException;
use Prado\Exceptions\TInvalidDataValueException;
use Prado\TPropertyValue;

/**
 * TCachePageStatePersister class
 *
 * TCachePageStatePersister implements a page state persistent method based on cache.
 * Page state are stored in cache (e.g. memcache, DB cache, etc.), and only a small token
 * is passed to the client side to identify the state. This greatly reduces the size of
 * the page state that needs to be transmitted between the server and the client. Of course,
 * this is at the cost of using server side resource.
 *
 * A cache module has to be loaded in order to use TCachePageStatePersister.
 * By default, TCachePageStatePersister will use the primary cache module.
 * A non-primary cache module can be used by setting {@link setCacheModuleID CacheModuleID}.
 * Any cache module, as long as it implements the interface {@link ICache}, may be used.
 * For example, one can use {@link TDbCache}, {@link TMemCache}, {@link TAPCCache}, etc.
 *
 * TCachePageStatePersister uses {@link setCacheTimeout CacheTimeout} to limit the data
 * that stores in cache.
 *
 * Since server resource is often limited, be cautious if you plan to use TCachePageStatePersister
 * for high-traffic Web pages. You may consider using a small {@link setCacheTimeout CacheTimeout}.
 *
 * There are a couple of ways to use TCachePageStatePersister.
 * One can override the page's {@link TPage::getStatePersister()} method and
 * create a TCachePageStatePersister instance there.
 * Or one can configure the pages to use TCachePageStatePersister in page configurations
 * as follows,
 * <code>
 *   <pages StatePersisterClass="Prado\Web\UI\TCachePageStatePersister"
 *          StatePersister.CacheModuleID="mycache"
 *          StatePersister.CacheTimeout="3600" />
 * </code>
 * Note in the above, we use StatePersister.CacheModuleID to configure the cache module ID
 * for the TCachePageStatePersister instance.
 *
 * The above configuration will affect the pages under the directory containing
 * this configuration and all its subdirectories.
 * To configure individual pages to use TCachePageStatePersister, use
 * <code>
 *   <pages>
 *     <page id="PageID" StatePersisterClass="Prado\Web\UI\TCachePageStatePersister" />
 *   </pages>
 * </code>
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 3.1.1
 */
class TCachePageStatePersister extends \Prado\TComponent implements IPageStatePersister
{
	private $_prefix = 'statepersister';
	private $_page;
	private $_cache;
	private $_cacheModuleID = '';
	private $_timeout = 1800;

/**
	 * @return TPage the page that this persister works for
	 */
	public function getPage()
	{
		return $this->_page;
	}

/**
	 * @param TPage $page the page that this persister works for.
	 */
	public function setPage(TPage $page)
	{
		$this->_page = $page;
	}

/**
	 * @return string the ID of the cache module.
	 */
	public function getCacheModuleID()
	{
		return $this->_cacheModuleID;
	}

/**
	 * @param string $value the ID of the cache module. If not set, the primary cache module will be used.
	 */
	public function setCacheModuleID($value)
	{
		$this->_cacheModuleID = $value;
	}

/**
	 * @return ICache the cache module being used for data storage
	 */
	public function getCache()
	{
		if ($this->_cache === null) {
			if ($this->_cacheModuleID !== '') {
				$cache = Prado::getApplication()->getModule($this->_cacheModuleID);
			} else {
				$cache = Prado::getApplication()->getCache();
			}
			if ($cache === null || !($cache instanceof ICache)) {
				if ($this->_cacheModuleID !== '') {
					throw new TConfigurationException('cachepagestatepersister_cachemoduleid_invalid', $this->_cacheModuleID);
				} else {
					throw new TConfigurationException('cachepagestatepersister_cache_required');
				}
			}
			$this->_cache = $cache;
		}
		return $this->_cache;
	}

/**
	 * @return int the number of seconds in which the cached state will expire. Defaults to 1800.
	 */
	public function getCacheTimeout()
	{
		return $this->_timeout;
	}

/**
	 * @param int $value the number of seconds in which the cached state will expire. 0 means never expire.
	 * @throws TInvalidDataValueException if the number is smaller than 0.
	 */
	public function setCacheTimeout($value)
	{
		if (($value = TPropertyValue::ensureInteger($value)) >= 0) {
			$this->_timeout = $value;
		} else {
			throw new TInvalidDataValueException('cachepagestatepersister_timeout_invalid');
		}
	}

/**
	 * @return string prefix of cache variable name to avoid conflict with other cache data. Defaults to 'statepersister'.
	 */
	public function getKeyPrefix()
	{
		return $this->_prefix;
	}

/**
	 * @param string $value prefix of cache variable name to avoid conflict with other cache data
	 */
	public function setKeyPrefix($value)
	{
		$this->_prefix = $value;
	}

/**
	 * @param string $timestamp micro timestamp when saving state occurs
	 * @return string a key that is unique per user request
	 */
	protected function calculateKey($timestamp)
	{
		return $this->getKeyPrefix() . ':'
			. $this->_page->getRequest()->getUserHostAddress()
			. $this->_page->getPagePath()
			. $timestamp;
	}

/**
	 * Saves state in cache.
	 * @param mixed $data state to be stored
	 */
	public function save($data)
	{
		$timestamp = (string) microtime(true);
		$key = $this->calculateKey($timestamp);
		$this->getCache()->add($key, $data, $this->_timeout);
		$this->_page->setClientState(TPageStateFormatter::serialize($this->_page, $timestamp));
	}

/**
	 * Loads page state from cache.
	 * @throws THttpException if page state is corrupted
	 * @return mixed the restored state
	 */
	public function load()
	{
		if (($timestamp = TPageStateFormatter::unserialize($this->_page, $this->_page->getRequestClientState())) !== null) {
			$key = $this->calculateKey($timestamp);
			if (($data = $this->getCache()->get($key)) !== false) {
				return $data;
			}
		}
		throw new THttpException(400, 'cachepagestatepersister_pagestate_corrupted');
	}
}

${this.title}

Code Editor : TCachePageStatePersister.php