Plentymarkets interface documentation
Facet
Contracts
FacetNameRepositoryContract
The contract for the facet name repository
Namespace
Plenty\Modules\Facet\Facet\Contracts
Methods
public findOne($facetId, $lang):Plenty\Modules\Facet\Facet\Models\FacetNameReturn type: FacetName
Name |
Type |
Description |
|
||
|
public create($data):Plenty\Modules\Facet\Facet\Models\FacetNameReturn type: FacetName
Name |
Type |
Description |
|
public update($facetId, $lang, $data):Plenty\Modules\Facet\Facet\Models\FacetNameReturn type: FacetName
Name |
Type |
Description |
|
||
|
||
|
public delete($facetId, $lang):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Name |
Type |
Description |
|
||
|
FacetRepositoryContract
The contract for the facet repository
Namespace
Plenty\Modules\Facet\Facet\Contracts
Methods
public search($with, $filters):Illuminate\Support\CollectionReturn type: Collection
Name |
Type |
Description |
|
||
|
public listByPlentyId($plentyId, $lang = "de"):arrayName |
Type |
Description |
|
||
|
public findOne($id):Plenty\Modules\Facet\Facet\Models\FacetReturn type: Facet
Name |
Type |
Description |
|
public create($data):Plenty\Modules\Facet\Facet\Models\FacetReturn type: Facet
Name |
Type |
Description |
|
public update($id, $data):Plenty\Modules\Facet\Facet\Models\FacetReturn type: Facet
Name |
Type |
Description |
|
||
|
public delete($id):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Name |
Type |
Description |
|
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
FacetValueNameRepositoryContract
The contract for the facet value name repository
Namespace
Plenty\Modules\Facet\Facet\Contracts
Methods
public findOne($valueId, $lang):Plenty\Modules\Facet\Facet\Models\FacetValueNameReturn type: FacetValueName
Name |
Type |
Description |
|
||
|
public create($data):Plenty\Modules\Facet\Facet\Models\FacetValueNameReturn type: FacetValueName
Name |
Type |
Description |
|
public update($valueId, $lang, $data):Plenty\Modules\Facet\Facet\Models\FacetValueNameReturn type: FacetValueName
Name |
Type |
Description |
|
||
|
||
|
public delete($valueId, $lang):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Name |
Type |
Description |
|
||
|
FacetValueReferenceRepositoryContract
The contract for the facet value reference repository
Namespace
Plenty\Modules\Facet\Facet\Contracts
Methods
public search($filters):Illuminate\Support\CollectionReturn type: Collection
Name |
Type |
Description |
|
public create($data):Plenty\Modules\Facet\Facet\Models\FacetValueReferenceReturn type: FacetValueReference
Name |
Type |
Description |
|
public delete($id):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Name |
Type |
Description |
|
public findOne($id):Plenty\Modules\Facet\Facet\Models\FacetValueReferenceReturn type: FacetValueReference
Name |
Type |
Description |
|
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
FacetValueRepositoryContract
The contract for the facet value repository
Namespace
Plenty\Modules\Facet\Facet\Contracts
Methods
public search($with, $filters):Illuminate\Support\CollectionReturn type: Collection
Name |
Type |
Description |
|
||
|
public create($data):Plenty\Modules\Facet\Facet\Models\FacetValueReturn type: FacetValue
Name |
Type |
Description |
|
public update($id, $data):Plenty\Modules\Facet\Facet\Models\FacetValueReturn type: FacetValue
Name |
Type |
Description |
|
||
|
public delete($id):Plenty\Repositories\Models\DeleteResponseReturn type: DeleteResponse
Name |
Type |
Description |
|
public findOne($id):Plenty\Modules\Facet\Facet\Models\FacetValueReturn type: FacetValue
Name |
Type |
Description |
|
public clearCriteria():voidResets all Criteria filters by creating a new instance of the builder object.
public applyCriteriaFromFilters():voidApplies criteria classes to the current repository.
public setFilters($filters = []):voidSets the filter array.
Name |
Type |
Description |
|
public getFilters():voidReturns the filter array.
public getConditions():voidReturns a collection of parsed filters as Condition object
public clearFilters():voidClears the filter array.
Models
Facet
The facet model.
Namespace
Plenty\Modules\Facet\Facet\Models
| Name | Type | Description |
|---|---|---|
id |
The unique ID of the facet |
|
cssClass |
||
position |
The position of the facet. Default value is 1 |
|
sort |
Allowed sorts are "position", "rate" and "a-z". Default value is "position" |
|
createdAt |
Timestamp of the date and time the facet was created. |
|
updatedAt |
Timestamp of the last date and time the facet was updated. |
|
type |
Allowed types: "dynamic", "producer", "availability", "price". Default value is "dynamic" |
|
minResultCount |
Default value is 1 |
|
maxResultCount |
Default value is 50 |
|
filterMethod |
Allowed filter methods: "restrict", "multi". Default value is "strict" |
|
names |
||
values |
||
references |
Methods
public toArray()Returns this model as an array.
FacetName
The facet name model.
Namespace
Plenty\Modules\Facet\Facet\Models
| Name | Type | Description |
|---|---|---|
facetId |
The unique ID of the facet |
|
lang |
The <a href="https://developers.plentymarkets.com/rest-doc/introduction#countries" target="_blank">language</a> of the facet |
|
name |
The name of the facet |
|
facet |
Methods
public toArray()Returns this model as an array.
FacetValue
The facet value model.
Namespace
Plenty\Modules\Facet\Facet\Models
| Name | Type | Description |
|---|---|---|
id |
The unique ID of the facet value |
|
facetId |
The unique ID of the facet |
|
cssClass |
The css class of the facet value |
|
position |
The position of the facet value |
|
createdAt |
Timestamp of the date and time the facet value was created. |
|
updatedAt |
Timestamp of the last date and time the facet value was updated. |
|
facet |
||
names |
||
references |
Methods
public toArray()Returns this model as an array.
FacetValueName
The facet value name model.
Namespace
Plenty\Modules\Facet\Facet\Models
| Name | Type | Description |
|---|---|---|
valueId |
The unique ID of the facet value |
|
lang |
The <a href="https://developers.plentymarkets.com/rest-doc/introduction#countries" target="_blank">language</a> of the facet value |
|
name |
The name of the facet value |
|
value |
Methods
public toArray()Returns this model as an array.
FacetValueReference
The facet value reference model.
Namespace
Plenty\Modules\Facet\Facet\Models
| Name | Type | Description |
|---|---|---|
id |
The unique ID of the facet value reference |
|
facetId |
The unique ID of the facet |
|
facetValueId |
The unique ID of the facet value |
|
type |
Allowed types are "attribute", "character", "producer" and "availability". Default value is "attribute" |
|
groupId |
The group ID of the facet value reference. Default value is 0 |
|
valueId |
The value ID of the facet value reference. Default value is 0 |
|
createdAt |
Timestamp of the date and time the facet was created. |
|
facet |
||
value |
Methods
public toArray()Returns this model as an array.