eZPublishCommunityProject  2013.9
eZ\Publish\Core\Persistence\Legacy\Content\Search\Gateway\EzcDatabase Class Reference

Content locator gateway implementation using the zeta handler component. More...

+ Inheritance diagram for eZ\Publish\Core\Persistence\Legacy\Content\Search\Gateway\EzcDatabase:
+ Collaboration diagram for eZ\Publish\Core\Persistence\Legacy\Content\Search\Gateway\EzcDatabase:

Public Member Functions

 __construct (EzcDbHandler $handler, CriteriaConverter $criteriaConverter, SortClauseConverter $sortClauseConverter, QueryBuilder $queryBuilder, LanguageHandler $languageHandler, LanguageMaskGenerator $languageMaskGenerator)
 Construct from handler handler. More...
 
 find (Criterion $criterion, $offset=0, $limit=null, array $sort=null, array $translations=null)
 Returns a list of object satisfying the $criterion. More...
 
- Public Member Functions inherited from eZ\Publish\Core\Persistence\Legacy\Content\Search\Gateway
 find (Criterion $criterion, $offset=0, $limit=null, array $sort=null, array $translations=null)
 Returns a list of object satisfying the $criterion. More...
 

Public Attributes

const MAX_LIMIT = 1073741824
 2^30, since PHP_INT_MAX can cause overflows in DB systems, if PHP is run on 64 bit systems More...
 

Protected Member Functions

 getContentIds (Criterion $criterion, $sort, $offset, $limit, $translations)
 Get sorted arrays of content IDs, which should be returned. More...
 
 getQueryCondition (Criterion $criterion, ezcQuerySelect $query, $translations)
 Get query condition. More...
 
 getResultCount (Criterion $criterion, $sort, $translations)
 Get result count. More...
 
 loadContent (array $contentIds, $translations)
 Loads the actual content based on the provided IDs. More...
 

Protected Attributes

 $criteriaConverter
 
 $handler
 
 $languageHandler
 
 $languageMaskGenerator
 
 $queryBuilder
 
 $sortClauseConverter
 

Detailed Description

Content locator gateway implementation using the zeta handler component.

Constructor & Destructor Documentation

eZ\Publish\Core\Persistence\Legacy\Content\Search\Gateway\EzcDatabase::__construct ( EzcDbHandler  $handler,
CriteriaConverter  $criteriaConverter,
SortClauseConverter  $sortClauseConverter,
QueryBuilder  $queryBuilder,
LanguageHandler  $languageHandler,
LanguageMaskGenerator  $languageMaskGenerator 
)

Construct from handler handler.

Parameters
\EzcDbHandler$handler
Returns
void

Member Function Documentation

eZ\Publish\Core\Persistence\Legacy\Content\Search\Gateway\EzcDatabase::find ( Criterion  $criterion,
  $offset = 0,
  $limit = null,
array  $sort = null,
array  $translations = null 
)

Returns a list of object satisfying the $criterion.

Exceptions
\eZ\Publish\API\Repository\Exceptions\InvalidArgumentExceptionif Criterion is not applicable to its target
Parameters
Criterion$criterion
int$offset
int | null$limit
\eZ\Publish\API\Repository\Values\Content\Query\SortClause[]$sort
string[]$translations
Returns
mixed[][]
eZ\Publish\Core\Persistence\Legacy\Content\Search\Gateway\EzcDatabase::getContentIds ( Criterion  $criterion,
  $sort,
  $offset,
  $limit,
  $translations 
)
protected

Get sorted arrays of content IDs, which should be returned.

Parameters
Criterion$criterion
array$sort
mixed$offset
mixed$limit
mixed$translations
Returns
int[]

Referenced by eZ\Publish\Core\Persistence\Legacy\Content\Search\Gateway\EzcDatabase\find().

eZ\Publish\Core\Persistence\Legacy\Content\Search\Gateway\EzcDatabase::getQueryCondition ( Criterion  $criterion,
ezcQuerySelect  $query,
  $translations 
)
protected

Get query condition.

Parameters
Criterion$criterion
\ezcQuerySelect$query
mixed$translations
Returns
string

Referenced by eZ\Publish\Core\Persistence\Legacy\Content\Search\Gateway\EzcDatabase\getContentIds(), and eZ\Publish\Core\Persistence\Legacy\Content\Search\Gateway\EzcDatabase\getResultCount().

eZ\Publish\Core\Persistence\Legacy\Content\Search\Gateway\EzcDatabase::getResultCount ( Criterion  $criterion,
  $sort,
  $translations 
)
protected

Get result count.

Parameters
Criterion$criterion
array$sort
mixed$translations
Returns
int

Referenced by eZ\Publish\Core\Persistence\Legacy\Content\Search\Gateway\EzcDatabase\find().

eZ\Publish\Core\Persistence\Legacy\Content\Search\Gateway\EzcDatabase::loadContent ( array  $contentIds,
  $translations 
)
protected

Loads the actual content based on the provided IDs.

Parameters
array$contentIds
mixed$translations
Returns
mixed[]

Referenced by eZ\Publish\Core\Persistence\Legacy\Content\Search\Gateway\EzcDatabase\find().

Member Data Documentation

eZ\Publish\Core\Persistence\Legacy\Content\Search\Gateway\EzcDatabase::$criteriaConverter
protected
eZ\Publish\Core\Persistence\Legacy\Content\Search\Gateway\EzcDatabase::$handler
protected
eZ\Publish\Core\Persistence\Legacy\Content\Search\Gateway\EzcDatabase::$languageHandler
protected
eZ\Publish\Core\Persistence\Legacy\Content\Search\Gateway\EzcDatabase::$languageMaskGenerator
protected
eZ\Publish\Core\Persistence\Legacy\Content\Search\Gateway\EzcDatabase::$queryBuilder
protected
eZ\Publish\Core\Persistence\Legacy\Content\Search\Gateway\EzcDatabase::$sortClauseConverter
protected
const eZ\Publish\Core\Persistence\Legacy\Content\Search\Gateway\EzcDatabase::MAX_LIMIT = 1073741824

2^30, since PHP_INT_MAX can cause overflows in DB systems, if PHP is run on 64 bit systems


The documentation for this class was generated from the following file: