[6.x] Added creation of custom Cast classes for Eloquent

src/Illuminate/Contracts/Database/Eloquent/Castable.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Illuminate\Contracts\Database\Eloquent;
+
+interface Castable
+{
+    /**
+     * Get a given attribute from the model.
+     *
+     * @param  string  $key
+     * @param  mixed  $value
+     * @return mixed
+     */
+    public function fromDatabase($key, $value = null);
+
+    /**
+     * Set a given attribute on the model.
+     *
+     * @param  string  $key
+     * @param  mixed  $value
+     * @return mixed
+     */
+    public function toDatabase($key, $value = null);
+}

src/Illuminate/Database/Eloquent/Concerns/HasAttributes.php

@@ -4,6 +4,8 @@
 
 use Carbon\CarbonInterface;
 use DateTimeInterface;
+use Illuminate\Container\Container;
+use Illuminate\Contracts\Database\Eloquent\Castable;
 use Illuminate\Contracts\Support\Arrayable;
 use Illuminate\Database\Eloquent\JsonEncodingException;
 use Illuminate\Database\Eloquent\Relations\Relation;
@@ -79,10 +81,18 @@ trait HasAttributes
      */
     protected static $mutatorCache = [];
 
+    /**
+     * Initialized instances of custom casts.
+     *
+     * @var \Illuminate\Contracts\Database\Eloquent\Castable[]
+     */
+    protected static $castsCache = [];
+
     /**
      * Convert the model's attributes to an array.
      *
      * @return array
+     * @throws \Illuminate\Contracts\Container\BindingResolutionException
      */
     public function attributesToArray()
     {
@@ -169,6 +179,7 @@ protected function addMutatedAttributesToArray(array $attributes, array $mutated
      * @param  array  $attributes
      * @param  array  $mutatedAttributes
      * @return array
+     * @throws \Illuminate\Contracts\Container\BindingResolutionException
      */
     protected function addCastAttributesToArray(array $attributes, array $mutatedAttributes)
     {
@@ -308,6 +319,7 @@ protected function getArrayableItems(array $values)
      *
      * @param  string  $key
      * @return mixed
+     * @throws \Illuminate\Contracts\Container\BindingResolutionException
      */
     public function getAttribute($key)
     {
@@ -338,6 +350,7 @@ public function getAttribute($key)
      *
      * @param  string  $key
      * @return mixed
+     * @throws \Illuminate\Contracts\Container\BindingResolutionException
      */
     public function getAttributeValue($key)
     {
@@ -474,9 +487,14 @@ protected function mutateAttributeForArray($key, $value)
      * @param  string  $key
      * @param  mixed  $value
      * @return mixed
+     * @throws \Illuminate\Contracts\Container\BindingResolutionException
      */
     protected function castAttribute($key, $value)
     {
+        if ($this->isCustomCastable($key)) {
+            return $this->fromCustomCastable($key, $value);
+        }
+
         if (is_null($value)) {
             return $value;
         }
@@ -523,15 +541,17 @@ protected function castAttribute($key, $value)
      */
     protected function getCastType($key)
     {
-        if ($this->isCustomDateTimeCast($this->getCasts()[$key])) {
+        $cast = $this->getCast($key);
+
+        if ($this->isCustomDateTimeCast($cast)) {
             return 'custom_datetime';
         }
 
-        if ($this->isDecimalCast($this->getCasts()[$key])) {
+        if ($this->isDecimalCast($cast)) {
             return 'decimal';
         }
 
-        return trim(strtolower($this->getCasts()[$key]));
+        return trim(strtolower($cast));
     }
 
     /**
@@ -557,12 +577,28 @@ protected function isDecimalCast($cast)
         return strncmp($cast, 'decimal:', 8) === 0;
     }
 
+    /**
+     * Is the checked value a custom Cast.
+     *
+     * @param  string  $key
+     * @return bool
+     */
+    protected function isCustomCastable($key)
+    {
+        if ($cast = $this->getCast($key)) {
+            return is_subclass_of($cast, Castable::class);
+        }
+
+        return false;
+    }
+
     /**
      * Set a given attribute on the model.
      *
      * @param  string  $key
      * @param  mixed  $value
      * @return mixed
+     * @throws \Illuminate\Contracts\Container\BindingResolutionException
      */
     public function setAttribute($key, $value)
     {
@@ -580,6 +616,12 @@ public function setAttribute($key, $value)
             $value = $this->fromDateTime($value);
         }
 
+        // If the attribute is specified as Cast, we will convert it according to
+        // the method specified in it.
+        if ($this->isCustomCastable($key)) {
+            $value = $this->toCustomCastable($key, $value);
+        }
+
         if ($this->isJsonCastable($key) && ! is_null($value)) {
             $value = $this->castAttributeAsJson($key, $value);
         }
@@ -929,6 +971,17 @@ public function getCasts()
         return $this->casts;
     }
 
+    /**
+     * Get the cast from casts array.
+     *
+     * @param  string  $key
+     * @return string|null
+     */
+    public function getCast($key)
+    {
+        return $this->getCasts()[$key] ?? null;
+    }
+
     /**
      * Determine whether a value is Date / DateTime castable for inbound manipulation.
      *
@@ -951,6 +1004,53 @@ protected function isJsonCastable($key)
         return $this->hasCast($key, ['array', 'json', 'object', 'collection']);
     }
 
+    /**
+     * Getting the execution result from a user Cast object.
+     *
+     * @param  string  $key
+     * @param  mixed  $value
+     * @return mixed
+     * @throws \Illuminate\Contracts\Container\BindingResolutionException
+     */
+    protected function fromCustomCastable($key, $value = null)
+    {
+        return $this
+            ->normalizeCastToCallable($key)
+            ->fromDatabase($key, $value);
+    }
+
+    /**
+     * Converting a value by custom Cast.
+     *
+     * @param  string  $key
+     * @param  mixed  $value
+     * @return mixed
+     * @throws \Illuminate\Contracts\Container\BindingResolutionException
+     */
+    protected function toCustomCastable($key, $value = null)
+    {
+        return $this
+            ->normalizeCastToCallable($key)
+            ->toDatabase($key, $value);
+    }
+
+    /**
+     * Getting a custom cast instance.
+     *
+     * @param  string  $key
+     * @return \Illuminate\Contracts\Database\Eloquent\Castable
+     * @throws \Illuminate\Contracts\Container\BindingResolutionException
+     */
+    protected function normalizeCastToCallable($key)
+    {
+        if (! isset(static::$castsCache[$key])) {
+            static::$castsCache[$key] = Container::getInstance()
+                ->make($this->getCast($key));
+        }
+
+        return static::$castsCache[$key];
+    }
+
     /**
      * Get all of the current attributes on the model.
      *
@@ -996,6 +1096,7 @@ public function getOriginal($key = null, $default = null)
      *
      * @param  array|mixed  $attributes
      * @return array
+     * @throws \Illuminate\Contracts\Container\BindingResolutionException
      */
     public function only($attributes)
     {
@@ -1052,6 +1153,7 @@ public function syncOriginalAttributes($attributes)
      * Sync the changed attributes.
      *
      * @return $this
+     * @throws \Illuminate\Contracts\Container\BindingResolutionException
      */
     public function syncChanges()
     {
@@ -1065,6 +1167,7 @@ public function syncChanges()
      *
      * @param  array|string|null  $attributes
      * @return bool
+     * @throws \Illuminate\Contracts\Container\BindingResolutionException
      */
     public function isDirty($attributes = null)
     {
@@ -1078,6 +1181,7 @@ public function isDirty($attributes = null)
      *
      * @param  array|string|null  $attributes
      * @return bool
+     * @throws \Illuminate\Contracts\Container\BindingResolutionException
      */
     public function isClean($attributes = null)
     {
@@ -1129,6 +1233,7 @@ protected function hasChanges($changes, $attributes = null)
      * Get the attributes that have been changed since last sync.
      *
      * @return array
+     * @throws \Illuminate\Contracts\Container\BindingResolutionException
      */
     public function getDirty()
     {
@@ -1159,6 +1264,7 @@ public function getChanges()
      * @param  string  $key
      * @param  mixed  $current
      * @return bool
+     * @throws \Illuminate\Contracts\Container\BindingResolutionException
      */
     public function originalIsEquivalent($key, $current)
     {

src/Illuminate/Foundation/Console/CastMakeCommand.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace Illuminate\Foundation\Console;
+
+use Illuminate\Console\GeneratorCommand;
+
+class CastMakeCommand extends GeneratorCommand
+{
+    /**
+     * The console command name.
+     *
+     * @var string
+     */
+    protected $name = 'make:cast';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Create a new custom Eloquent attribute caster';
+
+    /**
+     * The type of class being generated.
+     *
+     * @var string
+     */
+    protected $type = 'Cast';
+
+    /**
+     * Get the stub file for the generator.
+     *
+     * @return string
+     */
+    protected function getStub()
+    {
+        return __DIR__.'/stubs/cast.stub';
+    }
+
+    /**
+     * Get the default namespace for the class.
+     *
+     * @param string $rootNamespace
+     *
+     * @return string
+     */
+    protected function getDefaultNamespace($rootNamespace)
+    {
+        return $rootNamespace.'\Casts';
+    }
+}

src/Illuminate/Foundation/Console/stubs/cast.stub

@@ -0,0 +1,32 @@
+<?php
+
+namespace DummyNamespace;
+
+use Illuminate\Contracts\Database\Eloquent\Castable;
+
+class DummyClass implements Castable
+{
+    /**
+     * Get a given attribute from the model.
+     *
+     * @param  string  $key
+     * @param  mixed  $value
+     * @return mixed
+     */
+    public function fromDatabase($key, $value = null)
+    {
+        return $value;
+    }
+
+    /**
+     * Set a given attribute on the model.
+     *
+     * @param  string  $key
+     * @param  mixed  $value
+     * @return mixed
+     */
+    public function toDatabase($key, $value = null)
+    {
+        return $value;
+    }
+}

src/Illuminate/Foundation/Providers/ArtisanServiceProvider.php

@@ -13,6 +13,7 @@
 use Illuminate\Database\Console\Seeds\SeedCommand;
 use Illuminate\Database\Console\Seeds\SeederMakeCommand;
 use Illuminate\Database\Console\WipeCommand;
+use Illuminate\Foundation\Console\CastMakeCommand;
 use Illuminate\Foundation\Console\ChannelMakeCommand;
 use Illuminate\Foundation\Console\ClearCompiledCommand;
 use Illuminate\Foundation\Console\ConfigCacheCommand;
@@ -130,6 +131,7 @@ class ArtisanServiceProvider extends ServiceProvider implements DeferrableProvid
         'MailMake' => 'command.mail.make',
         'MiddlewareMake' => 'command.middleware.make',
         'ModelMake' => 'command.model.make',
+        'CastMake' => 'command.cast.make',
         'NotificationMake' => 'command.notification.make',
         'NotificationTable' => 'command.notification.table',
         'ObserverMake' => 'command.observer.make',
@@ -486,6 +488,18 @@ protected function registerModelMakeCommand()
         });
     }
 
+    /**
+     * Register the command.
+     *
+     * @return void
+     */
+    protected function registerCastMakeCommand()
+    {
+        $this->app->singleton('command.cast.make', function ($app) {
+            return new CastMakeCommand($app['files']);
+        });
+    }
+
     /**
      * Register the command.
      *