PHPC-640: Create interfaces for BSON types classes #621
Conversation
jmikola
force-pushed
the
phpc-640
branch
4 times, most recently
from
6803c0e to
f6650bb
Compare
| $myDecimal = new MyDecimal128('1234.5678'); | ||
|
|
||
| echo "\nTesting MyDecimal128 and Decimal128 are equivalent\n"; | ||
| var_dump((string) $decimal === (string) $myDecimal); |
There was a problem hiding this comment.
Note: __toString() is the only way to obtain the value of Decimal128 and ObjectID objects. The method is merely a convenience for Binary, Javascript, Regex, Timestamp, and UTCDateTime (note: it is the easiest way to obtain a UTCDateTime's milliseconds). It does not apply at all for MaxKey and MinKey.
I originally decided not to add it to the type-specific interfaces, as I didn't like the idea of incorporating a magic method into an interface (one could say the same about __debugInfo() if PHPC-470 was already merged). However, I'm not wondering if it makes sense to add it. I also purposefully omitted JsonSerializable and Serializable, am plan to simply suggest that users also implement those in their custom wrapper classes if desired.
There was a problem hiding this comment.
We discussed this while doing the HHVM versions, and this is what the conclusion was I believe: https://github.com/mongodb/mongo-hhvm-driver/blob/master/ext_mongodb.php#L1182
There was a problem hiding this comment.
Added __toString() to all interfaces except MinKey and MaxKey.
| throw new InvalidArgumentException('Cannot create MyUTCDateTime from ' . get_class($type)); | ||
| } | ||
|
|
||
| return new self((string) $type); |
There was a problem hiding this comment.
A string cast is necessary to avoid UTCDateTime::__construct() throwing an exception because its object argument is not a DateTime instance. This issue didn't come up in the Decimal128 and ObjectID tests, as we only parse the argument as a string and PHP happily calls __toString() on the object argument for us.
I don't think this is anything we need to fix, as this is all consistent with UTCDateTime's documentation and the Decimal128 and ObjectID behavior is just a happy coincidence.
jmikola
changed the title
These interfaces are implemented by the corresponding BSON classes and intended to be used by TypeWrapper implementations.
If the userland function throws, we should return early and avoid assigning the uninitialized return value (zwrapper) to zchild. On PHP 5.x, such an assignment could cause a segfault.
https://jira.mongodb.org/browse/PHPC-640
https://jira.mongodb.org/browse/PHPC-988
These interfaces are implemented by the corresponding BSON classes and intended to be used by TypeWrapper implementations.
TODO: