vendor/doctrine/persistence/src/Persistence/Mapping/Driver/ColocatedMappingDriver.php line 140

Open in your IDE?
  1. <?php
  3. namespace Doctrine\Persistence\Mapping\Driver;
  5. use Doctrine\Persistence\Mapping\MappingException;
  6. use FilesystemIterator;
  7. use RecursiveDirectoryIterator;
  8. use RecursiveIteratorIterator;
  9. use RecursiveRegexIterator;
  10. use ReflectionClass;
  11. use RegexIterator;
  13. use function array_merge;
  14. use function array_unique;
  15. use function assert;
  16. use function get_declared_classes;
  17. use function in_array;
  18. use function is_dir;
  19. use function preg_match;
  20. use function preg_quote;
  21. use function realpath;
  22. use function str_replace;
  23. use function strpos;
  25. /**
  26. * The ColocatedMappingDriver reads the mapping metadata located near the code.
  27. */
  28. trait ColocatedMappingDriver
  29. {
  30. /**
  31. * The paths where to look for mapping files.
  32. *
  33. * @var string[]
  34. */
  35. protected $paths = [];
  37. /**
  38. * The paths excluded from path where to look for mapping files.
  39. *
  40. * @var string[]
  41. */
  42. protected $excludePaths = [];
  44. /**
  45. * The file extension of mapping documents.
  46. *
  47. * @var string
  48. */
  49. protected $fileExtension = '.php';
  51. /**
  52. * Cache for getAllClassNames().
  53. *
  54. * @var string[]|null
  55. * @psalm-var list<class-string>|null
  56. */
  57. protected $classNames;
  59. /**
  60. * Appends lookup paths to metadata driver.
  61. *
  62. * @param string[] $paths
  63. *
  64. * @return void
  65. */
  66. public function addPaths(array $paths)
  67. {
  68. $this->paths = array_unique(array_merge($this->paths, $paths));
  69. }
  71. /**
  72. * Retrieves the defined metadata lookup paths.
  73. *
  74. * @return string[]
  75. */
  76. public function getPaths()
  77. {
  78. return $this->paths;
  79. }
  81. /**
  82. * Append exclude lookup paths to metadata driver.
  83. *
  84. * @param string[] $paths
  85. *
  86. * @return void
  87. */
  88. public function addExcludePaths(array $paths)
  89. {
  90. $this->excludePaths = array_unique(array_merge($this->excludePaths, $paths));
  91. }
  93. /**
  94. * Retrieve the defined metadata lookup exclude paths.
  95. *
  96. * @return string[]
  97. */
  98. public function getExcludePaths()
  99. {
  100. return $this->excludePaths;
  101. }
  103. /**
  104. * Gets the file extension used to look for mapping files under.
  105. *
  106. * @return string
  107. */
  108. public function getFileExtension()
  109. {
  110. return $this->fileExtension;
  111. }
  113. /**
  114. * Sets the file extension used to look for mapping files under.
  115. *
  116. * @return void
  117. */
  118. public function setFileExtension(string $fileExtension)
  119. {
  120. $this->fileExtension = $fileExtension;
  121. }
  123. /**
  124. * Returns whether the class with the specified name is transient. Only non-transient
  125. * classes, that is entities and mapped superclasses, should have their metadata loaded.
  126. *
  127. * @param string $className
  128. * @psalm-param class-string $className
  129. *
  130. * @return bool
  131. */
  132. abstract public function isTransient($className);
  134. /**
  135. * Gets the names of all mapped classes known to this driver.
  136. *
  137. * @return string[] The names of all mapped classes known to this driver.
  138. * @psalm-return list<class-string>
  139. */
  140. public function getAllClassNames()
  141. {
  142. if ($this->classNames !== null) {
  143. return $this->classNames;
  144. }
  146. if (! $this->paths) {
  147. throw MappingException::pathRequiredForDriver(static::class);
  148. }
  150. $classes = [];
  151. $includedFiles = [];
  153. foreach ($this->paths as $path) {
  154. if (! is_dir($path)) {
  155. throw MappingException::fileMappingDriversRequireConfiguredDirectoryPath($path);
  156. }
  158. $iterator = new RegexIterator(
  159. new RecursiveIteratorIterator(
  160. new RecursiveDirectoryIterator($path, FilesystemIterator::SKIP_DOTS),
  161. RecursiveIteratorIterator::LEAVES_ONLY
  162. ),
  163. '/^.+' . preg_quote($this->fileExtension) . '$/i',
  164. RecursiveRegexIterator::GET_MATCH
  165. );
  167. foreach ($iterator as $file) {
  168. $sourceFile = $file[0];
  170. if (preg_match('(^phar:)i', $sourceFile) === 0) {
  171. $sourceFile = realpath($sourceFile);
  172. }
  174. foreach ($this->excludePaths as $excludePath) {
  175. $realExcludePath = realpath($excludePath);
  176. assert($realExcludePath !== false);
  177. $exclude = str_replace('\\', '/', $realExcludePath);
  178. $current = str_replace('\\', '/', $sourceFile);
  180. if (strpos($current, $exclude) !== false) {
  181. continue 2;
  182. }
  183. }
  185. require_once $sourceFile;
  187. $includedFiles[] = $sourceFile;
  188. }
  189. }
  191. $declared = get_declared_classes();
  193. foreach ($declared as $className) {
  194. $rc = new ReflectionClass($className);
  195. $sourceFile = $rc->getFileName();
  196. if (! in_array($sourceFile, $includedFiles) || $this->isTransient($className)) {
  197. continue;
  198. }
  200. $classes[] = $className;
  201. }
  203. $this->classNames = $classes;
  205. return $classes;
  206. }
  207. }