class Filter extends AbstractModel

Class Filter

Properties

int $id from AbstractModel
static Dispatcher $conditionsDispatcher
static Dispatcher $similarityDispatcher
string $name
int $resultsPerPage
string $order
string $orderKey
AbstractCondition[] $preConditions
AbstractCondition[] $filters
AbstractSimilarity[] $similarities
int $index
Index $indexObject
boolean $useShopPagingSettings

Methods

static  null|AbstractModel
getById($id)

Get Range by id.

static  boolean
isMultiShop()

No description

static  boolean
isMultiShopFK()

No description

static  AbstractModel
create()

Create new instance of Pimcore Object.

static  AbstractModel|null
getByShopId($id, null $shopId = null)

No description

static  null|AbstractModel
getByField( string $field, string $value, int $shopId = null)

Get Range by id.

static  AbstractListing
getList()

get listing class.

static  AbstractModel[]
getAll()

Get all objects form this type.

int
getId()

No description

setId( int $id)

No description

string
getCacheKey()

No description

save()

save model to database.

bool
delete()

delete model.

getLocalizedFields()

Get LocalizedFields Provider.

setLocalizedFields($localizedFields)

Get LocalizedFields Provider.

AbstractModel
setValue($key, $value)

Override setValue function to support localized fields.

string
__toString()

No description

array
__sleep()

Prepare object to goto sleep.

__wakeup()

Prepare object to wakeup.

static  Dispatcher
getConditionDispatcher()

No description

static  Dispatcher
getSimilaritiesDispatcher()

No description

static 
addCondition($condition)

Add Condition Type.

static 
addSimilarityType($similarity)

Add Similarity Type.

mixed
prepareConditions($conditions)

No description

mixed
prepareSimilarities($similarities)

No description

string
getName()

No description

setName( string $name)

No description

int
getResultsPerPage()

No description

setResultsPerPage( int $resultsPerPage)

No description

string
getOrder()

No description

setOrder( string $order)

No description

mixed
getOrderKey()

No description

setOrderKey( mixed $orderKey)

No description

getPreConditions()

No description

setPreConditions( AbstractCondition[] $preConditions)

No description

getFilters()

No description

setFilters( AbstractCondition[] $filters)

No description

getSimilarities()

No description

setSimilarities( AbstractSimilarity[] $similarities)

No description

getIndex()

No description

setIndex( Index $index)

No description

boolean
getUseShopPagingSettings()

No description

setUseShopPagingSettings( boolean $useShopPagingSettings)

No description

Details

in AbstractModel at line line 72
static null|AbstractModel getById($id)

Get Range by id.

Parameters

$id

Return Value

null|AbstractModel

in AbstractModel at line line 80
static boolean isMultiShop()

Return Value

boolean

in AbstractModel at line line 94
static boolean isMultiShopFK()

Return Value

boolean

in AbstractModel at line line 112
static AbstractModel create()

Create new instance of Pimcore Object.

Return Value

AbstractModel

Exceptions

Exception

in AbstractModel at line line 122
static AbstractModel|null getByShopId($id, null $shopId = null)

Parameters

$id
null $shopId

Return Value

AbstractModel|null

in AbstractModel at line line 170
static null|AbstractModel getByField( string $field, string $value, int $shopId = null)

Get Range by id.

Parameters

string $field
string $value
int $shopId

Return Value

null|AbstractModel

in AbstractModel at line line 223
static AbstractListing getList()

get listing class.

Return Value

AbstractListing

Exceptions

Exception

in AbstractModel at line line 243
static AbstractModel[] getAll()

Get all objects form this type.

Return Value

AbstractModel[]

in AbstractModel at line line 253
int getId()

Return Value

int

in AbstractModel at line line 261
setId( int $id)

Parameters

int $id

in AbstractModel at line line 269
string getCacheKey()

Return Value

string

in AbstractModel at line line 277
save()

save model to database.

in AbstractModel at line line 294
bool delete()

delete model.

Return Value

bool

in AbstractModel at line line 310
LocalizedFields|null getLocalizedFields()

Get LocalizedFields Provider.

Return Value

LocalizedFields|null

in AbstractModel at line line 329
setLocalizedFields($localizedFields)

Get LocalizedFields Provider.

Parameters

$localizedFields

in AbstractModel at line line 342
AbstractModel setValue($key, $value)

Override setValue function to support localized fields.

Parameters

$key
$value

Return Value

AbstractModel

in AbstractModel at line line 360
string __toString()

Return Value

string

in AbstractModel at line line 370
array __sleep()

Prepare object to goto sleep.

Return Value

array

in AbstractModel at line line 390
__wakeup()

Prepare object to wakeup.

at line line 49
static Dispatcher getConditionDispatcher()

Return Value

Dispatcher

at line line 69
static Dispatcher getSimilaritiesDispatcher()

Return Value

Dispatcher

at line line 88
static addCondition($condition)

Add Condition Type.

Parameters

$condition

at line line 99
static addSimilarityType($similarity)

Add Similarity Type.

Parameters

$similarity

at line line 160
mixed prepareConditions($conditions)

Parameters

$conditions

Return Value

mixed

Exceptions

Exception

at line line 191
mixed prepareSimilarities($similarities)

Parameters

$similarities

Return Value

mixed

Exceptions

Exception

at line line 214
string getName()

Return Value

string

at line line 222
setName( string $name)

Parameters

string $name

at line line 230
int getResultsPerPage()

Return Value

int

at line line 238
setResultsPerPage( int $resultsPerPage)

Parameters

int $resultsPerPage

at line line 246
string getOrder()

Return Value

string

at line line 254
setOrder( string $order)

Parameters

string $order

at line line 262
mixed getOrderKey()

Return Value

mixed

at line line 270
setOrderKey( mixed $orderKey)

Parameters

mixed $orderKey

at line line 278
AbstractCondition[] getPreConditions()

Return Value

AbstractCondition[]

at line line 286
setPreConditions( AbstractCondition[] $preConditions)

Parameters

AbstractCondition[] $preConditions

at line line 294
AbstractCondition[] getFilters()

Return Value

AbstractCondition[]

at line line 302
setFilters( AbstractCondition[] $filters)

Parameters

AbstractCondition[] $filters

at line line 310
AbstractSimilarity[] getSimilarities()

Return Value

AbstractSimilarity[]

at line line 318
setSimilarities( AbstractSimilarity[] $similarities)

Parameters

AbstractSimilarity[] $similarities

at line line 326
Index getIndex()

Return Value

Index

at line line 338
setIndex( Index $index)

Parameters

Index $index

at line line 350
boolean getUseShopPagingSettings()

Return Value

boolean

at line line 358
setUseShopPagingSettings( boolean $useShopPagingSettings)

Parameters

boolean $useShopPagingSettings