Shortcode support #98
Conversation
This middleware allows to configure shortcodes using a config file. A shortcode like "[exemple]" will call a function and replace it by a view.
Configuration example :
return [
// This [contact] shortcode will be replaced by a view
'contact' => [
'view' => 'contact'
],
// This one will call Modules\Boats\Entities\Boat::prepareResult and display it's result in the "boat.result-content" view
'boats' => [
'view' => 'boat.result-content',
'callback' => [Modules\Boats\Entities\Boat::class, 'prepareResult']
],
'last-minute' => [
'view' => 'boat.result-content',
'callback' => [Modules\Boats\Entities\Boat::class, 'prepareOffers']
],
// In this example, a rendering function is called, so no view is needed
'sitemap' => [
'callback' => 'generateSitemap'
]
];
| // Get defined shortcodes from the config file | ||
| $shotcodesDefinitions = config('asgard.core.shortcodes', []); | ||
|
|
||
| foreach ($shotcodesDefinitions as $shortcodeName => $options) { |
There was a problem hiding this comment.
Expected 1 newline after opening brace; 2 found
|
Hello, Thanks for your contribution and time spent! Besides the code style issues I have a few comments.
Extracting this to a class(es) will allow independent tests and reduce all those conditions to one level only. |
|
It would probably be better to implement an already established Shortcode parser, than try to create our own. This one looks like it could make use of the config system you already thought up (for example, your middleware could add each configured shortcode as a handler). I can see several uses for shortcodes in the Page module alone, so I hope we can get something implemented. |
I finally found some time to propose you a more complete version of my shortcode support.
This middleware allows to configure shortcodes using a config file. A shortcode like "[exemple]" will call a function and replace it by a view.
This can be useful to allow users to easily insert advanced functionality when they are creating page on their website for example.
Configuration example :
return [
// This [contact] shortcode will be replaced by a view
'contact' => [
'view' => 'contact'
],
// This one will call Modules\Boats\Entities\Boat::prepareResult and display it's result in the "boat.result-content" view
'boats' => [
'view' => 'boat.result-content',
'callback' => [Modules\Boats\Entities\Boat::class, 'prepareResult']
],
'last-minute' => [
'view' => 'boat.result-content',
'callback' => [Modules\Boats\Entities\Boat::class, 'prepareOffers']
],
// In this example, a rendering function is called, so no view is needed
'sitemap' => [
'callback' => 'generateSitemap'
]
];
To be enabled, "asgard.page.config.php" needs to configured that way :
'middleware' => [ 'shortcode' => \Modules\Core\Http\Middleware\ShortcodeMiddleware::class ]