Загрузка LeanMapperQuery - Загрузка исходного кода LeanMapperQuery

LeanMapperQuery

Другие категории

Lean Mapper Query 1.3

Скачать

Запрос Lean Mapper

Lean Mapper Query — это концепция объекта запроса для библиотеки Lean Mapper, которая помогает создавать сложные запросы с использованием автоматических объединений ( идея взята из библиотеки NotORM ). Посмотрите предлагаемые базовые классы. Документацию на чешском языке можно найти в вики.

Функции

ведет себя как препроцессор SQL , поэтому доступно большинство выражений SQL.
автоматическое объединение с использованием точечной записи ( @book.tags.name )
возможность запрашивать репозитории или объекты
поддержка неявных фильтров

Установка

Его можно установить через Composer.

 composer require mbohuslavek/leanmapper-query

Что он делает?

Предположим, у нас есть следующие репозитории:

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

class BookRepository extends BaseRepository
{
}

и следующие субъекты:

 /**
 * @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
{
}

Строим запрос :

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

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

Теперь, если мы хотим получить все книги, автора которых зовут Карел, нам нужно сделать следующее:

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

Запрос к базе данных будет выглядеть так:

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

Вы можете видеть, что он выполняет автоматическое объединение с помощью точечной записи . Он поддерживает все типы отношений, известные Lean Mapper .

Использовать функции SQL очень просто. Мы можем обновить запрос следующим образом:

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

который изменяет запрос к базе данных на следующее:

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

Не повторяйся

Вы можете расширить класс Query и определить свои собственные методы.

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 );

Запрос сущностей

Также можно запросить свойство сущности ( в настоящее время только свойства с отношениями BelongsToMany или HasMany ). Давайте создадим класс 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
{
}

Обратите внимание, что BaseEntity должен расширять LeanMapperQuery Entity чтобы сделать возможным следующее.

Мы определили метод find как protected , поскольку, указав имя метода в свойстве $magicMethodsPrefixes , вы можете запрашивать такие сущности:

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

Волшебный метод findTags в конечном итоге вызовет ваш защищенный метод find с тегами в качестве первого аргумента.

Результирующий запрос к базе данных выглядит следующим образом:

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

Первое условие в where , [tag].[id] IN (1, 2) , берется из обхода объекта ( теги запрашиваются по собственным тегам этого конкретного объекта книги ).

Что еще вы можете сделать?

Если немного модифицировать BaseRepository и BaseEntity , то можно упростить работу с объектами запроса. Чтобы добиться этого, взгляните на предлагаемые базовые классы . Это делает возможным следующее.

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

// or...

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