Agavi\Core\Context

Complexity

Total Complexity

45

Size/Duplication

Total Lines	500
Duplicated Lines	3.4 %

Coupling/Cohesion

Components	5
Dependencies	5

Importance

Changes

0

20 Methods

Rating	Name	Duplication	Size	Complexity
A	__clone()	0	4	1
A	__construct()	0	4	1
A	__toString()	0	4	1
A	getFactoryInfo()	0	6	2
A	setFactoryInfo()	0	4	1
A	createInstanceFor()	0	11	2
A	getDatabaseConnection()	0	6	2
A	getDatabaseManager()	0	4	1
B	getInstance()	0	20	5
A	getLoggerManager()	0	4	1
A	initialize()	0	10	2
A	shutdown()	0	6	2
A	getDispatcher()	0	4	1
F	getModel()	17	98	17
A	getName()	0	4	1
A	getRequest()	0	4	1
A	getRouting()	0	4	1
A	getStorage()	0	4	1
A	getTranslationManager()	0	4	1
A	getUser()	0	4	1

<?php

// +---------------------------------------------------------------------------+
// | This file is part of the Agavi package.                                   |
// | Copyright (c) 2005-2011 the Agavi Project.                                |
// | Based on the Mojavi3 MVC Framework, Copyright (c) 2003-2005 Sean Kerr.    |
// |                                                                           |
// | For the full copyright and license information, please view the LICENSE   |
// | file that was distributed with this source code. You can also view the    |
// | LICENSE file online at http://www.agavi.org/LICENSE.txt                   |
// |   vi: set noexpandtab:                                                    |
// |   Local Variables:                                                        |
// |   indent-tabs-mode: t                                                     |
// |   End:                                                                    |
// +---------------------------------------------------------------------------+

namespace Agavi\Core;

use Agavi\Config\ConfigCache;
use Agavi\Database\DatabaseManager;
use Agavi\Exception\AgaviException;
use Agavi\Exception\AutoloadException;
use Agavi\Exception\DatabaseException;
use Agavi\Exception\DisabledModuleException;
use Agavi\Config\Config;
use Agavi\Dispatcher\Dispatcher;
use Agavi\Logging\LoggerManager;
use Agavi\Model\Model;
use Agavi\Request\Request;
use Agavi\Routing\Routing;
use Agavi\Storage\Storage;
use Agavi\Translation\TranslationManager;
use Agavi\User\User;
use Agavi\Util\Toolkit;

/**
 * Context provides information about the current application context,
 * such as the module and controller names and the module directory.
 * It also serves as a gateway to the core pieces of the framework, allowing
 * objects with access to the context, to access other useful objects such as
 * the current Dispatcher, request, user, database manager etc.
 *
 * @package    agavi
 * @subpackage core
 *
 * @author     Sean Kerr <skerr@mojavi.org>
 * @author     Mike Vincent <mike@agavi.org>
 * @author     David Zülke <dz@bitxtender.com>
 * @copyright  Authors
 * @copyright  The Agavi Project
 *
 * @since      0.9.0
 *
 * @version    $Id$
 */

class Context
{
    /**
     * @var        string The name of the Context.
     */
    protected $name = '';
    
    /**
     * @var        Dispatcher A Dispatcher instance.
     */
    protected $dispatcher = null;
    
    /**
     * @var        array An array of class names for frequently used factories.
     */
    protected $factories = array(
        'dispatch_filter' => null,
        'execution_container' => null,
        'execution_filter' => null,
        'filter_chain' => null,
        'response' => null,
        'security_filter' => null,
        'validation_manager' => null,
    );
    
    /**
     * @var        DatabaseManager A DatabaseManager instance.
     */
    protected $databaseManager = null;
    
    /**
     * @var        LoggerManager A LoggerManager instance.
     */
    protected $loggerManager = null;
    
    /**
     * @var        Request A Request instance.
     */
    protected $request = null;
    
