https://github.com/rapidwebltd/improved-polymorphic-eloquent-builder

🔨 Improved Polymorphic Eloquent Builder
https://github.com/rapidwebltd/improved-polymorphic-eloquent-builder

eloquent laravel laravel-5-package polymorphic-relationships relationships

Last synced: 2 days ago
JSON representation

🔨 Improved Polymorphic Eloquent Builder

• Host: GitHub
• URL: https://github.com/rapidwebltd/improved-polymorphic-eloquent-builder
• Owner: rapidwebltd
• License: lgpl-3.0
• Created: 2017-01-20T13:28:57.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2019-02-13T12:56:52.000Z (almost 6 years ago)
• Last Synced: 2024-05-03T02:25:13.723Z (7 months ago)
• Topics: eloquent, laravel, laravel-5-package, polymorphic-relationships, relationships
• Language: PHP
• Homepage:
• Size: 14.6 KB
• Stars: 12
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Improved Polymorphic Eloquent Builder

![Packagist](https://img.shields.io/packagist/dt/rapidwebltd/Improved-Polymorphic-Eloquent-Builder.svg)

Attempting to use `whereHas` queries with standard Eloquent polymorphic relationships will fail, due to Eloquent being unable

to determine the correct model to retrieve. You may receive an error similar to the one below as Eloquent tries to build the 

query using columns from the model without including its table name.

```

QueryException in Connection.php line 662:

SQLSTATE[42S22]: Column not found: 1054 Unknown column 'column_name' in 'where clause'

```

The 'Improved Polymorphic Eloquent Builder' is a class which extends the Eloquent Builder class that is built in to Laravel 5.1. 

It enables limited use of the `whereHas` method to query Eloquent polymorphic relationships.

## Requirements

You must be using Laravel 5.1 as your framework and Eloquent as your ORM.

## Installation

Simply require this package, using Composer, in the root directory of your project.

```

composer require rapidwebltd/improved-polymorphic-eloquent-builder

```

Then change any Eloquent models using polymorphic relationships to extend the `\RapidWeb\ImprovedPolymorphicEloquentBuilder\Model`

class. This will usually be any model(s) containing methods which return `morphTo()` relationship(s). An example class is shown below.

```php

class Variation extends \RapidWeb\ImprovedPolymorphicEloquentBuilder\Model

{

  public function model()

  {

    return $this->morphTo();

  }

}

```

## Usage

When performing a `whereHas` query, you must specify the morph types as the 5th argument. Morph types refers to an array

of the polymorphic types you wish to filter by. These should be presented as strings equal to one or more of the

possible values the `[...]_type` field of the polymorphic relationship in question.

The example below selects all `variation` records that have related `model` record  of type `bags`, with a `brand_id` of 2.

```php

Variation::whereHas('model', function($query) use ($brandId) {

  $query->where('brand_id', 2);

}, '>=', 1, ['bags'])->get();

```

A database structure for this example would be similar to the following. The polymorphic fields are highlighted in **bold**.

| variations                                  | bags        | sunglasses     |

|---------------------------------------------|-------------|----------------|

| id                                          | **id**      | **id**             |

| **model_type** ('bags', 'sunglasses', etc.) | brand_id    | brand_id       |

| **model_id**                                | material_id | lens_colour_id |