mirror/processwire
1
0
Fork 0
mirror of https://github.com/processwire/processwire.git synced 2025-08-15 11:14:12 +02:00
Code Issues Releases Wiki Activity

Upgrade WireFileTools ($files API var) getNamespace() method to support detection of namespaces in files that use declare() statements or comments before namespace declaration

Browse Source
This commit is contained in:
Ryan Cramer
2020-12-30 12:53:37 -05:00
parent ebdf0b9388
commit 2f50095d1e
1 changed files with 37 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
wire/core/WireFileTools.php
View File

@@ -1137,23 +1137,53 @@ class WireFileTools extends Wire {
$namespace = "\\"; // root namespace, if no namespace found $namespace = "\\"; // root namespace, if no namespace found
if($fileIsContents) { if($fileIsContents) {
$data = $file; $data = trim($file);
} else { } else {
$data = file_get_contents($file); $data = trim(file_get_contents($file));
if($data === false) return $namespace; if($data === false) return $namespace;
} }
// if there's no "namespace" keyword in the file, it's not declaring one // if there's no "namespace" keyword in the file, it's not declaring one
$namespacePos = strpos($data, 'namespace'); $namespacePos = strpos($data, 'namespace');
if($namespacePos === false) return $namespace; if($namespacePos === false) return $namespace;
// if file doesn't start with an opening PHP tag, then it's not going to have a namespace declaration
$phpOpen = strpos($data, '<' . '?');
if($phpOpen !== 0) return $namespace;
// quick optimization for common ProcessWire namespace usage // quick optimization for common ProcessWire namespace usage
if(strpos($data, '<' . '?php namespace ProcessWire;') === 0) return 'ProcessWire'; if(strpos($data, '<' . '?php namespace ProcessWire;') === 0) return 'ProcessWire';
// if file doesn't start with an opening PHP tag, then it's not going to have a namespace declaration
$phpOpen = strpos($data, '<' . '?');
if($phpOpen !== 0) {
// file does not begin with opening php tag
// note: this fails for PHP files executable on their own (like shell scripts)
return $namespace;
}
// get everything that appears before "namespace" keyword
$head = substr($data, 0, $namespacePos);
$headPrev = $head;
// declare(...); is the one statement allowed to appear before namespace in PHP files
if(strpos($head, 'declare')) {
$head = preg_replace('/declare[ ]*\(.+?\)[ ]*;\s*/s', '', $head);
}
// single line comment(s) appear before namespace
if(strpos($head, '//') !== false) {
$head = preg_replace('!//.*!', '', $head);
}
// single or multi-line comments before namespace
if(strpos($head, '/' . '*') !== false) {
$head = preg_replace('!/\*.*\*/!s', '', $head);
}
// replace cleaned up head in data
if($head !== $headPrev) {
$data = str_replace($headPrev, $head, $data);
}
$namespacePos = strpos($data, 'namespace'); // get fresh position
if($namespacePos === false) return $namespace; // was likely in a comment
$test = substr($data, 0, $namespacePos-1); $test = substr($data, 0, $namespacePos-1);
$test = trim(str_replace(array('<' . '?php', '<' . '?', "\n", "\r", "\t", " "), "", $test)); $test = trim(str_replace(array('<' . '?php', '<' . '?', "\n", "\r", "\t", " "), "", $test));
if(!strlen($test)) { if(!strlen($test)) {