Plentymarkets interface documentation

Property

Contracts

PropertyAmazonRepositoryContract

This interface allows you to get, create, update and delete property amazons.

Deprecated! (since 2021-06-24)

Please use \Plenty\Modules\Property\V2\Repositories\PropertyAmazonRepository instead

Namespace

Plenty\Modules\Property\Contracts

Methods
public getPropertyAmazon($propertyAmazonId):Plenty\Modules\Property\Models\PropertyAmazon
Return type: PropertyAmazon

Gets a property amazon. The ID of the property amazon must be specified.

Parameters

Name

Type

Description

$propertyAmazonId

int

public listPropertyAmazons($with = [], $filters = []):array

List property amazons

Parameters

Name

Type

Description

$with

array

$filters

array

The filter available is: <ol><li>propertyId</li></ol>

public createPropertyAmazon($data):Plenty\Modules\Property\Models\PropertyAmazon
Return type: PropertyAmazon

Creates one or multiple property amazon

Parameters

Name

Type

Description

$data

array

The request data

public updatePropertyAmazon($data):Plenty\Modules\Property\Models\PropertyAmazon
Return type: PropertyAmazon

Updates one or multiple property amazon.

Parameters

Name

Type

Description

$data

array

public deletePropertyAmazon($propertyAmazonId):void

Deletes a property amazon. The ID of property amazon must be specified.

Parameters

Name

Type

Description

$propertyAmazonId

int

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

PropertyAvailabilityRepositoryContract

Get, create, update and delete property availability.

Deprecated! (since 2021-06-24)

Please use Property V2 Repositories instead

Namespace

Plenty\Modules\Property\Contracts

Methods
public getAvailability($availabilityId):Plenty\Modules\Property\Models\PropertyAvailability
Return type: PropertyAvailability

Gets an availability. The ID of the availability must be specified.

Parameters

Name

Type

Description

$availabilityId

int

The ID of the availability

public listAvailabilities():array

Lists availabilities

public createAvailability($data):Plenty\Modules\Property\Models\PropertyAvailability
Return type: PropertyAvailability

Creates an availability

Parameters

Name

Type

Description

$data

array

The request data

public updateAvailability($availabilityId, $data):Plenty\Modules\Property\Models\PropertyAvailability
Return type: PropertyAvailability

Updates an availability. The ID of availability must be specified.

Parameters

Name

Type

Description

$availabilityId

int

The ID of the availability

$data

array

The request data

public deleteAvailability($availabilityId):array

Deletes an availability. The ID of availability must be specified.

Parameters

Name

Type

Description

$availabilityId

int

The ID of the availability

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

PropertyGroupNameRepositoryContract

This interface allows you to get, list, create, update and delete property group names.

Deprecated! (since 2021-06-24)

Please use \Plenty\Modules\Property\V2\Repositories\PropertyGroupNameRepository instead

Namespace

Plenty\Modules\Property\Contracts

Methods
public getGroupName($groupNameId):Plenty\Modules\Property\Models\PropertyGroupName
Return type: PropertyGroupName

Gets a group name. The ID of the group name must be specified.

Parameters

Name

Type

Description

$groupNameId

int

The ID of the group name

public listGroupNames():array

Lists group names

public createGroupName($data):Plenty\Modules\Property\Models\PropertyGroupName
Return type: PropertyGroupName

Creates a group name

Parameters

Name

Type

Description

$data

array

The request data

public updateGroupName($groupNameId, $data):Plenty\Modules\Property\Models\PropertyGroupName
Return type: PropertyGroupName

Updates a group name. The ID of the group name must be specified.

Parameters

Name

Type

Description

$groupNameId

int

The ID of the group name

$data

array

The request data

public deleteGroupName($groupNameId):array

Deletes a group name. The ID of group name must be specified.

Parameters

Name

Type

Description

$groupNameId

int

The ID of the group name

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

PropertyGroupOptionRepositoryContract

This interface allows you to get, create, update and delete property group options.

Deprecated! (since 2021-06-24)

Please use \Plenty\Modules\Property\V2\Repositories\PropertyGroupOptionRepository instead

Namespace

Plenty\Modules\Property\Contracts

Methods
public getGroupOption($groupOptionId):Plenty\Modules\Property\Models\PropertyGroupOption
Return type: PropertyGroupOption

Get a group option. The ID of the group option must be specified.

Parameters

Name

Type

Description

$groupOptionId

int

The ID of the group option

public listGroupOptions():array

List group options

public createGroupOption($data):Plenty\Modules\Property\Models\PropertyGroupOption
Return type: PropertyGroupOption

Creates a group option

Parameters

Name

Type

Description

$data

array

The request data

public updateGroupOption($groupOptionId, $data):Plenty\Modules\Property\Models\PropertyGroupOption
Return type: PropertyGroupOption

Updates a group option. The ID of group option must be specified.

Parameters

Name

Type

Description

$groupOptionId

int

The ID of the group option

$data

array

The request data

public deleteGroupOption($groupOptionId):array

Deletes a group option. The ID of group option must be specified.

Parameters

Name

Type

Description

$groupOptionId

int

The ID of the group option

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

PropertyGroupRelationRepositoryContract

This interface allows you to link or unlink properties with a property group.

Deprecated! (since 2021-06-24)

Please use \Plenty\Modules\Property\V2\Repositories\PropertyGroupRelationRepository instead

Namespace

Plenty\Modules\Property\Contracts

Methods

Links a property to a property group.

Parameters

Name

Type

Description

$propertyId

int

$propertyGroupId

int

Unlinks a property to a property group.

Parameters

Name

Type

Description

$propertyId

int

$propertyGroupId

int

PropertyGroupRepositoryContract

This interface allows you to get, list, create, update and delete property groups. Property groups help to structure properties.

Deprecated! (since 2021-06-24)

Please use \Plenty\Modules\Property\V2\Repositories\PropertyGroupRepository instead

Namespace

Plenty\Modules\Property\Contracts

Methods
public getGroup($groupId):Plenty\Modules\Property\Models\PropertyGroup
Return type: PropertyGroup

Gets a property group. The ID of the group must be specified.

Parameters

Name

Type

Description

$groupId

int

The ID of the group

public listGroups($page = 1, $itemsPerPage = 50, $with = [], $filters = [], $paginate = 1):array

Lists property groups

Parameters

Name

Type

Description

$page

int

The page to get. The default page that will be returned is page 1. See also $paginate.

$itemsPerPage

int

The number of groups to be displayed per page. The default number of groups per page is 50. See also $paginate.

$with

array

The relations available are: <ol><li>properties,</li> <li>options and</li> <li>names.</li></ol>

$filters

array

The filters allow to reduce the results listed. The following filters are currently availablle: <ol><li>ID</li> <li>name</li> <li>lang</li> <li>optionIdentifier</li> <li>groupType</li> <li>surchargeType/li></ol>

