root/trunk/src/main/php/net/stubbles/websites/processors/stubDefaultProcessorResolver.php @ 1445

<?php
/**
 * Default implementation for the processor resolver.
 * 
 * @author      Frank Kleine <mikey@stubbles.net>
 * @package     stubbles
 * @subpackage  websites_processors
 */
stubClassLoader::load('net::stubbles::lang::exceptions::stubConfigurationException',
                      'net::stubbles::util::validators::stubPreSelectValidator',
                      'net::stubbles::websites::processors::stubAbstractProcessorResolver'
);
/**
 * Default implementation for the processor resolver.
 * 
 * @static
 * @package     stubbles
 * @subpackage  websites_processors
 */
class stubDefaultProcessorResolver extends stubAbstractProcessorResolver
{
    /**
     * the default processor to use
     * 
     * @var  string
     */
    protected $defaultProcessor       = null;
    /**
     * list of processors
     * 
     * @var  array<string,string>
     */
    protected $processors             = array();
    /**
     * list of interceptor descriptors
     *
     * @var  array<string,string>
     */
    protected $interceptorDescriptors = array();
    /**
     * list of page factory classes
     *
     * @var  array<string,string>
     */
    protected $pageFactoryClasses     = array();

    /**
     * adds a processor to the list of available processors
     * 
     * @param  string  $paramValue             value of the request parameter that identifies this processor
     * @param  string  $fqClassName            full qualified class name of the processor
     * @param  string  $interceptorDescriptor  optional  the interceptor descriptor
     * @param  string  $pageFactoryClass       optional  page factory class for the processor
     */
    public function addProcessor($paramValue, $fqClassName, $interceptorDescriptor = 'interceptors', $pageFactoryClass = null)
    {
        $this->processors[$paramValue]              = $fqClassName;
        $this->interceptorDescriptors[$fqClassName] = $interceptorDescriptor;
        if (null !== $pageFactoryClass) {
            $this->pageFactoryClasses[$fqClassName] = $pageFactoryClass;
        }
    }

    /**
     * sets the name of the default processor
     * 
     * @param  string  $defaultProcessor  value of the request parameter that identifies this processor
     */
    public function setDefaultProcessor($defaultProcessor)
    {
        $this->defaultProcessor = $defaultProcessor;
    }

    /**
     * does the real resolving work
     *
     * @param   stubRequest   $request   the current request
     * @param   stubSession   $session   the current session
     * @param   stubResponse  $response  the current response
     * @return  string        full qualified classname of the processor to create
     * @throws  stubConfigurationException
     */
    protected function doResolve(stubRequest $request, stubSession $session, stubResponse $response)
    {
        if (isset($this->processors[$this->defaultProcessor]) == false) {
            throw new stubConfigurationException('Configuration error: the default processor ' . $this->defaultProcessor . ' is not set.');
        }
        
        if ($request->hasValue('processor') == false) {
            $paramValue = $this->defaultProcessor;
        } else {
            $paramValue = $request->getValidatedValue(new stubPreSelectValidator(array_keys($this->processors)), 'processor');
            if (null == $paramValue) {
                $paramValue = $this->defaultProcessor;
            }
        }
        
        $session->putValue('net::stubbles::websites.lastProcessor', $paramValue);
        return $this->processors[$paramValue];
    }

    /**
     * configures the processor
     *
     * @param  stubProcessor  $processor
     */
    protected function configure(stubProcessor $processor)
    {
        if (isset($this->interceptorDescriptors[$processor->getClassName()]) == true && strlen($this->interceptorDescriptors[$processor->getClassName()]) > 0) {
            $processor->setInterceptorDescriptor($this->interceptorDescriptors[$processor->getClassName()]);
        }
    }

    /**
     * returns the page factory class for the processor
     *
     * @param   stubProcessor  $processor
     * @return  string
     */
    protected function getPageFactoryClass(stubProcessor $processor)
    {
        if (isset($this->pageFactoryClasses[$processor->getClassName()]) === true) {
            return $this->pageFactoryClasses[$processor->getClassName()];
        }
        
        return null;
    }
}
?>