Changeset 1445 for trunk/src/main/php/net/stubbles/websites/processors/stubAbstractProcessorResolver.php

Timestamp:

03/20/08 17:51:12 (2 years ago)

Author:

mikey

Message:

refactoring #137, part 7: page factories are now attributes of the processors, and not of the resolvers

Files:

• trunk/src/main/php/net/stubbles/websites/processors/stubAbstractProcessorResolver.php (modified) (6 diffs)

trunk/src/main/php/net/stubbles/websites/processors/stubAbstractProcessorResolver.php

@@ -7 +7 @@
  * @subpackage  websites_processors
  */
-stubClassLoader::load('net::stubbles::websites::processors::stubPageBasedProcessor',
+stubClassLoader::load('net::stubbles::lang::exceptions::stubConfigurationException',
+                      'net::stubbles::lang::exceptions::stubRuntimeException',
+                      'net::stubbles::websites::stubPageFactory',
+                      'net::stubbles::websites::processors::stubPageBasedProcessor',
                       'net::stubbles::websites::processors::stubProcessorResolver'
 );
@@ -19 +22 @@
 {
     /**
-     * the page factory to use to read the page configuration
-     *
-     * @var  stubPageFactory
-     */
-    protected $pageFactory = null;
-
-    /**
-     * sets the page factory to use to read the page configuration
-     *
-     * @param  stubPageFactory  $pageFactory
-     */
-    public function setPageFactory(stubPageFactory $pageFactory)
-    {
-        $this->pageFactory = $pageFactory;
-    }
-
-    /**
-     * returns the page factory delivered within the constructor
-     *
-     * @return  stubPageFactory
-     */
-    public function getPageFactory()
-    {
-        return $this->pageFactory;
-    }
-
-    /**
      * resolves the request and creates the appropriate processor
      *
@@ -52 +28 @@
      * @param   stubResponse   $response  the current response
      * @return  stubProcessor
-     * @throws  stubProcessorException
+     * @throws  stubConfigurationException
+     * @throws  stubRuntimeException
      */
     public function resolve(stubRequest $request, stubSession $session, stubResponse $response)
@@ -58 +35 @@
         $processorClassName = $this->doResolve($request, $session, $response);
         if (null == $processorClassName) {
-            throw new stubProcessorException('Configuration error: no processor specified.');
+            throw new stubConfigurationException('Configuration error: no processor specified.');
         }
         
@@ -64 +41 @@
         $className = stubClassLoader::getNonQualifiedClassName($processorClassName);
         $processor = new $className($request, $session, $response);
-        if (($processor instanceof stubProcessor) == false) {
-            throw new stubProcessorException($processorClassName . ' is not an instance of ' . stubClassLoader::getFullQualifiedClassName('stubProcessor'));
+        if (($processor instanceof stubProcessor) === false) {
+            throw new stubRuntimeException($processorClassName . ' is not an instance of ' . stubClassLoader::getFullQualifiedClassName('stubProcessor'));
         }
         
-        $this->configureInterceptorDescriptor($processor);
-        
-        if ($processor instanceof stubPageBasedProcessor) {
-            $processor->selectPage($this->pageFactory);
-        }
-        
+        $this->configure($processor);
+        $this->handlePageBasedProcessor($processor);
         return $processor;
     }
@@ -84 +57 @@
      * @param   stubResponse  $response  the current response
      * @return  string        full qualified classname of the processor to create
-     * @throws  stubProcessorException
      */
     protected abstract function doResolve(stubRequest $request, stubSession $session, stubResponse $response);
 
     /**
-     * configures the processor with the interceptor descriptor
+     * configures the processor
      *
      * @param  stubProcessor  $processor
      */
-    protected abstract function configureInterceptorDescriptor(stubProcessor $processor);
+    protected abstract function configure(stubProcessor $processor);
 
     /**
-     * template method to hook into __sleep()
+     * returns the page factory class for the processor
      *
-     * @return  array<string>  list of property names that should not be serialized
+     * @param   stubProcessor  $processor
+     * @return  string
      */
-    protected function __doSleep()
-    {
-        $this->_serializedProperties['pageFactory'] = $this->pageFactory->getClassName();
-        return array('pageFactory');
-    }
+    protected abstract function getPageFactoryClass(stubProcessor $processor);
 
     /**
-     * template method to hook into __wakeup()
+     * helper method to handle page based processors
+     *
+     * @param   stubProcessor  $processor
+     * @throws  stubConfigurationException
+     * @throws  stubRuntimeException
      */
-    protected function __doWakeUp()
+    protected function handlePageBasedProcessor(stubProcessor $processor)
     {
-        $nqClassName = stubClassLoader::getNonQualifiedClassName($this->_serializedProperties['pageFactory']);
-        if (class_exists($nqClassName, false) == false) {
-            stubClassLoader::load($this->_serializedProperties['pageFactory']);
+        if (($processor instanceof stubPageBasedProcessor) === false) {
+            return;
         }
         
-        $this->pageFactory = new $nqClassName();
-        unset($this->_serializedProperties['pageFactory']);
+        $pageFactoryClass = $this->getPageFactoryClass($processor);
+        if (null == $pageFactoryClass) {
+            throw new stubConfigurationException('Configuration error: processor ' . $processor->getClassName() . ' requires page factory, but no page factory class configured.');
+        }
+        
+        stubClassLoader::load($pageFactoryClass);
+        $nqClassName = stubClassLoader::getNonQualifiedClassName($pageFactoryClass);
+        $pageFactory = new $nqClassName();
+        if (($pageFactory instanceof stubPageFactory) === false) {
+            throw new stubRuntimeException($processor->getClassName() . ' is not an instance of ' . stubClassLoader::getFullQualifiedClassName('stubPageFactory'));
+        }
+        
+        $processor->selectPage($pageFactory);
     }
 }