$paginate

int

Defines whether or not the result will be a paginated result or a list with all results. If 1 is given for the parameter, the result will be paginated.

public createGroup($data):Plenty\Modules\Property\Models\PropertyGroup
Return type: PropertyGroup

Creates a property group

Parameters

Name

Type

Description

$data

array

The request data

public updateGroup($groupId, $data):Plenty\Modules\Property\Models\PropertyGroup
Return type: PropertyGroup

Updates a property group. The ID of group must be specified.

Parameters

Name

Type

Description

$groupId

int

The ID of the group

$data

array

The request data

public deleteGroup($groupId):array

Deletes a property group. The ID of group must be specified.

Parameters

Name

Type

Description

$groupId

int

The ID of the group

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

PropertyMarketRepositoryContract

This interface allows you to get, list, create, update and delete property markets.

Deprecated! (since 2021-06-24)

Please use Property V2 Repositories instead

Namespace

Plenty\Modules\Property\Contracts

Methods
public getPropertyMarket($propertyMarketId):Plenty\Modules\Property\Models\PropertyMarket
Return type: PropertyMarket

Gets a property market. The ID of the property market must be specified.

Parameters

Name

Type

Description

$propertyMarketId

int

The ID of the property market

public listPropertyMarkets():array

Lists property markets

public createPropertyMarket($data):Plenty\Modules\Property\Models\PropertyMarket
Return type: PropertyMarket

Creates a property market

Parameters

Name

Type

Description

$data

array

The request data

public updatePropertyMarket($propertyMarketId, $data):Plenty\Modules\Property\Models\PropertyMarket
Return type: PropertyMarket

Updates a property market. The ID of property market must be specified.

Parameters

Name

Type

Description

$propertyMarketId

int

The ID of the property market

$data

array

The request data

public deletePropertyMarket($propertyMarketId):array

Deletes a property market. The ID of property market must be specified.

Parameters

Name

Type

Description

$propertyMarketId

int

The ID of the property market

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

PropertyNameRepositoryContract

This interface allows you to get, list, create, update and delete property names.

Deprecated! (since 2021-06-24)

Please use \Plenty\Modules\Property\V2\Repositories\PropertyNameRepository instead

Namespace

Plenty\Modules\Property\Contracts

Methods
public getName($nameId):Plenty\Modules\Property\Models\PropertyName
Return type: PropertyName

Gets a property name. The ID of the property name must be specified.

Parameters

Name

Type

Description

$nameId

int

The ID of the name

public listNames($filters = []):array

Lists property names

Parameters

Name

Type

Description

$filters

array

public createName($data):Plenty\Modules\Property\Models\PropertyName
Return type: PropertyName

Creates a property name

Parameters

Name

Type

Description

$data

array

The request data

public updateName($nameId, $data):Plenty\Modules\Property\Models\PropertyName
Return type: PropertyName

Updates a property name. The ID of property name must be specified.

Parameters

Name

Type

Description

$nameId

int

The ID of the name

$data

array

public deleteName($nameId):array

Deletes a property name. The ID of property name must be specified.

Parameters

Name

Type

Description

$nameId

int

The ID of the name

public getPropertyByName($name):Plenty\Modules\Property\Models\PropertyName
Return type: PropertyName

Get a property name by name

Parameters

Name

Type

Description

$name

string

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

PropertyOptionRepositoryContract

This interface allows you to get, list, create, update and delete property options.

Deprecated! (since 2021-06-24)

Please use \Plenty\Modules\Property\V2\Repositories\PropertyOptionRepository instead

Namespace

Plenty\Modules\Property\Contracts

Methods
public getPropertyOption($propertyOptionId):Plenty\Modules\Property\Models\PropertyOption
Return type: PropertyOption

Gets a property option. The ID of the property option must be specified.

Parameters

Name

Type

Description

$propertyOptionId

int

public listPropertyOptions():array

List property options

public createPropertyOption($data):Plenty\Modules\Property\Models\PropertyOption
Return type: PropertyOption

Creates a property option

Parameters

Name

Type

Description

$data

array

The request data

public createPropertyOptions($data):array

Creates property options

Parameters

Name

Type

Description

$data

array

The request data

public updatePropertyOption($propertyOptionId, $data):Plenty\Modules\Property\Models\PropertyOption
Return type: PropertyOption

Updates a property option. The ID of property option must be specified.

Parameters

Name

Type

Description

$propertyOptionId

int

$data

array

public deletePropertyOption($propertyOptionId):array

Deletes a property option. The ID of property option must be specified.

Parameters

Name

Type

Description

$propertyOptionId

int

public deletePropertyOptions($optionIds):array

Delete one or more property options.

Parameters

Name

Type

Description

$optionIds

array

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

PropertyRelationMarkupRepositoryContract

This interface allows you to get, list, create, update and delete property relation markups.

Deprecated! (since 2021-06-24)

Please use Property V2 Repositories instead

Namespace

Plenty\Modules\Property\Contracts

Methods
public getRelationMarkup($relationMarkupId):Plenty\Modules\Property\Models\PropertyRelationMarkup
Return type: PropertyRelationMarkup

Get a property relation markup. The ID of the property relation markup must be specified.

Parameters

Name

Type

Description

$relationMarkupId

int

public listRelationMarkups():array

List property relation markups

public createRelationMarkup($data):Plenty\Modules\Property\Models\PropertyRelationMarkup
Return type: PropertyRelationMarkup

Creates a property relation markup

Parameters

Name

Type

Description

$data

array

The request data

public updateRelationMarkup($relationMarkupId, $data):Plenty\Modules\Property\Models\PropertyRelationMarkup
Return type: PropertyRelationMarkup

Updates a property relation markup. The ID of property relation markup must be specified.

Parameters

Name

Type

Description

$relationMarkupId

int

$data

array

public deleteRelationMarkup($relationMarkupId):void

Deletes a property relation markup. The ID of property relation markup must be specified.

Parameters

Name

Type

Description

$relationMarkupId

int

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

PropertyRelationRepositoryContract

This interface allows you to get, create, update and delete property relations.

Deprecated! (since 2021-06-24)

Please use \Plenty\Modules\Property\V2\Repositories\PropertyRelationRepository instead

Namespace

Plenty\Modules\Property\Contracts

Methods
public getRelation($relationId):Plenty\Modules\Property\Models\PropertyRelation
Return type: PropertyRelation

Gets a property relation. The ID of the property relation must be specified.

Parameters

Name

Type

Description

$relationId

int

public listRelations($filters = [], $page = 1, $itemsPerPage = 50, $paginate, $sorting = []):array

List property relations

Parameters

Name

Type

Description

$filters

array

$page

int

$itemsPerPage

int

$paginate

int

$sorting

array

