Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/krakphp/php-inc
Composer Plugin for automatically including files for easing function usage in php.
https://github.com/krakphp/php-inc
autoloading autoloading-functions composer composer-plugin
Last synced: about 2 months ago
JSON representation
Composer Plugin for automatically including files for easing function usage in php.
- Host: GitHub
- URL: https://github.com/krakphp/php-inc
- Owner: krakphp
- License: mit
- Created: 2017-02-27T05:14:45.000Z (over 7 years ago)
- Default Branch: v0.x
- Last Pushed: 2021-08-23T23:08:12.000Z (about 3 years ago)
- Last Synced: 2024-05-03T01:20:19.758Z (5 months ago)
- Topics: autoloading, autoloading-functions, composer, composer-plugin
- Language: PHP
- Homepage:
- Size: 17.6 KB
- Stars: 5
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-composer - PHP Inc - Automatically includes files for autoload and autoload-dev to facilitate using functions and grouped definitions within composer loaded applications. (Plugins / Support)
README
# Php Inc
Php inc is a composer plugin for automatically including certain files into composer's `autoload` and `autoload-dev` `files` config. Given a set of file matchers, on the the `dump-autoload` event, php-inc will automatically include any matched files into the dumped autoloaded files.
This ameliorates the issues that come about when you want to include certain files that contain functions or maybe multiple classes but don't want to constantly update the composer autoload files configuration which can get hard to deal with when you start including more files.
## Installation
Install via composer at `krak/php-inc`
## Usage
With the default configuration, simply name any file in your `src` or `tests` directory starting with a lower case letter with a `.php` extension will automatically be included in the dumped autoload files when composer's `dump-autoload` event is triggered. This happens on install, update, or dump-autoload commands.
The composer plugin is automatically loaded after it is installed, so in most scenarios, you shouldn't have to do anything for the files to be automatically included. However, if you add files and want to include them right away during development, you can run `composer dump-autoload` to make sure they are included.
## Configuration
Here's an example of the default configuration that is applied:
```json
{
"extra": {
"php-inc": {
"src-path": "src",
"test-path": "tests",
"matches": {
"type": "and",
"matches": [
{"type": "ext", "exts": ["php"]},
{"type": "lowerCase"},
{"type": "excludePath", "path": "@.*/(Resources|Tests)/.*@"}
]
},
"matches-dev-src": {
"type": "and",
"matches": [
{"type": "ext", "exts": ["php"]},
{"type": "lowerCase"},
{"type": "includePath", "path": "@.*/Tests/.*@"},
{"type": "excludePath", "path": "@.*/Tests/.*/Fixtures/.*@"}
]
},
"matches-dev-test": {
"type": "and",
"matches": [
{"type": "ext", "exts": ["php"]},
{"type": "lowerCase"},
{"type": "excludePath", "path": "@.*/Fixtures/.*@"}
]
}
}
}
}
```
Let's go through and explain what each part means and refers to.
### src-path
`src-path` will determine the path to your source code where any autoload files will be searched in.
If you are working with the standard Laravel file structure, you'll want to change the src-path to `app` instead of `src`.
### test-path
`test-path` will determine the path to your test code where the autoload-dev files will be searched.
### matches
`matches` can be any hierarchy of configured matches to determine how you want the src folder to be searched for files to be included in `autoload.files`. The default configuration ensures that all files that start with a lower case file name, have a `php` extension, and are not inside of a Resources or Tests directory will be included in the `autoload.files` composer configuration.
### matches-dev-src
`matches-dev-src` can be any hierarchy of configured matches to determine how you want the src folder to be searched for files to be included in `autoload-dev.files`. The default configuration ensures that all files that start with a lower case file name, have a `php` extension, are inside of a `Tests` directory, and *not* apart of a `Fixtures` directory will be included in the `autoload-dev.files` composer configuration.
### matches-dev-test
`matches-dev-test` can be any hierarchy of configured matches to determine how you want the test folder to be searched for files to be included in `autoload-dev.files`. The default configuration ensures that all files that start with a lower case file name, have a `php` extension, and are *not* apart of a `Fixtures` directory will be included in the `autoload-dev.files` composer configuration.
## Debugging
If you are ever curious what files are being included, you can simply run `composer dump-autoload -v` and view the php-inc output to see which files are being merged with which composer files definition.
## Managing Dependencies
With extended use, you may come into a situation where one file included needs to be loaded before another. If this comes up, the best solution I've found for now is to prefix those files with an `_` and just create a new file named inc.php which loads them in the correct order.
For example:
```
src/a.php
src/b.php
```
`a.php` depends on `b.php` loading first. To enforce loading order, we'd make the following change:
```
src/_a.php
src/_b.php
src/inc.php
```
Where `inc.php` is as follows:
```php