    /**
     * @var        Routing A Routing instance.
     */
    protected $routing = null;
    
    /**
     * @var        Storage A Storage instance.
     */
    protected $storage = null;
    
    /**
     * @var        TranslationManager A TranslationManager instance.
     */
    protected $translationManager = null;
    
    /**
     * @var        User A User instance.
     */
    protected $user = null;
    
    /**
     * @var        array The array used for the shutdown sequence.
     */
    protected $shutdownSequence = array();
    
    /**
     * @var        array An array of Context instances.
     */
    protected static $instances = array();
    
    /**
     * @var        array An array of SingletonModel instances.
     */
    protected $singletonModelInstances = array();

    /**
     * Clone method, overridden to prevent cloning, there can be only one.
     *
     * @author     Mike Vincent <mike@agavi.org>
     * @since      0.9.0
     */
    public function __clone()
    {
        trigger_error('Cloning a Context instance is not allowed.', E_USER_ERROR);
    }

    /**
     * Constructor method, intentionally made protected so the context cannot be
     * created directly.
     *
     * @param      string $name The name of this context.
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @author     Mike Vincent <mike@agavi.org>
     * @since      0.9.0
     */
    protected function __construct($name)
    {
        $this->name = $name;
    }

    /**
     * __toString overload, returns the name of the Context.
     *
     * @return     string The context name.
     *
     * @see        Context::getName()
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.11.0
     */
    public function __toString()
    {
        return $this->getName();
    }
    
    /**
     * Get information on a frequently used class.
     *
     * @param      string $for The factory identifier.
     *
     * @return     array An associative array (keys 'class' and 'parameters').
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.11.0
     */
    public function getFactoryInfo($for)
    {
        if (isset($this->factories[$for])) {
            return $this->factories[$for];
        }
    }
    
    /**
     * Set information on a frequently used class.
     *
     * @param      string $for The factory identifier.
     * @param      array $info An associative array (keys 'class' and 'parameters').
     *
     * @author     Felix Gilcher <felix.gilcher@bitxtender.com>
     * @since      1.0.1
     */
    public function setFactoryInfo($for, array $info)
    {
        $this->factories[$for] = $info;
    }

    /**
     * Factory for frequently used classes from factories.xml
     *
     * @param      string $for The factory identifier.
     *
     * @return     mixed An instance, already initialized with parameters.
     *
     * @throws     AgaviException If no such identifier exists.
     *
     * @author     David Zülke <david.zuelke@bitextender.com>
     * @since      1.0.0
     */
    public function createInstanceFor($for)
    {
        $info = $this->getFactoryInfo($for);
        if (null === $info) {
            throw new AgaviException(sprintf('No factory info for "%s"', $for));
        }
        
        $class = new $info['class']();
        $class->initialize($this, $info['parameters']);
        return $class;
    }

    /**
     * Retrieve the Dispatcher.
     *
     * @return     Dispatcher The current Dispatcher implementation instance.
     *
     * @author     Sean Kerr <skerr@mojavi.org>
     * @since      0.9.0
     */
    public function getDispatcher()
    {
        return $this->dispatcher;
    }

    /**
     * Retrieve a database connection from the database manager.
     *
     * This is a shortcut to manually getting a connection from an existing
     * database implementation instance.
     *
     * If the core.use_database setting is off, this will return null.
     *
     * @param      string $name A database name.
     *
     * @return     mixed A database connection.
     *
     * @throws     DatabaseException If the requested database name
     *                                           does not exist.
     *
     * @author     Sean Kerr <skerr@mojavi.org>
     * @since      0.9.0
     */
    public function getDatabaseConnection($name = null)
    {
        if ($this->databaseManager !== null) {
            return $this->databaseManager->getDatabase($name)->getConnection();
        }
    }

    /**
     * Retrieve the database manager.
     *
     * @return     DatabaseManager The current DatabaseManager instance.
     *
     * @author     Sean Kerr <skerr@mojavi.org>
     * @since      0.9.0
     */
    public function getDatabaseManager()
    {
        return $this->databaseManager;
    }

