Models

Variation

PropertyValue

The Property values of the variation

Namespace

Plenty\Modules\Pim\DocumentService\Models\Variation

Properties

Type Name Description
string id The id of the relation value
string lang The lang of the relation value
string value The value of the relation value
string description The description of the relation value

Methods

public toArray()

Returns this model as an array.

SearchService

Aggregations

AttributeValueAggregation

Aggregate data by attributeValue ids

Namespace

Plenty\Modules\Pim\SearchService\Aggregations

Methods

public getName():string

Get the name of the aggregation

public getField():string

Get the field of the aggregation

public getAggregation():array
public setInclude(string $string):void
Parameters
string $string
public toArray():array
public process(array $data):array
Parameters
array $data
public addAggregation(AggregationInterface
 $aggregation):void
Parameters
AggregationInterface $aggregation
public addSource(SourceInterface
 $source):AggregationInterface
Parameters
SourceInterface $source
public setPage(int $page, int $rowsPerPage):AggregationInterface
Parameters
int $page
int $rowsPerPage
public getSources():void

CategoryAllTermsAggregation

Aggregate data by all category ids

Namespace

Plenty\Modules\Pim\SearchService\Aggregations

Methods

public getName():string

Get the name of the aggregation

public getField():string

Get the field of the aggregation

public getAggregation():array
public setInclude(string $string):void
Parameters
string $string
public toArray():array
public process(array $data):array
Parameters
array $data
public addAggregation(AggregationInterface
 $aggregation):void
Parameters
AggregationInterface $aggregation
public addSource(SourceInterface
 $source):AggregationInterface
Parameters
SourceInterface $source
public setPage(int $page, int $rowsPerPage):AggregationInterface
Parameters
int $page
int $rowsPerPage
public getSources():void

CategoryPathTermsAggregation

Aggregate data by all category paths

Namespace

Plenty\Modules\Pim\SearchService\Aggregations

Methods

public getName():string

Get the name of the aggregation

public getField():string

Get the field of the aggregation

public getAggregation():array
public setInclude(string $string):void
Parameters
string $string
public toArray():array
public process(array $data):array
Parameters
array $data
public addAggregation(AggregationInterface
 $aggregation):void
Parameters
AggregationInterface $aggregation
public addSource(SourceInterface
 $source):AggregationInterface
Parameters
SourceInterface $source
public setPage(int $page, int $rowsPerPage):AggregationInterface
Parameters
int $page
int $rowsPerPage
public getSources():void

ItemCardinalityAggregation

Get the count of found items

Namespace

Plenty\Modules\Pim\SearchService\Aggregations

Methods

public getName():string

Get the name of the aggregation

public getField():string

Get the field of the aggregation

public getAggregation():array
public toArray():array
public process(array $data):array
Parameters
array $data
public addAggregation(AggregationInterface
 $aggregation):void
Parameters
AggregationInterface $aggregation
public addSource(SourceInterface
 $source):AggregationInterface
Parameters
SourceInterface $source
public setPage(int $page, int $rowsPerPage):AggregationInterface
Parameters
int $page
int $rowsPerPage
public getSources():void

ItemIdTermsAggregation

Aggregate data by item ids

Namespace

Plenty\Modules\Pim\SearchService\Aggregations

Methods

public getName():string

Get the name of the aggregation

public getField():string

Get the field of the aggregation

public getAggregation():array
public setInclude(string $string):void
Parameters
string $string
public toArray():array
public process(array $data):array
Parameters
array $data
public addAggregation(AggregationInterface
 $aggregation):void
Parameters
AggregationInterface $aggregation
public addSource(SourceInterface
 $source):AggregationInterface
Parameters
SourceInterface $source
public setPage(int $page, int $rowsPerPage):AggregationInterface
Parameters
int $page
int $rowsPerPage
public getSources():void

SalableFilterAggregation

Filter Aggregated Data if variation is salable

Namespace

Plenty\Modules\Pim\SearchService\Aggregations

Methods

public getName():string

Get the name of the aggregation

public getAggregation():array
public addFilter(TypeInterface
 $filter):void
Parameters
TypeInterface $filter
public setIndex($index):void
Parameters
$index
public toArray():array
public process(array $data):array
Parameters
array $data
public addAggregation(AggregationInterface
 $aggregation):void
Parameters
AggregationInterface $aggregation
public addSource(SourceInterface
 $source):AggregationInterface
Parameters
SourceInterface $source
public setPage(int $page, int $rowsPerPage):AggregationInterface
Parameters
int $page
int $rowsPerPage
public getSources():void

UnitCombinationAggregation

Aggregate data by unit combination ids

Namespace

Plenty\Modules\Pim\SearchService\Aggregations

Methods

public getName():string

Get the name of the aggregation

public getField():string

Get the field of the aggregation

public getAggregation():array
public setInclude(string $string):void
Parameters
string $string
public toArray():array
public process(array $data):array
Parameters
array $data
public addAggregation(AggregationInterface
 $aggregation):void
Parameters
AggregationInterface $aggregation
public addSource(SourceInterface
 $source):AggregationInterface
Parameters
SourceInterface $source
public setPage(int $page, int $rowsPerPage):AggregationInterface
Parameters
int $page
int $rowsPerPage
public getSources():void

Filter

AmazonFilter

Includes filters for amazon

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public hasAnyFlatFile(array $flatFiles):Filter

Restricts the result to have any of the specified flatFiles.

Parameters
array $flatFiles
public hasAnyProductType(array $productTypes):Filter

Restricts the result to have any of the specified productTypes.

Parameters
array $productTypes
public hasAnyProductTypeId(array $productTypeIds):Filter

Restricts the result to have any of the specified typeIds.

Parameters
array $productTypeIds
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

AttributeFilter

Includes filters for attributes

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public hasAttribute(int $attributeId):Filter

Restricts the result to have the specified attributeId.

Parameters
int $attributeId
public hasAnyAttribute(array $attributeIds):Filter

Restricts the result to have any of the specified attributeId.

Parameters
array $attributeIds
public hasAllAttributes(array $attributeIds):Filter

Restricts the result to has all of the specified attributeId.

Parameters
array $attributeIds
public hasAttributeValue(int $attributeValueId):Filter