public createRelation($data):Plenty\Modules\Property\Models\PropertyRelation
Return type: PropertyRelation

Creates a property relation

Parameters

Name

Type

Description

$data

array

The request data

public updateRelation($relationId, $data):Plenty\Modules\Property\Models\PropertyRelation
Return type: PropertyRelation

Updates a property relation. The ID of property relation must be specified.

Parameters

Name

Type

Description

$relationId

int

$data

array

public deleteRelation($relationId):void

Deletes a property relation. The ID of property relation must be specified.

Parameters

Name

Type

Description

$relationId

int

public savePropertyRelationFile($relationId, $data, $file = &quot;&quot;):string

Save property relation file to S3

Parameters

Name

Type

Description

$relationId

int

$data

array

$file

string

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

PropertyRelationValueRepositoryContract

This interface allows you to get, create, update and delete property relation values.

Deprecated! (since 2021-06-24)

Please use \Plenty\Modules\Property\V2\Repositories\PropertyRelationValueRepository instead

Namespace

Plenty\Modules\Property\Contracts

Methods
public getPropertyRelationValue($propertyRelationValueId):Plenty\Modules\Property\Models\PropertyRelationValue
Return type: PropertyRelationValue

Gets an property relation value. The ID of the property relation value must be specified.

Parameters

Name

Type

Description

$propertyRelationValueId

int

public listPropertyRelationValues():array

List property relation values

public createPropertyRelationValue($data):Plenty\Modules\Property\Models\PropertyRelationValue
Return type: PropertyRelationValue

Creates an property relation value

Parameters

Name

Type

Description

$data

array

The request data

public updatePropertyRelationValue($propertyRelationValueId, $data):Plenty\Modules\Property\Models\PropertyRelationValue
Return type: PropertyRelationValue

Updates a property relation value. The ID of property relation value must be specified.

Parameters

Name

Type

Description

$propertyRelationValueId

int

$data

array

public updatePropertyRelationValues($data):Plenty\Modules\Property\Models\PropertyRelationValue
Return type: PropertyRelationValue

Update multiple property relation values

Parameters

Name

Type

Description

$data

array

public deletePropertyRelationValue($propertyRelationValueId):void

Delete a property relation value

Parameters

Name

Type

Description

$propertyRelationValueId

int

public deleteRelationsByRelationId($relationId):void

Delete all property relation values of a specified property relation.

Parameters

Name

Type

Description

$relationId

int

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

PropertyRepositoryContract

This interface allows you to get, create, update and delete properties.

Deprecated! (since 2021-06-24)

Please use \Plenty\Modules\Property\V2\Repositories\PropertyRepository instead

Namespace

Plenty\Modules\Property\Contracts

Methods
public getProperty($propertyId, $with = []):Plenty\Modules\Property\Models\Property
Return type: Property

Gets a property. The ID of the property must be specified.

Parameters

Name

Type

Description

$propertyId

int

The id of the property

$with

array

The relations available are: <ol><li>availibilities</li> <li>relation</li> <li>selections</li> <li>names</li> <li>options</li> <li>markets</li> <li>groups</li></ol>

public listProperties($page = 1, $itemsPerPage = 50, $with = [], $filters = [], $paginate = 1, $orderBy = []):array

Lists properties

Parameters

Name

Type

Description

$page

int

The page to get. The default page that will be returned is page 1. See also $paginate.

$itemsPerPage

int

The number of properties to be displayed per page. The default number of properties per page is 50. See also $paginate.

$with

array

The relations available are: <ol><li>availibilities</li> <li>relation</li> <li>selections</li> <li>names</li> <li>options</li> <li>markets</li> <li>groups</li></ol>

$filters

array

The following filters are available: <ol><li>id</li> <li>cast</li> <li>position</li> <li>name</li> <li>lang</li> <li>group</li></ol>

$paginate

int

Defines whether or not the result will be a paginated result or a list with all results. If 1 is given for the parameter, the result will be paginated.

$orderBy

array

The order after which the result is sorted

public createProperty($data):Plenty\Modules\Property\Models\Property
Return type: Property

Creates a property

Parameters

Name

Type

Description

$data

array

The request data

public updateProperty($propertyId, $data):Plenty\Modules\Property\Models\Property
Return type: Property

Updates a property. The ID of property must be specified.

Parameters

Name

Type

Description

$propertyId

int

$data

array

public deleteProperty($propertyId):void

Deletes a property. The ID of property must be specified.

Parameters

Name

Type

Description

$propertyId

int

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

PropertySelectionRepositoryContract

This interface allows you to get, create, update and delete property selections.

Deprecated! (since 2021-06-24)

Please use \Plenty\Modules\Property\V2\Repositories\PropertySelectionRepository instead

Namespace

Plenty\Modules\Property\Contracts

Methods
public getPropertySelection($propertySelectionId):Plenty\Modules\Property\Models\PropertySelection
Return type: PropertySelection

Gets a property selection. The ID of the property selection must be specified.

Parameters

Name

Type

Description

$propertySelectionId

int

public listPropertySelections($page = 1, $itemsPerPage = 50, $with = [], $filters = []):array

List property selections

Parameters

Name

Type

Description

$page

int

The page to get. The default page that will be returned is page 1. See also $paginate.

$itemsPerPage

int

The number of property selections to be displayed per page. The default number of selections per page is 50. See also $paginate.

$with

array

The relations available are: <ol><li>property</li> <li>relation</li></ol>

$filters

array

The filter available is: <ol><li>porpertyId</li></ol>

public createPropertySelection($data):Plenty\Modules\Property\Models\PropertySelection
Return type: PropertySelection

Creates a property selection

Parameters

Name

Type

Description

$data

array

The request data

public updatePropertySelection($propertySelectionId, $data):Plenty\Modules\Property\Models\PropertySelection
Return type: PropertySelection

Updates a property selection. The ID of property selection must be specified.

Parameters

Name

Type

Description

$propertySelectionId

int

$data

array

public deletePropertySelection($propertySelectionId):void

Deletes a property selection. The ID of property selection must be specified.

Parameters

Name

Type

Description

$propertySelectionId

int

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

Property

Deprecated. Use V2 instead.The property model. Properties allow to further describe items, categories etc. A property can have one name per language. The property names have an own model.

Namespace

Plenty\Modules\Property\Models

Properties
Name Type Description

id

int

The ID of the property

cast

string

The cast of the property (array values: 'empty','int','float','selection','shortText','longText','date','file')

position

int

The position of the property

createdAt

The date when the property was created

updatedAt

The date when the property was last updated

names

Collection

options

Collection

relation

Collection

amazons

Collection

selections

Collection

groups

Collection

Methods
public toArray()

Returns this model as an array.

PropertyAmazon

Deprecated. Use V2 instead.The property amazon model.

Namespace

Plenty\Modules\Property\Models

