4 * Accepts a list of files and directories to search for
5 * php files and generates $wgAutoloadLocalClasses or $wgAutoloadClasses
6 * lines for all detected classes. These lines are written out
7 * to an autoload.php file in the projects provided basedir.
11 * $gen = new AutoloadGenerator( __DIR__ );
12 * $gen->readDir( __DIR__ . '/includes' );
13 * $gen->readFile( __DIR__ . '/foo.php' )
14 * $gen->generateAutoload();
16 class AutoloadGenerator
{
18 * @var string Root path of the project being scanned for classes
23 * @var ClassCollector Helper class extracts class names from php files
28 * @var array Map of file shortpath to list of FQCN detected within file
30 protected $classes = array();
33 * @var string The global variable to write output to
35 protected $variableName = 'wgAutoloadClasses';
38 * @var array Map of FQCN to relative path(from self::$basepath)
40 protected $overrides = array();
43 * @param string $basepath Root path of the project being scanned for classes
44 * @param array|string $flags
46 * local - If this flag is set $wgAutoloadLocalClasses will be build instead
47 * of $wgAutoloadClasses
49 public function __construct( $basepath, $flags = array() ) {
50 if ( !is_array( $flags ) ) {
51 $flags = array( $flags );
53 $this->basepath
= realpath( $basepath );
54 $this->collector
= new ClassCollector
;
55 if ( in_array( 'local', $flags ) ) {
56 $this->variableName
= 'wgAutoloadLocalClasses';
61 * Force a class to be autoloaded from a specific path, regardless of where
62 * or if it was detected.
64 * @param string $fqcn FQCN to force the location of
65 * @param string $inputPath Full path to the file containing the class
67 public function forceClassPath( $fqcn, $inputPath ) {
68 $path = realpath( $inputPath );
70 throw new \
Exception( "Invalid path: $inputPath" );
72 $len = strlen( $this->basepath
);
73 if ( substr( $path, 0, $len ) !== $this->basepath
) {
74 throw new \
Exception( "Path is not within basepath: $inputPath" );
76 $shortpath = substr( $path, $len );
77 $this->overrides
[$fqcn] = $shortpath;
81 * @var string $inputPath Path to a php file to find classes within
83 public function readFile( $inputPath ) {
84 $path = realpath( $inputPath );
86 throw new \
Exception( "Invalid path: $inputPath" );
88 $len = strlen( $this->basepath
);
89 if ( substr( $path, 0, $len ) !== $this->basepath
) {
90 throw new \
Exception( "Path is not within basepath: $inputPath" );
92 $result = $this->collector
->getClasses(
93 file_get_contents( $path )
96 $shortpath = substr( $path, $len );
97 $this->classes
[$shortpath] = $result;
102 * @param string $dir Path to a directory to recursively search
103 * for php files with either .php or .inc extensions
105 public function readDir( $dir ) {
106 $it = new RecursiveDirectoryIterator( realpath( $dir ) );
107 $it = new RecursiveIteratorIterator( $it );
109 foreach ( $it as $path => $file ) {
110 $ext = pathinfo( $path, PATHINFO_EXTENSION
);
111 // some older files in mw use .inc
112 if ( $ext === 'php' ||
$ext === 'inc' ) {
113 $this->readFile( $path );
119 * Write out all known classes to autoload.php in
120 * the provided basedir
122 public function generateAutoload() {
125 // We need to generate a line each rather than exporting the
126 // full array so __DIR__ can be prepended to all the paths
127 $format = "%s => __DIR__ . %s,";
128 foreach ( $this->classes
as $path => $contained ) {
129 $exportedPath = var_export( $path, true );
130 foreach ( $contained as $fqcn ) {
131 $content[$fqcn] = sprintf(
133 var_export( $fqcn, true ),
139 foreach ( $this->overrides
as $fqcn => $path ) {
140 $content[$fqcn] = sprintf(
142 var_export( $fqcn, true ),
143 var_export( $path, true )
147 // sort for stable output
150 $output = implode( "\n\t", $content );
152 $this->basepath
. '/autoload.php',
155 // This file is generated, do not adjust manually
157 global \${$this->variableName};
159 \${$this->variableName} = array(
168 * Reads PHP code and returns the FQCN of every class defined within it.
170 class ClassCollector
{
173 * @var string Current namespace
175 protected $namespace = '';
178 * @var array List of FQCN detected in this pass
183 * @var array Token from token_get_all() that started an expect sequence
185 protected $startToken;
188 * @var array List of tokens that are members of the current expect sequence
193 * @var string $code PHP code (including <?php) to detect class names from
194 * @return array List of FQCN detected within the tokens
196 public function getClasses( $code ) {
197 $this->namespace = '';
198 $this->classes
= array();
199 $this->startToken
= null;
200 $this->tokens
= array();
202 foreach ( token_get_all( $code ) as $token ) {
203 if ( $this->startToken
=== null ) {
204 $this->tryBeginExpect( $token );
206 $this->tryEndExpect( $token );
210 return $this->classes
;
214 * Determine if $token begins the next expect sequence.
216 * @param array $token
218 protected function tryBeginExpect( $token ) {
219 if ( is_string( $token ) ) {
222 switch( $token[0] ) {
226 $this->startToken
= $token;
231 * Accepts the next token in an expect sequence
235 protected function tryEndExpect( $token ) {
236 switch( $this->startToken
[0] ) {
238 if ( $token === ';' ||
$token === '{' ) {
239 $this->namespace = $this->implodeTokens() . '\\';
241 $this->tokens
[] = $token;
247 $this->tokens
[] = $token;
248 if ( is_array( $token ) && $token[0] === T_STRING
) {
249 $this->classes
[] = $this->namespace . $this->implodeTokens();
255 * Returns the string representation of the tokens within the
256 * current expect sequence and resets the sequence.
260 protected function implodeTokens() {
262 foreach ( $this->tokens
as $token ) {
263 $content[] = is_string( $token ) ?
$token : $token[1];
266 $this->tokens
= array();
267 $this->startToken
= null;
269 return trim( implode( '', $content ), " \n\t" );