summaryrefslogtreecommitdiff
path: root/lib/prado/framework/Web/UI/TPageStatePersister.php
diff options
context:
space:
mode:
Diffstat (limited to 'lib/prado/framework/Web/UI/TPageStatePersister.php')
-rw-r--r--lib/prado/framework/Web/UI/TPageStatePersister.php69
1 files changed, 69 insertions, 0 deletions
diff --git a/lib/prado/framework/Web/UI/TPageStatePersister.php b/lib/prado/framework/Web/UI/TPageStatePersister.php
new file mode 100644
index 0000000..161316b
--- /dev/null
+++ b/lib/prado/framework/Web/UI/TPageStatePersister.php
@@ -0,0 +1,69 @@
+<?php
+/**
+ * TPageStatePersister class file
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @link https://github.com/pradosoft/prado
+ * @copyright Copyright &copy; 2005-2015 The PRADO Group
+ * @license https://github.com/pradosoft/prado/blob/master/COPYRIGHT
+ * @package System.Web.UI
+ */
+
+/**
+ * TPageStatePersister class
+ *
+ * TPageStatePersister implements a page state persistent method based on
+ * form hidden fields.
+ *
+ * Since page state can be very big for complex pages, consider using
+ * alternative persisters, such as {@link TSessionPageStatePersister},
+ * which store page state on the server side and thus reduce the network
+ * traffic for transmitting bulky page state.
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @package System.Web.UI
+ * @since 3.0
+ */
+class TPageStatePersister extends TComponent implements IPageStatePersister
+{
+ private $_page;
+
+ /**
+ * @return TPage the page that this persister works for
+ */
+ public function getPage()
+ {
+ return $this->_page;
+ }
+
+ /**
+ * @param TPage the page that this persister works for
+ */
+ public function setPage(TPage $page)
+ {
+ $this->_page=$page;
+ }
+
+ /**
+ * Saves state in hidden fields.
+ * @param mixed state to be stored
+ */
+ public function save($state)
+ {
+ $this->_page->setClientState(TPageStateFormatter::serialize($this->_page,$state));
+ }
+
+ /**
+ * Loads page state from hidden fields.
+ * @return mixed the restored state
+ * @throws THttpException if page state is corrupted
+ */
+ public function load()
+ {
+ if(($data=TPageStateFormatter::unserialize($this->_page,$this->_page->getRequestClientState()))!==null)
+ return $data;
+ else
+ throw new THttpException(400,'pagestatepersister_pagestate_corrupted');
+ }
+}
+