Properties
Name Type Description

id

int

The ID of the property amazon

propertyId

int

The ID of the property

platform

string

The platform of the property amazon

category

string

The category of the property amazon

field

string

The field of the property amazon

createdAt

The date when the property name was created

updatedAt

The date when the property name was last updated

propertyRelation

Property

Methods
public toArray()

Returns this model as an array.

PropertyAvailability

Deprecated. Use V2 instead. The property availability model.

Namespace

Plenty\Modules\Property\Models

Properties
Name Type Description

id

int

The ID of the property availability

propertyId

int

The ID of the property

type

string

The type of the property availability

value

float

The value of the property availability

createdAt

The date when the property availability was created

updatedAt

The date when the property availability was last updated

Methods
public toArray()

Returns this model as an array.

PropertyGroup

Deprecated. Use V2 instead.The property group model. A property group allows to group several properties together and helps to structure properties. Property groups can have different names per language. The property group names have an own model.

Namespace

Plenty\Modules\Property\Models

Properties
Name Type Description

id

int

The ID of the property group

position

int

The position of the property group

createdAt

The date when the property group was created

updatedAt

The date when the property group was last updated

options

The group options

names

The group names

properties

The properties the group belongs to

Methods
public toArray()

Returns this model as an array.

PropertyGroupName

Deprecated. Use V2 instead.The property group name model. A property group can have several names. One name per language. Each name has a unique ID.

Namespace

Plenty\Modules\Property\Models

Properties
Name Type Description

id

int

The ID of the property group name

propertyGroupId

int

The ID of the property group

lang

string

The language of the property group name as ISO 639-1 language code, e.g. en for English

name

string

The name of the property group

description

string

The description of the property group

createdAt

The date when the property group name was created

updatedAt

The date when the property group name was last updated

Methods
public toArray()

Returns this model as an array.

PropertyGroupOption

Deprecated. Use V2 instead.The property group option model.

Namespace

Plenty\Modules\Property\Models

Properties
Name Type Description

id

int

The ID of the property group option

propertyGroupId

int

The ID of the property group

groupOptionIdentifier

string

The identifier of the property group option

value

string

The value of the property group option

createdAt

The date when the property group option was created

updatedAt

The date when the property group option was last updated

Methods
public toArray()

Returns this model as an array.

PropertyGroupRelation

Deprecated. Use V2 instead.The property group relation model. The model shows which property is related to which property group.

Namespace

Plenty\Modules\Property\Models

Properties
Name Type Description

propertyId

int

The ID of the property

propertyGroupId

int

The ID of the property group

Methods
public toArray()

Returns this model as an array.

PropertyMarket

Deprecated. Use V2 instead.The property market model.

Namespace

Plenty\Modules\Property\Models

Properties
Name Type Description

id

int

The ID of the property market

propertyId

int

The ID of the property

referrerId

float

The ID of the referrer

referrerSubId

int

The ID of the sub referrer

value

string

The value of the property market

createdAt

The date when the property market was created

updatedAt

The date when the property market was last updated

Methods
public toArray()

Returns this model as an array.

PropertyName

Deprecated. Use V2 instead.The property name model. A property can have several names. One name per language. Each name has a unique ID.

Namespace

Plenty\Modules\Property\Models

Properties
Name Type Description

id

int

The ID of the property name

propertyId

int

The ID of the property

lang

string

The language of the property name as ISO 639-1 language code, e.g. en for English

name

string

The name of the property

description

string

The description of the property

createdAt

The date when the property name was created

updatedAt

The date when the property name was last updated

propertyRelation

Property

Methods
public toArray()

Returns this model as an array.

PropertyOption

Deprecated. Use V2 instead.The property option model. Property options allow to add further specification to a property. Each property option can have several values. The porperty option values have an own model.

Namespace

Plenty\Modules\Property\Models

Properties
Name Type Description

id

int

The ID of the property option

propertyId

int

The ID of the property

typeOptionIdentifier

string

The identifier of the type option

createdAt

The date when the property option was created

updatedAt

The date when the property option was last updated

propertyOptionValues

Collection

Methods
public toArray()

Returns this model as an array.

PropertyOptionValue

Deprecated. Use V2 instead.The property option value model.

Namespace

Plenty\Modules\Property\Models

Properties
Name Type Description

id

int

The ID of the property option value

optionId

int

The ID of the property option

value

string

The value of the property option

createdAt

The date when the property option value was created

updatedAt

The date when the property option value was last updated

Methods
public toArray()

Returns this model as an array.

PropertyRelation

Deprecated. Use V2 instead.The property relation model allows to relate a property e.g. to a variation or other targets.

Namespace

Plenty\Modules\Property\Models

Properties
Name Type Description

id

int

The ID of the property relation

propertyId

int

The ID of the property

relationTypeIdentifier

string

The identifier of the property relation

relationTargetId

int

The ID of the target of the relation

selectionRelationId

int

The ID of the selection relation

groupId

int

The ID of the property group

markup

float

The mark up of the property relation

createdAt

The date when the property was created

updatedAt

The date when the property was last updated

relationValues

Collection

propertyRelation

Property

group

PropertyGroup

Methods
public toArray()

Returns this model as an array.

PropertyRelationMarkup

Deprecated. Use V2 instead.The property relation markup model.

Namespace

Plenty\Modules\Property\Models

Properties
Name Type Description

id

int

The ID of the property relation markup

propertyRelationId

int

The ID of the property relation

variationSalesPriceId

int

The variation sales price id of the property relation markup

markup

float

The markup of the property relation markup

createdAt

The date when the property was created

updatedAt

The date when the property was last updated

Methods
public toArray()

Returns this model as an array.

PropertyRelationValue

Deprecated. Use V2 instead.The property relation value model.

Namespace

Plenty\Modules\Property\Models

Properties
Name Type Description

id

int

The ID of the property relation value

propertyRelationId

int

The ID of the property relation

lang

string

The language of the property relation value

value

string

The value of the property relation

description

string

The description of the property relation value

createdAt

The date when the property relation value was created

updatedAt

The date when the property relation value was last updated

Methods
public toArray()

Returns this model as an array.

PropertySelection

Deprecated. Use V2 instead.The property selection model.

Namespace

Plenty\Modules\Property\Models

Properties
Name Type Description

id

int

The ID of the property selection

propertyId

int

The ID of the property

position

int

The position of the property selection

createdAt

The date when the property selection was created

updatedAt

The date when the property selection was last updated

relation

PropertyRelation

allRelations

array

property

Property

Methods
public toArray()

Returns this model as an array.

V2

Contracts

PropertyAmazonRepositoryContract

This interface allows you to get, create, update and delete property amazons.

Namespace

Plenty\Modules\Property\V2\Contracts

Methods
Parameters

Name

Type

Description

$with

array

$perPage

int

$page

int

