[5.2] Model casting to any object #11225

bkuhl · 2015-12-07T01:08:40Z

The intended functionality of this PR is to provide the ability to cast to any object. A great example of where this would be useful is user settings when they are stored as json in a users.settings column. Having the json converted to an object allows one to easily define the default values for settings and a streamlined method of accessing these settings.

Here's an example:

class User extends Model {
    protected $casts = [
        'settings' => Settings::class
    ];
}

class Settings extends Fluent
{
    public function __construct($attributes = [])
    {
        if (!is_null($attributes)) {
            parent::__construct($attributes);
        }
    }

    public function timeszone()
    {
        return $this->get('timezone', 'America/Kentucky/Louisville');
    }
}

Currently I'm experiencing an issue with a unit test am I'm unsure how to mock app(). Thus a test is failing:

PHP Fatal error:  Call to a member function getBindings() on null in /Users/bkuhl/Personal/framework/src/Illuminate/Database/Eloquent/Model.php on line 2825

I'd like to add another assertion or two once I can get passed this issue.

Nitpick-CI · 2015-12-07T01:36:30Z

src/Illuminate/Database/Eloquent/Model.php

+                class_exists($this->casts[$key]) ||
+                in_array($key, app()->getBindings())
+            )
+        ) {


Expected 1 newline after opening brace; 2 found

JosephSilber · 2015-12-07T02:53:58Z

Wouldn't it be better to just have a default block in that switch statement that calls castTo{type}?

bkuhl · 2015-12-07T02:59:43Z

Currently if it's null, it bypasses object mapping altogether. In the use case I provided, I'd still want to get an instance of Settings when it's null so that the object can decide what to do.

AdenFraser · 2015-12-07T03:08:43Z

I think the ability to extend castAttribute with custom cast types would be very helpful, and perhaps a better route to acheive the functionality you are after and offer greater flexibility for others?

If a check was made for a custom attribute cast type before both the check of a null value and the getCastType switch, it would be possible to create custom cast types for objects (including null objects), serialzed objects (which are not currenty supported) and any other implementations (binary, CSV, bson etc.)

GrahamCampbell · 2015-12-07T18:20:47Z

tests/Database/DatabaseEloquentModelTest.php

@@ -3,6 +3,7 @@
 use Mockery as m;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\Relation;
+use Illuminate\Support\Fluent;


please sort by length

GrahamCampbell · 2015-12-07T18:22:09Z

👎

GrahamCampbell · 2015-12-07T18:22:27Z

This involves using the application object that eloquent shouldn't know about.

taylorotwell · 2015-12-07T20:04:12Z

Yeah, we probably won't be able to have access to the container from within Eloquent.

Probably the only option I can think of is to simply pass the raw database value into the object just using like new Settings($rawValue). And you can do whatever you want in the Settings constructor.

One thing I'm wondering about is how do you cast back for storage... like if I do:

$model = Model::find(1);
$model->settings = new Settings('something');
$model->save();

How do I know what to make settings in the database?

bkuhl · 2015-12-07T20:14:14Z

I appreciate the feedback. I did miss this in the implementation, but my thought was that casted objects would need to implement Jsonable. I see the challenges with the IOC container... maybe this functionality is best staying in a Laravel package.

GrahamCampbell changed the title ~~Pushing code up to share~~ [5.2] Pushing code up to share Dec 7, 2015

bkuhl changed the title ~~[5.2] Pushing code up to share~~ [5.2] Model casting to any object Dec 7, 2015

Nitpick-CI reviewed Dec 7, 2015
View reviewed changes

Pushing code up to share

cd0b695

GrahamCampbell reviewed Dec 7, 2015
View reviewed changes

bkuhl closed this Dec 8, 2015

bkuhl deleted the casting-any-object branch September 17, 2017 22:24

antonkomarev mentioned this pull request Dec 28, 2019

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

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[5.2] Model casting to any object #11225

[5.2] Model casting to any object #11225

bkuhl commented Dec 7, 2015

Nitpick-CI Dec 7, 2015

JosephSilber commented Dec 7, 2015

bkuhl commented Dec 7, 2015

AdenFraser commented Dec 7, 2015

GrahamCampbell Dec 7, 2015

GrahamCampbell commented Dec 7, 2015

GrahamCampbell commented Dec 7, 2015

taylorotwell commented Dec 7, 2015

bkuhl commented Dec 7, 2015

[5.2] Model casting to any object #11225

[5.2] Model casting to any object #11225

Conversation

bkuhl commented Dec 7, 2015

Nitpick-CI Dec 7, 2015

Choose a reason for hiding this comment

JosephSilber commented Dec 7, 2015

bkuhl commented Dec 7, 2015

AdenFraser commented Dec 7, 2015

GrahamCampbell Dec 7, 2015

Choose a reason for hiding this comment

GrahamCampbell commented Dec 7, 2015

GrahamCampbell commented Dec 7, 2015

taylorotwell commented Dec 7, 2015

bkuhl commented Dec 7, 2015