PHPackages                             shopapps/has-table-relation - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Database & ORM](/categories/database)
4. /
5. shopapps/has-table-relation

ActiveLibrary[Database & ORM](/categories/database)

shopapps/has-table-relation
===========================

Provides a hasTable Eloquent relation to fetch all records from a table.

1.0.5(2y ago)02.4k↓100%MITPHPPHP ^7.3|^8.0

Since Oct 9Pushed 2y ago1 watchersCompare

[ Source](https://github.com/shopapps/has-table-relation)[ Packagist](https://packagist.org/packages/shopapps/has-table-relation)[ RSS](/packages/shopapps-has-table-relation/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (6)Dependencies (1)Versions (7)Used By (0)

HasTable and BelongsToTable relationships for Laravel Eloquent
==============================================================

[](#hastable-and-belongstotable-relationships-for-laravel-eloquent)

Provides a relation to an entire table without the need for any linked foreign key attributes.

This package provides a way to link a model to an entire table without the need for any foreign key attributes. This is useful when you have a table that contains data that should be related to a model but does not have a foreign key column to link it to.

Whilst it is always recommend to have a local\_key <=> foreign\_key mapping (e.g. `numbers.customer_id` <=> `customer.id`) for any related data which allows for the standard `hasMany` / `belongsTo` relationship(s), sometimes you just inherit data and don't have the luxury of properly designed data models. :-(

#### NOTE: before usign this package, you could also consider using a `belongsToMany` relationship and create a pivot table between the two tables. Make sure if you do that you then seed the pivot table mapping all the records you need and also keep them in sync when your code add's removes records. I have added a sample migration file at the bottom of this readme that would allow you to do this as per my customer -> numbers example scenario.

[](#note-before-usign-this-package-you-could-also-consider-using-a-belongstomany-relationship-and-create-a-pivot-table-between-the-two-tables--make-sure-if-you-do-that-you-then-seed-the-pivot-table-mapping-all-the-records-you-need-and-also-keep-them-in-sync-when-your-code-adds-removes-records--i-have-added-a-sample-migration-file-at-the-bottom-of-this-readme-that-would-allow-you-to-do-this-as-per-my-customer---numbers-example-scenario)

installation
============

[](#installation)

```
composer require shopapps/has-table-relation
```

HasTable relationship
---------------------

[](#hastable-relationship)

### Example

[](#example)

In this example the given Customer Model has all the records in the `numbers` table related to it. Normally you would expect to see a related foreign key column such as `customer_id` in the `numbers` table to achieve this and use a hasMany relationship, however in my data this does not exist and due to the sensitive nature of the data I cannot add an extra column to this table.

```
use ShopApps\HasTableRelation\Illuminate\Database\Eloquent\Concerns\HasOtherRelationships;
use App\Models\Number;

class Customer extends Model
{
    use HasOtherRelationships;

    public function numbers()
    {
        return $this->hasTable(Number::class);
    }
}
```

You can now retrieve all records from the numbers table using:

```
$customer = Customer::find(1);

$customer->numbers;

$customer->numbers()->where( 'last_called', '=>', Carbon::now()->subDays(14) )->paginate();

```

BelongsToTable relationship
---------------------------

[](#belongstotable-relationship)

### Example

[](#example-1)

The inverse of the hasTable relationship.

In this example all records in the `numbers` table belong to the given `Customer` model. Normally you would expect to see a related local key column such as `customer_id` in the `numbers` table to achieve this and use a belongsTo relationship, however in my data this does not exist and due to the sensitive nature of the data I cannot add an extra column to this table.

you can pass an optional second parameter to the belongsToTable method to specify the method to call on the parent model. The default is `first` but you can also use `last` or `all` to call the corresponding method on the parent model query.

```
use ShopApps\HasTableRelation\Illuminate\Database\Eloquent\Concerns\HasOtherRelationships;
use App\Models\Customer;

class Number extends Model
{
    use HasOtherRelationships;

    public function customer()
    {
        return $this->belongsToTable(Customer::class);
    }
    // equivelent to ...
    public function customer()
    {
        return $this->belongsToTable(Customer::class, 'first'); // calls $query->first() on the parent model
    }
    // another example...
    public function customer()
    {
        return $this->belongsToTable(Customer::class, 'last'); // calls $query->last() on the parent model
    }
    // another example...
    public function customers() // plural since we will be returning more than one ;-)
    {
        return $this->belongsToTable(Customer::class, 'all'); // calls $query->get() on the parent model
    }
}
```

You can now retrieve the parent record from any of the the number records using:

```
$number = Number::find(1);

$number->customer;

// or if you have more than one customer record owner of this number
$number->customer()->where( 'active', true )->paginate();

```

BelongsToMany - A laravel standard relationship
===============================================

[](#belongstomany---a-laravel-standard-relationship)

Before usign this package, you could also consider using a `belongsToMany` relationship and create a pivot table between the two tables. Make sure if you do that you then seed the pivot table mapping all the records you need. I have added a sample migration file below that would do this as per my customer -> numbers example scenario.

```