conedevelopment / blade-filters
Use filters easily in your blade templates.
Installs: 116 678
Dependents: 1
Suggesters: 0
Security: 0
Stars: 489
Watchers: 9
Forks: 27
Open Issues: 0
Type:project
Requires
- php: ^7.3 || ^8.0
- illuminate/support: ^8.0 || ^9.0 || ^10.0
- illuminate/view: ^8.0 || ^9.0 || ^10.0
Requires (Dev)
- laravel/laravel: 9.x-dev
- phpunit/phpunit: ^9.5
README
Use string filters easily in Laravel Blade.
If you have any question how the package works, we suggest to read this post: Laravel Blade Filters.
Getting started
You can install the package with composer, running the composer require conedevelopment/blade-filters
command.
Using the filters
You can use the filters in any of your blade templates.
Regular usage:
{{ 'john' | ucfirst }} // John
Chained usage:
{{ 'john' | ucfirst | substr:0,1 }} // J {{ '1999-12-31' | date:'Y/m/d' }} // 1999/12/31
Passing non-static values:
{{ $name | ucfirst | substr:0,1 }} {{ $user['name'] | ucfirst | substr:0,1 }} {{ $currentUser->name | ucfirst | substr:0,1 }} {{ getName() | ucfirst | substr:0,1 }}
Passing variables as filter parameters:
$currency = 'HUF' {{ '12.75' | currency:$currency }} // HUF 12.75
Built-in Laravel functionality:
{{ 'This is a title' | slug }} // this-is-a-title {{ 'This is a title' | title }} // This Is A Title {{ 'foo_bar' | studly }} // FooBar
Limitations
Echos
Laravel supports three types of echos. Raw – {!! !!}
, regular – {{ }}
and escaped (legacy) – {{{ }}}
.
Filters can be used only with regular echos. Also, filters cannot be used in blade directives directly.
Why? Raw should be as it is. Forced escaping should be escaped only, without modification.
Bitwise operators
Bitwise operators are allowed, but they must be wrapped in parentheses, since they are using the same "pipe operator".
{{ ('a' | 'b') | upper }} // C
The Filters
About the filters
Filters are string functions, that are defined in the Pine\BladeFilters\BladeFilters
facade.
It has several reasons, that are discussed in the Create custom filters section.
The available filters
The package comes with a few built-in filters, also the default Laravel string methods can be used.
Currency
{{ '17.99' | currency:'CHF' }} // CHF 17.99 {{ '17.99' | currency:'€',false }} // 17.99 €
Passing
false
as the second parameter will align the symbol to the right.
Date
{{ '1999/12/31' | date }} // 1999-12-31 {{ '1999/12/31' | date:'F j, Y' }} // December 31, 1999
Lcfirst
{{ 'Árpamaláta' | lcfirst }} // árpamaláta
Unlike PHP's default
lcfirst()
, this filter works with multi-byte strings as well.
Reverse
{{ 'ABCDEF' | reverse }} //FEDCBA
Substr
{{ 'My name is' | substr:0,2 }} // My {{ 'My name is' | substr:3 }} // name is
Trim
{{ ' trim me ' | trim }} // trim me
Ucfirst
{{ 'árpamaláta' | ucfirst }} // Árpamaláta
Unlike PHP's default
ucfirst()
, this filter works with multi-byte strings as well.
Supported built-in Str functions
- Str::after()
- Str::before()
- Str::camel()
- Str::finish()
- Str::kebab()
- Str::limit()
- Str::plural()
- Str::singular()
- Str::slug()
- Str::snake()
- Str::start()
- Str::studly()
- Str::title()
Create custom filters
As it was mentioned before, every filter is a method that can be called through the Pine\BladeFilters\BladeFilters
facade.
It has several reasons why is this approach better, but let's take the most important ones:
- It's easy to define custom filters by extending the facade with the
BladeFilters::macro()
, - No extra files, autoloading or class mapping, it's enough to use any service provider to define filters,
- By default Laravel provides a bunch of handy methods that we can use as filters.
Parameter ordering
PHP is not very strict regarding to function's parameter ordering and this way it's easier to coordiante or override them. Also, sometimes it happens with Laravel's string functions. It's important that only those functions can be used, that accept the parameters in the following order:
- The value to be transformed
- Any other parameter if needed
For example:
BladeFilters::macro('filterName', function ($value, $param1 = 'default', $param2 = null) { return ...; }); {{ 'string' | filterName:1,2 }}
Defining custom filters
Since the filters are only methods that are defined in the Str
facade and the BladeFilters
class, to create filters,
you need to create a macro in a service provider's boot()
method.
class AppServiceProvider extends ServiceProvider { public function boot() { BladeFilters::macro('substr', function ($value, $start, $length = null) { return mb_substr($value, $start, $length); }); } }
Contribute
If you found a bug or you have an idea connecting the package, feel free to open an issue.