Changeset 1433 for trunk/src/main/php/net/stubbles/websites/xml/generator/stubPageXMLGenerator.php

Timestamp:

03/18/08 14:59:53 (2 years ago)

Author:

mikey

Message:

enhancement #133, part 1: XML processor should use website cache - xml generators now have methods to determine cache ability and cache keys

Files:

• trunk/src/main/php/net/stubbles/websites/xml/generator/stubPageXMLGenerator.php (modified) (5 diffs)

trunk/src/main/php/net/stubbles/websites/xml/generator/stubPageXMLGenerator.php

@@ -10 +10 @@
                       'net::stubbles::ipo::request::stubRequest',
                       'net::stubbles::ipo::request::stubRequestPrefixDecorator',
+                      'net::stubbles::ipo::response::stubResponse',
                       'net::stubbles::ipo::session::stubSession',
                       'net::stubbles::lang::exceptions::stubRuntimeException',
-                      'net::stubbles::util::stubRegistry',
                       'net::stubbles::websites::stubPage',
                       'net::stubbles::websites::xml::generator::stubXMLGenerator',
@@ -50 +50 @@
     protected $page;
     /**
+     * list of available page elements
+     *
+     * @var  array<string,stubPageElement>
+     */
+    protected $pageElements = array();
+    /**
      * injector instance to be used
      *
@@ -55 +61 @@
      */
     protected $injector;
+    /**
+     * switch whether document part is cachable or not
+     *
+     * @var  bool
+     */
+    protected $isCachable   = true;
+    /**
+     * list of cache variables for this page
+     *
+     * @var  array<string,scalar>
+     */
+    protected $cacheVars    = array();
+    /**
+     * list of used files for this page
+     *
+     * @var  array<string>
+     */
+    protected $usedFiles    = array();
 
     /**
@@ -62 +86 @@
      * @param  stubSession   $session
      * @param  stubResponse  $response
-     * @param  stubPage      $page
      * @param  stubInjector  $injector
      * @Inject
      */
-    public function __construct(stubRequest $request, stubSession $session, stubResponse $response, stubPage $page, stubInjector $injector)
+    public function __construct(stubRequest $request, stubSession $session, stubResponse $response, stubInjector $injector)
     {
-        $this->request  = $request;
+        $this->request  = new stubRequestPrefixDecorator($request, '');
         $this->session  = $session;
         $this->response = $response;
-        $this->page     = $page;
         $this->injector = $injector;
+    }
+
+    /**
+     * sets the page
+     *
+     * @param  stubPage  $page
+     * @Inject
+     */
+    public function setPage(stubPage $page)
+    {
+        $this->page = $page;
+        if (count($this->page->getResources()) > 0) {
+            $this->isCachable = false;
+        }
+        
+        foreach ($this->page->getElements() as $name => $element) {
+            $this->request->setPrefix($name);
+            $this->injector->handleInjections($element);
+            $element->init($this->request, $this->session, $this->response);
+            if ($element->isAvailable() === true) {
+                $this->pageElements[$name] = $element;
+                // we can spare this if the page is not cachable
+                if (true === $this->isCachable) {
+                    if ($element->isCachable() === false) {
+                        $this->isCachable = false;
+                    } elseif (true === $this->isCachable) {
+                        $this->cacheVars = array_merge($this->cacheVars, $element->getCacheVars());
+                        $this->usedFiles = array_merge($this->usedFiles, $element->getUsedFiles());
+                    }
+                }
+            }
+        }
+    }
+
+    /**
+     * checks whether document part is cachable or not
+     *
+     * Document part is cachable if page has no session resources and all page
+     * elements are cachable.
+     *
+     * @return  bool
+     */
+    public function isCachable()
+    {
+        return $this->isCachable;
+    }
+
+    /**
+     * returns a list of variables that have an influence on caching
+     *
+     * @return  array<string,scalar>
+     */
+    public function getCacheVars()
+    {
+        return $this->cacheVars;
+    }
+
+    /**
+     * returns a list of files used to create the content
+     *
+     * @return  array<string>
+     */
+    public function getUsedFiles()
+    {
+        return $this->usedFiles;
     }
 
@@ -83 +170 @@
     public function generate(stubXMLStreamWriter $xmlStreamWriter, stubXMLSerializer $xmlSerializer)
     {
-        $prefixRequest = new stubRequestPrefixDecorator($this->request, '');
-        $formValues    = array();
-        foreach ($this->page->getElements() as $name => $element) {
-            $prefixRequest->setPrefix($name);
-            $this->injector->handleInjections($element);
-            $element->init($prefixRequest, $this->session, $this->response);
-            if ($element->isAvailable() === true) {
-                $data = $element->process();
-                if ($prefixRequest->isCancelled() === true) {
-                    return;
-                }
-    
-                $xmlSerializer->serialize($data, $xmlStreamWriter, array(stubXMLSerializer::OPT_ROOT_TAG => $name));
-                if ($element instanceof stubXMLPageElement) {
-                    $formValues[$name] = $element->getFormValues();
-                }
+        $formValues = array();
+        foreach ($this->pageElements as $name => $element) {
+            $this->request->setPrefix($name);
+            $element->init($this->request, $this->session, $this->response);
+            $data = $element->process();
+            if ($this->request->isCancelled() === true) {
+                return;
+            }
+            
+            $xmlSerializer->serialize($data, $xmlStreamWriter, array(stubXMLSerializer::OPT_ROOT_TAG => $name));
+            if ($element instanceof stubXMLPageElement) {
+                $formValues[$name] = $element->getFormValues();
             }
         }