Jaspaul/eloquent-sti

# Eloquent STI (Single Table Inheritance)

[![Build
Status](https://travis-ci.org/Jaspaul/eloquent-sti.svg?branch=master)](https://travis-ci.org/Jaspaul/eloquent-sti) [![Coverage
Status](https://coveralls.io/repos/github/Jaspaul/eloquent-sti/badge.svg?branch=master)](https://coveralls.io/github/Jaspaul/eloquent-sti?branch=master) [![Code Climate](https://codeclimate.com/github/Jaspaul/eloquent-sti/badges/gpa.svg)](https://codeclimate.com/github/Jaspaul/eloquent-sti)

## Install

Via Composer

``` bash
$ composer require jaspaul/eloquent-sti
```

## Requirements

The following versions of PHP are supported by this version.

* PHP 7.2
* PHP 7.3
* PHP 7.4

## Usage

```php
<?php

use Tests\Helpers\User;
use Tests\Helpers\Administrator;
use Jaspaul\EloquentSTI\Inheritable;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    use Inheritable;

    /**
     * Provides a map of types to resolve for this object. The format is:
     *     'user' => User::class,
     *     'administrator' => Administrator::class
     *
     * @var array
     */
    protected $types = [
        'user' => User::class,
        'administrator' => Administrator::class
    ];
}
```

```php
<?php

class Administrator extends User
{
}
```

Now when you select users through the User model, they'll be returned with the associated type. For instance if you have a record in the users table with the type administrator, an Administrator object will be returned when you run `User::where('type', 'administrator')->first()`.