Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Small but useful. Entity class. #1176 #1186

Closed
wants to merge 13 commits into from
+123 −5
Closed

Small but useful. Entity class. #1176 #1186

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
5451c1a
Small but useful. Entity class. #1176
nowackipawel Aug 30, 2018
31843fd
entity cast json / json-array docs
nowackipawel Sep 2, 2018
e3a52a8
Adding support for system/Exceptions/CastException
nowackipawel Sep 11, 2018
fc93a03
language file (Cast) for system/Exception/CastException.php
nowackipawel Sep 11, 2018
5fcd663
Update Cast.php
nowackipawel Sep 11, 2018
8496c6b
Update Cast.php
nowackipawel Sep 11, 2018
7fd144f
Update Cast.php
nowackipawel Sep 11, 2018
90ba7bb
Cast exceptions
nowackipawel Sep 11, 2018
96a9d12
Update CastException.php
nowackipawel Sep 11, 2018
ad7c74f
Update Entity.php
nowackipawel Sep 11, 2018
919b3bd
Update CastException.php
nowackipawel Sep 11, 2018
cdaffdd
Keys: Cast.stringName => stringName
nowackipawel Sep 12, 2018
33395e5
improvments
nowackipawel Sep 14, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions system/Entity.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,14 @@ public function __set(string $key, $value = null)
$value = serialize($value);
}

// JSON casting requires that we JSONize the value
// when setting it so that it can easily be stored
// back to the database.
if (function_exists('json_encode') && array_key_exists($key, $this->_options['casts']) && ($this->_options['casts'][$key] === 'json' || $this->_options['casts'][$key] === 'json-array'))
{
$value = json_encode($value);
}

// if a set* method exists for this key,

// use that method to insert this value.

$method = 'set' . str_replace(' ', '', ucwords(str_replace(['-', '_'], ' ', $key)));
Expand Down Expand Up @@ -388,6 +396,22 @@ protected function castAs($value, string $type)
$value = unserialize($value);
}

$value = (array)$value;
break;
case 'json':
if (function_exists('json_decode') && is_string($value) && (strpos($value, '[') === 0 || strpos($value, '{') === 0))
{
$value = json_decode($value, false);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should check the json_error_code here, also, to ensure it's valid json, or throw an exception otherwise, so the developer knows what went wrong.

Copy link
Contributor Author

@nowackipawel nowackipawel Aug 30, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Firstly I am not convinced about throwing exception when case 'array' won't throw anything when serialized array is formatted incorrectly.

Secondly if you think it is really required to throw exception with json (let me say more, I do not see any proper exception in CI that I could throw in this case; should I use "Config Exception" and a new Language/en/Entuty.php file dedicated to it?) then we have to clarify that
json_error_code() will return error if $value is null; what could be very likely case when data is retrieved from database. Do you reckon we should treat NULL value as exception or just ignore it? I bet: ignore it, as we do in the moment.

--
i will add docs and test in tmrw.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a fair point about the array - except that PHP itself will throw exceptions if the serialization fails, while I'm pretty sure json_encode doesn't throw an exception, it just returns false, leaving it to us to throw that ourself.

Yes - I do agree that we ignore nulls like we currently do, because that's a possible valid response from a database query.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

exception + language (messages) files added and docs modified

}

$value = (object)$value;
break;
case 'json-array':
if (function_exists('json_decode') && is_string($value) && (strpos($value, '[') === 0 || strpos($value, '{') === 0))
{
$value = json_decode($value, true);
}

$value = (array)$value;
break;
case 'datetime':
Expand Down