Restricts the result to have the specified attributeValueId.

Parameters
int $attributeValueId
public hasAnyAttributeValue(array $attributeValueIds):Filter

Restricts the result to have any of the specified attributeValueId.

Parameters
array $attributeValueIds
public hasAllAttributeValues(array $attributeValueIds):Filter

Restricts the result to have all of the specified attributeValueId.

Parameters
array $attributeValueIds
public hasNoAttributeValue():void

Restricts the result to have no attribute value.

public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

BarcodeFilter

Includes filters for barcodes

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public hasCode($code, string $precision):Filter

Restricts the result to have a specified code.

Parameters
$code
string $precision
public hasType(string $type):void

Restricts the result to have a specified type. Not implemented.

Parameters
string $type
public hasId(int $id):Filter

Restricts the result to have a specified id.

Parameters
int $id
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

CategoryFilter

Includes filters for categories

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public isInAtLeastOneCategory(array $categoryIds, string $depth = self::DEPTH_ANY):Filter

Restricts the result to have any of the categoryIds.

Parameters
array $categoryIds
string $depth
public static getPathByDepth(string $depth):string

Get the path by depth.

Parameters
string $depth
public isInEachCategory(array $categoryIds, string $depth = self::DEPTH_ANY):Filter

Restricts the result to have all of the categoryIds.

Parameters
array $categoryIds
string $depth
public isInCategory(int $categoryId, string $depth = self::DEPTH_ANY):Filter

Restricts the result to have the categoryId.

Parameters
int $categoryId
string $depth
public isInACategory():Filter

Restricts the result to have a category.

public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

CharacteristicFilter

Includes filters for characteristics

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public hasAtLeastOneProperty(array $ids):Filter

Restricts the result to have any of the characteristicIds.

Parameters
array $ids
public hasEachProperty(array $ids):Filter

Restricts the result to have all of the characteristicIds.

Parameters
array $ids
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

ClientFilter

Includes filters for clients

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public isVisibleForClient(int $clientId):Filter

Restricts the result to have the clientId.

Parameters
int $clientId
public isVisibleForAtLeastOneClient(array $clientIds):Filter

Restricts the result to have any of the clientIds.

Parameters
array $clientIds
public isVisibleForAllClients(array $clientIds):Filter

Restricts the result to have all of the clientIds.

Parameters
array $clientIds
public hasAutomaticClientVisibility(array $values):Filter

Restricts the result to have any of the automaticClientVisibilities. (-1, 0, 1, 2)

Parameters
array $values
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

CrossSellingFilter

Includes filters for cross selling

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public getPath():string

get the nested path of the filter

public hasItemId(int $itemId):void

Restricts the result to have the itemId linked

Parameters
int $itemId
public hasRelation(string $relation):Filter

Restricts the result to have the relation

Parameters
string $relation
public hasAnyRelation(array $relations):Filter

Restricts the result to have any relation

Parameters
array $relations
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

FacetFilter

Includes filters for facets

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public hasAtLeastOneFacet(array $facetIds):Filter

Restricts the result to have any of the facetIds.

Parameters
array $facetIds
public hasEachFacet(array $facetIds):Filter

Restricts the result to have all facetIds.

Parameters
array $facetIds
public hasFacet(int $facetIds):Filter

Restricts the result to have the facetIds.

Parameters
int $facetIds
public hasFacetValue(int $facetValueId):Filter

Restricts the result to have the facetValueId.

Parameters
int $facetValueId
public hasAFacet():Filter

Restricts the result to have any of the facetValueIds.

public hasAtLeastOneFacetValue(array $valueIds):Filter

Restricts the result to have any of the facetValueIds.

Parameters
array $valueIds
public hasEachFacetValue(array $valueIds):Filter

Restricts the result to have all the facetValueIds.

Parameters
array $valueIds
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

FeedbackRangeFilter

Includes filters for feedback

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public hasFeedbackGreaterThan(int $value):Filter

Restricts the result to have feedback greater than or equal the value.

Parameters
int $value
public getType():string
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

ItemCreatedAtFilter

Used to filter by item created at timestamp

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public getTimestamp():string

Get the timestamp of the filter

public getType():string
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

ItemFilter

Includes filters for the item

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public hasId(int $id):Filter

Restricts the result to have the item id.

Parameters
int $id
public hasIds(array $ids):Filter

Restricts the result to have all the item ids.

Parameters
array $ids
public hasAnImage():Filter

Restricts the result to have an image.

public hasFlag1(int $flagId):Filter

Restricts the result to have the specified flag 1.

Parameters
int $flagId
public hasFlag2(int $flagId):Filter

Restricts the result to have the specified flag 2.

Parameters
int $flagId
public hasManufacturer(int $manufacturerId):Filter

Restricts the result to have the manufacturer id.

Parameters
int $manufacturerId
public hasManufacturers(array $manufacturerIds):Filter

Restricts the result to have any of the manufacturer ids.

Parameters
array $manufacturerIds
public hasAManufacturer():Filter

Restricts the result to have an manufacturer.

public isItemType(string $itemType):Filter

Restricts the result to have the specified item type.

Parameters
string $itemType
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

ItemLastUpdatedAtFilter

Used to filter by item last update timestamp

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public getTimestamp():string

Get the timestamp of the filter

public getType():string
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

ItemRangeFilter

used to filter the range between item ids

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public getType():string
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

MarketFilter

Includes filters for markets

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public isVisibleForMarket(float $marketId):Filter

Restricts the result to have the market id.

Parameters
float $marketId
public isVisibleForAtLeastOneMarket(array $marketIds):Filter

Restricts the result to have any of the market ids.

Parameters
array $marketIds
public isVisibleForAllMarkets(array $marketIds):Filter

Restricts the result to have all the market ids.

Parameters
array $marketIds
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

PriceFilter

Includes filters for prices

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public getPath():string

Get the path of the filter

public between(float $min = null, float $max = null):void

Restricts the result to have a price between the specified min and max value.

Parameters
float $min
float $max
public betweenByPriceId(array $priceIds = [], float $min = null, float $max = null):Filter

Restricts the result to a price between the specified min and max value. The price must be related to one of the specified price ids.

