PHPC-1070 and PHPC-1071: Report class name for unexpected object values #705
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jmikola
commented
Dec 14, 2017
| ); | ||
| zval_ptr_dtor(&obj_data); | ||
| #else | ||
| if (Z_TYPE_P(obj_data) != IS_ARRAY && !(Z_TYPE_P(obj_data) == IS_OBJECT && instanceof_function(Z_OBJCE_P(obj_data), zend_standard_class_def TSRMLS_CC))) { | ||
| phongo_throw_exception(PHONGO_ERROR_UNEXPECTED_VALUE TSRMLS_CC, | ||
| "Expected %s::%s() to return an array or stdClass, %s given", | ||
| Z_OBJCE_P(object)->name, | ||
| ZSTR_VAL(Z_OBJCE_P(object)->name), |
There was a problem hiding this comment.
Technically, this isn't necessary since we're in PHP 5 mode here, but it reduces some variation between the PHP 5 and 7 blocks. The only real difference in these blocks is that obj_data is a zval * for PHP 5.
jmikola
commented
Dec 14, 2017
| #else | ||
| Z_OBJCE_P(data)->name, | ||
| #endif | ||
| ZSTR_VAL(Z_OBJCE_P(data)->name), |
There was a problem hiding this comment.
We could have eliminated the #if block much earlier, but I just noticed this.
jmikola
commented
Dec 14, 2017
| (Z_TYPE_P(obj_data) == IS_OBJECT | ||
| ? Z_OBJCE_P(obj_data)->name | ||
| : zend_get_type_by_const(Z_TYPE_P(obj_data)) | ||
| PHONGO_ZVAL_CLASS_OR_TYPE_NAME_P(obj_data) |
There was a problem hiding this comment.
Only difference here is that obj_data is a zval * for PHP 5.
derickr
approved these changes
Dec 15, 2017
This was referenced Dec 15, 2017
Merged
This only updates exceptions where object types are entirely unexpected. For instance, options that expect a BSON document (i.e. array or object) need not use this macro, as any object would be accepted.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
https://jira.mongodb.org/browse/PHPC-1070
https://jira.mongodb.org/browse/PHPC-1071
Adds a macro for accessing zval's class or type name, depending on whether it's an object type. This replaces existing ternary statements we had for some BSON exceptions. I've also gone through and updated exceptions where object types are entirely unexpected. Options that expect a BSON document (i.e. array or object) remain unchanged and do not use this macro, as any object type would be accepted.
IMO, this makes the exceptions more helpful and also makes PHPC more consistent with the invalid type exception messages in PHPLIB.