public findByPropertyId($propertyId):void

Gets a list of property amazon. The ID of the property must be specified.

Parameters

Name

Type

Description

$propertyId

int

public get($id, $with = []):Plenty\Modules\Property\V2\Models\PropertyAmazon
Return type: PropertyAmazon

Gets a property amazon. The ID of the property amazon must be specified.

Parameters

Name

Type

Description

$id

int

$with

array

public update($id, $data):Plenty\Modules\Property\V2\Models\PropertyAmazon
Return type: PropertyAmazon

Updates a property amazon. The ID of the property amazon must be specified.

Parameters

Name

Type

Description

$id

int

$data

array

public create($data):Plenty\Modules\Property\V2\Models\PropertyAmazon
Return type: PropertyAmazon

Creates a property amazon.

Parameters

Name

Type

Description

$data

array

public delete($id):bool

Deletes a property amazon. The ID of the property amazon must be specified.

Parameters

Name

Type

Description

$id

int

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

PropertyGroupNameRepositoryContract

This interface allows you to get, create, update and delete property group names.

Namespace

Plenty\Modules\Property\V2\Contracts

Methods
public findByGroupId($groupId):void

Gets a list of property group names. The ID of the property group must be specified.

Parameters

Name

Type

Description

$groupId

int

public get($id):Plenty\Modules\Property\V2\Models\PropertyGroupName
Return type: PropertyGroupName

Gets a property group name. The ID of the property group name must be specified.

Parameters

Name

Type

Description

$id

int

public update($id, $data):Plenty\Modules\Property\V2\Models\PropertyGroupName
Return type: PropertyGroupName

Updates a property group name. The ID of the property group name must be specified.

Parameters

Name

Type

Description

$id

int

$data

array

public create($data):Plenty\Modules\Property\V2\Models\PropertyGroupName
Return type: PropertyGroupName

Creates a property group name.

Parameters

Name

Type

Description

$data

array

public delete($id):bool

Deletes a property group name. The ID of the property group name must be specified.

Parameters

Name

Type

Description

$id

int

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

PropertyGroupOptionRepositoryContract

This interface allows you to get, create, update and delete property group options.

Namespace

Plenty\Modules\Property\V2\Contracts

Methods
public findByGroupId($groupId):void

Gets a list of property group options. The ID of the property group must be specified.

Parameters

Name

Type

Description

$groupId

int

public get($id):Plenty\Modules\Property\V2\Models\PropertyGroupOption
Return type: PropertyGroupOption

Gets a property group option. The ID of the property group option must be specified.

Parameters

Name

Type

Description

$id

int

public update($id, $data):Plenty\Modules\Property\V2\Models\PropertyGroupOption
Return type: PropertyGroupOption

Updates a property group option. The ID of the property group option must be specified.

Parameters

Name

Type

Description

$id

int

$data

array

public create($data):Plenty\Modules\Property\V2\Models\PropertyGroupOption
Return type: PropertyGroupOption

Creates a property group option.

Parameters

Name

Type

Description

$data

array

public delete($id):bool

Deletes a property group option. The ID of the property group option must be specified.

Parameters

Name

Type

Description

$id

int

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

PropertyGroupRelationRepositoryContract

This interface allows you to get, create and delete property group relations.

Namespace

Plenty\Modules\Property\V2\Contracts

Methods

Gets a list of property group relations.

Parameters

Name

Type

Description

$with

array

$perPage

int

$page

int

$sorting

array

public count():int

Count the property group relations.

public get($id, $with = []):Plenty\Modules\Property\V2\Models\PropertyGroupRelation
Return type: PropertyGroupRelation

Gets a property group relation. The ID of the property group relation must be specified.

Parameters

Name

Type

Description

$id

int

$with

array

public create($data):Plenty\Modules\Property\V2\Models\PropertyGroupRelation
Return type: PropertyGroupRelation

Creates a property group relation.

Parameters

Name

Type

Description

$data

array

public delete($id):bool

Deletes a property group relation. The ID of the property group relation must be specified.

Parameters

Name

Type

Description

$id

int

public findOne($propertyId, $groupId):Plenty\Modules\Property\V2\Models\PropertyGroupRelation
Return type: PropertyGroupRelation

Gets a property group relation. The property ID and the group ID of the property group relation must be specified.

Parameters

Name

Type

Description

$propertyId

int

The property ID of the property group relation

$groupId

int

The group ID of the property group relation

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

PropertyGroupRepositoryContract

This interface allows you to get, create, update and delete property groups.

Namespace

Plenty\Modules\Property\V2\Contracts

Methods

Gets a list of property groups. Filter can be specified.

Parameters

Name

Type

Description

$with

array

$perPage

int

$page

int

$sorting

array

public count():int

Count the property groups.

public get($id, $with = []):Plenty\Modules\Property\V2\Models\PropertyGroup
Return type: PropertyGroup

Gets a property group. The ID of the property group must be specified.

Parameters

Name

Type

Description

$id

int

$with

array

public update($id, $data):Plenty\Modules\Property\V2\Models\PropertyGroup
Return type: PropertyGroup

Updates a property group. The ID of the property group must be specified.

Parameters

Name

Type

Description

$id

int

$data

array

public create($data):Plenty\Modules\Property\V2\Models\PropertyGroup
Return type: PropertyGroup

Creates a property group.

Parameters

Name

Type

Description

$data

array

public delete($id):bool

Deletes a property group. The ID of the property group must be specified.

Parameters

Name

Type

Description

$id

int

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

PropertyNameRepositoryContract

This interface allows you to get, create, update and delete property names.

Namespace

Plenty\Modules\Property\V2\Contracts

Methods
public findByPropertyId($propertyId):void

Gets a list of property names. The ID of the property must be specified.

Parameters

Name

Type

Description

$propertyId

int

public get($id):Plenty\Modules\Property\V2\Models\PropertyName
Return type: PropertyName

Gets a property name. The ID of the property name must be specified.

Parameters

Name

Type

Description

$id

int

public update($id, $data):Plenty\Modules\Property\V2\Models\PropertyName
Return type: PropertyName

Updates a property name. The ID of the property name must be specified.

Parameters

Name

Type

Description

$id

int

$data

array

public create($data):Plenty\Modules\Property\V2\Models\PropertyName
Return type: PropertyName

Creates a property name.

Parameters

Name

Type

Description

$data

array

public delete($id):bool

Deletes a property name. The ID of the property name must be specified.

Parameters

Name

Type

Description

$id

int

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

PropertyOptionRepositoryContract

This interface allows you to get, create, update and delete property options.

Namespace

Plenty\Modules\Property\V2\Contracts

Methods
public searchByPropertyId($propertyId, $with = []):void

Gets a list of property options. The ID of the property must be specified.

Parameters

Name

Type

Description

$propertyId

int

$with

array

public get($id):Plenty\Modules\Property\V2\Models\PropertyOption
Return type: PropertyOption

Gets a property option. The ID of the property option must be specified.

Parameters

Name

Type

Description

$id

int

public update($id, $data):Plenty\Modules\Property\V2\Models\PropertyOption
Return type: PropertyOption

Updates a property option. The ID of the property option must be specified.

Parameters

Name

Type

Description

$id

int

$data

array

public create($data):Plenty\Modules\Property\V2\Models\PropertyOption
Return type: PropertyOption

Creates a property option.

Parameters

Name

Type

Description

$data

array

public delete($id):bool

Deletes a property option. The ID of the property option must be specified.

Parameters

Name

Type

Description

$id

int

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

PropertyRelationRepositoryContract

This interface allows you to get, create, update and delete property relations.

Namespace

Plenty\Modules\Property\V2\Contracts

Methods

Gets a list of property relation. Filter can be specified.

Parameters

Name

Type

Description

$with

array

$perPage

int

$page

int

$sorting

array

public count():int

Count the property relations.

public get($id, $with = []):Plenty\Modules\Property\V2\Models\PropertyRelation
Return type: PropertyRelation

Gets a property relation. The ID of the property relation must be specified.

Parameters

Name

Type

Description

$id

int

$with

array

public update($id, $data):Plenty\Modules\Property\V2\Models\PropertyRelation
Return type: PropertyRelation

Updates a property relation. The ID of the property relation must be specified.

Parameters

Name

Type

Description

$id

int

$data

array

public create($data):Plenty\Modules\Property\V2\Models\PropertyRelation
Return type: PropertyRelation

Creates a property relation.

Parameters

Name

Type

Description

$data

array

public createBulk($data):void

Creates a list of property relations.

Parameters

Name

Type

Description

$data

array

public updateBulk($data):void

Updates a list of property relations.

Parameters

Name

Type

Description

$data

array

public delete($id):bool

Deletes a property relation. The ID of the property relation must be specified.

Parameters

Name

Type

Description

$id

int

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

PropertyRelationSelectionRepositoryContract

This interface allows you to get, create, update and delete property relation selections.T hey are used for linked properties of the type selection and multiSelection.

Namespace

Plenty\Modules\Property\V2\Contracts

Methods
public findByPropertyRelationId($propertyRelationId, $with = []):void

Gets a list of property relation selections. The ID of the property relation must be specified.

Parameters

Name

Type

Description

$propertyRelationId

int

$with

array

public get($id, $with = []):Plenty\Modules\Property\V2\Models\PropertyRelationSelection
Return type: PropertyRelationSelection

Gets a property relation selection. The ID of the property relation selection must be specified.

Parameters

Name

Type

Description

$id

int

$with

array

public update($id, $data):Plenty\Modules\Property\V2\Models\PropertyRelationSelection
Return type: PropertyRelationSelection

Updates a property relation selection. The ID of the property relation selection must be specified.

Parameters

Name

Type

Description

$id

int

$data

array

public create($data):Plenty\Modules\Property\V2\Models\PropertyRelationSelection
Return type: PropertyRelationSelection

Creates a property relation selection.

Parameters

Name

Type

Description

$data

array

public delete($id):bool

Deletes a property relation selection. The ID of the property relation selection must be specified.

Parameters

Name

Type

Description

$id

int

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

PropertyRelationValueRepositoryContract

This interface allows you to get, create, update and delete property relation values. They are used for linked properties of the type html and text.

Namespace

Plenty\Modules\Property\V2\Contracts

Methods
public findByPropertyRelationId($propertyRelationId, $with = []):void

Gets a list of property relation values. The ID of the property relation must be specified.

Parameters

Name

Type

Description

$propertyRelationId

int

$with

array

public get($id, $with = []):Plenty\Modules\Property\V2\Models\PropertyRelationValue
Return type: PropertyRelationValue

Gets a property relation value. The ID of the property relation value must be specified.

Parameters

Name

Type

Description

$id

int

$with

array

public update($id, $data):Plenty\Modules\Property\V2\Models\PropertyRelationValue
Return type: PropertyRelationValue

Updates a property relation value. The ID of the property relation value must be specified.

Parameters

Name

Type

Description

$id

int

$data

array

public create($data):Plenty\Modules\Property\V2\Models\PropertyRelationValue
Return type: PropertyRelationValue

Creates a property relation value.

Parameters

Name

Type

Description

$data

array

public delete($id):bool

Deletes a property relation value. The ID of the property relation value must be specified.

Parameters

Name

Type

Description

$id

int

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

PropertyRepositoryContract

This interface allows you to get, create, update and delete properties.

Namespace

Plenty\Modules\Property\V2\Contracts

Methods

Gets a list of properties. Filter can be specified.

Parameters

Name

Type

Description

$with

array

$perPage

int

$page

int

$sorting

array

public count():int

Count the properties.

public get($id, $with = []):Plenty\Modules\Property\V2\Models\Property
Return type: Property

Gets a property. The ID of the property must be specified.

Parameters

Name

Type

Description

$id

int

$with

array

public update($id, $data):Plenty\Modules\Property\V2\Models\Property
Return type: Property

Updates a property. The ID of the property must be specified.

Parameters

Name

Type

Description

$id

int

$data

array

public create($data):Plenty\Modules\Property\V2\Models\Property
Return type: Property

Creates a property.

Parameters

Name

Type

Description

$data

array

public delete($id):bool

Deletes a property. The ID of the property must be specified.

Parameters

Name

Type

Description

$id

int

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

PropertySelectionNameRepositoryContract

This interface allows you to get, create, update and delete property selection names.

Namespace

Plenty\Modules\Property\V2\Contracts

Methods
public findBySelectionId($selectionId):void

Gets a list of property selection names. The ID of the property selection must be specified.

Parameters

Name

Type

Description

$selectionId

int

public get($id):Plenty\Modules\Property\V2\Models\PropertySelectionName
Return type: PropertySelectionName

Gets a property selection name. The ID of the property selection name must be specified.

Parameters

Name

Type

Description

$id

int

public update($id, $data):Plenty\Modules\Property\V2\Models\PropertySelectionName
Return type: PropertySelectionName

Updates a property selection name. The ID of the property selection name must be specified.

Parameters

Name

Type

Description

$id

int

$data

array

public create($data):Plenty\Modules\Property\V2\Models\PropertySelectionName
Return type: PropertySelectionName

Create a property selection name.

Parameters

Name

Type

Description

$data

array

public delete($id):bool

Deletes a property selection name. The ID of the property selection name must be specified.

Parameters

Name

Type

Description

$id

int

PropertySelectionRepositoryContract

This interface allows you to get, create, update and delete property selections.

Namespace

Plenty\Modules\Property\V2\Contracts