Parameters
array $priceIds
float $min
float $max
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

PropertyFilter

Includes filters for Properties

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public hasPropertySelection(int $id):Filter

Restricts the result to have the property selection id.

Parameters
int $id
public hasAtLeastOnePropertySelection(array $ids):Filter

Restricts the result to have any of the property selection ids.

Parameters
array $ids
public hasEachPropertySelection(array $ids):Filter

Restricts the result to have all of the property selection ids.

Parameters
array $ids
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

SalesPriceFilter

Includes filters for salesPrices

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public hasAtLeastOnePrice(array $priceIds):Filter

Restricts the result to have any of the price ids.

Parameters
array $priceIds
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

SkuFilter

Includes filters for skus

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public getPath():string

Get the path of the filter.

public hasMarketId(float $marketId):Filter

Restricts the result to have a sku with the market referrer id.

Parameters
float $marketId
public hasAccountId(int $accountId):Filter

Restricts the result to have a sku with the account id.

Parameters
int $accountId
public hasStatus(string $status):Filter

Restricts the result to have a sku with the status.

Parameters
string $status
public hasSku(string $sku):Filter

Restricts the result to have a specified sku.

Parameters
string $sku
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

TagFilter

Includes filters for tags

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public hasTag(int $tagId):Filter

Restricts the result to have the tag id.

Parameters
int $tagId
public hasAnyTag(array $tagIds):Filter

Restricts the result to have any of the tag ids.

Parameters
array $tagIds
public hasAllTags(array $tagIds):Filter

Restricts the result to have all of the tag ids.

Parameters
array $tagIds
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

TextFilter

Includes filters for texts

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public hasAnyName():Filter

Restricts the result to have any name.

public hasNameInLanguage(string $lang = "de", string $filter = self::FILTER_ANY_NAME):Filter

Restricts the result to have specific or any name in language: Possible filter are hasAnyNameInLanguage, hasName1InLanguage, hasName2InLanguage, hasName3InLanguage.

Parameters
string $lang
string $filter
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement
public static isLanguageSupported(string $lang):bool
Parameters
string $lang
public static isLanguageActivated(string $lang):bool
Parameters
string $lang
public static getM10lByLanguage(string $lang, string $fallback = "en"):string
Parameters
string $lang
string $fallback
public static getLanguageByM10l(string $lang, string $fallback = "english"):string
Parameters
string $lang
string $fallback

VariationAvailabilityUpdatedAtFilter

Used to filter by variation availability last update timestamp

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public getTimestamp():string

Get the timestamp of the filter

public getType():string
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

VariationBaseFilter

Includes filters for the base variation

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public hasNumber(string $number, string $precision):Filter

Restricts the result to have the number. Possible precisions are: exact, fuzzy and autocomplete

Parameters
string $number
string $precision
public hasAnyNumber(array $numbers):void

Restricts the result to have any of the numbers.

Parameters
array $numbers
public isActive():Filter

Restricts the result to have active variations only.

public isInactive():Filter

Restricts the result to have inactive variations only.

public hasId(int $id):Filter

Restricts the result to have the variation id.

Parameters
int $id
public hasIds(array $ids):Filter

Restricts the result to have any of the variation ids.

Parameters
array $ids
public hasItemId(int $itemId):Filter

Restricts the result to have the item id.

Parameters
int $itemId
public hasAnyPriceCalculationId():Filter

Restricts the result to have the any price calculation id

public hasPriceCalculationIds(array $ids):Filter

Restricts the result to have the any of the price calculation ids

Parameters
array $ids
public hasItemIds(array $itemIds):Filter

Restricts the result to have the any of the item ids

Parameters
array $itemIds
public isMain():Filter

Restricts the result to have no child's

public isChild():Filter

Restricts the result to have child's only

public isSalable(bool $bool = true):Filter

Restricts the result whether is salable or not.

Parameters
bool $bool
public isHiddenInCategoryList(bool $bool = true):Filter

Restricts the result whether is hidden in category list or not.

Parameters
bool $bool
public hasADescriptionInLanguage(string $language):Filter

This filter is not implemented. Deprecated.

Parameters
string $language
public hasAnImageOrItemHasAnImage():Filter

Restricts the result to have an image.

public hasAnImage():Filter

Restricts the result to have an item image.

public hasManufacturer(int $manufacturerId):Filter

Restricts the result to have the manufacturer.

Parameters
int $manufacturerId
public hasSupplier(int $supplierId):Filter

Restricts the result to have the supplier.

Parameters
int $supplierId
public hasAtLeastOneAvailability(array $availabilities):Filter

Restricts the result to have any of the availabilities.

Parameters
array $availabilities
public hasActiveChildren(bool $bool = true):Filter

Restricts the result to have active child variations or not.

Parameters
bool $bool
public hasChildren(bool $bool = true):Filter

Restricts the result to have child variations or not.

Parameters
bool $bool
public hasCustomsTariffNumber(string $customsTariffNumber):Filter

Restricts the result to have the customs tariff number.

Parameters
string $customsTariffNumber
public customsTariffNumberNotExists():Filter

Restricts the result to have no customs tariff number.

public customsTariffNumberExists():Filter

Restricts the result to have a customs tariff number.

public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

VariationBundleFilter

Includes filters for bundles

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public hasBundleType(string $bundleType):Filter

Restricts the result to have the bundle type.

Parameters
string $bundleType
public hasNoBundleType():Filter

Restricts the result to have the no bundle type.

public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

VariationCreatedAtFilter

Used to filter by variation created at timestamp

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public getTimestamp():string

Get the timestamp of the filter

public getType():string
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

VariationLastUpdatedAtFilter

Used to filter by variation last update timestamp

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public getTimestamp():string

Get the timestamp of the filter

public getType():string
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

VariationSalesPriceUpdatedAtFilter

Used to filter by variation saleyPrice last update timestamp

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public getTimestamp():string

Get the timestamp of the filter

public getType():string
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

VariationStockUpdatedAtFilter

Used to filter by variation stock last update timestamp

Namespace

Plenty\Modules\Pim\SearchService\Filter

Methods

public getTimestamp():string

Get the timestamp of the filter

public getType():string
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement

Query

