desmart / laravel-domain-core
DeSmart core DDD package for Laravel
Installs: 1 097
Dependents: 0
Suggesters: 0
Security: 0
Stars: 3
Watchers: 14
Forks: 2
Open Issues: 0
Requires
- php: >=5.6.0
- illuminate/container: ^5.2
- illuminate/database: ^5.2
- illuminate/events: ^5.2
- illuminate/log: ^5.2
- illuminate/support: ^5.2
- netresearch/jsonmapper: 0.10.*
- psr/log: ^1.0
Requires (Dev)
- phpspec/phpspec: ^2.4
README
Hydrating models to entities
Models should use DeSmart\DomainCore\ConvertsToEntityTrait
. It gives toEntity()
method which tries to convert the model to entity.
Entity class name
Entity class name is based on model class name. The convention here is:
Module\Model\SomeModel -> Module\Entity\SomeModelEntity
Entity class name can be changed. Simply set $entityClassName
attribute in model definition.
Passing data to entity
Model is converted to array, and through JsonMapper
all entity properties are set.
Passing related models to entity
toEntity()
will also map related models to proper entites.
It's done similar to JsonMapper
.
If needed some relations can be converted through a dedicated method. Simply create [relationName]ToEntity
method inside your model.
One-to-many relations have to represented as type hinted variadic argument in entity (see example below).
Example
<?php class User extends \Illuminate\Database\Eloquent\Model { use ConvertsToEntityTrait; public function files() { return $this->hasMany(File::class); } public function bio() { return $this->hasOne(Bio::class); } public function avatar() { return $this->files() ->where('is_avatar', 1); } public function avatarToEntity(File $avatar, UserEntity $user) { return new Avatar($file->toEntity()); } } class UserEntity { public function setFiles(FileEntity ...$files) { $this->files = $files; } public function setBio(BioEntity $bio) { $this->bio = $bio; } public function setAvatar(Avatar $avatar) { $this->avatar = $avatar; } }
Querying Collections
Example
<?php class UserEntitiesRepository { use ConvertsCollectionToEntitiesTrait; /** @var User */ private $query; public function __construct(User $user) { $this->query = $user; } /** * @param CriteriaCollectionInterface $criteriaCollection * @return UserEntity[] */ public function getAllMatching(CriteriaCollectionInterface $criteriaCollection) { /** @var \Illuminate\Database\Eloquent\Builder $builder */ $builder = $this->getQueryBuilder(); $queryBuilder = $builder->getQuery(); $queryBuilder->select($this->query->getTable() . '.*'); foreach ($criteriaCollection->getAll() as $criterion) { $criterion->apply($builder); } $collection = $builder->get(); return $this->convertCollectionToEntities($collection); } } class WithIdsCriterion implements \DeSmart\DomainCore\Repository\Criteria\CriterionInterface { /** @var array */ protected $ids; /** * @param array $ids */ public function __construct(array $ids) { $this->ids = $ids; } /** * @param \Illuminate\Database\Eloquent\Builder $query * @return mixed */ public function apply($query) { $idsList = array_map(function ($id) { return "'{$id}'"; }, $this->ids); $query->whereIn($query->getModel()->getQualifiedKeyName(), $this->ids); if (false === empty($idsList)) { $query->orderBy(\DB::raw("FIELD ({$query->getModel()->getQualifiedKeyName()}," . implode(',', $idsList) . ")")); } return $query; } } $criteriaCollection = new \DeSmart\DomainCore\Repository\Criteria\CriteriaCollection(); $usersRepository = new UsersRepository(new User()); $criteriaCollection->add( new WithIdsCriterion([1, 2, 3]) ); $users = $usersRepository->getAllMatchingCriteria($criteriaCollection);