laravel-jmespath
A Laravel 5 wrapper for use of the jmespath.php library. The jmespath.php library is an implementation of the JMESPath specification., (*1)
This package also provides Artisan commands to pre-compile and manage your JMESPath expressions., (*2)
Installation
Install through composer
$ composer require libtek/laravel-jmespath
Add Service Provider
In config/app.php, add the service provider to the $providers array:, (*3)
'providers' => [
// ...
Libtek\Jmes\JmesServiceProvider::class,
],
Add alias
In config/app.php, add the facade to the $aliases array:, (*4)
'aliases' => [
// ...
'Jmes' => Libtek\Jmes\Facades\Jmes::class,
],
Publish the configuration file
If you'd like to modify the default configuration values or define expressions to pre-compile, publish the package config file:, (*5)
php artisan vendor:publish --provider="Libtek\Jmes\JmesServiceProvider"
This will create a jmes.php file in your config directory., (*6)
Usage
With facade:
$result = Jmes::search($expression, $data);
Helper function:
$result = jmes($expression, $data);
Artisan commands
Two Artisan commands are available with the package:, (*7)
jmes:compile
This compiles and caches JMESPath expressions. Expressions can be sourced in multiple ways:, (*8)
-
Running the command with no options or arguments will look for expressions in the jmes.php config file:, (*9)
php artisan jmes:compile
-
Passing a single expression to the command:, (*10)
php artisan jmes:compile 'foo.*.baz'
-
Setting the -c or --cli option will prompt for expressions to be added manually:, (*11)
php artisan jmes:compile --cli
Please enter a JMESPath expression:
> foo.*.baz
jmes:clear
This will delete any previously compiled expressions:, (*12)
php artisan jmes:clear
Pass -h or --help to either command to view its usage., (*13)