Initial commit

Author: markusjwetzel

.gitignore

@@ -0,0 +1,4 @@
+.idea
+/vendor
+/coverage
+composer.lock

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023-present Markus Wetzel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,86 @@
+# Eloquent Inheritance
+
+[![Latest Stable Version](https://poser.pugx.org/proai/eloquent-inheritance/v/stable)](https://packagist.org/packages/proai/eloquent-inheritance) [![Total Downloads](https://poser.pugx.org/proai/eloquent-inheritance/downloads)](https://packagist.org/packages/proai/eloquent-inheritance) [![Latest Unstable Version](https://poser.pugx.org/proai/eloquent-inheritance/v/unstable)](https://packagist.org/packages/proai/eloquent-inheritance) [![License](https://poser.pugx.org/proai/eloquent-inheritance/license)](https://packagist.org/packages/proai/eloquent-inheritance)
+
+Single table inheritance is a way to emulate object-oriented inheritance in a relational database. While other frameworks like Ruby on Rails have a built-in implementation for this pattern, Laravel has not. This package aims to provide an as easy as possible implementation for Laravel.
+
+## Installation
+
+You can install the package via composer:
+
+```bash
+composer require proai/eloquent-inheritance
+```
+
+Please note that you need at least **PHP 8.0** and **Laravel 9** for this package.
+
+## Usage
+
+First you need to add the `Inheritance` trait to your root model:
+
+```php
+use ProAI\Inheritance\Inheritance;
+
+class Pet extends Model
+{
+    use Inheritance;
+
+    //
+}
+```
+
+Then you can extend the root model by other models that use the same table:
+
+```php
+class Cat extends Pet
+{
+    //
+}
+
+class Dog extends Pet
+{
+    //
+}
+```
+
+> Note that you need a table `pets` with a column called `type` in order to make the example above work.
+
+Whenever a `Cat` or `Dog` model is instantiated, the attribute `type` will be set to the classname of the class (e.g. `App\Models\Cat`).
+
+Other than that there is no magic and a `Cat` or a `Dog` model will behave just like a normal Eloquent model. You can define cat or dog specific attributes and relationships on these models. An attribute only set for dogs for example should be a nullable column on the table, so that it is set for dogs but `null` for other pets.
+
+### Custom type column
+
+By default the name of the type column is `type`. However, you can set a custom type column name:
+
+```php
+use ProAI\Inheritance\Inheritance;
+
+class Pet extends Model
+{
+    use Inheritance;
+
+    protected static $inheritanceColumn = 'pet_type';
+}
+```
+
+### Custom type name
+
+If you want a different name than the classname, you can use the `$inheritanceType` property:
+
+```php
+class Cat extends Pet
+{
+    protected static $inheritanceType = 'cat';
+}
+```
+
+> Hint: The value of `$inheritanceType` can also be an enum value.
+
+## Support
+
+Bugs and feature requests are tracked on [GitHub](https://github.com/proai/eloquent-inheritance/issues).
+
+## License
+
+This package is released under the [MIT License](LICENSE).

composer.json

@@ -0,0 +1,38 @@
+{
+    "name": "proai/eloquent-versioning",
+    "description": "Single table inheritance for Laravel inspired by the Rails implementation",
+    "keywords": [
+        "laravel",
+        "orm",
+        "eloquent",
+        "single",
+        "table",
+        "inheritance"
+    ],
+    "homepage": "http://github.com/ProAI/eloquent-inheritance",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Markus J. Wetzel",
+            "email": "[email protected]"
+        }
+    ],
+    "require": {
+        "php": "^8.0",
+        "illuminate/support": "^9.0||^10.0"
+    },
+    "require-dev": {
+        "orchestra/testbench": "^7.0||^8.0",
+        "phpunit/phpunit": "^9.5.10||^10.0"
+    },
+    "autoload": {
+        "psr-4": {
+            "ProAI\\Inheritance\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "ProAI\\Inheritance\\Tests\\": "tests/"
+        }
+    }
+}

src/Inheritance.php

@@ -0,0 +1,96 @@
+<?php
+
+namespace ProAI\Inheritance;
+
+use Illuminate\Support\Str;
+
+trait Inheritance
+{
+    /**
+     * Defines the column name for use with single table inheritance.
+     *
+     * @var string
+     */
+    public static $inheritanceColumn = 'type';
+
+    /**
+     * Defines the type name for use with single table inheritance.
+     *
+     * @var mixed
+     */
+    public static $inheritanceType;
+
+    /**
+     * Bootstrap the inheritance trait.
+     *
+     * @return void
+     */
+    protected static function bootInheritance()
+    {
+        if (! static::modelInherited()) {
+            return;
+        }
+
+        static::addGlobalScope(function ($query) {
+            $query->where(static::$inheritanceColumn, static::getInheritanceType());
+        });
+
+        static::creating(function ($model) {
+            $model->{static::$inheritanceColumn} = static::getInheritanceType();
+        });
+    }
+
+    /**
+     * Check if model is inherited.
+     *
+     * @return bool
+     */
+    protected static function modelInherited()
+    {
+        return self::class !== static::class;
+    }
+
+    /**
+     * Get the column name for use with single table inheritance.
+     *
+     * @return mixed
+     */
+    protected static function getInheritanceType()
+    {
+        if (isset(static::$inheritanceType)) {
+            return static::$inheritanceType;
+        }
+
+        return static::$inheritanceType = static::class;
+    }
+
+    /**
+     * Get the table associated with the model.
+     *
+     * @return string
+     */
+    public function getTable()
+    {
+        return $this->table ?? Str::snake(Str::pluralStudly(class_basename($this->getRootClass())));
+    }
+
+    /**
+     * Get the default foreign key name for the model.
+     *
+     * @return string
+     */
+    public function getForeignKey()
+    {
+        return Str::snake(class_basename($this->getRootClass())).'_'.$this->getKeyName();
+    }
+
+    /**
+     * Get the class name of the root class.
+     *
+     * @return string
+     */
+    protected function getRootClass()
+    {
+        return self::class;
+    }
+}