Download the PHP package vkovic/laravel-model-meta without Composer
On this page you can find all versions of the php package vkovic/laravel-model-meta. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package laravel-model-meta
Laravel Model Meta
Laravel Model meta storage
Easily store and access model related metadata and avoid cluttering your models table with more fields.
Compatibility
The package is compatible with Laravel versions 5.5
, 5.6
, 5.7
, 5.8
and 6
.
Installation
Install the package via composer:
Run migrations to create table which will be used to store our model metadata:
Simple examples
To be able to write metadata from our model object, we'll need to add trait HasMetadata
to the model we want to associate metadata with.
Let's take Laravel default User
model as an example:
Also lets assume that we already have users in our users table. We'll need a random one for the examples below:
Let's create and retrieve some metadata for fetched user:
Beside string, metadata can also be stored as integer, float, null, boolean or array:
We can easily check if related user meta exists without actually retrieving it from meta table:
Counting all related user meta records is also a breeze:
If we need all user metadata, or just keys, no problem:
Also, we can remove all user meta data easily:
If, for some reason, we want to delete all meta related to this user at once, no problem:
Retrieve models through meta scopes
HasMetadata
trait also provides functionality to filter models with specific meta,
let's take a look at examples below:
Beside filtering users against meta value, we can also perform filtering based on meta key:
Check if model has metadata
If you need to check if model has metadata functionality, you can implement an interface that comes with the package like:
Implementing HasMetadataInterface
gives us possibility to check if our model has metadata functionality implemented.
Contributing
If you plan to modify this Laravel package you should run tests that comes with it.
Easiest way to accomplish this would be with Docker
, docker-compose
and phpunit
.
First, we need to initialize Docker containers:
After that, we can run tests and watch the output:
Similar packages
The package is one of three metadata packages based on the same approach:
- vkovic/laravel-model-meta (this package - Laravel model related meta storage)
- vkovic/laravel-meta (general purpose meta storage)
- vkovic/laravel-settings (app specific settings meta storage)
Packages can be used separately or together. Internally they are using same table and share common logic.