Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/michaeluno/php-classmap-generator
Generates class maps of specified directories.
https://github.com/michaeluno/php-classmap-generator
autoload class-file class-file-list class-file-map-generator class-map class-map-generator file-list file-list-generator file-map-generator library php php-library
Last synced: about 1 month ago
JSON representation
Generates class maps of specified directories.
- Host: GitHub
- URL: https://github.com/michaeluno/php-classmap-generator
- Owner: michaeluno
- License: mit
- Created: 2020-01-19T13:33:18.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-02-22T16:57:17.000Z (almost 3 years ago)
- Last Synced: 2024-10-03T12:30:41.684Z (3 months ago)
- Topics: autoload, class-file, class-file-list, class-file-map-generator, class-map, class-map-generator, file-list, file-list-generator, file-map-generator, library, php, php-library
- Language: PHP
- Size: 96.7 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- License: LICENSE
Awesome Lists containing this project
README
# PHP Class Map Generator
A PHP class that generates class maps for autoload.
## Installation
### Composer
To install the library using Composer, run
```bash
composer require michaeluno/php-classmap-generator
```
## Usage
Instantiate the class with options.
```php
new \PHPClassMapGenerator\PHPClassMapGenerator(
__DIR__, // base dir
__DIR__ . '/_scandir', // scan dir path
__DIR__ . '/class-map.php', // the result output file
);
```
This creates a class map file looking like a following.
```php
CLASS_MAP_BASE_DIR_VAR . "/_scandir/FooClass.php",
"Foo\FooClass_Base" => CLASS_MAP_BASE_DIR_VAR . "/_scandir/FooClass_Base.php",
"Joe\JoeInterface" => CLASS_MAP_BASE_DIR_VAR . "/_scandir/interfaces/JoeInterface.php",
"Bar\Bar" => CLASS_MAP_BASE_DIR_VAR . "/_scandir/traits/BarTrait.php",
);
```
Before including the map file, define the constant `CLASS_MAP_BASE_DIR_VAR` in your PHP script.
```php
define( 'CLASS_MAP_BASE_DIR_VAR', __DIR__ );
```
or whatever the base directory path should be.
This automatically inserted string `CLASS_MAP_BASE_DIR_VAR` can be changed to whatever string you need with the option argument `base_dir_var`. For more details, see the 4th parameter section.
Interfaces and traits are also included.
### Parameters
The class accepts four parameters.
#### 1. (string) Base Directory Path
The first parameter accepts the base directory path.
This is required because scanned and gathered absolute paths are on the system where the script runs. However, the actual users of your programs do not share the same absolute paths depending on their systems. That's why the base directory path will be replaced with a constant or a variable in the output.
#### 2. (string|array) Scan Directory Paths
The second parameter accepts directory paths to scan. For multiple paths, pass an numerically indexed array holding them.
##### Examples
```php
new \PHPClassMapGenerator\PHPClassMapGenerator(
__DIR__,
__DIR__ . '/scandir',
__DIR__ . '/class-map.php',
);
```
```php
new \PHPClassMapGenerator\PHPClassMapGenerator(
__DIR__,
[ __DIR__ . '/scandir', __DIR__ . '/scandir2' ],
__DIR__ . '/class-map.php',
);
```
#### 3. (string) The output PHP file path.
Set a path that the generated list will be written.
#### 4. Options (optional)
This parameter accepts an array holding options.
- `output_buffer` : (boolean) whether output buffer should be printed.
- `exclude_classes` : (array) an array holding class names to exclude.
- `base_dir_var` : (string) the variable or constant name that is prefixed before the inclusion path. Default: `__DIR__`.
- `output_var_name` : (string) the variable string that the map array is assigned to. Default: `$aClassMap`. If `return` is set, the variable will not be set but the file just returns the generated map array.
- `do_in_constructor` : (boolean) whether to perform the action in the constructor. Default: `true`.
- `structure` : (string) either `CLASS` or `PATH`. When `CLASS` is set, the generated array keys consist of class names. When `PATH` is set, the generated array keys consist of paths. Default: `CLASS`.
- `short_array_syntax` : (boolean) whether to use `array()` or `[]` for array declaration. `true` for `[]`. Default: `false`.
- `search` : (array) the arguments for the directory search options.
- `allowed_extensions`: (array) allowed file extensions to be listed. e.g. `[ 'php', 'inc' ]`
- `exclude_dir_paths`: (array) directory paths to exclude from the list.
- `exclude_dir_names`: (array) directory base names to exclude from the list. e.g. `[ 'temp', '_bak', '_del', 'lib', 'vendor', ]`
- `exclude_file_names`: (array) a sub-string of file names to exclude from the list. e.g. `[ '.min' ]`
- `exclude_substrings`: (array) sub-strings of paths to exclude from the list. e.g. `[ '.min', '_del', 'temp', 'library', 'vendor' ]`
- `is_recursive`: (boolean) whether to scan sub-directories.
- `ignore_note_file_names`: (array) ignore note file names that tell the parser to skip the directory. When one of the files exist in the parsing directory, the directory will be skipped. Default: `[ 'ignore-class-map.txt' ]`,
- `comment_header` : (array, optional) what header comment to insert at the top of the generated file
- `text` : (string, optional) the header comment to set
- `path` : (string, optional) the file path to extract the comment from
- `class` : (string, optional) the class name to use its doc-block as the header comment
- `type` : (string, optional) indicates what type of data to collect. Accepted values are `DOCBLOCK`, `CONSTANT`.
##### Example
##### Generating a class map in the script directory.
```php
new \PHPClassMapGenerator\PHPClassMapGenerator(
dirname( __DIR__ ),
[ __DIR__ . '/includes', ],
__DIR__ . '/class-map.php',
[
'output_buffer' => true,
'exclude_classes' => [ 'TestClass' ],
'output_var_name' => '$classMap',
'base_dir_var' => '\MyProject\Registry::$dirPath',
'search' => [
'allowed_extensions' => [ 'php' ],
'exclude_dir_paths' => [ __DIR__ . '/includes/class/admin' ],
'exclude_dir_names' => [ '_del', '_bak' ],
'exclude_file_names' => [ 'test.php', 'uninsall.php' ],
'is_recursive' => true,
],
]
);
```
##### Do not write to a file
```php
$_oGenerator = new \PHPClassMapGenerator\PHPClassMapGenerator(
__DIR__, // base dir
__DIR__ . '/_scandir', // scan dir name
__DIR__ . '/class-map.php',
[
'do_in_constructor' => false,
]
);
print_r( $_oGenerator->get() );
```
#### Find CSS files
```php
$_oGenerator = new \PHPClassMapGenerator\PHPClassMapGenerator(
__DIR__, // base dir
__DIR__ . '/_scandir', // scan dir name
__DIR__ . '/class-map.php',
[
'output_var_name' => 'return',
'do_in_constructor' => false,
'structure' => 'PATH',
'search' => [
'allowed_extensions' => [ 'css' ],
'ignore_note_file_names' => [ 'ignore-css-map.txt' ],
'exclude_file_names' => [ '.min.' ],
],
]
);
print_r( $_oGenerator->get() );
```
To find JavaScript files, change the `'css'` part to `'js'` in the `allowed_extensions` search argument.
## Bundled Utility Autoloader
This package includes an autoloader.
### Examples
#### Including an array of class list
```
$_aClassMap = [
"PHPClassMapGenerator\\PHPClassMapGenerator" => __DIR__ . "/PHPClassMapGenerator.php",
"PHPClassMapGenerator\\Autoload" => __DIR__ . "/autoload.php",
];
PHPClassMapGenerator\Utility\Autoload::set( $_aClassMap );
```
#### Including the class map file that returns an array of class list
```
PHPClassMapGenerator\Utility\Autoload::set( include( __DIR__ . '/class-map.php' ) );
```
## License
Licensed under [MIT](./LICENSE).