Move model to a trait #2580
Move model to a trait #2580
Conversation
|
Currently, the |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
GromNaN
force-pushed
the
model-trait
branch
3 times, most recently
from
5d0d693
to
2163745
Compare
| @@ -76,699 +28,10 @@ abstract class Model extends BaseModel | |||
| */ | |||
| protected $keyType = 'string'; | |||
There was a problem hiding this comment.
When the trait is used, the properties $keyType and $primaryKey must be defined, because they can't be redefined by the trait.
| /** @inheritdoc */ | ||
| public function getTable() | ||
| { | ||
| return $this->collection ?? parent::getTable(); |
There was a problem hiding this comment.
This property is not defined in the trait, otherwise it's allowed to redefine in the class that uses the trait.
| /** | ||
| * The parent relation instance. | ||
| */ | ||
| private Relation $parentRelation; |
There was a problem hiding this comment.
Changing the visibility to private. There is a getter and an setter for this method. It doesn't need to be protected. Since it's a trait, it can still be accessed directly in a class that uses the trait.
| */ | ||
| public function unset($columns) | ||
| public static function isDocumentModel(string|object $related): bool |
There was a problem hiding this comment.
This method replaces $class instanceof MongoDB\Laravel\Eloquent\Model to check if the model class is for a MongoDB connection. It is public and can be used in projects.
| { | ||
| use DocumentModel; |
There was a problem hiding this comment.
All the test models have been updated to use the trait, so that we are sure all the features works without extending MongoDB\Laravel\Eloquent\Model.
Fix #2120
By moving all the logic to a trait, it make it possible to reuse entities provided by community projects. Example: https://github.com/z-song/laravel-admin/blob/master/src/Auth/Database/Administrator.php
The properties
$primaryKeyand$keyTypecan't be in the trait because PHP forbid declaring a property in a trait that is different (type and value) than the property declared in the parent class.I have mixed feelings about this change, as it breaks the link with the overloaded parent methods. It would probably be better to make the change in each community-package when necessary.