1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 <?php
/* --------------------------------------------------------------
ClassFinder.inc.php 2016-07-13
Gambio GmbH
http://www.gambio.de
Copyright (c) 2016 Gambio GmbH
Released under the GNU General Public License (Version 2)
[http://www.gnu.org/licenses/gpl-2.0.html]
--------------------------------------------------------------
*/
/**
* Class Finder
*
* @category System
* @package Shared
* @subpackage ClassFinder
*/
class ClassFinder implements ClassFinderInterface
{
/**
* @var array
*/
protected $availableClassesArray = array();
/**
* @var array
*/
protected $allowedDirectories = array();
/**
* @var array
*/
protected $disallowedDirectories = array();
/**
* Constructor
*
* @param ClassFinderSettingsInterface $settings
*/
public function __construct(ClassFinderSettingsInterface $settings)
{
$this->availableClassesArray = $settings->getAvailableClasses();
$this->allowedDirectories = $settings->getAllowedDirectories();
$this->disallowedDirectories = $settings->getDisallowedDirectories();
}
/**
* Returns an associative array with classes that have the given class in their parent list.
* Array format: [ClassName] => [ClassFullFilePath]
*
* @param string $parentClassName
*
* @return array
*/
public function findByParent($parentClassName)
{
$resultArray = array();
foreach($this->availableClassesArray as $className => $classFile)
{
if($this->_hasNeededParent($className, $parentClassName) === true)
{
$resultArray[$className] = $classFile;
}
}
return MainFactory::create('KeyValueCollection', $resultArray);
}
/**
* Returns an associative array with classes that implement the given interface.
* Array format: [ClassName] => [ClassFullFilePath]
*
* @param string $interfaceName
*
* @return array
*
* @throws RuntimeException
*/
public function findByInterface($interfaceName)
{
throw new RuntimeException('Not implemented yet.');
}
/**
* Checks if $className a sub-class of $neededParentClassName
*
* @param string $className
* @param string $neededParentClassName
*
* @return bool
*/
protected function _hasNeededParent($className, $neededParentClassName)
{
// May I load the class file?
$classFile = $this->availableClassesArray[$className];
if($this->_isLoadableClassFile($classFile) === false)
{
return false;
}
// Is the expected class inside?
MainFactory::load_class($className);
if(class_exists($className, false) === false)
{
return false;
}
// Does the class have the needed parent?
$classParentsArray = class_parents($className, false);
if(is_array($classParentsArray) === false || in_array($neededParentClassName, $classParentsArray) === false)
{
return false;
}
return true;
}
/**
* Checks if $classFile is allowed to be included
*
* @param string $classFile
*
* @return bool
*/
protected function _isLoadableClassFile($classFile)
{
if(substr($classFile, -8, 8) !== '.inc.php')
{
// File needs to end with ".inc.php"
return false;
}
foreach($this->disallowedDirectories as $dirItem)
{
if(strpos($classFile, $dirItem) !== false)
{
// File is located in not allowed directory
return false;
}
}
foreach($this->allowedDirectories as $dirItem)
{
if(strpos($classFile, $dirItem) !== false)
{
// File is located in allowed directory
return true;
}
}
return false;
}
}