ManagedSearchQuery

Used to search for variations by a specified term.

Namespace

Plenty\Modules\Pim\SearchService\Query

Methods

public setLang(string $lang):void

Sets the language to search in.

Parameters
string $lang
public toArray():array

Returns the search query as array.

public setOperator(string $operator):void

Set the operator for the terms in the search query. Possible values: or, and

Parameters
string $operator
public setFuzzy(string $fuzzy):void

Set whether this is a fuzzy search or not.

Parameters
string $fuzzy
public addFilterField(string $field, int $boost):void

Add a filter field to search in.

Parameters
string $field
int $boost
public addMultilingualField(string $field, string $language, int $boost):void

Add a multilingual field to search in.

Parameters
string $field
string $language
int $boost
public addOtherAnalyzedField(string $field, int $boost):void

Add a other analyzed field to search in.

Parameters
string $field
int $boost
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement
public static isLanguageSupported(string $lang):bool
Parameters
string $lang
public static isLanguageActivated(string $lang):bool
Parameters
string $lang
public static getM10lByLanguage(string $lang, string $fallback = "en"):string
Parameters
string $lang
string $fallback
public static getLanguageByM10l(string $lang, string $fallback = "english"):string
Parameters
string $lang
string $fallback

SearchQuery

Used to search for variations by a specified term.

Namespace

Plenty\Modules\Pim\SearchService\Query

Methods

public setOperator(string $operator):void

Set the operator for the terms in the search query. Possible values: or, and

Parameters
string $operator
public setFuzzy(string $fuzzy):void

Set whether this is a fuzzy search or not.

Parameters
string $fuzzy
public addFilterField(string $field, int $boost):void

Add a filter field to search in.

Parameters
string $field
int $boost
public addMultilingualField(string $field, string $language, int $boost):void

Add a multilingual field to search in.

Parameters
string $field
string $language
int $boost
public addOtherAnalyzedField(string $field, int $boost):void

Add a other analyzed field to search in.

Parameters
string $field
int $boost
public toArray():array
public addStatement(StatementInterface
 $statement):void
Parameters
StatementInterface $statement
public addQuery($statement):void
Parameters
$statement
public static isLanguageSupported(string $lang):bool
Parameters
string $lang
public static isLanguageActivated(string $lang):bool
Parameters
string $lang
public static getM10lByLanguage(string $lang, string $fallback = "en"):string
Parameters
string $lang
string $fallback
public static getLanguageByM10l(string $lang, string $fallback = "english"):string
Parameters
string $lang
string $fallback

Aggregations

Facet

NestedFacetValuesAggregation

Provides a list of all facet value ids of a specific facet

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Facet

Methods

public getName():string

Get the name of the aggregation

public getAggregation():array

Get the aggregation as array

public toArray():array

Returns the aggregation as array

public process(array $data):array
Parameters
array $data
public addAggregation(AggregationInterface
 $aggregation):void
Parameters
AggregationInterface $aggregation
public addSource(SourceInterface
 $source):AggregationInterface
Parameters
SourceInterface $source
public setPage(int $page, int $rowsPerPage):AggregationInterface
Parameters
int $page
int $rowsPerPage
public getSources():void

Feedback

FeedbackRangeAggregation

Provides the count feedbacks in specific ranges (1 to 6, 2 to 6, 3 to 6, 4 to 6 and 5 to 6)

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Feedback

Methods

public getName():string

Get the name of the aggregation

public getField():string

Get the field of the aggregation

public getRanges():array

Get the ranges of the aggregation

public getAggregation():void
public toArray():array
public process(array $data):array
Parameters
array $data
public addAggregation(AggregationInterface
 $aggregation):void
Parameters
AggregationInterface $aggregation
public addSource(SourceInterface
 $source):AggregationInterface
Parameters
SourceInterface $source
public setPage(int $page, int $rowsPerPage):AggregationInterface
Parameters
int $page
int $rowsPerPage
public getSources():void

Price

ItemMinPriceAggregation

Get min price by price id for found variations

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Price

Methods

public getName():string

Get the name of the aggregation

public getAggregation():array

Get the aggregation as array

public toArray():array
public process(array $data):array
Parameters
array $data
public addAggregation(AggregationInterface
 $aggregation):void
Parameters
AggregationInterface $aggregation
public addSource(SourceInterface
 $source):AggregationInterface
Parameters
SourceInterface $source
public setPage(int $page, int $rowsPerPage):AggregationInterface
Parameters
int $page
int $rowsPerPage
public getSources():void

PriceRangeAggregation

Get price range for found variations

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Price

Methods

public getName():string

Get the name of the aggregation

public setPriceIds(array $ids):void

Set the price ids which should be aggregated

Parameters
array $ids
public process(array $data):array

Process the provided data

Parameters
array $data
public getAggregation():array

Get the aggregation as array

public toArray():array
public addAggregation(AggregationInterface
 $aggregation):void
Parameters
AggregationInterface $aggregation
public addSource(SourceInterface
 $source):AggregationInterface
Parameters
SourceInterface $source
public setPage(int $page, int $rowsPerPage):AggregationInterface
Parameters
int $page
int $rowsPerPage
public getSources():void

Processors

AttributeValueAggregationProcessor

Processor for AttributeValueAggregation

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Processors

Methods

public process(array $data):array

Processes the data provided by the aggregation

Parameters
array $data
public getName():string

Get the name of the aggregation

public getDependencies():array
public addMutator(MutatorInterface
 $mutator):Processor
Parameters
MutatorInterface $mutator
public addCondition(ConditionInterface
 $conditions):Processor
Parameters
ConditionInterface $conditions

CategoryAllTermsAggregationProcessor

Processor for CategoryAllTermsAggregation

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Processors

Methods

public process(array $data):array

Processes the data provided by the aggregation

Parameters
array $data
public getName():string

Get the name of the aggregation

public getDependencies():array
public addMutator(MutatorInterface
 $mutator):Processor
Parameters
MutatorInterface $mutator
public addCondition(ConditionInterface
 $conditions):Processor
Parameters
ConditionInterface $conditions

CategoryPathTermsAggregationProcessor

Processor for CategoryAllTermsAggregation

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Processors

Methods

