LeanMapperQuery

Consulta do Mapeador Lean

Lean Mapper Query é um conceito de objeto de consulta para a biblioteca Lean Mapper que ajuda a construir consultas complexas usando junções automáticas ( ideia retirada da biblioteca NotORM ). Veja as classes base sugeridas. Para documentação tcheca, dê uma olhada no wiki.

Características

• comporta-se como um pré-processador SQL , portanto a maioria das expressões SQL estão disponíveis
• junções automáticas usando a notação de ponto ( @book.tags.name )
• capacidade de consultar repositórios ou entidades
• suporte para filtros implícitos

Instalação

Ele pode ser instalado via Composer.

 composer require mbohuslavek/leanmapper-query

O que isso faz?

Suponha que temos os seguintes repositórios:

 class BaseRepository extends LeanMapper Repository
{
	public function find ( Query $ query )
	{
		$ this -> createEntities ( $ query
			-> applyQuery ( $ this -> createFluent (), $ this -> mapper )
			-> fetchAll ()
		);
	}
}

class BookRepository extends BaseRepository
{
}

e as seguintes entidades:

 /**
 * @property int    $id
 * @property string $name
 */
class Tag extends LeanMapper Entity
{
}

/**
 * @property int      $id
 * @property Author   $author m:hasOne
 * @property Tag[]    $tags m:hasMany
 * @property DateTime $pubdate
 * @property string   $name
 * @property bool     $available
 */
class Book extends LeanMapper Entity
{
}

/**
 * @property int    $id
 * @property string $name
 * @property Book[] $books m:belongsToMany
 */
class Author extends LeanMapper Entity
{
}

Construímos uma consulta :

LeanMapperQueryQuery; $query->where('@author.name', 'Karel');">

 $ query = new LeanMapperQuery  Query ;
$ query -> where ( ' @author.name ' , ' Karel ' );

Agora, se quisermos obter todos os livros cujo nome do autor é Karel, temos que fazer o seguinte:

 $ bookRepository = new BookRepository (...);
$ books = $ bookRepository -> find ( $ query );

A consulta ao banco de dados ficará assim:

 SELECT [book]. *
FROM [book]
LEFT JOIN [author] ON [book].[author_id] = [author].[id]
WHERE ([author].[name] = ' Karel ' )

Você pode ver que ele realiza junções automáticas por meio da notação de ponto . Ele suporta todos os tipos de relacionamento conhecidos pelo Lean Mapper .

É muito fácil usar funções SQL. Podemos atualizar a consulta assim:

 $ query -> where ( ' DATE(@pubdate) > %d ' , ' 1998-01-01 ' );
$ books = $ bookRepository -> find ( $ query );

que altera a consulta do banco de dados para o seguinte:

 SELECT [book]. *
FROM [book]
LEFT JOIN [author] ON [book].[author_id] = [author].[id]
WHERE ([author].[name] = ' Karel ' ) AND ( DATE ([book].[pubdate]) > ' 1998-01-01 ' )

Não se repita

Você pode estender a classe Query e definir seus próprios métodos.

LeanMapperQueryQuery { public function restrictAvailable() { $this->where('@available', true) ->orderBy('@author.name'); return $this; } } ///////// $query = new BookQuery; $query->restrictAvailable(); $books = $this->bookRepository->find($query);">

 class BookQuery extends LeanMapperQuery Query
{
	public function restrictAvailable ()
	{
		$ this -> where ( ' @available ' , true )
			-> orderBy ( ' @author.name ' );
		return $ this ;
	}
}

/////////

$ query = new BookQuery ;
$ query -> restrictAvailable ();
$ books = $ this -> bookRepository -> find ( $ query );

Consultando entidades

Também é possível consultar uma propriedade de entidade ( atualmente apenas aquelas propriedades com relacionamentos BelongsToMany ou HasMany ). Vamos fazer a classe BaseEntity :

LeanMapperQueryEntity { protected static $magicMethodsPrefixes = ['find']; protected function find($field, Query $query) { $entities = $this->queryProperty($field, $query); return $this->entityFactory->createCollection($entities); } } /* * ... */ class Book extends BaseEntity { }">

 class BaseEntity extends LeanMapperQuery Entity
{
	protected static $ magicMethodsPrefixes = [ ' find ' ];

	protected function find ( $ field , Query $ query )
	{
		$ entities = $ this -> queryProperty ( $ field , $ query );
		return $ this -> entityFactory -> createCollection ( $ entities );
	}
}

/*
 * ...
 */
class Book extends BaseEntity
{
}

Observe que BaseEntity deve estender LeanMapperQuery Entity para tornar possível o seguinte.

Definimos o método find como protected porque especificando o nome do método na propriedade $magicMethodsPrefixes , você pode consultar entidades como esta:

 $ book ; // previously fetched instance of an entity from a repository
$ query = new LeanMapper  Query ;
$ query -> where ( ' @name != ' , ' ebook ' );
$ tags = $ book -> findTags ( $ query );

O método mágico findTags eventualmente chamará seu método protegido find com 'tags' como primeiro argumento.

A consulta de banco de dados resultante é semelhante a esta:

 SELECT [tag]. *
FROM [tag]
WHERE [tag].[id] IN ( 1 , 2 ) AND ([tag].[name] != ' ebook ' )

A primeira condição na cláusula where , [tag].[id] IN (1, 2) , é obtida da passagem da entidade ( as tags são consultadas em relação às próprias tags desta entidade de livro específica ).

O que mais você pode fazer?

Se modificarmos ligeiramente BaseRepository e BaseEntity , podemos simplificar o trabalho com objetos de consulta. Para conseguir isso, veja as classes base sugeridas . Isso torna possível o seguinte.

 $ books = $ bookRepository -> query ()
	-> where ( ' @author.name ' , ' Karel ' )
	-> where ( ' DATE(@pubdate) > ? ' , ' 1998-01-01 ' )
	-> find ();

// or...

$ tags = $ book -> queryTags ()
	-> where ( ' @name != ' , ' ebook ' )
	-> find ();

Licença

Copyright (c) 2013 Michal Bohuslávek

Licenciado sob a licença MIT.