PHP Class Pimcore\Model\Listing\AbstractListing

Inheritance: extends Pimcore\Model\AbstractModel
Mostra file Open project: pimcore/pimcore Class Usage Examples

Protected Properties

Property Type Description
$condition string
$conditionParams array
$conditionVariables array
$groupBy string
$limit integer
$offset integer
$order string | array
$orderKey string | array
$validOrders array

Public Methods

Method Description
addConditionParam ( $key, null $value = null, string $concatenator = 'AND' )
getCondition ( ) : string
getConditionParams ( ) : array
getConditionVariables ( ) : array
getGroupBy ( ) : string
getLimit ( ) : integer
getOffset ( ) : integer
getOrder ( ) : array | string
getOrderKey ( ) : array | string
getValidOrders ( ) : array
isValidOrderKey ( $key ) : boolean
quote ( $value, $type = null ) : string
resetConditionParams ( )
setCondition ( $condition, null $conditionVariables = null )
setConditionVariables ( $conditionVariables )
setGroupBy ( $groupBy, boolean $qoute = true )
setLimit ( $limit )
setOffset ( $offset )
setOrder ( $order )
setOrderKey ( string | array $orderKey, boolean $quote = true )
setValidOrders ( $validOrders )

Method Details

addConditionParam() public method

public addConditionParam ( $key, null $value = null, string $concatenator = 'AND' )
$key
$value null
$concatenator string

getCondition() public method

public getCondition ( ) : string
return string

getConditionParams() public method

public getConditionParams ( ) : array
return array

getConditionVariables() public method

public getConditionVariables ( ) : array
return array

getGroupBy() public method

public getGroupBy ( ) : string
return string

getLimit() public method

public getLimit ( ) : integer
return integer

getOffset() public method

public getOffset ( ) : integer
return integer

getOrder() public method

public getOrder ( ) : array | string
return array | string

getOrderKey() public method

public getOrderKey ( ) : array | string
return array | string

getValidOrders() public method

public getValidOrders ( ) : array
return array

isValidOrderKey() abstract public method

abstract public isValidOrderKey ( $key ) : boolean
$key
return boolean

quote() public method

public quote ( $value, $type = null ) : string
$value
return string

resetConditionParams() public method

public resetConditionParams ( )

setCondition() public method

public setCondition ( $condition, null $conditionVariables = null )
$condition
$conditionVariables null

setConditionVariables() public method

public setConditionVariables ( $conditionVariables )
$conditionVariables

setGroupBy() public method

public setGroupBy ( $groupBy, boolean $qoute = true )
$groupBy
$qoute boolean

setLimit() public method

public setLimit ( $limit )
$limit

setOffset() public method

public setOffset ( $offset )
$offset

setOrder() public method

public setOrder ( $order )
$order

setOrderKey() public method

public setOrderKey ( string | array $orderKey, boolean $quote = true )
$orderKey string | array
$quote boolean

setValidOrders() public method

public setValidOrders ( $validOrders )
$validOrders

Property Details

$condition protected_oe property

protected string $condition
return string

$conditionParams protected_oe property

protected array $conditionParams
return array

$conditionVariables protected_oe property

protected array $conditionVariables
return array

$groupBy protected_oe property

protected string $groupBy
return string

$limit protected_oe property

protected int $limit
return integer

$offset protected_oe property

protected int $offset
return integer

$order protected_oe property

protected string|array $order
return string | array

$orderKey protected_oe property

protected string|array $orderKey
return string | array

$validOrders protected_oe property

protected array $validOrders
return array