LeanMapperQueryダウンロード - LeanMapperQueryソースコードのダウンロード

LeanMapperQuery

その他のカテゴリー

Lean Mapper Query 1.3

ダウンロード

リーンマッパークエリ

Lean Mapper Query は、自動結合を使用して複雑なクエリを構築するのに役立つ Lean Mapper ライブラリのクエリオブジェクトの概念です ( NotORM ライブラリから取得したアイデア)。提案された基本クラスを見てください。チェコ語のドキュメントについては、wiki を参照してください。

特徴

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

さて、著者名が 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拡張する必要があることに注意してください。

$magicMethodsPrefixesプロパティにメソッド名を指定することで、次のようにエンティティをクエリできるため、 findメソッドをprotectedとして定義しました。

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

マジックメソッドfindTags最終的に、最初の引数として「tags」を指定して保護されたメソッド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 ();