VariationSearchFactory

Concrete factory to build variation searches

Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory
Namespace

IO\Services\ItemSearch\Factories

Extends

BaseSearchFactory

Properties
Type Name Description

``

$isAdminPreview
Methods
public __construct()
public setAdminPreview($isAdminPreview):Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::setAdminPreview()
Parameters

Type

Name

Description

bool

$isAdminPreview

 
public isActive():Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::isActive()

Filter active variations

public isInactive():Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::isInactive()

Filter inactive variations

public hasItemId($itemId):Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::hasItemId()

Filter variation by a single item id

Parameters

Type

Name

Description

int

$itemId

Item id to filter by.

 
public hasItemIds($itemIds):Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::hasItemIds()

Filter variations by multiple item ids

Parameters

Type

Name

Description

array

$itemIds

List of item ids to filter by.

 
public hasVariationId($variationId):Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::hasVariationId()

Filter variation by a single variation id.

Parameters

Type

Name

Description

int

$variationId

The variation id to filter by.

 
public hasVariationIds($variationIds):Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::hasVariationIds()

Filter variations by multiple variation ids.

Parameters

Type

Name

Description

array

$variationIds

List of variation ids to filter by.

 
public hasAtLeastOneAvailability($availabilityIds):Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::hasAtLeastOneAvailability()

Filter variations by multiple availability ids.

Parameters

Type

Name

Description

array

$availabilityIds

List of availability ids to filter by.

 
public hasSupplier($supplierId):Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::hasSupplier()

Filter variations by multiple availability ids.

Parameters

Type

Name

Description

int

$supplierId

The supplier id to filter by.

 
public hasManufacturer($manufacturerId):Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::hasManufacturer()

Filter manufacturers by id.

Parameters

Type

Name

Description

int

$manufacturerId

To filter by manufacturer

 
public hasEachProperty($propertyIds):Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::hasEachProperty()

Filter variations by multiple property ids.

Parameters

Type

Name

Description

array

$propertyIds

The property ids to filter by.

 
public isMain():Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::isMain()

Filter only main variations

public isChild():Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::isChild()

Filter only child variations

public isHiddenInCategoryList($isHidden = true):Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::isHiddenInCategoryList()

Filter by visibility in category list.

Parameters

Type

Name

Description

bool

$isHidden

Visibility in category list to filter by.

 
public isSalable():Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::isSalable()

Filter variations by isSalable flag

public isVisibleForClient($clientId = null):Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::isVisibleForClient()

Filter variations by visibility for client

Parameters

Type

Name

Description

int

$clientId

The client id to filter by. If null, default client id on application will be used.

 
public hasNameInLanguage($type = \Plenty\Modules\Item\Search\Filter\TextFilter::FILTER_ANY_NAME, $lang = null):Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::hasNameInLanguage()

Filter variations having texts in a given language.

Parameters

Type

Name

Description

string

$type

The text field to filter by ('hasAny', 'hasName1', 'hasName2', 'hasName3')

string

$lang

The language to filter by. If null, language defined in session will be used.

 
public isInCategory($categoryId):Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::isInCategory()

Filter variations contained in a category.

Parameters

Type

Name

Description

int

$categoryId

A category id to filter variations by.

 
public hasAtLeastOnePrice($priceIds):Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::hasAtLeastOnePrice()

Filter variations having at least on price.

Parameters

Type

Name

Description

array

$priceIds

List of price ids to filter variations by

 
public hasPriceForCustomer():Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::hasPriceForCustomer()

Filter variations having at least one price accessible by current customer.

public hasPriceInRange($priceMin, $priceMax):Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::hasPriceInRange()
Parameters

Type

Name

Description

float

$priceMin

float

$priceMax

 
public hasTag($tagId):Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::hasTag()
Parameters

Type

Name

Description

int

$tagId

 
public hasAnyTag($tagIds):Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::hasAnyTag()
Parameters

Type

Name

Description

int

$tagIds

 
public groupByTemplateConfig($key = "ids.itemAttributeValue"):Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::groupByTemplateConfig()

Group results depending on a config value.

Parameters

Type

Name

Description

string

$key

 
public isCrossSellingItem($itemId, $relation):Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::isCrossSellingItem()

Filter variations having a cross selling relation to a given item.

Parameters

Type

Name

Description

int

$itemId

Item id to filter cross selling items for

string

$relation

The relation of cross selling items.

 
public hasFacets($facetValues, $clientId = null, $lang = null):Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::hasFacets()

Filter variations by facets.

Parameters

Type

Name

Description

string | array

$facetValues

List of facet values. If string is given, it will be exploded by ';'

int

$clientId

Client id to filter facets by. If null, default client id from application will be used.

string

$lang

Language to filter facets by. If null, active language from session will be used.

 
public hasSearchString($query, $lang = null, $searchType = \Plenty\Modules\Cloud\ElasticSearch\Lib\ElasticSearch::SEARCH_TYPE_EXACT, $operator = \Plenty\Modules\Cloud\ElasticSearch\Lib\ElasticSearch::OR_OPERATOR):Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::hasSearchString()

Filter variations by given search string.

Parameters

Type

Name

Description

string

$query

The search string to filter variations by

string

$lang

The language to apply search on. If null, default language from session will be used

string

$searchType

Type of the search ('exact', 'fuzzy', 'autocomplete')

string

$operator

Operator ot be used for search

 
public hasNameString($query, $lang = null):Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::hasNameString()

Filter variations by searching names

Parameters

Type

Name

Description

string

$query

The search string

string

$lang

Language to apply search on. If null, default language from session will be used.

 
public withLanguage($lang = null):Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::withLanguage()

Only request given language.

Parameters

Type

Name

Description

string

$lang

Language to get texts for. If null, default language from session will be used.

 
public withImages($clientId = null):Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::withImages()

Include images in result

Parameters

Type

Name

Description

int

$clientId

The client id to get images for. If null, default client id from application will be used.

 
public withAttributes():Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::withAttributes()

Includes VariatonAttributeMap for variation select

public withPropertyGroups():Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::withPropertyGroups()

 
public withOrderPropertySelectionValues():Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::withOrderPropertySelectionValues()

 
public withVariationProperties():Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::withVariationProperties()

 
public withUrls():Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::withUrls()

Append URLs to result.

public withPrices($params):Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::withPrices()

Append prices to result.

Parameters

Type

Name

Description

array

$params

Params to be passed to price search.

 
public withCurrentCategory():Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::withCurrentCategory()

Set result as current category

public withDefaultImage():Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::withDefaultImage()

Append default item image if images are requested by result fields and item does not have any image

public withBundleComponents():Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::withBundleComponents()

 
public withLinkToContent():Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::withLinkToContent()

 
public withGroupedAttributeValues():Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::withGroupedAttributeValues()

 
public withReducedResults($removeProperties = false):Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::withReducedResults()
Parameters

Type

Name

Description

bool

$removeProperties

 
public withAvailability():Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::withAvailability()

 
public withTags():Factories
Deprecated!

since 5.0.0 will be deleted in 6.0.0

see:VariationSearchFactory::withTags()