Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mridang/pearify
Pearify converts PSR-4 Composer packages to PEAR compliant code.
https://github.com/mridang/pearify
classname command-line-tool composer magento pear psr-4
Last synced: 3 months ago
JSON representation
Pearify converts PSR-4 Composer packages to PEAR compliant code.
- Host: GitHub
- URL: https://github.com/mridang/pearify
- Owner: mridang
- License: mit
- Archived: true
- Created: 2017-03-17T12:32:36.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-06-27T03:10:55.000Z (over 2 years ago)
- Last Synced: 2024-06-24T05:01:56.760Z (4 months ago)
- Topics: classname, command-line-tool, composer, magento, pear, psr-4
- Language: PHP
- Homepage: https://packagist.org/packages/mridang/pearify
- Size: 50.8 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pearify — Like Browserify, For PEAR compliance
Pearify is a tool to rewrite PSR-0 and PSR-4 PHP class names to the PEAR naming conventions. Pearify
is based on the excellent PHP class-rewriting project by Michael Tibben.
Requirements
------------
Pearify requires PHP version 5.4 or greater.
Installation
------------
The simplest way to get Pearify is via Packagist. Simply add `mridang/pearify` to your composer JSON's
list of requirements and run `composer install`.
About
------------
Pearify relies heavily on Composer and works only on Composer-based projects. Pearify uses the classmap
generated by Composer to get a list of PHP classes to be renamed.
Pearify requires that you have dumped the optimised autoload classmap so it can include the
array of file paths. You can generate the classmap by invoking
```
composer dump-autoload --optimize
```
Running the aforementioned command, will generate a file called `autoload_classmap.php` in the
`vendor\composer` directory. More information on the `dump-autoload` directive can be found at
https://getcomposer.org/doc/03-cli.md#dump-autoload.
The classmap contains an exhaustive list of all the PHP classnames (including paths of dev
dependencies) and the relative file paths. While this file contains classes from development
dependencies as well, they are automatically excluded by Pearify.
Pearify reads your project's `composer.json` file to recursively deduce all the production
dependencies of your project and only select classes from the classmap belonging to your project's
production dependencies.
If you had a PHP class file called `MyClass.php` in the directory `vendor/myname/myproject/`
```php
namespace MyName\MyProject;
use DateTime;
class MyClass {
public function getDate() {
return new DateTime("2014-10-20");
}
}
```
It would be renamed and copied over to a file name `lib\MyName\MyProject\MyClass.php`
```php
class MyName_MyProject_MyClass {
public function getDate() {
return new DateTime("2014-10-20");
}
}
```
The original file is left untouched and the new file is created (or overwritten) with all the `use`
and `namespace` statements removed.
Gotchas
-------
Pearify has quite a few shortcomings. If you'd like to see support for one of the following added to
Composer, please create a pull-request.
* Only the `vendor` directory is processed. No support for the `vendor-dir` property as shown at
https://getcomposer.org/doc/06-config.md#vendor-dir
* No support for the suggested dependencies using the `suggests` property as shown at
https://getcomposer.org/doc/04-schema.md#suggest
* Files without any classes are excluded
* Resources in the dependencies are excluded
* Tests in the dependencies are excluded
Authors
-------
* Mridang Agarwalla
* Hannu Pölönen
Credits
-------
* Michael Tibben (@mtibben)
License
-------
Pearify is licensed under the MIT License - see the LICENSE file for details.