This repository has been archived by the owner on Jan 30, 2020. It is now read-only.
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
2 changed files
with
10 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,8 @@ | ||
# The Class Map Generator utility: bin/classmap\_generator.php | ||
|
||
The script `bin/classmap_generator.php` can be used to generate class map files for use with the | ||
[ClassMapAutoloader](class-map-autoloader.md). | ||
> ### Removed functionality | ||
> | ||
> The script `bin/classmap_generator.php` has been removed and is no longer available. | ||
> Instead, we recommend using [Composer for autoloading](https://getcomposer.org/doc/04-schema.md#autoload). | ||
Internally, it consumes both the [zend-console getopt functionality](https://docs.zendframework.com/zend-console/getopt/intro/) | ||
(for parsing command-line options) and the [zend-file ClassFileLocator](https://docs.zendframework.com/zend-file/class-file-locator/) | ||
for recursively finding all PHP class files in a given tree. | ||
|
||
## Quick Start | ||
|
||
You may run the script over any directory containing source code. By default, it | ||
will look in the current directory, and will write the script to | ||
`autoloader_classmap.php` in the directory you specify. | ||
|
||
```bash | ||
$ php classmap_generator.php Some/Directory/ | ||
``` | ||
|
||
## Configuration Options | ||
|
||
Option | Description | ||
------------------ | ----------- | ||
`--help | -h` | Returns the usage message. If any other options are provided, they will be ignored. | ||
`--library | -l` | Expects a single argument, a string specifying the library directory to parse. If this option is not specified, it will assume the current working directory. | ||
`--output | -o` | Where to write the autoload class map file. If not provided, assumes `autoload_classmap.php` in the library directory. | ||
`--append | -a` | Append to autoload file if it exists. | ||
`--overwrite | -w` | If an autoload class map file already exists with the name as specified via the `--output` option, you can overwrite it by specifying this flag. Otherwise, the script will not write the class map and return a warning. | ||
If you are upgrading from an existing Zend Framework v2 application, please refer to the [migration guide](https://docs.zendframework.com/tutorials/migration/to-v3/application/#scripts) for more detailed information. |