Differential D68 Diff 164 core/kernel/utility/factory.php

Changeset View

Standalone View

core/kernel/utility/factory.php

	<?php			<?php
	/**			/**
	* @version $Id$			* @version $Id$
	* @package In-Portal			* @package In-Portal
	* @copyright Copyright (C) 1997 - 2009 Intechnic. All rights reserved.			* @copyright Copyright (C) 1997 - 2009 Intechnic. All rights reserved.
	* @license GNU/GPL			* @license GNU/GPL
	* In-Portal is Open Source software.			* In-Portal is Open Source software.
	* This means that this software may have been modified pursuant			* This means that this software may have been modified pursuant
	* the GNU General Public License, and as distributed it includes			* the GNU General Public License, and as distributed it includes
	* or is derivative of works licensed under the GNU General Public License			* or is derivative of works licensed under the GNU General Public License
	* or other free or open source software licenses.			* or other free or open source software licenses.
	* See http://www.in-portal.org/license for copyright notices and details.			* See http://www.in-portal.org/license for copyright notices and details.
	*/			*/

				use Intechnic\InPortal\Core\kernel\utility\ClassDiscovery\ClassMapBuilder;

	defined('FULL_PATH') or die('restricted access!');			defined('FULL_PATH') or die('restricted access!');

	class kFactory extends kBase implements kiCacheable {			class kFactory extends kBase implements kiCacheable {

	/**			/**
	* Mapping between class name and file name			* Mapping between class name and file name
	* where class definition can be found.			* where class definition can be found.
	* File path absolute!			* File path absolute!
	*			*
	* @var Array			* @var Array
	* @access protected			* @access protected
	*/			*/
	protected $classMap = Array ();			protected $classMap = Array ();

	/**			/**
				* The PSR-4 compliant namespace-to-folder mapping.
				*
				* @var array
				*/
				protected $namespaceMap = array();

				/**
	* Map class names to their pseudo			* Map class names to their pseudo
	* class names, e.g. key=pseudo_class,			* class names, e.g. key=pseudo_class,
	* value=real_class_name			* value=real_class_name
	*			*
	* @var Array			* @var Array
	* @access protected			* @access protected
	*/			*/
	protected $realClasses = Array ();			protected $realClasses = Array ();
	Show All 9 Lines
	public function __construct()			public function __construct()
	{			{
	parent::__construct();			parent::__construct();

	spl_autoload_register(Array (&$this, 'autoload'));			spl_autoload_register(Array (&$this, 'autoload'));
	}			}

	/**			/**
				* Configures module-based autoloader.
				*
				* @return void
				*/
				public function configureAutoloader()
				{
				if ( !$this->Application->ModuleInfo ) {
				$error_msg = 'Autoloader configuration can be only performed after module information is available';
				throw new LogicException($error_msg);
				}

				$this->namespaceMap = array();

				foreach ( $this->Application->ModuleInfo as $module_name => $module_info ) {
				if ( $module_name == 'In-Portal' ) {
				continue;
				}

				$this->namespaceMap[$module_info['ClassNamespace']] = rtrim($module_info['Path'], '/');
				}

				if ( defined('IS_INSTALL') && IS_INSTALL ) {
				// During installation process all modules, because unit configs from all modules are scanned too.
				$class_map_builders = ClassMapBuilder::createBuilders();
				}
				else {
				$class_map_builders = ClassMapBuilder::createBuilders($this->Application->ModuleInfo);
				}

				foreach ( $class_map_builders as $class_map_builder ) {
				$class_map = $class_map_builder->get();
				$class_names = array_keys($class_map);

				$this->classMap = array_merge($this->classMap, $class_map);
				$this->realClasses = array_merge($this->realClasses, array_combine($class_names, $class_names));
				}
				}

				/**
	* Sets data from cache to object			* Sets data from cache to object
	*			*
	* @param Array $data			* @param Array $data
	* @return void			* @return void
	* @access public			* @access public
	*/			*/
	public function setFromCache(&$data)			public function setFromCache(&$data)
	{			{
	$this->classMap = $data['Factory.Files'];			$this->classMap = $data['Factory.Files'];
				$this->namespaceMap = $data['Factory.Namespaces'];
	$this->realClasses = $data['Factory.realClasses'];			$this->realClasses = $data['Factory.realClasses'];
	}			}

	/**			/**
	* Performs automatic loading of classes registered with the factory			* Performs automatic loading of classes registered with the factory
	*			*
	* @param string $class			* @param string $class
	* @return bool\|null			* @return bool\|null
	Show All 39 Lines
	else {			else {
	// PEAR-like class name			// PEAR-like class name
	$class_path = null;			$class_path = null;
	$class_name = $class;			$class_name = $class;
	}			}

	$class_path .= str_replace('_', DIRECTORY_SEPARATOR, $class_name) . '.php';			$class_path .= str_replace('_', DIRECTORY_SEPARATOR, $class_name) . '.php';

	foreach ($this->Application->ModuleInfo as $module_name => $module_info) {			foreach ( $this->namespaceMap as $namespace_prefix => $namespace_path ) {
	if ( $module_name == 'In-Portal' ) {			if ( strpos($class, $namespace_prefix) === 0 ) {
	continue;
	}

	if ( strpos($class, $module_info['ClassNamespace']) === 0 ) {
	$test_class_path = str_replace(			$test_class_path = str_replace(
	str_replace('\\', DIRECTORY_SEPARATOR, $module_info['ClassNamespace']),			str_replace('\\', DIRECTORY_SEPARATOR, $namespace_prefix),
	rtrim($module_info['Path'], '/'),			$namespace_path,
	$class_path			$class_path
	);			);

	if ( file_exists(FULL_PATH . DIRECTORY_SEPARATOR . $test_class_path) ) {			if ( file_exists(FULL_PATH . DIRECTORY_SEPARATOR . $test_class_path) ) {
	return DIRECTORY_SEPARATOR . $test_class_path;			return DIRECTORY_SEPARATOR . $test_class_path;
	}			}
	}			}
	}			}

	return $this->classMap[$class] = false;			return $this->classMap[$class] = false;
	}			}

	/**			/**
	* Gets object data for caching			* Gets object data for caching
	*			*
	* @return Array			* @return Array
	* @access public			* @access public
	*/			*/
	public function getToCache()			public function getToCache()
	{			{
				ksort($this->classMap);
				ksort($this->namespaceMap);
				ksort($this->realClasses);

	return Array (			return Array (
	'Factory.Files' => $this->classMap,			'Factory.Files' => $this->classMap,
				'Factory.Namespaces' => $this->namespaceMap,
	'Factory.realClasses' => $this->realClasses,			'Factory.realClasses' => $this->realClasses,
	);			);
	}			}

	/**			/**
	* Splits any mixing of prefix and			* Splits any mixing of prefix and
	* special into correct ones			* special into correct ones
	*			*
	▲ Show 20 Lines • Show All 181 Lines • ▼ Show 20 Line(s)
	{			{
	unset($this->classMap[$real_class]);			unset($this->classMap[$real_class]);
	}			}
	}			}


	class kFactoryException extends Exception {			class kFactoryException extends Exception {

	}			}
	No newline at end of file