namespace CoreFramework\Loader;
// Import framework stuff
+use CoreFramework\Bootstrap\FrameworkBootstrap;
use CoreFramework\Configuration\FrameworkConfiguration;
-use CoreFramework\Object\BaseFrameworkSystem;
// Import SPL stuff
use \InvalidArgumentException;
private $ignoreList = array();
/**
- * Debug this class loader? (TRUE = yes, FALSE = no)
+ * Debug this class loader? (true = yes, false = no)
*/
- private $debug = FALSE;
+ private $debug = false;
/**
* Whether the file list is cached
*/
- private $listCached = FALSE;
+ private $listCached = false;
/**
* Wethe class content has been cached
*/
- private $classesCached = FALSE;
+ private $classesCached = false;
/**
* Filename for the list cache
*/
private $total = 0;
+ /**
+ * By default the class loader is strict with naming-convention check
+ */
+ private static $strictNamingConvention = true;
+
/**
* Framework/application paths for classes, etc.
*/
'middleware' // The middleware
);
+ /**
+ * Registered paths where test classes can be found. These are all relative
+ * to base_path .
+ */
+ private static $testPaths = array();
/**
* The protected constructor. Please use the factory method below, or use
* @return void
*/
protected function __construct () {
- // Is currently empty
+ // This is empty for now
}
/**
} // END - if
// Skip here if already cached
- if ($this->listCached === FALSE) {
+ if ($this->listCached === false) {
// Writes the cache file of our list away
$cacheContent = json_encode($this->foundClasses);
file_put_contents($this->listCacheFQFN, $cacheContent);
} // END - if
// Skip here if already cached
- if ($this->classesCached === FALSE) {
+ if ($this->classesCached === false) {
// Generate a full-cache of all classes
$cacheContent = '';
foreach (array_keys($this->loadedClasses) as $fqfn) {
// Trace message
//* NOISY-DEBUG: */ printf('[%s:%d]: CALLED!' . PHP_EOL, __METHOD__, __LINE__);
- // Cache loader instance
+ // Get loader instance
$loaderInstance = self::getSelfInstance();
+ // Get config instance
+ $configInstance = FrameworkConfiguration::getSelfInstance();
+
// Load all classes
- foreach (self::$frameworkPaths as $pathName) {
+ foreach (self::$frameworkPaths as $shortPath) {
// Debug message
- //* NOISY-DEBUG: */ printf('[%s:%d]: pathName=%s' . PHP_EOL, __METHOD__, __LINE__, $pathName);
+ //* NOISY-DEBUG: */ printf('[%s:%d]: shortPath=%s' . PHP_EOL, __METHOD__, __LINE__, $shortPath);
+
+ // Generate full path from it
+ $realPathName = realpath(sprintf(
+ '%smain%s%s%s',
+ $configInstance->getConfigEntry('framework_base_path'),
+ DIRECTORY_SEPARATOR,
+ $shortPath,
+ DIRECTORY_SEPARATOR
+ ));
+
+ // Debug message
+ //* NOISY-DEBUG: */ printf('[%s:%d]: realPathName=%s' . PHP_EOL, __METHOD__, __LINE__, $realPathName);
+
+ // Is it not false and accessible?
+ if (is_bool($realPathName)) {
+ // Skip this
+ continue;
+ } elseif (!is_readable($realPathName)) {
+ // @TODO Throw exception instead of break
+ break;
+ }
// Try to load the framework classes
- $loaderInstance->scanClassPath('framework/main/' . $pathName . '/');
+ $loaderInstance->scanClassPath($realPathName);
} // END - foreach
+
+ // Trace message
+ //* NOISY-DEBUG: */ printf('[%s:%d]: EXIT!' . PHP_EOL, __METHOD__, __LINE__);
}
/**
// Trace message
//* NOISY-DEBUG: */ printf('[%s:%d]: CALLED!' . PHP_EOL, __METHOD__, __LINE__);
+ // Get loader instance
+ $loaderInstance = self::getSelfInstance();
+
// Get config instance
- $cfg = FrameworkConfiguration::getSelfInstance();
+ $configInstance = FrameworkConfiguration::getSelfInstance();
// Load all classes for the application
- foreach (self::$frameworkPaths as $class) {
+ foreach (self::$frameworkPaths as $shortPath) {
+ // Debug message
+ //* NOISY-DEBUG: */ printf('[%s:%d]: shortPath=%s' . PHP_EOL, __METHOD__, __LINE__, $shortPath);
+
// Create path name
- $pathName = sprintf('%s/%s/%s', $cfg->getConfigEntry('application_path'), $cfg->getConfigEntry('app_name'), $class);
+ $pathName = realpath(sprintf(
+ '%s%s%s%s%s',
+ $configInstance->getConfigEntry('application_base_path'),
+ DIRECTORY_SEPARATOR,
+ $configInstance->getConfigEntry('detected_app_name'),
+ DIRECTORY_SEPARATOR,
+ $shortPath
+ ));
// Debug message
- //* NOISY-DEBUG: */ printf('[%s:%d]: pathName=%s' . PHP_EOL, __METHOD__, __LINE__, $pathName);
+ //* NOISY-DEBUG: */ printf('[%s:%d]: pathName[%s]=%s' . PHP_EOL, __METHOD__, __LINE__, gettype($pathName), $pathName);
// Is the path readable?
if (is_dir($pathName)) {
// Try to load the application classes
- ClassLoader::getSelfInstance()->scanClassPath($pathName);
+ $loaderInstance->scanClassPath($pathName);
} // END - if
} // END - foreach
+
+ // Trace message
+ //* NOISY-DEBUG: */ printf('[%s:%d]: EXIT!' . PHP_EOL, __METHOD__, __LINE__);
}
/**
- * Initializes our loader class
+ * Scans for test classes, etc.
*
- * @param $configInstance Configuration class instance
* @return void
*/
- protected function initLoader (FrameworkConfiguration $configInstance) {
- // Set configuration instance
- $this->configInstance = $configInstance;
+ public static function scanTestsClasses () {
+ // Trace message
+ //* NOISY-DEBUG: */ printf('[%s:%d]: CALLED!' . PHP_EOL, __METHOD__, __LINE__);
- // Construct the FQFN for the cache
- if (!defined('DEVELOPER')) {
- $this->listCacheFQFN = $this->configInstance->getConfigEntry('local_db_path') . 'list-' . $this->configInstance->getConfigEntry('app_name') . '.cache';
- $this->classCacheFQFN = $this->configInstance->getConfigEntry('local_db_path') . 'class-' . $this->configInstance->getConfigEntry('app_name') . '.cache';
- } // END - if
+ // Get config instance
+ $configInstance = FrameworkConfiguration::getSelfInstance();
- // Set suffix and prefix from configuration
- $this->suffix = $configInstance->getConfigEntry('class_suffix');
- $this->prefix = $configInstance->getConfigEntry('class_prefix');
+ // Load all classes for the application
+ foreach (self::$testPaths as $shortPath) {
+ // Debug message
+ //* NOISY-DEBUG: */ printf('[%s:%d]: shortPath=%s' . PHP_EOL, __METHOD__, __LINE__, $shortPath);
- // Set own instance
- self::$selfInstance = $this;
+ // Construct path name
+ $pathName = sprintf(
+ '%s%s%s',
+ $configInstance->getConfigEntry('root_base_path'),
+ DIRECTORY_SEPARATOR,
+ $shortPath
+ );
- // Skip here if no dev-mode
- if (defined('DEVELOPER')) {
- return;
- } // END - if
+ // Debug message
+ //* NOISY-DEBUG: */ printf('[%s:%d]: pathName[%s]=%s - BEFORE!' . PHP_EOL, __METHOD__, __LINE__, gettype($pathName), $pathName);
- // IS the cache there?
- if (BaseFrameworkSystem::isReadableFile($this->listCacheFQFN)) {
- // Get content
- $cacheContent = file_get_contents($this->listCacheFQFN);
+ // Try to find it
+ $realPathName = realpath($pathName);
- // And convert it
- $this->foundClasses = json_decode($cacheContent);
+ // Debug message
+ //* NOISY-DEBUG: */ printf('[%s:%d]: realPathName[%s]=%s - AFTER!' . PHP_EOL, __METHOD__, __LINE__, gettype($realPathName), $realPathName);
- // List has been restored from cache!
- $this->listCached = TRUE;
- } // END - if
+ // Is the path readable?
+ if ((is_dir($realPathName)) && (is_readable($realPathName))) {
+ // Try to load the application classes
+ ClassLoader::getSelfInstance()->scanClassPath($realPathName);
+ } // END - if
+ } // END - foreach
- // Does the class cache exist?
- if (BaseFrameworkSystem::isReadableFile($this->listCacheFQFN)) {
- // Then include it
- require($this->classCacheFQFN);
+ // Trace message
+ //* NOISY-DEBUG: */ printf('[%s:%d]: EXIT!' . PHP_EOL, __METHOD__, __LINE__);
+ }
- // Mark the class cache as loaded
- $this->classesCached = TRUE;
- } // END - if
+ /**
+ * Enables or disables strict naming-convention tests on class loading
+ *
+ * @param $strictNamingConvention Whether to strictly check naming-convention
+ * @return void
+ */
+ public static function enableStrictNamingConventionCheck ($strictNamingConvention = true) {
+ self::$strictNamingConvention = $strictNamingConvention;
+ }
+
+ /**
+ * Registeres given relative path where test classes reside. For regular
+ * framework uses, they should not be loaded (and used).
+ *
+ * @param $relativePath Relative path to test classes
+ * @return void
+ */
+ public static function registerTestsPath ($relativePath) {
+ // Trace message
+ //* NOISY-DEBUG: */ printf('[%s:%d]: relativePath=%s - CALLED!' . PHP_EOL, __METHOD__, __LINE__, $relativePath);
+
+ // "Register" it
+ self::$testPaths[$relativePath] = $relativePath;
+
+ // Trace message
+ //* NOISY-DEBUG: */ printf('[%s:%d]: EXIT!' . PHP_EOL, __METHOD__, __LINE__);
}
/**
* @return void
*/
public static function autoLoad ($className) {
+ // Trace message
+ //* NOISY-DEBUG: */ printf('[%s:%d]: className=%s - CALLED!' . PHP_EOL, __METHOD__, __LINE__, $className);
+
// Try to include this class
self::getSelfInstance()->loadClassFile($className);
+
+ // Trace message
+ //* NOISY-DEBUG: */ printf('[%s:%d]: EXIT!' . PHP_EOL, __METHOD__, __LINE__);
}
/**
/**
* Scans recursively a local path for class files which must have a prefix and a suffix as given by $this->suffix and $this->prefix
*
- * @param $basePath The relative base path to 'base_path' constant for all classes
+ * @param $basePath The relative base path to 'framework_base_path' constant for all classes
* @param $ignoreList An optional list (array forced) of directory and file names which shall be ignored
* @return void
*/
public function scanClassPath ($basePath, array $ignoreList = array() ) {
// Is a list has been restored from cache, don't read it again
- if ($this->listCached === TRUE) {
+ if ($this->listCached === true) {
// Abort here
return;
} // END - if
*/
$basePath2 = realpath($basePath);
- // If the basePath is FALSE it is invalid
- if ($basePath2 === FALSE) {
+ // If the basePath is false it is invalid
+ if ($basePath2 === false) {
/* @TODO: Do not exit here. */
exit(__METHOD__ . ': Cannot read ' . $basePath . ' !' . PHP_EOL);
} else {
// Get current entry
$currentEntry = $iteratorInstance->current();
- // Get filename from iterator
+ // Get filename from iterator which is the class' name (according naming-convention)
$fileName = $currentEntry->getFileName();
// Get the "FQFN" (path and file name)
$fqfn = $currentEntry->getRealPath();
- // Current entry must be a file, not smaller than 100 bytes and not on ignore list
+ // Current entry must be a file, not smaller than 100 bytes and not on ignore list
if ((!$currentEntry->isFile()) || (in_array($fileName, $this->ignoreList)) || (filesize($fqfn) < 100)) {
// Advance to next entry
$iteratorInstance->next();
}
/**
- * Load extra config files
+ * Initializes our loader class
*
+ * @param $configInstance Configuration class instance
* @return void
*/
- public function loadExtraConfigs () {
- // Backup old prefix
- $oldPrefix = $this->prefix;
+ private function initLoader (FrameworkConfiguration $configInstance) {
+ // Set configuration instance
+ $this->configInstance = $configInstance;
+
+ // Construct the FQFN for the cache
+ if (!defined('DEVELOPER')) {
+ $this->listCacheFQFN = $this->configInstance->getConfigEntry('local_database_path') . 'list-' . $this->configInstance->getConfigEntry('detected_app_name') . '.cache';
+ $this->classCacheFQFN = $this->configInstance->getConfigEntry('local_database_path') . 'class-' . $this->configInstance->getConfigEntry('detected_app_name') . '.cache';
+ } // END - if
- // Set new prefix (temporary!)
- $this->prefix = 'config-';
+ // Set suffix and prefix from configuration
+ $this->suffix = $configInstance->getConfigEntry('class_suffix');
+ $this->prefix = $configInstance->getConfigEntry('class_prefix');
+
+ // Set own instance
+ self::$selfInstance = $this;
- // Set base directory
- $basePath = $this->configInstance->getConfigEntry('base_path') . 'framework/config/';
+ // Skip here if no dev-mode
+ if (defined('DEVELOPER')) {
+ return;
+ } // END - if
- // Load all classes from the config directory
- $this->scanClassPath($basePath);
+ // IS the cache there?
+ if (FrameworkBootstrap::isReadableFile($this->listCacheFQFN)) {
+ // Load and convert it
+ $this->foundClasses = json_decode(file_get_contents($this->listCacheFQFN));
- // Include these extra configs now
- $this->includeExtraConfigs();
+ // List has been restored from cache!
+ $this->listCached = true;
+ } // END - if
- // Set back the old prefix
- $this->prefix = $oldPrefix;
+ // Does the class cache exist?
+ if (FrameworkBootstrap::isReadableFile($this->listCacheFQFN)) {
+ // Then include it
+ FrameworkBootstrap::loadInclude($this->classCacheFQFN);
+
+ // Mark the class cache as loaded
+ $this->classesCached = true;
+ } // END - if
}
/**
*
* @param $className The class that shall be loaded
* @return void
+ * @throws InvalidArgumentException If strict-checking is enabled and class name is not following naming-convention
*/
private function loadClassFile ($className) {
// Trace message
$classNameParts = explode("\\", $className);
// At least 3 parts should be there
- if (count($classNameParts) < 3) {
+ if ((self::$strictNamingConvention === true) && (count($classNameParts) < 3)) {
// Namespace scheme is: Project\Package[\SubPackage...]
throw new InvalidArgumentException(sprintf('Class name "%s" is not conform to naming-convention: Project\Package[\SubPackage...]\SomeFooBar', $className));
} // END - if
if ((isset($this->foundClasses[$fileName])) && (!isset($this->loadedClasses[$this->foundClasses[$fileName]]))) {
// File is found and not loaded so load it only once
//* NOISY-DEBUG: */ printf('[%s:%d] LOAD: %s - START' . PHP_EOL, __METHOD__, __LINE__, $fileName);
- require($this->foundClasses[$fileName]);
+ FrameworkBootstrap::loadInclude($this->foundClasses[$fileName]);
//* NOISY-DEBUG: */ printf('[%s:%d] LOAD: %s - END' . PHP_EOL, __METHOD__, __LINE__, $fileName);
// Count this loaded class/interface/exception
$this->total++;
// Mark this class as loaded for other purposes than loading it.
- $this->loadedClasses[$this->foundClasses[$fileName]] = TRUE;
+ $this->loadedClasses[$this->foundClasses[$fileName]] = true;
// Remove it from classes list so it won't be found twice.
//* NOISY-DEBUG: */ printf('[%s:%d] UNSET: %s' . PHP_EOL, __METHOD__, __LINE__, $fileName);
// Developer mode excludes caching (better debugging)
if (!defined('DEVELOPER')) {
// Reset cache
- //* NOISY-DEBUG: */ printf('[%s:%d] classesCached=FALSE' . PHP_EOL, __METHOD__, __LINE__);
- $this->classesCached = FALSE;
+ //* NOISY-DEBUG: */ printf('[%s:%d] classesCached=false' . PHP_EOL, __METHOD__, __LINE__);
+ $this->classesCached = false;
} // END - if
} else {
// Not found
}
}
- /**
- * Includes all extra config files
- *
- * @return void
- */
- private function includeExtraConfigs () {
- // Run through all class names (should not be much)
- foreach ($this->foundClasses as $fileName => $fqfn) {
- // Is this a config?
- if (substr($fileName, 0, strlen($this->prefix)) == $this->prefix) {
- // Then include it
- //* NOISY-DEBUG: */ printf('[%s:%d] LOAD: %s - START' . PHP_EOL, __METHOD__, __LINE__, $fileName);
- require($fqfn);
- //* NOISY-DEBUG: */ printf('[%s:%d] LOAD: %s - END' . PHP_EOL, __METHOD__, __LINE__, $fileName);
-
- // Remove it from the list
- //* NOISY-DEBUG: */ printf('[%s:%d] UNSET: %s' . PHP_EOL, __METHOD__, __LINE__, $fileName);
- unset($this->foundClasses[$fileName]);
- } // END - if
- } // END - foreach
- }
-
/**
* Getter for total include counter
*
projects / core.git / blobdiff