    /**
     * Retrieve the Context instance.
     *
     * If you don't supply a profile name this will try to return the context
     * specified in the <kbd>core.default_context</kbd> setting.
     *
     * @param      string $profile A name corresponding to a section of the config
     *
     * @return     Context An context instance initialized with the
     *                     settings of the requested context name
     *
     * @author     Dominik del Bondio <ddb@bitxtender.com>
     * @author     David Zülke <dz@bitxtender.com>
     * @author     Mike Vincent <mike@agavi.org>
     * @since      0.9.0
     */
    public static function getInstance($profile = null)
    {
        try {
            if ($profile === null) {
                $profile = Config::get('core.default_context');
                if ($profile === null) {
                    throw new AgaviException('You must supply a context name to Context::getInstance() or set the name of the default context to be used in the configuration directive "core.default_context".');
                }
            }
            $profile = strtolower($profile);
            if (!isset(self::$instances[$profile])) {
                $class = Config::get('core.context_implementation', get_called_class());
                self::$instances[$profile] = new $class($profile);
                self::$instances[$profile]->initialize();
            }
            return self::$instances[$profile];
        } catch (\Exception $e) {
            AgaviException::render($e);
        }
    }
    
    /**
     * Retrieve the LoggerManager
     *
     * @return     LoggerManager The current LoggerManager implementation
     *                           instance.
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.11.0
     */
    public function getLoggerManager()
    {
        return $this->loggerManager;
    }

    /**
     * (re)Initialize the Context instance.
     *
     * @author     Dominik del Bondio <ddb@bitxtender.com>
     * @author     David Zülke <dz@bitxtender.com>
     * @author     Mike Vincent <mike@agavi.org>
     * @since      0.10.0
     */
    public function initialize()
    {
        try {
            include(ConfigCache::checkConfig(Config::get('core.config_dir') . '/factories.xml', $this->name));
        } catch (\Exception $e) {
            AgaviException::render($e, $this);
        }
        
        register_shutdown_function(array($this, 'shutdown'));
    }
    
    /**
     * Shut down this Context and all related factories.
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.11.0
     */
    public function shutdown()
    {
        foreach ($this->shutdownSequence as $object) {
            $object->shutdown();
        }
    }
    
