Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bnomei/autoloader-for-kirby
Helper to automatically load various Kirby extensions in a plugin
https://github.com/bnomei/autoloader-for-kirby
autoloader extension kirby kirby-cms plugin
Last synced: 2 months ago
JSON representation
Helper to automatically load various Kirby extensions in a plugin
- Host: GitHub
- URL: https://github.com/bnomei/autoloader-for-kirby
- Owner: bnomei
- License: mit
- Created: 2021-08-31T10:14:12.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-21T17:43:39.000Z (10 months ago)
- Last Synced: 2024-05-22T20:22:05.658Z (8 months ago)
- Topics: autoloader, extension, kirby, kirby-cms, plugin
- Language: PHP
- Homepage: https://forum.getkirby.com/t/composer-package-to-autload-extensions-in-plugins/23294
- Size: 428 KB
- Stars: 17
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Autoloader for Kirby
[](https://codeclimate.com/github/bnomei/autoloader-for-kirby)
[](https://codeclimate.com/github/bnomei/autoloader-for-kirby)
[](https://discordapp.com/users/bnomei)
Helper to automatically load various Kirby extensions in a plugin
## Commercial Usage
>
> Support open source!
> This plugin is free but if you use it in a commercial project please consider to sponsor me or make a donation.
> If my work helped you to make some cash it seems fair to me that I might get a little reward as well, right?
> Be kind. Share a little. Thanks.
> ‐ Bruno
>
| M | O | N | E | Y |
|---|----|---|---|---|
| [Github sponsor](https://github.com/sponsors/bnomei) | [Patreon](https://patreon.com/bnomei) | [Buy Me a Coffee](https://buymeacoff.ee/bnomei) | [Paypal dontation](https://www.paypal.me/bnomei/15) | [Hire me](mailto:[email protected]?subject=Kirby) |
## Installation
```bash
composer require bnomei/autoloader-for-kirby
```
## This package is NOT a kirby plugin
- This is a composer package because that actually makes it easier to setup and does not mess with the loading order of extensions.
- Being a package it also can be used not only for local plugins but also as a composer dependency within plugins published online.
### Autoloading of extensions
Add the autoloader for each extension type you want once and it will register all files in subfolders correctly.
#### Supported Extensions
The following extensions can be autoloaded:
- [x] blueprints (php or yml, classes)
- [x] classes (php)
- [x] collections (php)
- [x] commands (php)
- [x] controllers (php)
- [x] blockModels (php)
- [x] pageModels (php)
- [x] routes (php)
- [x] api/routes (php)
- [x] userModels (php)
- [x] snippets (php)
- [x] templates (php)
- [X] translations (php or yml or json)
#### Notes
- Loading translations from yaml or json files is added by this package and not originally part of kirby core.
- The `classes` autoloader is very basic. Using a custom array with kirby's `load()`-helper or composers psr-4 autoloading is recommended.
- The `routes` and `apiRoutes` autoloader is based on code from @tobimori and needs a file structure similar to Next.js [see examples](https://github.com/bnomei/autoloader-for-kirby/blob/main/tests/site/plugins/routastic).
- Blueprints loaded from classes need the [kirby-blueprints](https://github.com/bnomei/kirby-blueprints) plugin
## Usage
After requiring it as a dependency in either your project or plugin `composer.json` you can use the `autoload()`-helper to load various extension.
**/site/plugins/example/index.php**
```php
toArray());
```
```php
toArray([
'options' => [
// options
],
// other extensions
]));
```
```php
[
'folder' => 'schnippschnapp',
],
]);
*/
autoloader(__DIR__)->classes();
// use a different folder
// autoloader(__DIR__)->classes('src');
// set each option explicitly without merging
Kirby::plugin('bnomei/example', [
'options' => [
// options
],
'blueprints' => autoloader(__DIR__)->blueprints(),
'collections' => autoloader(__DIR__)->collections(),
'commands' => autoloader(__DIR__)->commands(),
'controllers' => autoloader(__DIR__)->controllers(),
'blockModels' => autoloader(__DIR__)->blockModels(),
'pageModels' => autoloader(__DIR__)->pageModels(),
'routes' => autoloader(__DIR__)->routes(),
'userModels' => autoloader(__DIR__)->userModels(),
'snippets' => autoloader(__DIR__)->snippets(),
'templates' => autoloader(__DIR__)->templates(),
'translations' => autoloader(__DIR__)->translations(),
// other extensions
]);
```
## Settings
The package does come with [default settings](https://github.com/bnomei/autoloader-for-kirby/blob/main/classes/Autoloader.php#L27) to fit most usecases. But you can change them every time you call the `autoloader()`-helper for a different directory (aka in each plugin `index.php`-file).
**/site/plugins/example/index.php**
```php
[
// mapping BlockModel class names to file names, like
// MyCustomBlock::class => 'my.custom' (site/blueprints/blocks/my.custom.yml)
'transform' => fn ($key) => \Bnomei\Autoloader::pascalToDotCase($key),
],
])->toArray()
);
```
## Suggestion
This plugin works great in combination with my [Kirby CLI Tool](https://github.com/bnomei/kirby3-plopfile) which helps you to create extension files faster.
## Disclaimer
This package is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you find any issues, please [create a new issue](https://github.com/bnomei/autoloader-for-kirby/issues/new).
## License
[MIT](https://opensource.org/licenses/MIT)
It is discouraged to use this package in any project that promotes racism, sexism, homophobia, animal abuse, violence or any other form of hate speech.