This repository was archived by the owner on Aug 22, 2023. It is now read-only.
Add header documentation for classes & traits that can be used in applications #12
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
GromNaN
commented
Jul 12, 2023
| @@ -46,7 +46,7 @@ public function get($model, string $key, $value, array $attributes) | |||
| * @param string $key | |||
| * @param mixed $value | |||
| * @param array $attributes | |||
| * @return mixed | |||
| * @return Binary | |||
There was a problem hiding this comment.
By reading the code, Binary is the only possible return type.
| /** | ||
| * Cross-database relationships between SQL and MongoDB. | ||
| * Use this trait in SQL models to define relationships with MongoDB models. | ||
| */ |
| * @param mixed $column | ||
| * @param mixed $value | ||
| * @param bool $unique | ||
| * @param string|array $column |
There was a problem hiding this comment.
If not an array, $column is used as array key.
| @@ -818,14 +818,14 @@ public function push($column, $value = null, $unique = false) | |||
| /** | |||
| * Remove one or more values from an array. | |||
| * | |||
| * @param mixed $column | |||
| * @param mixed $value | |||
| * @param string|array $column | |||
There was a problem hiding this comment.
If not an array, $column is used as array key.
alcaeus
suggested changes
Jul 13, 2023
src/Eloquent/Model.php
Outdated
| @@ -56,7 +56,7 @@ abstract class Model extends BaseModel | |||
| * Custom accessor for the model's id. | |||
| * | |||
| * @param mixed $value | |||
| * @return mixed | |||
| * @return string | |||
There was a problem hiding this comment.
I believe this is incorrect: any value other than ObjectId or Binary instances will be left as-is, so the return type is indeed mixed. Consider having a numeric identifier, which will be returned as int.
GromNaN
added a commit
that referenced
this pull request
Aug 22, 2023
…lications (#12) * Add header documentation for classes & traits that can be used in applications * Precise mixed types when possible
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This is the case for
CollectionandConnectionwhich are decorators for MongoDB objects.