Methods
public searchByPropertyId($propertyId, $with = [], $perPage = 50, $page = 1, $sorting = []):void

Gets a list of property selections. The ID of the property must be specified.

Parameters

Name

Type

Description

$propertyId

int

$with

array

$perPage

int

$page

int

$sorting

array

public countByPropertyId($propertyId):int

Count the property selections. The ID of the property must be specified.

Parameters

Name

Type

Description

$propertyId

int

public get($id, $with = []):Plenty\Modules\Property\V2\Models\PropertySelection
Return type: PropertySelection

Gets a property selection. The ID of the property selection must be specified.

Parameters

Name

Type

Description

$id

int

$with

array

public update($id, $data):Plenty\Modules\Property\V2\Models\PropertySelection
Return type: PropertySelection

Updates a property selection. The ID of the property selection must be specified.

Parameters

Name

Type

Description

$id

int

$data

array

public create($data):Plenty\Modules\Property\V2\Models\PropertySelection
Return type: PropertySelection

Creates a property selection.

Parameters

Name

Type

Description

$data

array

public delete($id):bool

Deletes a property selection. The ID of the property selection must be specified.

Parameters

Name

Type

Description

$id

int

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

Models

Property

The property model. Properties allow to further describe items, customers etc.

Namespace

Plenty\Modules\Property\V2\Models

Properties
Name Type Description

id

int

The ID of the property

cast

string

The cast of the property (array values: 'empty','int','float','string','selection','text','html','date','file')

type

string

The type of the property (e.g. 'item' or 'contact')

position

int

The position of the property

createdAt

The date when the property was created

updatedAt

The date when the property was last updated

amazon

array

Property amazon

names

Property names

groups

Property Groups

options

Property Options

selections

Property selections

Methods
public toArray()

Returns this model as an array.

PropertyAmazon

The property amazon model.

Namespace

Plenty\Modules\Property\V2\Models

Properties
Name Type Description

id

int

The ID of the property amazon

propertyId

int

The property ID of the property amazon

platform

string

The platform of the property amazon

category

string

The category of the property amazon

field

string

The field of the property amazon

createdAt

The date when the property amazon was created

updatedAt

The date when the property amazon was last updated

property

Property

The associated property

Methods
public toArray()

Returns this model as an array.

PropertyGroup

The property group model.

Namespace

Plenty\Modules\Property\V2\Models

Properties
Name Type Description

id

int

The ID of the property group

position

int

The position of the property group

createdAt

The date when the property group was created

updatedAt

The date when the property group was last updated

names

The property group names of the property group

options

The property group options of the property group

Methods
public toArray()

Returns this model as an array.

PropertyGroupName

The property group name model.

Namespace

Plenty\Modules\Property\V2\Models

Properties
Name Type Description

id

int

The ID of the property group name

groupId

int

The property group ID of the property group

lang

string

The language of the property group name as ISO 639-1 language code, e.g. en for English

name

string

The name of the property group

description

string

The description of the property group

createdAt

The date when the property group name was created

updatedAt

The date when the property group name was last updated

group

PropertyGroup

The associated property group

Methods
public toArray()

Returns this model as an array.

PropertyGroupOption

The property group option model.

Namespace

Plenty\Modules\Property\V2\Models

Properties
Name Type Description

id

int

The ID of the property group option

groupId

int

The property group ID of the property group

type

string

The identifier of the property group option

value

string

The value of the property group option

createdAt

The date when the property group option was created

updatedAt

The date when the property group option was last updated

Methods
public toArray()

Returns this model as an array.

PropertyGroupRelation

The property group relation model. The model shows which property is related to which property group.

Namespace

Plenty\Modules\Property\V2\Models

Properties
Name Type Description

id

int

The ID of the property group relation

propertyId

int

The ID of the property

groupId

int

The ID of the property group

group

PropertyGroup

The associated property group

property

Property

The associated property

Methods
public toArray()

Returns this model as an array.

PropertyName

The property name model. A property can have several names. One name per language. Each name has a unique ID.

Namespace

Plenty\Modules\Property\V2\Models

Properties
Name Type Description

id

int

The ID of the property name

propertyId

int

The property ID of the property name

lang

string

The language of the property name as ISO 639-1 language code, e.g. en for English

name

string

The name of the property name

description

string

The description of the property name

createdAt

The date when the property name was created

updatedAt

The date when the property name was last updated

property

Property

The associated property

Methods
public toArray()

Returns this model as an array.

PropertyOption

The property option model.

Namespace

Plenty\Modules\Property\V2\Models

Properties
Name Type Description

id

int

The ID of the property option

propertyId

int

The property ID of the property option

type

string

The identifier type of the option

value

string

The value of the option

createdAt

The date when the property option was created

updatedAt

The date when the property option was last updated

property

Property

The associated property

Methods
public toArray()

Returns this model as an array.

PropertyRelation

The property relation model.

Namespace

Plenty\Modules\Property\V2\Models

Properties
Name Type Description

id

int

The ID of the property relation

propertyId

int

The property ID of the property relation

type

string

The type of the property relation

targetId

int

The ID of the target of the property relation

groupId

int

The property group ID of the property relation

markup

float

The mark up of the property relation

value

string

The value of the property relation for properties of the following type: int, float, date and file.

createdAt

The date when the property was created

updatedAt

The date when the property was last updated

property

Property

The associated property

group

PropertyGroup

The associated property group

values

array

The property relation values of the property relation. Includes properties of the types short and long text.

selectionValues

array

The property relation values of the property relation. Includes properties of the types selection and multi selection.

Methods
public toArray()

Returns this model as an array.

PropertyRelationSelection

The property relation selection value model. Contains linked values for selections and multi selections.

Namespace

Plenty\Modules\Property\V2\Models

Properties
Name Type Description

id

int

The ID of the property relation selection value

relationId

int

The relation ID of the property relation selection value

selectionId

int

The selection ID of the property relation selection value

createdAt

The date when the property relation value was created

updatedAt

The date when the property relation value was last updated

relation

PropertyRelation

The associated property relation

selection

PropertySelection

The associated property selection

Methods
public toArray()

Returns this model as an array.

PropertyRelationValue

The property relation value model. Includes the values in different languages for properties of the type short text and long text.

Namespace

Plenty\Modules\Property\V2\Models

Properties
Name Type Description

id

int

The ID of the property relation value

relationId

int

The ID of the property relation

lang

string

The language of the property relation value

value

string

The value of the property relation

description

string

The description of the property relation value

createdAt

The date when the property relation value was created

updatedAt

The date when the property relation value was last updated

relation

PropertyRelation

The associated property relation

Methods
public toArray()

Returns this model as an array.

PropertySelection

The property selection model.

Namespace

Plenty\Modules\Property\V2\Models

Properties
Name Type Description

id

int

The ID of the property selection

propertyId

int

