protonemedia / laravel-blade-on-demand
Compile Blade templates in memory
Fund package maintenance!
pascalbaljet
Installs: 16 200
Dependents: 1
Suggesters: 0
Security: 0
Stars: 46
Watchers: 4
Forks: 5
Open Issues: 0
Requires
- php: ^8.1 || ^8.2
- illuminate/mail: ^9.0 || ^10.0
- illuminate/view: ^9.0 || ^10.0
Requires (Dev)
- orchestra/testbench: ^7.0 || ^8.0
- phpunit/phpunit: ^9.5
This package is auto-updated.
Last update: 2023-05-21 21:28:59 UTC
README
Laravel package to compile Blade templates in memory. Requires PHP 8.0 or higher, compatible with Laravel 9.
Sponsor this package!
❤️ We proudly support the community by developing Laravel packages and giving them away for free. If this package saves you time or if you're relying on it professionally, please consider sponsoring the maintenance and development. Keeping track of issues and pull requests takes time, but we're happy to help!
Laravel Splade
Did you hear about Laravel Splade? 🤩
It's the magic of Inertia.js with the simplicity of Blade. Splade provides a super easy way to build Single Page Applications using Blade templates. Besides that magic SPA-feeling, it comes with more than ten components to sparkle your app and make it interactive, all without ever leaving Blade.
Installation
You can install the package via composer:
composer require protonemedia/laravel-blade-on-demand
Usage
Render Blade template
You can render any valid Blade Template by calling the render
method on the BladeOnDemand
facade. The method only takes two parameters, the template content and the data you want to pass to the template.
$output = BladeOnDemand::render('Hello {{ $name }}', ['name' => 'Protone Media']); echo $output; // "Hello Protone Media"
This is a just an example but you can use statements, components and other Blade features as well.
Handle missing variables
This feature prevents your render from failing whenever a variable is missing in your data array. By default it will fill the missing variable with the name of the variable itself. In this case $name
is missing so the data array becomes ['name' => 'name']
;
$output = BladeOnDemand::fillMissingVariables()->render('Hello {{ $name }}', []); echo $output; // "Hello name"
You could also use this feature to preview a template without any data. Note that this might give unexpected results when using statements. You can also pass a callable
to the fillMissingVariables
method to customize the handling of missing variables:
$output = BladeOnDemand::fillMissingVariables( fn ($variable) => "_MISSING_{$variable}_MISSING_" )->render('Hello {{ $name }}'); echo $output; // "Hello _MISSING_name_MISSING_"
Render Markdown Mail to HTML
This feature can be used to render a mail as if you're using a Markdown mailable.
$contents = implode(PHP_EOL, [ '@component("mail::message")', '# Hello {{ $name }}', '@endcomponent', ]); $output = BladeOnDemand::renderMarkdownMailToHtml($contents, ['name' => 'Protone Media']); echo $output; // <!DOCTYPE> // <html xmlns="http://www.w3.org/1999/xhtml"> // <head> // ... // </head> // <body> // <style> // ... // </style> // <table> // ... // <h1>Hello Protone Media</h1> // ... // </table> // </body> // </html>
You can optionally specify a theme, just like calling the theme
method on a Mailable.
BladeOnDemand::theme('invoice')->renderMarkdownMailToHtml($contents, $data);
Render Markdown Mail to text
Similair feature as the above renderMarkdownMailToHtml
method except it uses components from the text
directory. You can read more about this feature in the Laravel documentation.
$contents = implode(PHP_EOL, [ '@component("mail::message")', '# Hello {{ $name }}', '@endcomponent', ]); $output = BladeOnDemand::renderMarkdownMailToText($contents, ['name' => 'Protone Media']); echo $output; // [AppName](http://localhost) // // # Hello Protone Media // // © 2020 AppName. All rights reserved.
Parse Maildown Mail
The parseMarkdownMail
method is the same as the renderMarkdownMailToText
method but it also parses the Markdown.
$contents = implode(PHP_EOL, [ '@component("mail::message")', '# Hello {{ $name }}', '@endcomponent', ]); $output = BladeOnDemand::parseMarkdownMail($contents, ['name' => 'Protone Media']); echo $output; // <p><a href="http://localhost">AppName</a></p> // <h1>Hello Protone Media</h1> // <p>© 2020 AppName. All rights reserved.</p>
Testing
composer test
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Other Laravel packages
Laravel Analytics Event Tracking
: Laravel package to easily send events to Google Analytics.Laravel Cross Eloquent Search
: Laravel package to search through multiple Eloquent models.Laravel Eloquent Scope as Select
: Stop duplicating your Eloquent query scopes and constraints in PHP. This package lets you re-use your query scopes and constraints by adding them as a subquery.Laravel FFMpeg
: This package provides an integration with FFmpeg for Laravel. The storage of the files is handled by Laravel's Filesystem.Laravel Form Components
: Blade components to rapidly build forms with Tailwind CSS Custom Forms and Bootstrap 4. Supports validation, model binding, default values, translations, includes default vendor styling and fully customizable!Laravel Mixins
: A collection of Laravel goodies.Laravel Paddle
: Paddle.com API integration for Laravel with support for webhooks/events.Laravel Verify New Email
: This package adds support for verifying new email addresses: when a user updates its email address, it won't replace the old one until the new one is verified.Laravel WebDAV
: WebDAV driver for Laravel's Filesystem.
Security
If you discover any security related issues, please email pascal@protone.media instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.