public process(array $data):array

Processes the data provided by the aggregation

Parameters
array $data
public getName():string

Get the name of the aggregation

public setFullPath(bool $fullPath):CategoryPathTermsAggregationProcessor

Set if the full path should be used, or only the last element

Parameters
bool $fullPath
public getDependencies():array
public addMutator(MutatorInterface
 $mutator):Processor
Parameters
MutatorInterface $mutator
public addCondition(ConditionInterface
 $conditions):Processor
Parameters
ConditionInterface $conditions

FacetAggregationProcessor

Processor for MultiAggregation

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Processors

Methods

public process(array $data):array

Processes the data provided by the aggregation

Parameters
array $data
public getName():string

Get the name of the aggregation

public getDependencies():array
public addMutator(MutatorInterface
 $mutator):Processor
Parameters
MutatorInterface $mutator
public addCondition(ConditionInterface
 $conditions):Processor
Parameters
ConditionInterface $conditions

FeedbackRangeAggregationProcessor

Processor for FeedbackRangeAggregation

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Processors

Methods

public process(array $data):array

Processes the data provided by the aggregation

Parameters
array $data
public getName():string

Get the name of the aggregation

public getDependencies():array
public addMutator(MutatorInterface
 $mutator):Processor
Parameters
MutatorInterface $mutator
public addCondition(ConditionInterface
 $conditions):Processor
Parameters
ConditionInterface $conditions

ItemCardinalityAggregationProcessor

Processor for ItemCardinalityAggregation

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Processors

Methods

public process(array $data):array

Processes the data provided by the aggregation

Parameters
array $data
public getDependencies():array

Get dependencies of the aggregation

public addMutator(MutatorInterface
 $mutator):Processor
Parameters
MutatorInterface $mutator
public addCondition(ConditionInterface
 $conditions):Processor
Parameters
ConditionInterface $conditions

ItemIdTermsAggregationProcessor

Processor for ItemIdTermsAggregation

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Processors

Methods

public process(array $data):array

Processes the data provided by the aggregation

Parameters
array $data
public getName():string

Get the name of the aggregation

public getDependencies():array
public addMutator(MutatorInterface
 $mutator):Processor
Parameters
MutatorInterface $mutator
public addCondition(ConditionInterface
 $conditions):Processor
Parameters
ConditionInterface $conditions

ItemMinPriceAggregationProcessor

Processor for ItemMinPriceAggregation

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Processors

Methods

public process(array $data):array

Processes the data provided by the aggregation

Parameters
array $data
public getName():string

Get the name of the aggregation

public getDependencies():array
public addMutator(MutatorInterface
 $mutator):Processor
Parameters
MutatorInterface $mutator
public addCondition(ConditionInterface
 $conditions):Processor
Parameters
ConditionInterface $conditions

SalableFilterAggregationProcessor

Processor for SalableFilterAggregation

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Processors

Methods

public process(array $data):array

Processes the data provided by the aggregation

Parameters
array $data
public getName():string

Get the name of the aggregation

public addSubProcessor(ProcessorInterface
 $processor):void

Add a sub processor to this processor

Parameters
ProcessorInterface $processor
public getDependencies():array
public addMutator(MutatorInterface
 $mutator):Processor
Parameters
MutatorInterface $mutator
public addCondition(ConditionInterface
 $conditions):Processor
Parameters
ConditionInterface $conditions

SearchSuggestionsTermsAggregationProcessor

Processor for SearchSuggestionsTermsAggregation

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Processors

Methods

public process(array $data):array

Processes the data provided by the aggregation

Parameters
array $data
public getName():string

Get the name of the aggregation

public getDependencies():array
public addMutator(MutatorInterface
 $mutator):Processor
Parameters
MutatorInterface $mutator
public addCondition(ConditionInterface
 $conditions):Processor
Parameters
ConditionInterface $conditions

UnitCombinationAggregationProcessor

Processor for UnitCombinationAggregation

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\Processors

Methods

public process(array $data):array

Processes the data provided by the aggregation

Parameters
array $data
public getName():string

Get the name of the aggregation

public getDependencies():array
public addMutator(MutatorInterface
 $mutator):Processor
Parameters
MutatorInterface $mutator
public addCondition(ConditionInterface
 $conditions):Processor
Parameters
ConditionInterface $conditions

SearchSuggestions

SearchSuggestionsTermsAggregation

Get suggestions for found variations, use setInclude to filter them.

Namespace

Plenty\Modules\Pim\SearchService\Aggregations\SearchSuggestions

Methods

public getName():string

Get the name of the aggregation

public getField():string

Get the field of the aggregation

public getAggregation():array
public setInclude(string $string):void
Parameters
string $string
public toArray():array
public process(array $data):array
Parameters
array $data
public addAggregation(AggregationInterface
 $aggregation):void
Parameters
AggregationInterface $aggregation
public addSource(SourceInterface
 $source):AggregationInterface
Parameters
SourceInterface $source
public setPage(int $page, int $rowsPerPage):AggregationInterface
Parameters
int $page
int $rowsPerPage
public getSources():void
public static isLanguageSupported(string $lang):bool
Parameters
string $lang
public static isLanguageActivated(string $lang):bool
Parameters
string $lang
public static getM10lByLanguage(string $lang, string $fallback = "en"):string
Parameters
string $lang
string $fallback
public static getLanguageByM10l(string $lang, string $fallback = "english"):string
Parameters
string $lang
string $fallback

VariationDataInterface

Contracts

AttributeInterface

The interface of all variation attributes

Namespace

Plenty\Modules\Pim\VariationDataInterface\Contracts

Methods

public getName():string

Get the name of the attribute

public static getVariationAttribute():string

Get the related key on the variation model.

public addLazyLoadParts(array $lazyLoadParts):Contracts

Get all parts which should be lazy loaded.

Parameters
array $lazyLoadParts
public getLazyLoadParts():array

Get all parts which should be lazy loaded.

VariationDataInterfaceContract

Use this interface to load performant article data

Namespace

Plenty\Modules\Pim\VariationDataInterface\Contracts

Methods

public getResult(VariationDataInterfaceContext
 $context):VariationDataInterfaceResultInterface

Get the result, using the context.