The property ID of the property selection

position

int

The position of the property selection

createdAt

he date when the property selection was created

updatedAt

The date when the property selection was last updated

property

Property

The associated property

names

The names of the property selection

Methods
public toArray()

Returns this model as an array.

PropertySelectionName

The property selection name model.

Namespace

Plenty\Modules\Property\V2\Models

Properties
Name Type Description

id

int

The ID of the property selection name

selectionId

int

The selection ID of the property selection name

lang

string

The language of the property selection name

name

string

The name of the property selection name

description

string

The description of the property selection name

createdAt

The date when the property selection name was created

updatedAt

The date when the property selection name was last updated

selection

PropertySelection

The associated property selection

Methods
public toArray()

Returns this model as an array.

Contracts

UUID

PropertyRelationRepositoryContract

This interface allows you to get, create, update and delete property relations.

Namespace

Plenty\Modules\Property\V2\Contracts\UUID

Methods

Gets a list of property relation. Filter can be specified.

Parameters

Name

Type

Description

$with

array

$perPage

int

$page

int

$sorting

array

public count():int

Count the property relations.

public get($id, $with = []):Plenty\Modules\Property\V2\Models\UUID\PropertyRelation
Return type: PropertyRelation

Gets a property relation. The ID of the property relation must be specified.

Parameters

Name

Type

Description

$id

int

$with

array

public update($id, $data):Plenty\Modules\Property\V2\Models\UUID\PropertyRelation
Return type: PropertyRelation

Updates a property relation. The ID of the property relation must be specified.

Parameters

Name

Type

Description

$id

int

$data

array

public create($data):Plenty\Modules\Property\V2\Models\UUID\PropertyRelation
Return type: PropertyRelation

Creates a property relation.

Parameters

Name

Type

Description

$data

array

public createBulk($data):void

Creates a list of property relations.

Parameters

Name

Type

Description

$data

array

public updateBulk($data):void

Updates a list of property relations.

Parameters

Name

Type

Description

$data

array

public delete($id):bool

Deletes a property relation. The ID of the property relation must be specified.

Parameters

Name

Type

Description

$id

int

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

PropertyRelationSelectionRepositoryContract

This interface allows you to get, create, update and delete property relation selections.T hey are used for linked properties of the type selection and multiSelection.

Namespace

Plenty\Modules\Property\V2\Contracts\UUID

Methods
public findByPropertyRelationId($propertyRelationId, $with = []):void

Gets a list of property relation selections. The ID of the property relation must be specified.

Parameters

Name

Type

Description

$propertyRelationId

int

$with

array

public get($id, $with = []):Plenty\Modules\Property\V2\Models\UUID\PropertyRelationSelection
Return type: PropertyRelationSelection

Gets a property relation selection. The ID of the property relation selection must be specified.

Parameters

Name

Type

Description

$id

int

$with

array

public update($id, $data):Plenty\Modules\Property\V2\Models\UUID\PropertyRelationSelection
Return type: PropertyRelationSelection

Updates a property relation selection. The ID of the property relation selection must be specified.

Parameters

Name

Type

Description

$id

int

$data

array

public create($data):Plenty\Modules\Property\V2\Models\UUID\PropertyRelationSelection
Return type: PropertyRelationSelection

Creates a property relation selection.

Parameters

Name

Type

Description

$data

array

public delete($id):bool

Deletes a property relation selection. The ID of the property relation selection must be specified.

Parameters

Name

Type

Description

$id

int

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

PropertyRelationValueRepositoryContract

This interface allows you to get, create, update and delete property relation values. They are used for linked properties of the type html and text.

Namespace

Plenty\Modules\Property\V2\Contracts\UUID

Methods
public findByPropertyRelationId($propertyRelationId, $with = []):void

Gets a list of property relation values. The ID of the property relation must be specified.

Parameters

Name

Type

Description

$propertyRelationId

int

$with

array

public get($id, $with = []):Plenty\Modules\Property\V2\Models\UUID\PropertyRelationValue
Return type: PropertyRelationValue

Gets a property relation value. The ID of the property relation value must be specified.

Parameters

Name

Type

Description

$id

int

$with

array

public update($id, $data):Plenty\Modules\Property\V2\Models\UUID\PropertyRelationValue
Return type: PropertyRelationValue

Updates a property relation value. The ID of the property relation value must be specified.

Parameters

Name

Type

Description

$id

int

$data

array

public create($data):Plenty\Modules\Property\V2\Models\UUID\PropertyRelationValue
Return type: PropertyRelationValue

Creates a property relation value.

Parameters

Name

Type

Description

$data

array

public delete($id):bool

Deletes a property relation value. The ID of the property relation value must be specified.

Parameters

Name

Type

Description

$id

int

public clearCriteria():void

Resets all Criteria filters by creating a new instance of the builder object.

public applyCriteriaFromFilters():void

Applies criteria classes to the current repository.

public setFilters($filters = []):void

Sets the filter array.

Parameters

Name

Type

Description

$filters

array

public getFilters():void

Returns the filter array.

public getConditions():void

Returns a collection of parsed filters as Condition object

public clearFilters():void

Clears the filter array.

Models

UUID

PropertyRelation

The property uuid relation model.

Namespace

Plenty\Modules\Property\V2\Models\UUID

Properties
Name Type Description

id

int

The ID of the property relation

propertyId

int

The property ID of the property relation

type

string

The type of the property relation

targetId

string

The ID of the target of the property relation

groupId

int

The property group ID of the property relation

markup

float

The mark up of the property relation

value

string

The value of the property relation for properties of the following type: int, float, date and file.

createdAt

The date when the property was created

updatedAt

The date when the property was last updated

Methods
public toArray()

Returns this model as an array.

PropertyRelationSelection

The property uuid relation selection value model. Contains linked values for selections and multi selections.

Namespace

Plenty\Modules\Property\V2\Models\UUID

Properties
Name Type Description

id

int

The ID of the property relation selection value

relationId

int

The relation ID of the property relation selection value

selectionId

int

The selection ID of the property relation selection value

createdAt

The date when the property relation value was created

updatedAt

The date when the property relation value was last updated

relation

PropertyRelation

The associated property uuid relation

selection

PropertySelection

The associated property selection

Methods
public toArray()

Returns this model as an array.

PropertyRelationValue

The property uuid relation value model. Includes the values in different languages for properties of the type short text and long text.

Namespace

Plenty\Modules\Property\V2\Models\UUID

Properties
Name Type Description

id

int

The ID of the property relation value

relationId

int

The ID of the property relation

lang

string

The language of the property relation value

value

string

The value of the property relation

description

string

The description of the property relation value

createdAt

The date when the property relation value was created

updatedAt

The date when the property relation value was last updated

relation

PropertyRelation

The associated property uuid relation

Methods
public toArray()

Returns this model as an array.