PHP 클래스 Doctrine\Search\Query

파일 보기 프로젝트 열기: doctrine/search 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$cacheLifetime integer
$count integer
$entityClasses array
$facets array
$hydrationMode integer
$hydrationParameter string
$hydrationQuery object
$query object
$sm Doctrine\Search\SearchManager
$useResultCache boolean

공개 메소드들

메소드 설명
__call ( string $method, array $arguments ) Magic method to pass query building to the underlying query object, saving the need to abstract.
__construct ( Doctrine\Search\SearchManager $sm )
addFrom ( string $entityClass ) Add a searchable entity class to search against.
count ( ) Return the total hit count for the given query as provided by the search engine.
from ( mixed $entityClasses ) Specifies the searchable entity class to search against.
getFacets ( ) : array
getResult ( integer $hydrationMode = null ) : mixed Execute search and hydrate results if required.
getSingleResult ( integer $hydrationMode = null ) : mixed Execute search for single result and hydrate results if required.
hydrateWith ( object $hydrationQuery, string $parameter = null ) Set a custom Doctrine Query to execute in order to hydrate the search engine results into required entities. The assumption is made the the search engine result id is correlated to the entity id. An optional query parameter override can be specified.
searchWith ( mixed $query ) Set the query object to be executed on the search engine
setHydrationMode ( integer $mode ) Set the hydration mode from the underlying query modes or bypass and return search result directly from the client
useResultCache ( boolean $useCache, integer $cacheLifetime = null ) If hydrating with Doctrine then you can use the result cache on the default or provided query

보호된 메소드들

메소드 설명
getHydrationQuery ( ) : object Return a provided hydration query
getSearchManager ( )

메소드 상세

__call() 공개 메소드

Magic method to pass query building to the underlying query object, saving the need to abstract.
public __call ( string $method, array $arguments )
$method string
$arguments array

__construct() 공개 메소드

public __construct ( Doctrine\Search\SearchManager $sm )
$sm Doctrine\Search\SearchManager

addFrom() 공개 메소드

Add a searchable entity class to search against.
public addFrom ( string $entityClass )
$entityClass string

count() 공개 메소드

Return the total hit count for the given query as provided by the search engine.
public count ( )

from() 공개 메소드

Specifies the searchable entity class to search against.
public from ( mixed $entityClasses )
$entityClasses mixed

getFacets() 공개 메소드

public getFacets ( ) : array
리턴 array

getHydrationQuery() 보호된 메소드

Return a provided hydration query
protected getHydrationQuery ( ) : object
리턴 object

getResult() 공개 메소드

Execute search and hydrate results if required.
public getResult ( integer $hydrationMode = null ) : mixed
$hydrationMode integer
리턴 mixed

getSearchManager() 보호된 메소드

protected getSearchManager ( )

getSingleResult() 공개 메소드

Execute search for single result and hydrate results if required.
public getSingleResult ( integer $hydrationMode = null ) : mixed
$hydrationMode integer
리턴 mixed

hydrateWith() 공개 메소드

Set a custom Doctrine Query to execute in order to hydrate the search engine results into required entities. The assumption is made the the search engine result id is correlated to the entity id. An optional query parameter override can be specified.
public hydrateWith ( object $hydrationQuery, string $parameter = null )
$hydrationQuery object
$parameter string

searchWith() 공개 메소드

Set the query object to be executed on the search engine
public searchWith ( mixed $query )
$query mixed

setHydrationMode() 공개 메소드

Set the hydration mode from the underlying query modes or bypass and return search result directly from the client
public setHydrationMode ( integer $mode )
$mode integer

useResultCache() 공개 메소드

If hydrating with Doctrine then you can use the result cache on the default or provided query
public useResultCache ( boolean $useCache, integer $cacheLifetime = null )
$useCache boolean
$cacheLifetime integer

프로퍼티 상세

$cacheLifetime 보호되어 있는 프로퍼티

protected int $cacheLifetime
리턴 integer

$count 보호되어 있는 프로퍼티

protected int $count
리턴 integer

$entityClasses 보호되어 있는 프로퍼티

protected array $entityClasses
리턴 array

$facets 보호되어 있는 프로퍼티

protected array $facets
리턴 array

$hydrationMode 보호되어 있는 프로퍼티

protected int $hydrationMode
리턴 integer

$hydrationParameter 보호되어 있는 프로퍼티

protected string $hydrationParameter
리턴 string

$hydrationQuery 보호되어 있는 프로퍼티

protected object $hydrationQuery
리턴 object

$query 보호되어 있는 프로퍼티

protected object $query
리턴 object

$sm 보호되어 있는 프로퍼티

protected SearchManager,Doctrine\Search $sm
리턴 Doctrine\Search\SearchManager

$useResultCache 보호되어 있는 프로퍼티

protected bool $useResultCache
리턴 boolean