feat: Plugin extension autoloader #7035
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 |
|---|---|---|
| @@ -0,0 +1,290 @@ | ||
| <?php | ||
|
|
||
| namespace Kirby\Plugin; | ||
|
|
||
| /** | ||
| * Autoloader | ||
| */ | ||
|
|
||
| use Closure; | ||
| use Kirby\Filesystem\Dir; | ||
| use Kirby\Toolkit\A; | ||
| use Kirby\Data\Data; | ||
| use Kirby\Exception\Exception; | ||
| use Kirby\Exception\InvalidArgumentException; | ||
| use Kirby\Filesystem\F; | ||
| use Kirby\Toolkit\Str; | ||
| use Throwable; | ||
|
|
||
| class Autoloader | ||
| { | ||
|
|
||
| public array $data = []; | ||
|
|
||
| /** | ||
| * @param string $name Plugin name | ||
| * @param string $root The root path of the plugin | ||
| * @param array $data Predefined extension data to extend | ||
| * @return void|$this | ||
| */ | ||
| public function __construct( | ||
| public string $name, | ||
| public string $root | ||
| ) { | ||
|
|
||
| //Load classes before everything else | ||
| $classfolder = $root . '/classes/'; | ||
|
|
||
| if (Dir::exists($classfolder)) { | ||
| $this->loadClasses($classfolder); | ||
| } | ||
|
|
||
| $folders = [ | ||
| 'autoload' => 'loadAutoload', | ||
| 'blueprints' => 'loadBlueprints', | ||
| 'i18n' => 'loadTranslations', | ||
| 'fields' => 'loadFields', | ||
| 'sections' => 'loadSections', | ||
| 'snippets' => 'loadSnippets', | ||
| 'templates' => 'loadTemplates' | ||
| ]; | ||
|
|
||
| foreach (Dir::dirs($this->root) as $dir) { | ||
| if (array_key_exists($dir, $folders)) { | ||
| $method = $folders[$dir]; | ||
| $this->$method($this->root . '/' . $dir . '/'); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Autoload autoload | ||
| * @param string $root | ||
| * @return void | ||
| */ | ||
| public function loadAutoload(string $root): void | ||
| { | ||
| foreach (Dir::files($root) as $path) { | ||
|
|
||
| $key = F::name($path); | ||
| $file = $root . $path; | ||
| $this->data[$key] = Data::read($file); | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * Autoload blueprints | ||
| * @param string $root | ||
| * @return void | ||
| */ | ||
| public function loadBlueprints(string $root): void | ||
| { | ||
| foreach (Dir::index($root) as $path) { | ||
|
|
||
| $file = $root . $path; | ||
|
|
||
| //Skip folder and file/folder thats starts with '_' | ||
| if (F::exists($file) === false || Str::contains($path, '/_')) { | ||
| continue; | ||
| } | ||
|
|
||
| //Has no Subfolder | ||
| if (($dirname = F::dirname($path)) === '.') { | ||
| $key = F::name($path); | ||
| } | ||
|
|
||
| $key ??= $dirname . '/' . F::name($path); | ||
|
|
||
| $this->data['blueprints'][$key] = Data::read($file); | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * Load classes | ||
| * @param string $root | ||
| * @return void | ||
| */ | ||
| public function loadClasses(string $root): void | ||
| { | ||
|
|
||
| $classes = []; | ||
|
|
||
| foreach (Dir::index($root) as $path) { | ||
|
|
||
| $file = $root . $path; | ||
|
|
||
| //Skip folder and file/folder thats starts with '_' | ||
| if (F::exists($file) === false || Str::contains($path, '/_')) { | ||
| continue; | ||
| } | ||
|
|
||
| //Has no Subfolder | ||
| if (($dirname = F::dirname($path)) === '.') { | ||
| $key = F::name($path); | ||
| } | ||
|
|
||
| $key ??= $dirname . '/' . F::name($path); | ||
|
|
||
| $prefix = array_map('ucfirst', explode('/', $this->name)); | ||
| $classname = A::merge($prefix, explode('/', $key)); | ||
| $classes[implode('\\', $classname)] = $file; | ||
| }; | ||
|
|
||
| F::loadClasses($classes); | ||
| } | ||
|
|
||
|
|
||
| /** | ||
| * Autoload translations | ||
| * @param string $root | ||
| * @return void | ||
| */ | ||
| public function loadTranslations(string $root): void | ||
| { | ||
| foreach (Dir::index($root) as $path) { | ||
|
|
||
| $file = $root . $path; | ||
|
|
||
| //Skip folder and file/folder thats starts with '_' | ||
| if (F::exists($file) === false || Str::contains($path, '/_')) { | ||
| continue; | ||
| } | ||
|
|
||
| //Has no Subfolder | ||
| if (($dirname = F::dirname($path)) === '.') { | ||
| $key = F::name($path); | ||
| } | ||
|
|
||
| $key ??= $dirname . '/' . F::name($path); | ||
|
|
||
| $this->data['translations'][$key] = Data::read($file); | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * Autoload fields | ||
| * @param string $root | ||
| * @return void | ||
| */ | ||
| public function loadFields(string $root): void | ||
| { | ||
| foreach (Dir::index($root) as $path) { | ||
|
|
||
| $file = $root . $path; | ||
|
|
||
| //Skip folder and file/folder thats starts with '_' | ||
| if (F::exists($file) === false || Str::contains($path, '/_')) { | ||
| continue; | ||
| } | ||
|
|
||
| //Has no Subfolder | ||
| if (($dirname = F::dirname($path)) === '.') { | ||
| $key = F::name($path); | ||
| } | ||
|
|
||
| $key ??= $dirname . '/' . F::name($path); | ||
|
|
||
| $this->data['fields'][$key] = Data::read($file); | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * Autoload sections | ||
| * @param string $root | ||
| * @return void | ||
| */ | ||
| public function loadSections(string $root): void | ||
| { | ||
| foreach (Dir::index($root) as $path) { | ||
|
|
||
| $file = $root . $path; | ||
|
|
||
| //Skip folder and file/folder thats starts with '_' | ||
| if (F::exists($file) === false || Str::contains($path, '/_')) { | ||
| continue; | ||
| } | ||
|
|
||
| //Has no Subfolder | ||
| if (($dirname = F::dirname($path)) === '.') { | ||
| $key = F::name($path); | ||
| } | ||
|
|
||
| $key ??= $dirname . '/' . F::name($path); | ||
|
|
||
| $this->data['sections'][$key] = Data::read($file); | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * Autoload snippets | ||
| * @param string $root | ||
| * @return void | ||
| */ | ||
| public function loadSnippets(string $root): void | ||
| { | ||
| foreach (Dir::index($root) as $path) { | ||
|
|
||
| $file = $root . $path; | ||
|
|
||
| //Skip folder and file/folder thats starts with '_' | ||
| if (F::exists($file) === false || Str::contains($path, '/_')) { | ||
| continue; | ||
| } | ||
|
|
||
| //Has no Subfolder | ||
| if (($dirname = F::dirname($path)) === '.') { | ||
| $key = F::name($path); | ||
| } | ||
|
|
||
| $key ??= $dirname . '/' . F::name($path); | ||
|
|
||
| $this->data['snippets'][$key] = $file; | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * Autoload templates | ||
| * @param string $root | ||
| * @return void | ||
| */ | ||
| public function loadTemplates(string $root): void | ||
| { | ||
| foreach (Dir::index($root) as $path) { | ||
|
|
||
| $file = $root . $path; | ||
|
|
||
| //Skip folder and file/folder thats starts with '_' | ||
| if (F::exists($file) === false || Str::contains($path, '/_')) { | ||
| continue; | ||
| } | ||
|
|
||
| //Has no Subfolder | ||
| if (($dirname = F::dirname($path)) === '.') { | ||
| $key = F::name($path); | ||
| } | ||
|
|
||
| $key ??= $dirname . '/' . F::name($path); | ||
|
|
||
| $this->data['templates'][$key] = $file; | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * Run autoloader and return the results | ||
| * @param mixed ...$params | ||
| * @return array | ||
| */ | ||
| public static function load(...$params): array | ||
| { | ||
| $self = new self(...$params); | ||
| return $self->toArray(); | ||
| } | ||
|
|
||
| /** | ||
| * Returns the autoloaded data | ||
| * @return array */ | ||
| public function toArray(): array | ||
| { | ||
| return $this->data; | ||
| } | ||
| } |
This file contains hidden or 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 hidden or 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
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Question:What for would one use a custom autoloader class?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For example: In one of my cases i used it to extend the
$this->extend()with data from a Class (Which is loading in the autoloader). So i made a custom Autoloader class and modified thetoArray()method.An other case could be, that you need to load snippets from another folder than snippets.