Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Extra useful functional for Laravel

License

NotificationsYou must be signed in to change notification settings

akalongman/laravel-lodash

Build StatusCode CoverageCode QualityLatest Stable VersionTotal DownloadsDownloads MonthLicense

This package adds lot of useful functionality to the Laravel >=8.0 project

Note: For Laravel older than 5.8 use the package version 1., for older than 8.0 - version 4.

Table of Contents

Installation

Install this package throughComposer.

Run a command in your command line:

composer require longman/laravel-lodash

AddLodashServiceProvider to your service providers list in theapp.php

'providers' => [    .. ./*     * Package Service Providers...     */Longman\LaravelLodash\ServiceProvider::class,    .. .],

Copy the package config and translations to your application with the publish command:

php artisan vendor:publish --provider="Longman\LaravelLodash\LodashServiceProvider"

Usage

General

Enable Debug Mode depending on visitor's IP Address

AddLongman\LaravelLodash\Debug\DebugServiceProvider::class in toconfig/app.phpand specify debug IP's in yourconfig/lodash.php config file:

. ..'debug' => ['ips' => [// IP list for enabling debug mode//'127.0.0.1',        ],    ],    .. .

Add created_by, updated_by and deleted_by to the eloquent models

Sometimes we need to know who created, updated or deleted entry in the database.

For this just addLongman\LaravelLodash\Eloquent\UserIdentities trait to your model and alsoupdate migration file adding necessary columns:

$table->unsignedInteger('created_by')->nullable();$table->unsignedInteger('updated_by')->nullable();$table->unsignedInteger('deleted_by')->nullable();

Use UUID in the Eloquent Models

For this just addLongman\LaravelLodash\Eloquent\UuidAsPrimary trait to your model and alsoupdate related migration file:

$table->uuid('id')->primary();

Also there is possible to specify uuid version via defininguuidVersion property in the model class.

Eager loading of limited many to many relations via subquery or union

Eager load many to many relations with limit via subquery or union.For using this feature, addLongman\LaravelLodash\Eloquent\ManyToManyPreload trait to the models.After that you can use methodslimitPerGroupViaUnion() andlimitPerGroupViaSubQuery().For example you want to select users and 3 related user photos per user.

$items = (newUser)->with(['photos' =>function (BelongsToMany$builder) {// Select via union. There you should pass pivot table fields array$builder->limitPerGroupViaUnion(3, ['user_id','photo_id']);// or// Select via subquery$builder->limitPerGroupViaSubQuery(3);        },'other.relation1','other.relation2'    ]);$items =$items->get();

Now each user model have 3 photos model selected via one query.You can specify additional where clauses or order by fields before the group method call.

Redis using igbinary

Igbinary is a drop in replacement for the standard php serializer.Igbinary stores php data structures in compact binary form.Savings are significant when using Redis or similar memory based storages for serialized data.Via Igbinary repetitive strings are stored only once. Collections of Eloquent objects benefit significantly from this.

By default Laravel does not provide an option to enable igbinary serializer for PhpRedis connectionand you have to use LaravelLodash implementation for this.

First of all, make sure you enabled PhpRedis driver by this guidehttps://laravel.com/docs/5.5/redis#phpredis

After that include Cache and Redis service providers in theapp.php before your App providers:

. ..Longman\LaravelLodash\Cache\CacheServiceProvider::class,Longman\LaravelLodash\Redis\RedisServiceProvider::class,    .. .

You can remove Laravel's Cache and Redis service providers from the config,because LaravelLodash providers are extended from them and therefore implements entire functional.

Now you can specify the serializer in yourdatabase.php underconfig folder:

Also, you can specify other options likescan or etc. Seehttps://github.com/phpredis/phpredis#setoption

Redis client side sharding

PhpRedis extension along with native Redis Cluster, also supportsclient-side sharding.This feature is very useful, when you want distribute your data between multiple servers, but do not want use native Redis Cluster.

Its not implemented in the Laravel by default. We tried to fix this 😄

Config example:

. ..'redis' => ['client' =>'phpredis','clusters' => ['options' => ['lazy_connect'      =>true,'connect_timeout'   =>1,'read_timeout'      =>3,'password'          =>env('REDIS_PASSWORD',null),'database'          =>env('REDIS_DATABASE',0),'prefix'            =>env('REDIS_PREFIX'),'serializer'        => Redis::SERIALIZER_IGBINARY,'compression'       => Redis::COMPRESSION_ZSTD,'compression_level' => Redis::COMPRESSION_ZSTD_DEFAULT,            ],'default' => [                ['host' =>env('REDIS_SHARD1_HOST','127.0.0.1'),'port' =>env('REDIS_SHARD1_PORT',6379),                ],                ['host' =>env('REDIS_SHARD2_HOST','127.0.0.2'),'port' =>env('REDIS_SHARD2_PORT',6379),                ],. ..            ],        ],    ],    .. .

AWS SQS Fifo Queue

Laravel by default does not supports AWS FIFO queues and this package fixes it.

You have to addQueueServiceProvider service provider in theapp.php before your App providers:

. ..Longman\LaravelLodash\Queue\QueueServiceProvider::class,    .. .

You can remove Laravel's Queue service provider from the config,because LaravelLodash provider are extended from that and therefore implements entire functional.

Now you can add the new connection in thequeue.php underconfig folder:

. ..'sqs_fifo' => ['driver'  =>'sqs.fifo','version' =>'latest','key'     =>env('AWS_ACCESS_KEY_ID'),'secret'  =>env('AWS_SECRET_ACCESS_KEY'),'prefix'  =>env('AWS_SQS_URL'),'queue'   =>env('AWS_SQS_DEFAULT_QUEUE'),'region'  =>env('AWS_DEFAULT_REGION'),'options' => ['type'      =>'fifo',// fifo, normal'polling'   =>'long',// long, short'wait_time' =>20,        ],    ],    .. .

Elasticsearch Integration

First of all you have to install official elasticsearch php sdk:

composer require elasticsearch/elasticsearch

After addElasticsearchServiceProvider service provider in theapp.php before your App providers:

. ..Longman\LaravelLodash\Elasticsearch\ElasticsearchServiceProvider::class,    .. .

Now you can add the configuration in theservices.php underconfig folder:

. ..'elasticsearch' => ['enabled'          =>env('ELASTICSEARCH_ENABLED',false),'log_channel'      => ['daily'],'hosts'            => [            ['host' =>env('ELASTICSEARCH_HOST','localhost'),'port' =>env('ELASTICSEARCH_PORT',9200),            ],        ],'connectionParams' => ['client' => ['timeout'         =>env('ELASTICSEARCH_TIMEOUT',3),'connect_timeout' =>env('ELASTICSEARCH_TIMEOUT',3),            ],        ],    ],    .. .

You can use Elasticsearch integration via

$elasticsearch_manager =app(ElasticsearchManagerContract::class);// Call wrapped methods$elasticsearch_manager->createIndex('some-index');// Or get native client and access their methods$client =$elasticsearch_manager->getClient();$client->indices()->create($params);

Also you can perform search via searchable query object. Just create class andimplementElasticsearchQueryContract and you can pass object toperformSearch method

$elasticsearch_manager =app(ElasticsearchManagerContract::class);$results =$elasticsearch_manager->performSearch($query);

Check if installed packages are in sync with composer.lock

For development purposes, it is recommended to check if vendor folder is in sync with composer.lock file.

For this, in composer.json you have to add scriptComposerScripts::createPackageHash:

. . ."post-autoload-dump": ["Longman\\LaravelLodash\\Composer\\ComposerScripts::createPackageHash",. . .    ],. . .

And in theAppServiceProvider::boot add these lines:

. ..if (config('app.debug')) {$checker =newComposerChecker(base_path());$checker->checkHash();    }. ..

Helper Functions

FunctionDescription
p(...$values): voidAdd debug messages to the debugbar
get_db_query(): ?stringGet last executed database query
get_db_queries(): ?arrayGet all executed database queries

Extended Classes

For this fuctional you should addLongman\LaravelLodash\LodashServiceProvider::class in theconfig/app.php file.

There is an extended classes via Laravel's builtin macros functionality

Request class

MethodDescription
getInt(string $name, int $default = 0): intReturn request field value as a integer
getBool(string $name, bool $default = false): boolReturn request field value as a boolean
getFloat(string $name, float $default = 0): floatReturn request field value as a float
getString(string $name, string $default = ''): stringReturn request field value as a string

Artisan Commands

For this fuctional you should addLongman\LaravelLodash\LodashServiceProvider::class in theconfig/app.php file.

CommandDescription
php artisan clear-allClear entire cache and all cached routes, views, etc.
php artisan db:clearDrop all tables from database. Options:
--database= : The database connection to use.
--force : Force the operation to run when in production.
--pretend : Dump the SQL queries that would be run.
php artisan db:dumpDump database to sql file using mysqldump CLI utility. Options:
--database= : The database connection to use.
--path= : Folder path for store database dump files.
php artisan db:restore {file}Restore database from sql file using mysqldump CLI utility. Options:
--database= : The database connection to use.
--force : Force the operation to run when in production
php artisan log:clearClear log files fromstorage/logs recursively. Options:
--force : Force the operation to run when in production.
php artisan user:add {email} {password?}Create a new user. Options:
--guard= : The guard to use.
php artisan user:password {email} {password?}Update/reset user password. Options:
--guard= : The guard to use.

Middleware List

XssSecurity

Sets XSS Security headers. Can be configured excluded URI-s, etc in theconfig/lodash.php .

SimpleBasicAuth

Add simple basic auth to a route.

In theconfig/auth.php you have to add:

. ..'simple' => ['enabled'  =>env('SIMPLE_AUTH_ENABLED',true),'user'     =>env('SIMPLE_AUTH_USER','user'),'password' =>env('SIMPLE_AUTH_PASS','secret'),    ],    . . .

Blade Directives

For this functional you should addLongman\LaravelLodash\LodashServiceProvider::class in theconfig/app.php file.

DirectiveDescription
@datetime($date);Display relative time. Example:
$date = Carbon\Carbon::now();
@datetime($date);
@plural($count, $word)Pluralization helper. Example:
@plural(count($posts), 'post')
Produces '1 post' or '2 posts', depending on how many items in $posts there are

Misc

SelfDiagnosis Checks

For using this checks, you have to install the package:laravel-self-diagnosis

Available Disk Space Check

...\Longman\LaravelLodash\SelfDiagnosis\Checks\AvailableDiskSpace::class => ['paths' => ['/' =>'100G',// At least 100G should be available for the path "/"'/var/www' =>'5G',    ],],...

Filesystem Disks Are Available

...\Longman\LaravelLodash\SelfDiagnosis\Checks\FilesystemsAreAvailable::class => ['disks' => ['local','s3',    ],],...

Elasticsearch Health Check

...\Longman\LaravelLodash\SelfDiagnosis\Checks\ElasticsearchCanBeAccessed::class => ['client' => ElasticSearchClient::class,],...

Php Ini Options Check

...\Longman\LaravelLodash\SelfDiagnosis\Checks\PhpIniOptions::class => ['options' => ['upload_max_filesize' =>'>=128M','post_max_size'       =>'>=128M','memory_limit'        =>'>=128M','max_input_vars'      =>'>=10000','file_uploads'        =>'1','disable_functions'   =>'',    ],],...

Php Ini Options Check

...\Longman\LaravelLodash\SelfDiagnosis\Checks\RedisCanBeAccessed::class => ['default_connection' =>true,'connections'        => ['sessions'],],...

Servers Are Pingable Check

...\Longman\LaravelLodash\SelfDiagnosis\Checks\ServersArePingable::class => ['servers' => [        ['host'    =>config('app.url'),'port'    =>80,'timeout' =>1,        ],        ['host'    =>'sqs.eu-west-1.amazonaws.com','port'    =>443,'timeout' =>3,        ],        ['host'    =>'www.googleapis.com','port'    =>443,'timeout' =>3,        ],    ],],...

Horizon is running

...\Longman\LaravelLodash\SelfDiagnosis\Checks\HorizonIsRunning::class,...

TODO

write more tests and add more features

Troubleshooting

If you like living on the edge, please report any bugs you find on thelaravel-lodash issues page.

Contributing

Pull requests are welcome.SeeCONTRIBUTING.md for information.

License

Please see theLICENSE included in this repository for a full copy of the MIT license,which this project is licensed under.

Credits

Full credit list inContributors

About

Extra useful functional for Laravel

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors7

Languages

[8]ページ先頭
©2009-2025 Movatter.jp