Parameters
VariationDataInterfaceContext $context
public getMultipleResults(array $contextList):array

Get the multiple results, using multiple contexts

Parameters
array $contextList

VariationDataInterfaceResultInterface

The Result of the variation data interface

Namespace

Plenty\Modules\Pim\VariationDataInterface\Contracts

Methods

public getContext():VariationDataInterfaceContext

Get the context which is uses for this result .

public total():int

Get the total found variations.

public get():void

Get all found variations as Traversable.

public getAdditionalData():array

Get additional data provided by the elasticsearch result

Model

Variation

The variation model, contains all possible informations of a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model

Properties

Type Name Description
int id The id of the variation.
array additionalSkus The additional skus of the variation.
array attributeValues The attribute values of the variation.
Base base The base data of the variation.
array barcodes The barcodes of the variation.
array bundleComponents The bundle components of the variation.
array categories The categories of the variation.
array clients The clients of the variation.
array defaultCategories The default categories of the variation.
array images The images of the variation.
array markets The markets of the variation.
array marketIdentNumbers The market ident numbers of the variation.
array salesPrices The sales prices of the variation.
array skus The skus of the variation.
array supplier The supplier of the variation.
Timestamp timestamps The timestamps of the variation.
array warehouses The warehouses of the variation.
Unit unit The unit of the variation.
array tags The tags of the variation.
array comments The comments of the variation.
array properties The properties of the variation.
array elasticSearchSource

Methods

public toArray()

Returns this model as an array.

VariationDataInterfaceContext

The Conext to define what you get frome the VDI

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model

Methods

public addFilter(TypeInterface
 $filter):VariationDataInterfaceContext

Add filter to restrict the result.

Parameters
TypeInterface $filter
public addAggregation(AggregationInterface
 $aggregation):VariationDataInterfaceContext

Add aggregation to aggregate the result.

Parameters
AggregationInterface $aggregation
public addSuggestion(SuggestionInterface
 $suggestion):VariationDataInterfaceContext

Add suggestion to get suggestions in the result.

Parameters
SuggestionInterface $suggestion
public addQuery(TypeInterface
 $filter):VariationDataInterfaceContext

Add query to restrict the result. Queries affecting the score.

Parameters
TypeInterface $filter
public getFilter():Collection

Get filters which are added to the context.

public getIds():void

Get ids which are added to the context.

public setIds(Collection
 $ids):void

Set ids. All other restrictions are ignored.

Parameters
Collection $ids
public getAggregations():void

Get aggregations which are added to the result.

public getSuggestions():void

Get suggestions which are added to the result.

public getQuery():void

Get queries which are added to the result.

public getParts():void

Get parts which are added to the result.

public addPart(AttributeInterface
 $part):void

Add part to the result. A part specifies what is returned in the result.

Parameters
AttributeInterface $part
public setParts(array $parts):VariationDataInterfaceContext

Set parts. A part specifies what is returned in the result.

Parameters
array $parts
public getPlentyIds():void

Get plenty ids. No further functionality added yet

public setPlentyIds(Collection
 $plentyIds):void

Set plenty ids. No further functionality added yet

Parameters
Collection $plentyIds
public getLanguages():void

Get languages. No further functionality added yet

public setLanguages(Collection
 $languages):void

Set languages. No further functionality added yet

Parameters
Collection $languages
public getPage():int

Get the wanted page value.

public setPage(int $page = 1, int $perPage = 50):VariationDataInterfaceContext

Set the page and Items per page.

Parameters
int $page
int $perPage
public getPerPage():int

Get the wanted per page value.

public isGetAllFound():bool

returns whether get all found or not

public setGetAllFound(bool $getAll):Model

set whether the result should return all found entities or not

Parameters
bool $getAll
public getBatchSize():int

Get the wanted batch size.

public setBatchSize(int $batchSize):VariationDataInterfaceContext

Set the batch size of result batch.

Parameters
int $batchSize
public getContextId():string

Get the current context id.

public getGroupBy():GroupBy

Get the wanted group by or null if non is set.

public setGroupBy(GroupBy
 $groupBy):VariationDataInterfaceContext

Set a group by for the result.

Parameters
GroupBy $groupBy
public getDecoratedReturnType():string

Get the decorated return type.

public getSorting():SortingInterface

Get the sorting the result should be sorted by.

public setSorting(SortingInterface
 $sorting):VariationDataInterfaceContext

SeSett the sorting the result should be sorted by.

Parameters
SortingInterface $sorting
public getScoreModifier():ScoreModifierInterface

Get a score modifier. Score modifier are manipulation the score of the result hits.

public setScoreModifier(ScoreModifierInterface
 $scoreModifier):VariationDataInterfaceContext

Set a score modifier. Score modifier are manipulation the score of the result hits.

Parameters
ScoreModifierInterface $scoreModifier
public getAdditionalSource():IndependentSource

Get the additional source which should be added to the result.

public setAdditionalSource(IndependentSource
 $additionalSource):VariationDataInterfaceContext

Set the additional source which should be added to the result.

Parameters
IndependentSource $additionalSource
public hasAdditionalSource():bool

Returns whether the context has an additional source or not

public getUseInMemoryCache():bool

Returns whether the in memory cache should be used or not

public setUseInMemoryCache(bool $useInMemoryCache):VariationDataInterfaceContext

Set whether the in memory cache should be used or not. It is recommended to use this cache (Default)

Parameters
bool $useInMemoryCache
public isHasAdditionalSource():bool

Returns whether the context has an additional source or not

public setHasAdditionalSource(bool $hasAdditionalSource):void

Set whether the context has an additional source or not. This is normally determined automatically

Parameters
bool $hasAdditionalSource
public getSearchAfterKey():string

Get the search after key.

public setSearchAfterKey(string $searchAfterKey):Model

Set the search after key. Set null for the first page.

Parameters
string $searchAfterKey
public isSearchAfter():bool

Returns whether this is an search after search.

Model

Attributes

VariationAdditionalSkuAttribute

The additional sku part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationAttributeValueAttribute

The attribute part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationBarcodeAttribute

The barcode part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationBaseAttribute

The base part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationBundleComponentAttribute

The bundle component part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationCategoryAttribute

