ghanuz/relations

To create a Eloquent relationships with comma separated foreign key or using a FIND_IN_SET mysql function.

3.6 2024-12-02 08:14 UTC

Requires

• php: ^7.0|^8.0|^8.1|^8.2
• laravel/framework: 8.*|9.*|^10.0|^11.0

MIT

• Ghanu Z

• laravel
• eloquent
• relationship
• comma-separate
• find_in_set

README

Set eloquent relationships with table that contains comma separated values as a foreign key

Installation

Get package using composer :

composer require ghanuz/relations

1.

You have to extends GhanuZ\Model class instead of Illuminate\Database\Eloquent\Model

<?php

namespace App;

use GhanuZ\Model;

class Test extends Model
{
    //
}

You can also use traits instead of extend Model class

Like in Laravel, Users model not extending Model class. So you can use trait. GhanuZ\FindInSet\FindInSetRelationTrait

Example:

<?php

namespace App;

use Illuminate\Notifications\Notifiable;
use Illuminate\Foundation\Auth\User as Authenticatable;
use GhanuZ\FindInSet\FindInSetRelationTrait;

class User extends Authenticatable
{
    use Notifiable, FindInSetRelationTrait;

    public function city ()
    {
        return $this->FindInSetOne( 'App\City', 'city_ids', 'id', 1);
    }

    public function state ()
    {
        return $this->FindInSetOne( 'App\State', 'city_ids', 'id', 2);
    }

    public function country ()
    {
        return $this->FindInSetOne( 'App\Country', 'city_ids', 'id', 3);
    }

    public function hobbies ()
    {
        return $this->FindInSetMany( 'App\Hobbies', 'hobbies_id', 'id');
    }

}

To create HasMany Relation you have to write as :

public function order_product (){
    return $this->FindInSetMany( CLASS_NAME, FOREIGN_KEY, LOCAL_KEY);
}

To create HasOne Relation you have to write as :

public function order_product (){
    return $this->FindInSetOne( CLASS_NAME, FOREIGN_KEY, LOCAL_KEY);
}

You can also pass 4th argumaent to detect position in FIND_IN_SET :

If you have an address table schema and stored city_ids like city_id,state_id,country_id.

Now, you want to find only city_id, you will do as : select * from address where FIND_IN_CITY( 2, city_ids ) = 1;// Here $index = 1

Like, for state_id: select * from address where FIND_IN_CITY( 1, city_ids ) = 2;// Here $index = 2

Like, for country_id: select * from address where FIND_IN_CITY( 5, city_ids ) = 3;// Here $index = 3

4th argument is optional

public function order_product (){
    return $this->FindInSetMany( CLASS_NAME, FOREIGN_KEY, LOCAL_KEY, Number);
}

Added support of Array cast from version v3.

From version v3, you can also use custom casting provided by the Laravel framework to manipulate comma deligated value into array. If you are using casts of Laravel to convert the string with comma value into Array then this package also support it to retrive the related table data.

Example

/**
* The attributes that should be cast.
*
* @var array<string, string>
*/
protected $casts = [
    'FIELD' => CUSTOM_CLASS::class,
];


/**
*
* To retrive array of relational tables 
*
*/
public function order_products ()
{
    return $this->FindInSetMany( CLASS_NAME, FOREIGN_KEY, LOCAL_KEY, Number);
}

/**
*
* To retrive single data of the relational table
*
*/
public function order_product ()
{
    return $this->FindInSetOne( CLASS_NAME, FOREIGN_KEY, LOCAL_KEY, Number);
}