Kappa\Doctrine

Collection of classes for better work with Doctrine, _(*2)

Requirements

Installation:

The best way to install Kappa\Doctrine is using Composer, _(*3)

$ composer require kappa/doctrine:@dev

Usages

Converter::entityToArray()

Method entityToArray requires entity object and returns Kappa\Doctrine\Converters\EntityToArrayConverter., _(*4)

setIgnoreList(array) - set list of items which you can ignore (ignore list and white list can be combined)
setWhiteList(array) - set list of items which you can transform (ignore list and white list can be combined)
addFieldResolver(column name, resolver) - you can set closure or concrete value for field
convert() - returns generated array

Example:, _(*5)

<?php
$user = new User("Joe");
$user->setParent(new User("Joe senior"))
    ->setAge(50);
    ->setPrivate("private");
$array = $converter->entityToArray($user)
    ->setIgnoreList(["private"])
    ->addFieldResolver("age", 10)
    ->addFieldResolver("parent", function(User $parent) { return $parent->getName(); })
    ->convert();
echo $array['name']; // print Joe
echo $array['parent']; // print Joe senior
echo $array['age']; // print 10

Converter::arrayToEntity()

Method arrayToEntity requires two argument. First argument can be entity object or entity class name and returns Kappa\Doctrine\Converters\ArrayToEntityConverter., _(*6)

setIgnoreList(array) - set list of items which you can ignore (ignore list and white list can be combined)
setWhiteList(array) - set list of items which you can transform (ignore list and white list can be combined)
addItemResolver(column name, resolver) - you can set closure or concrete value for item
convert() - returns generated array

Example:, _(*7)

$data = [
    'name' => 'Joe',
    'age' => 50, 
    'parent' => 1,
    'sex' => 'male',
    'private' => 'text',
];
$entity = $converter->arrayToEntity('User', $data)
    ->setIgnoreList(['private'])
    ->setWhiteList(['age', 'name', 'private'])
    ->setItemResolver('parent', function ($parent) {
        return $this->dao->find($parent);
    })
    ->setItemResolver('sex', 'female')
    ->convert();
echo $entity->getName(); // print Joe
echo $entity->getSex(); // print female
$entity->getParent(); // returns instance of User

CrudManager

Recommended way for create instance of Kappa\Doctrine\Managers\CrudManager is use Kappa\Managers\CrudManagerFactory., _(*8)

<?php
$crudManager = $this->crudManagerFactory->create(new User());
// or
$crudManager = $this->crudManagerFactory->create('Some\Entity\User');

Method create() requires only one argument which it can be instance of entity or full namespace name., _(*9)

Created CrudManager contains three methods for basic works with entity., _(*10)

create(array) - Create a new entity and fill with data
update(id, array) - Find entity by id and fill with data
delete(id) - Delete entity with id

FormItemsCreator

$form = new Form();
$form->addSelect('parent', 'Parent item: ', $this->formItemsCreator->create('\UserEntity', new GetAll());
// or
$user = new User();
$form->addSelect('parent', 'Parent item: ', $this->formItemsCreator->create($user, new GetAll());

$this->formItemsCreator->create('\UserEntity', new GetAll());

use default columns id and title and create array like this, _(*11)

$array = [
    '1' => 'John'
];

You can change default columns via config, _(*12)

doctrine:
    forms:
        items:
            identifierColumn: id
            valueColumn: name

or as a third and fourth argument, _(*13)

$this->formItemsCreator->create('\UserEntity', new GetAll(), 'name', 'id');

Third argument is valueColumn and last argument is identifierColumn, _(*14)

QueryExecutor

Time to time is needed run DQL query instead of manipulate with entity. Great way is build UPDATE (or DELETE) with QueryBuilder., _(*15)

Is very useful to create a query object for such cases. In Doctrine and Kdyby\Doctrine you can create SELECT query and run with $this->repository->fetch(new QueryObject) but UPDATE or DELETE query is not supported. QueryExecutor is precisely for these situations., _(*16)

Example:, _(*17)

<?php

class ExecutableQuery implements Executable
{
    /**
     * @param QueryBuilder $queryBuilder
     * @return QueryBuilder
     */
    public function build(QueryBuilder $queryBuilder)
    {
        $queryBuilder->update('KappaTests\Mocks\FormItemsEntity', 'r')
            ->set('r.title', $queryBuilder->expr()->literal('UPDATED'))
            ->where('r.id = ?0')
            ->setParameters(1);

        return $queryBuilder;
    }
}

// and

$this->queryExecutor->execute(new ExecutableQuery());

## RouteParamsResolver

You can use `Kappa\Doctrine\Routes\RouteParamsResolver` for easy works with `FILTER_IN/OUT` in your routes

**Example**

```php
<?php

class Router
{
    private $paramsResolver;

    public function __construct(RouteParamsResolverFactory $factory)
    {
        $this->paramsResolver = $factory->create('App\Entities\Article');
    }

    /**
     * @return \Nette\Application\IRouter
     */
    public function createRouter()
    {
        $router = new RouteList();
        $router[] = new Route('<presenter>/<action>[/<id>', [
            'presenter' => 'Homepage',
            'action' => 'default',
            'id' => [
                Route::FILTER_IN => [$this->paramsResolver, 'filterIn'],
                Route::FILTER_IN => [$this->paramsResolver, 'filterOut']
            ]
        ]);

        return $router;
    }
}