Download the PHP package edulazaro/larakeep without Composer
On this page you can find all versions of the php package edulazaro/larakeep. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download edulazaro/larakeep
More information about edulazaro/larakeep
Files in edulazaro/larakeep
Package larakeep
Short Description Maintenance Tasks for Laravel Models Fields
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package larakeep
Keepers for Laravel
Introduction
Larakeep is a package which allows to create and handle Keepers. Keepers allow to process the value of the desired model fields.
Sometimes, a field value must be configured when creating or updating a model instance. A common place to do this are the observers. This can lead to bloat the observers with repeated code or bloating the the models with functions, resulting in big files.
keepers allow to set the value of the desired fields on separate classes, keeping the code cleaner.
Actions VS Keepers
While Keepers and Actions share similarities, they serve different purposes in Laravel applications:
| Feature | Actions Pattern | Keepers (Larakeep) |
|---|---|---|
| Purpose | Perform a self-contained operation (e.g., CreateUserAction, DeletePostAction) |
Maintain or compute model field values dynamically |
| Scope | Often used for operations that affect multiple models or require business logic | Specific to maintaining values inside a model |
| Implementation | Typically standalone classes invoked as SomeAction::run($params) |
Assigned to models using attributes or manually (keep()) |
| Examples | CreateInvoiceAction, SendNotificationAction |
getFormattedName(), computeRankings() |
- Use Keepers when: You need to centralize computed fields, enforce model-based transformations, or derive values dynamically.
- Use Actions when: You are performing operations that modify multiple models, involve services, or handle workflow logic.
How to install Larakeep
Execute this command on the Laravel root project folder:
How to create a Keeper
You can create a Keeper manually or using the make command:
The Keeper will be created by default for the model \App\Models\MyModel.
You can also specify the model you are creating the Keeper for by using a second argument:
In this case, the keeper will be created for the model \App\Models\Whatever\MyModel.
How to configure a Keeper
After creating a Keeper, you will need to add the HasKeepers concern to the referenced model:
Registering Keepers manually
You can manually assign a Keeper to a model in a service provider's boot method:
You can add many Keepers to a single model:
Registering Keepers using Attributes
Alternatively, you can register Keepers using attributes directly in the model:
This method allows you to keep the registration clean and self-contained within the model itself, without needing to modify the service provider.
Larakeep supports assigning multiple Keepers to a model using multiple #[KeptBy] attributes:
How to use a Keeper
To use Keeper you need to use the word get + the camel case version of the model attribute to process. For example, it's common to keep separate the model name and the search string for the model. In this case a keeper method is handy to set the attribute value:
The method can also accept parameters, adding the keyword With to the method name:
Now, on an observer, you can process the search_text field to set its value:
Or if the method has parameters:
You can also pass an array of fields to process all of them at the same time:
The model will still need to be saved.
How to add Tasks
You can prepend any other word thanget to the keeper methods, like configure:
However to process these fields with these methods you will need to use the processTask method:
In the same way, these methods can also accept parameters:
The you would do:
You can also pass an array of fields to process all of them at the same time:
Saving data
The attributes will not be saved to the database. In order to do that, call the save method as usually:
License
Larakeep is open-sourced software licensed under the MIT license.
