Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jakewhiteley/bladezero
https://github.com/jakewhiteley/bladezero
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/jakewhiteley/bladezero
- Owner: jakewhiteley
- License: mit
- Created: 2019-12-27T20:29:53.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-11T19:52:52.000Z (9 months ago)
- Last Synced: 2024-10-21T03:01:19.648Z (2 months ago)
- Language: PHP
- Size: 313 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# BladeZero
Import Laravel's Blade templating engine into non-Laravel applications **the right way**.
### The wrong way
All other standalone versions of blade require ~16 dependencies, and run the `Iluminate/Container` and `Illuminate/View` packages in your app. This adds a ton of complexity to your app, and is [considered a bad idea](https://mattallan.org/posts/dont-use-illuminate-support/).
There are a few instances of packages rewriting the entire Blade engine from scratch, which creates the following typical issues:
* No longer able to rely on the [Laravel docs](https://laravel.com/docs/6.x/blade) means documentation is often incorrect.
* Features are often missing or implemented incorrectly.
### The \*right\* way
BladeZero is a direct split from `laravel/framework` and only includes files directly needed to compile Blade templates - no Container, no View, no fuss.
95% of the code is a perfect match for the code written by Taylor Otwell and the Laravel contributors, meaning every single Blade feature is supported exactly as it should be.
## Installation
Use [Composer](https://getcomposer.org/):
```bash
composer require jakewhiteley/bladezero
```
### Usage
After pulling the package down, you need to provide the full paths to your templates and cache directories:
```php
use Bladezero\Factory;
$templatesPath = realpath('./files');
$cachePath = realpath('./cache');
$blade = new Factory($templatesPath, $cachePath);
// Make and output a view with some data
echo $blade->make('example', ['title' => 'It Works!']);
```
### Extending BladeZero
As the `BladeZero\Factory` class is just a modifed `Illuminate\View\Factory`, all the methods you would expect are available:
```php
// Add a new templates directory
$blade->addLocation(realpath('./shared/components'));
// Add a namespace
$blade->addNamespace('shared', realpath('./shared/components'));
// Register a component
$blade->component('components.alert', 'alert');
// Register a custom directive
$blade->directive('foo', function($expression) {
return "";
});
// Register a custom if directive
$blade->if('foo', function($bar) {
return $bar === 'foobar';
});
// Register a custom template alias
$blade->include('php.raw', 'foo');
// Add shared data
$blade->share($key, $value = null);
```
BladeZero supports all the Blade features you know such as [custom directives](https://laravel.com/docs/6.x/blade#extending-blade), [custom if statements](https://laravel.com/docs/6.x/blade#custom-if-statements), [components](https://laravel.com/docs/6.x/blade#components-and-slots).
BladeZero lets you write your own View classes as this package is to provide the Blade rendering engine for your own projects - not include half of Laravel. In order to facilitate this, some functionality you would access vie the `View` facade is also available; such as [making data available to all views](https://laravel.com/docs/6.x/views#passing-data-to-views), and view namespaces
## Differences
Even though the Blade compiler is 100% the same as it's Laravel twin, *your application is not*.
Because of this, BladeZero provides methods to easily get the Laravel-specific features of Blade working in your framework:
### @csrf
Use the `setCsrfHandler` method to specify how to provide the `@csrf()` directive with the correct token:
```php
$blade->setCsrfHandler(function(): string {
return MySessionClass::getUserToken();
});
```
### @auth
Set how your application handles auth directives such as `@auth`, `@elseauth`, and `@guest`:
```php
$blade->setAuthHandler(function(string $guard = null): bool {
return MyUserClass::currentUserIs($guard);
});
```
### @can
Set how your application handles permissions directives such as `@can`, `@cannot`, and `@canany`:
```php
$blade->setcanHandler(function($abilities, $arguments = []): bool {
return MyUserClass::currentUserCan($abilities, $arguments);
});
```
### @inject
If your application uses a [dependency injection Container](https://github.com/jakewhiteley/hodl), sepcify how services should be resolved via `@inject`:
```php
$blade->setInjectHandler(function(string $service) {
return MyContainer::resolveService($service);
});
```
### @error
Allwos you to provide how the `@error` directive should work.
Your callback should return the first error string or `false`:
```php
$blade->setErrorHandler(function(string $key) {
return MyErrorBag::getErrorMessageFor($key);
});
```