    /**
     * Retrieve a Model implementation instance.
     *
     * @param      string $modelName A model name.
     * @param      string $moduleNameA module name, if the requested model is a module model,

There is no parameter named $moduleNameA. Did you maybe mean $moduleName?

     *                    or null for global models.
     * @param      array  $parameters An array of parameters to be passed to initialize() or
     *                    the constructor.
     *
     * @return     Model A Model implementation instance.
     *
     * @throws     AutoloadException if class is ultimately not found.
     *
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.11.0
     */
    public function getModel($modelName, $moduleName = null, array $parameters = null)
    {

        $modelName = $origModelName = str_replace('.', '\\', $modelName);

        // We have a namespace, get the name
        if (strpos($modelName, '\\') !== false) {

This code seems to be duplicated across your project.

            // Remove any submodel-references
            $modelName = substr($modelName, strrpos($modelName, '\\')+1);
        }
        $file = null;
        $rc = null;

        // We have a namespace, get the name
        if (strpos($modelName, '\\') !== false) {

This code seems to be duplicated across your project.

            $modelName = substr($modelName, strrpos($modelName, '\\')+1);
        }

        $ns = Config::get('app.namespace');

        $class = $modelName;

        if ($moduleName === null) {

            // If we have a base namespace defined, add it to the model name
            if ($ns)
                $class = $ns . '\\Models\\' . $origModelName . 'Model';

            // global model
            // let's try to autoload that baby
            if (!class_exists($class)) {

This code seems to be duplicated across your project.

                // it's not there. the hunt is on
                $file = Config::get('core.model_dir') . '/' . str_replace('\\', DIRECTORY_SEPARATOR, $origModelName) . 'Model.class.php';
                require($file);
            }

        } else {

            try {
                $this->dispatcher->initializeModule($moduleName);
            } catch (DisabledModuleException $e) {
                // swallow, this will load the modules autoload but throw an exception
                // if the module is disabled.
            }

            if ($ns)
                $class = $ns . '\\Modules\\' . $moduleName . '\\Models\\' . $origModelName . 'Model';

            // module model
            // let's try to autoload the baby
            if (!class_exists($class)) {

This code seems to be duplicated across your project.

                // it's not there. the hunt is on
                $file = Config::get('core.module_dir') . '/' . $moduleName . '/models/' . str_replace('\\', DIRECTORY_SEPARATOR, $origModelName) . 'Model.class.php';
                require($file);
            }
        }

        if (!class_exists($class)) {
            // it's not there.
            throw new AgaviException(sprintf("Couldn't find class %s for Model %s in file %s", $class, $modelName, $file));
        }
        
        // so if we're here, we found something, right? good.
        
        $rc = new \ReflectionClass($class);
        
        if ($rc->implementsInterface('Agavi\\Model\\SingletonModelInterface')) {
            // it's a singleton
            if (!isset($this->singletonModelInstances[$class])) {
                // no instance yet, so we create one
                
                if ($parameters === null || $rc->getConstructor() === null) {
                    // it has an initialize() method, or no parameters were given, so we don't hand arguments to the constructor
                    $this->singletonModelInstances[$class] = new $class();
                } else {
                    // we use this approach so we can pass constructor params or if it doesn't have an initialize() method
                    $this->singletonModelInstances[$class] = $rc->newInstanceArgs($parameters);
                }
            }
            $model = $this->singletonModelInstances[$class];
        } else {
            // create an instance
            if ($parameters === null || $rc->getConstructor() === null) {
                // it has an initialize() method, or no parameters were given, so we don't hand arguments to the constructor
                $model = new $class();
            } else {
                // we use this approach so we can pass constructor params or if it doesn't have an initialize() method
                $model = $rc->newInstanceArgs($parameters);
            }
        }
        
        if (is_callable(array($model, 'initialize'))) {
            // pass the constructor params again. dual use for the win
            $model->initialize($this, (array) $parameters);
        }
        
        return $model;
    }

    /**
     * Retrieve the name of this Context.
     *
     * @return     string A context name.
     *
     * @author     David Zülke <dz@bitxtender.com>
     * @since      0.11.0
     */
    public function getName()
    {
        return $this->name;
    }
    
    /**
     * Retrieve the request.
     *
     * @return     Request The current Request implementation instance.
     *
     * @author     Sean Kerr <skerr@mojavi.org>
     * @since      0.9.0
     */
    public function getRequest()
    {
        return $this->request;
    }

    /**
     * Retrieve the routing.
     *
     * @return     Routing The current Routing implementation instance.
     *
     * @author     Dominik del Bondio <ddb@bitxtender.com>
     * @since      0.11.0
     */
    public function getRouting()
    {
        return $this->routing;
    }

    /**
     * Retrieve the storage.
     *
     * @return     Storage The current Storage implementation instance.
     *
     * @author     Sean Kerr <skerr@mojavi.org>
     * @since      0.9.0
     */
    public function getStorage()
    {
        return $this->storage;
    }

    /**
     * Retrieve the translation manager.
     *
     * @return     TranslationManager The current TranslationManager
     *                                     implementation instance.
     *
     * @author     Dominik del Bondio <ddb@bitxtender.com>
     * @since      0.11.0
     */
    public function getTranslationManager()
    {
        return $this->translationManager;
    }

    /**
     * Retrieve the user.
     *
     * @return     User The current User implementation instance.
     *
     * @author     Sean Kerr <skerr@mojavi.org>
     * @since      0.9.0
     */
    public function getUser()
    {
        return $this->user;
    }
}