The category part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationClientAttribute

The client part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationCommentAttribute

The comment part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationDefaultCategoryAttribute

The default category part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationImageAttribute

The image part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationMarketAttribute

The market part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationMarketIdentNumberAttribute

The market ident number part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationPropertyAttribute

The property part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationSalesPriceAttribute

The sales price part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationSkuAttribute

The sku part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationSupplierAttribute

The supplier part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationTagAttribute

The tag part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationTimestampAttribute

The timestamp part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationUnitAttribute

The unit part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

VariationWarehouseAttribute

The warehouse part of the variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Attributes

Methods

public static getVariationAttribute():string

Get the related key on the variation model.

public getName():string
public addLazyLoadParts($lazyLoadParts):void
Parameters
$lazyLoadParts
public getLazyLoadParts():void

Context

GroupBy

Group by the result, expects 2 params: field - the field which the result is grouped by, sorting - the inner sorting, must be instance of SortingInterface.)

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\Context

Methods

public getField():string

Get the field the result should be grouped by.

DecoratedAttributes

AdditionalSku

contains informations about an additonal sku, belongs to a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
int id The unique ID of the additional sku
float marketId The ID of the market
int marketAccountId The ID of the market account
string sku The additional sku for this variation.

Methods

public toArray()

Returns this model as an array.

AttributeValue

contains informations about an attribute value, belongs to a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
With with
int attributeId The unique ID of the attribute
int attributeValueSetId The unique ID of the attribute
int valueId The unique ID of the attribute value

Methods

public toArray()

Returns this model as an array.

Barcode

contains informations about a barcode, belongs to a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
With with
string code The code of the variation's barcode. The combination of code and barcode ID must be unique.
int barcodeId The unique ID of the barcode linked to the variation. The combination of code and barcode ID must be unique.

Methods

public toArray()

Returns this model as an array.

Base

contains the basic informations of a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
With with
bool isMain
int mainVariationId
int itemId
int position
bool isActive
string number
string model
string externalId
int availability
string estimatedAvailableAt
float purchasePrice
float movingAveragePrice
int priceCalculationId
string priceCalculationUUID
string picking
int stockLimitation
string isVisibleIfNetStockIsPositive
string isInvisibleIfNetStockIsNotPositive
string isAvailableIfNetStockIsPositive
string isUnavailableIfNetStockIsNotPositive
string isVisibleInListIfNetStockIsPositive
string isInvisibleInListIfNetStockIsNotPositive
int mainWarehouseId
float maximumOrderQuantity
float minimumOrderQuantity
float intervalOrderQuantity
string availableUntil
string releasedAt
string name
int weightG
int weightNetG
int widthMM
int lengthMM
int heightMM
float extraShippingCharge1
float extraShippingCharge2
int unitsContained
int palletTypeId
int packingUnits
int packingUnitsTypeId
float transportationCosts
float storageCosts
float customs
float operatingCosts
int vatId
string bundleType
int automaticClientVisibility
int automaticListVisibility
string isHiddenInCategoryList
float defaultShippingCosts
string mayShowUnitPrice
int parentVariationId
float parentVariationQuantity
int singleItemCount
string hasCalculatedBundleWeight
string hasCalculatedBundleNetWeight
string hasCalculatedBundlePurchasePrice
string hasCalculatedBundleMovingAveragePrice
string customsTariffNumber
bool categoriesInherited
bool referrerInherited
bool clientsInherited
bool salesPricesInherited
bool supplierInherited
bool warehousesInherited
bool propertiesInherited
bool tagsInherited

Methods

public toArray()

Returns this model as an array.

BundleComponent

contains informations about a barcode, belongs to a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
int componentVariationId The unique ID of the variation added as bundle component
float componentQuantity The quantity of the variation to be added as bundle component

Methods

public toArray()

Returns this model as an array.

Category

contains informations about a category, belongs to a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
With with
int categoryId The unique ID of the category
int position The position of the category
string isNeckermannPrimary Flag that indicates if the category is the primary category for the market Neckermann for this variation.

Methods

public toArray()

Returns this model as an array.

Client

contains informations about a client, belongs to a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
int plentyId The unique ID of the client (store)

Methods

public toArray()

Returns this model as an array.

Comment

contains informations about a comment, belongs to a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
int id
int userId The unique ID of the user
string text
bool isVisibleForContact

Methods

public toArray()

Returns this model as an array.

DefaultCategory

contains informations about a default category, belongs to a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
With with
int branchId The unique ID of the category branch
int plentyId The unique plenty ID of the client (store)
bool manually

Methods

public toArray()

Returns this model as an array.

Image

contains informations about an image, belongs to a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
With with
int imageId The unique ID of the image

Methods

public toArray()

Returns this model as an array.

Market

contains informations about an market, belongs to a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
float marketId The unique ID of the market

Methods

public toArray()

Returns this model as an array.

MarketIdentNumber

contains informations about an market ident number, belongs to a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
int id The unique id of the market ident number (ASIN/ePID)
int countryId The country code of the market ident number (ASIN/ePID)
string type The type of market ident number (ASIN/ePID)
int position The position of the market ident number (ASIN/ePID)
string value The value of the market ident number (ASIN/ePID)

Methods

public toArray()

Returns this model as an array.

Property

contains informations about a property, belongs to a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
With with
int propertyId The unique ID of the property
array values the values of this relation

Methods

public toArray()

Returns this model as an array.

SalesPrice

contains informations about a client, belongs to a salesPrice

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
With with
int salesPriceId The unique ID of the sales price
float price The price of the variation saved for this sales price

Methods

public toArray()

Returns this model as an array.

Sku

contains informations about a sku, belongs to a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
int id The ID of the sku
float marketId The ID of the market
int accountId The ID of the market account
string initialSku The initial SKU of the variation. The initial SKU cannot be modified even if the variation SKU is changed. However, it is possible to reset the variation SKU to the initial SKU.
string sku The SKU of the variation. The SKU is adjustable but may not exist twice for the combination of market Id and account Id.
string parentSku The Parent SKU of the variation. The Parent SKU is adjustable. The same Parent SKU value should be used on variations of same article.
bool isActive Flag that indicates if the item is ready for export (currently not in use).
string exportedAt The time the variation was last exported (YYYY-MM-DD HH:MM:SS).
string stockUpdatedAt
string deletedAt The time the variation was deleted (YYYY-MM-DD HH:MM:SS).
string status The status of the variation after the export. Possible entries are INACTIVE, ERROR, SENT and ACTIVE.
string additionalInformation The field that contains additional information.

