https://github.com/balajidharma/laravel-attributes
A flexible attribute management system for Laravel models.
https://github.com/balajidharma/laravel-attributes
laravel laravel-attribute-package laravel-attributes laravel-framework laravel-package
Last synced: 4 months ago
JSON representation
A flexible attribute management system for Laravel models.
- Host: GitHub
- URL: https://github.com/balajidharma/laravel-attributes
- Owner: balajidharma
- License: mit
- Created: 2024-12-17T04:25:47.000Z (6 months ago)
- Default Branch: 1.x
- Last Pushed: 2024-12-24T18:32:43.000Z (6 months ago)
- Last Synced: 2025-01-25T08:47:53.558Z (4 months ago)
- Topics: laravel, laravel-attribute-package, laravel-attributes, laravel-framework, laravel-package
- Language: PHP
- Homepage:
- Size: 19.5 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Laravel Attributes
A flexible attribute management system for Laravel models.
## Overview
Laravel Attributes allows you to add custom attributes to your Laravel models with support for different data types, sorting, and automatic casting.
## Table of Contents
- [Installation](#installation)
- [Save Attrubute](#save-attribute)
- [Get Attributes](#get-attributes)
- [Getting Attribute Casting Values](#getting-attribute-casting-values)
- [Configuration](#configuration-options)
- [Credits](#credits)
- [Demo](#demo)
## Installation
- Install the package via composer
```bash
composer require balajidharma/laravel-attributes
```
- Publish the migration with
```bash
php artisan vendor:publish --provider="BalajiDharma\LaravelAttributes\AttributesServiceProvider" --tag="migrations"
```
- Run the migration
```bash
php artisan migrate
```
- To Publish the config/attributes.php config file with
```bash
php artisan vendor:publish --provider="BalajiDharma\LaravelAttributes\AttributesServiceProvider" --tag="config"
```
- Preparing your model
To associate views with a model, the model must implement the HasAttributes trait:
```php
save();
$thread->attachAttribute('color', 'red');
```
- Save single attibute with data type
```php
$thread->attachAttribute('color', 'red', 'string');
$thread->attachAttribute('price', '10', 'integer');
$thread->attachAttribute('is_active', '1', 'boolean');
```
default data type is `string`
- Save single attibute with weight
The weight used to sort the attributes
```php
$thread->attachAttribute('color', 'red', 'string', 1);
$thread->attachAttribute('price', '10', 'integer', 2);
$thread->attachAttribute('is_active', '1', 'boolean', 3);
```
default weight value is `0`
- Save multiple attibute
```php
$data = [
[
'name' => 'color',
'value' => 'red',
'data_type' => 'string'
],
[
'name' => 'price',
'value' => '10',
'data_type' => 'interger'
],
[
'name' => 'is_active',
'value' => '1',
'data_type' => 'boolean'
],
]
$thread->attachAttributes($data);
```
`weight` will be added based on array index
## Get Attributes
- Get attributes with query
```php
$thread = Thread::query()->with('attributes')->get();
$thread->attributes;
```
- Check attribute value is exists
```php
if ($thread->hasAttributeValue('red')) {
return 'attribute value';
}
return 'no attribute value';
```
- Check attribute name is exists
```php
if ($thread->hasAttributName('color')) {
return 'attribute name';
}
return 'no attribute name';
```
- Check attribute data type is exists
```php
if ($thread->hasAttributDataType('json')) {
return 'attribute data type';
}
return 'no attribute data type';
```
### Getting Attribute Casting Values
You can get the casting value in data attribute
```php
// Fetch threads with their related attributes
$thread = Thread::query()->with('attributes')->get();
// Access attribute data
foreach ($thread->attributes as $attribute) {
echo $attribute->data;
}
```
## Delete Attributes
- Delete all attributes
```php
$thread->deleteAllAttribute();
```
- Delete attribute by name and value
```php
$thread->deleteAttribute('color', 'red');
```
- Delete attribute by name
```php
$thread->deleteAttributeByName('color');
```
- Delete attribute by value
```php
$thread->deleteAttributeByValue('red');
```
- Delete attribute by data type
```php
$thread->deleteAttributeByDataType('string');
```
# Laravel Attributes Configuration
This document describes all configuration options available in the `attributes.php` config file.
## Configuration Options
### Models
```php
'models' => [
'attributes' => BalajiDharma\LaravelAttributes\Models\Attributes::class,
],
```
Defines the model class used to save attributes. You can override this with your own model class if needed.
```php
'table_names' => [
'attributes' => 'attributes',
],
```
Specifies the database table name used for storing attributes. Default is 'attributes'.
### Validation
```php
'validate_value_before_save' => true,
```
Disable or enable the value validation based on data type.
### Data Type and Casting
```php
'data_types' => [
['name' => 'string', 'validation' => 'string', 'cast' => 'string'],
['name' => 'integer', 'validation' => 'integer', 'cast' => 'integer'],
['name' => 'float', 'validation' => 'numeric', 'cast' => 'float'],
['name' => 'boolean', 'validation' => 'boolean', 'cast' => 'boolean'],
['name' => 'date', 'validation' => 'date', 'cast' => 'date'],
['name' => 'json', 'validation' => 'json', 'cast' => 'array'],
],
```
Support all the Eloquent [Attribute Casting](https://laravel.com/docs/eloquent-mutators#attribute-casting)
## Credits
This package is based on [milwad-dev/laravel-attributes](https://github.com/milwad-dev/laravel-attributes) and has been modified to provide additional functionality.
## Demo
The "[Basic Laravel Admin Penel](https://github.com/balajidharma/basic-laravel-admin-panel)" starter kit come with Laravel Attributes