PHP Class eZ\Publish\Core\Search\Legacy\Content\Common\Gateway\SortClauseHandler

Show file Open project: ezsystems/ezpublish-kernel Class Usage Examples

Protected Properties

Property Type Description
$dbHandler eZ\Publish\Core\Persistence\Database\DatabaseHandler Database handler.

Public Methods

Method Description
__construct ( eZ\Publish\Core\Persistence\Database\DatabaseHandler $dbHandler ) Creates a new sort clause handler.
accept ( eZ\Publish\API\Repository\Values\Content\Query\SortClause $sortClause ) : boolean Check if this sort clause handler accepts to handle the given sort clause.
applyJoin ( eZ\Publish\Core\Persistence\Database\SelectQuery $query, eZ\Publish\API\Repository\Values\Content\Query\SortClause $sortClause, integer $number, array $languageSettings ) Applies joins to the query.
applySelect ( eZ\Publish\Core\Persistence\Database\SelectQuery $query, eZ\Publish\API\Repository\Values\Content\Query\SortClause $sortClause, integer $number ) : string Apply selects to the query.

Protected Methods

Method Description
getSortColumnName ( integer $number ) : string Returns the quoted sort column name.
getSortTableName ( integer $number, null | string $externalTableName = null ) : string Returns the sort table name.

Method Details

__construct() public method

Creates a new sort clause handler.
public __construct ( eZ\Publish\Core\Persistence\Database\DatabaseHandler $dbHandler )
$dbHandler eZ\Publish\Core\Persistence\Database\DatabaseHandler

accept() abstract public method

Check if this sort clause handler accepts to handle the given sort clause.
abstract public accept ( eZ\Publish\API\Repository\Values\Content\Query\SortClause $sortClause ) : boolean
$sortClause eZ\Publish\API\Repository\Values\Content\Query\SortClause
return boolean

applyJoin() public method

Applies joins to the query.
public applyJoin ( eZ\Publish\Core\Persistence\Database\SelectQuery $query, eZ\Publish\API\Repository\Values\Content\Query\SortClause $sortClause, integer $number, array $languageSettings )
$query eZ\Publish\Core\Persistence\Database\SelectQuery
$sortClause eZ\Publish\API\Repository\Values\Content\Query\SortClause
$number integer
$languageSettings array

applySelect() abstract public method

Returns the name of the (aliased) column, which information should be used for sorting.
abstract public applySelect ( eZ\Publish\Core\Persistence\Database\SelectQuery $query, eZ\Publish\API\Repository\Values\Content\Query\SortClause $sortClause, integer $number ) : string
$query eZ\Publish\Core\Persistence\Database\SelectQuery
$sortClause eZ\Publish\API\Repository\Values\Content\Query\SortClause
$number integer
return string

getSortColumnName() protected method

Returns the quoted sort column name.
protected getSortColumnName ( integer $number ) : string
$number integer
return string

getSortTableName() protected method

Returns the sort table name.
protected getSortTableName ( integer $number, null | string $externalTableName = null ) : string
$number integer
$externalTableName null | string
return string

Property Details

$dbHandler protected property

Database handler.
protected DatabaseHandler,eZ\Publish\Core\Persistence\Database $dbHandler
return eZ\Publish\Core\Persistence\Database\DatabaseHandler