Methods

public toArray()

Returns this model as an array.

Supplier

contains informations about a supplier, belongs to a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
With with
int id The unique ID of the link between variation and supplier.
int supplierId The unique ID of the supplier.
float purchasePrice The price at which the variation was purchased from this supplier.
int minimumPurchase The minimum quantity of the variation that has to be ordered from the supplier. This value is also used as a quantity suggestion when creating reorders.
string itemNumber The external item number assigned to the variation by this supplier.
string lastPriceQuery The date of the last price query to this supplier. This helps to plan price negotiations.
int deliveryTimeInDays The delivery time in days for the variation saved for this supplier.
float discount The discount in percent the supplier grants for the variation.
bool isDiscountable Flag that indicates if the supplier's discount for this variation is active.
float packagingUnit The packaging unit of the supplier if it differs from the packaging unit settings in plentymarkets.
float currencyPurchasePrice The price at which the variation was purchased from this supplier in the currency of the supplier.
string itemDescription The supplier item description.

Methods

public toArray()

Returns this model as an array.

Tag

contains informations about a tag, belongs to a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
With with
int tagId The unique ID of the tag

Methods

public toArray()

Returns this model as an array.

Timestamp

contains informations the timestamps of a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
Carbon availability The time the availability of the variation was last modified.
Carbon additionalSku The time any additional sku of the variation was last modified.
Carbon barcode The time any barcode of the variation was last modified.
Carbon base The time any field of the variation was last modified.
Carbon bundleComponent The time any bundle component of the variation was last modified.
Carbon category The time any category of the variation was last modified.
Carbon client The time any client of the variation was last modified.
Carbon defaultCategory The time any default category of the variation was last modified.
Carbon image The time any image of the variation was last modified.
Carbon market The time any market of the variation was last modified.
Carbon marketIdentNumber The time any market ident number of the variation was last modified.
Carbon related The time any relation of the variation was last modified.
Carbon salesPrice The time any sales price of the variation was last modified.
Carbon sku The time any sku of the variation was last modified.
Carbon supplier The time any supplier of the variation was last modified.
Carbon warehouse The time any warehouse of the variation was last modified.
Carbon property The time any property of the variation was last modified.
Carbon comment The time any comment of the variation was last added.
Carbon tag The time any tag of the variation was last modified.
Carbon createdAt The time any warehouse of the variation was last modified.

Methods

public toArray()

Returns this model as an array.

Unit

contains informations about the unit of the variaiton

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
With with
int unitId The unique ID of the unit
float content The content
int unitCombinationId The unit combinationId

Methods

public toArray()

Returns this model as an array.

Warehouse

contains informations about a warehouse, belongs to a variation

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes

Properties

Type Name Description
With with
int warehouseId The unique ID of the warehouse
int warehouseZoneId The unique ID of the warehouse zone
string storageLocationType The storage location type of the warehouse
int reorderLevel The reorder level for the variation in this warehouse
int maximumStock The maximum stock for the variation in this warehouse
int stockTurnoverInDays The stock turnover in days for the variation in this warehouse
int storageLocation The storage location of the variation in this warehouse
int stockBuffer The stock buffer for the variation in this warehouse
bool isBatch Is for warehouse and variation stock batch active
bool isBestBeforeDate Is for warehouse and variation stock best before date active

Methods

public toArray()

Returns this model as an array.

Decorators

AttributeValue

With

contains lazy loaded attribute data

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes\Decorators\AttributeValue

Properties

Type Name Description
Attribute attribute
AttributeValue attributeValue

Methods

public toArray()

Returns this model as an array.

Barcode

With

contains lazy loaded barcode data

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes\Decorators\Barcode

Properties

Type Name Description
Barcode barcode

Methods

public toArray()

Returns this model as an array.

Base

With

contains lazy loaded base data

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes\Decorators\Base

Properties

Type Name Description
Item item
array characteristics
array crossSelling
array texts
array feedback
Availability availability
array shippingProfiles
array images
array stock
array stockStorageLocations
array serialNumbers
ItemSetConfig setConfig

Methods

public toArray()

Returns this model as an array.

Category

With

contains lazy loaded category data

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes\Decorators\Category

Properties

Type Name Description
Category category
CategoryBranch categoryBranch

Methods

public toArray()

Returns this model as an array.

DefaultCategory

With

contains lazy loaded default category data

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes\Decorators\DefaultCategory

Properties

Type Name Description
Category defaultCategory

Methods

public toArray()

Returns this model as an array.

Images

With

contains lazy loaded image data

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes\Decorators\Images

Properties

Type Name Description
ItemImage image

Methods

public toArray()

Returns this model as an array.

Property

With

contains lazy loaded property data

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes\Decorators\Property

Properties

Type Name Description
Property property

Methods

public toArray()

Returns this model as an array.

SalesPrice

With

contains lazy loaded sales price data

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes\Decorators\SalesPrice

Properties

Type Name Description
SalesPrice salesPrice

Methods

public toArray()

Returns this model as an array.

Supplier

With

contains lazy loaded supplier data

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes\Decorators\Supplier

Properties

Type Name Description
Contact supplier

Methods

public toArray()

Returns this model as an array.

Tag

With

contains lazy loaded tag data

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes\Decorators\Tag

Properties

Type Name Description
Tag tag

Methods

public toArray()

Returns this model as an array.

Unit

With

contains lazy loaded unit data

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes\Decorators\Unit

Properties

Type Name Description
Unit unit

Methods

public toArray()

Returns this model as an array.

Warehouse

With

contains lazy loaded warehouse data

Namespace

Plenty\Modules\Pim\VariationDataInterface\Model\DecoratedAttributes\Decorators\Warehouse

Properties

Type Name Description
Warehouse warehouse

Methods

public toArray()

Returns this model as an array.