Laravel cast array still returns a string

Question

When retrieving a column I'd like to get it as an array, however it's returned as a string.

Migration

$table->text('balance')->nullable();

On the model (as per the Laravel docs)

protected $casts = [
   'balance' => 'array',
];

When saving data to the balance column

$exchange = Exchange::findOrFail($id);
$exchange->balance = json_encode($balance);
$exchange->save();

When retrieving the model

$exchanges = Exchange::orderBy('title')->get();

In the view

foreach($exchanges as $ex)
   echo gettype($ex->balance) // This returns string, not an array
endforeach

I'm puzzled as to why it's still a string while it should be an array. I've also tried the json instead of text column type in the migration, same result.

Kenny Horna · Accepted Answer · 2019-05-17 21:36:17Z

6

If you config your model to cast an attribute to array, you don't need to convert it back to json when trying to store it, Laravel will handle this for you. From the docs:

Array & JSON Casting

...

Once the cast is defined, you may access the options attribute and it will automatically be deserialized from JSON into a PHP array. When you set the value of the options attribute, the given array will automatically be serialized back into JSON for storage:
$user = App\User::find(1);

$options = $user->options;

$options['key'] = 'value';

$user->options = $options;

$user->save();

So in your case:

$exchange = Exchange::findOrFail($id);
$exchange->balance = ['your', 'values', 'as', 'an', 'array'];
$exchange->save();

answered May 17, 2019 at 21:36

Kenny Horna

14.3k5 gold badges49 silver badges74 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Bruno Tomé · Accepted Answer · 2019-05-17 21:58:23Z

2

You can remove the cast and implement an accessor method on the Exchange model:

public function getBalanceAttribute($value)
{
    return json_decode($value);
}

And consume normally like you want:

foreach($exchanges as $ex)
   echo gettype($ex->balance)
endforeach

edited May 17, 2019 at 21:58

answered May 17, 2019 at 21:36

Bruno Tomé

5901 gold badge8 silver badges25 bronze badges

3 Comments

eskimo Over a year ago

If I use the accessor method it returns an Object, not an array?

Adam Rodriguez Over a year ago

I like this approach. I feel it gives you better flexibility with the data. You can even add the setBalanceAttribute method to json_encode your value.

Andrew Over a year ago

@eskimo Try using json_decode($value, true) to return an array instead of an object.

Collectives™ on Stack Overflow

Laravel cast array still returns a string

2 Answers 2

Array & JSON Casting

Comments

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related