Bitrix API

PropertyCatalogFeature extends PropertyFeature

Table of Contents

Constants

EVENT_ID_FEATURE_LIST  = 'OnPropertyFeatureBuildList'
FEATURE_ID_BASKET_PROPERTY  = 'IN_BASKET'
FEATURE_ID_DETAIL_PAGE_SHOW  = 'DETAIL_PAGE_SHOW'
FEATURE_ID_LIST_PAGE_SHOW  = 'LIST_PAGE_SHOW'
FEATURE_ID_OFFER_TREE_PROPERTY  = 'OFFER_TREE'

Methods

addFeatures()  : Result
Add features for new property. Do not check features in database.
getBasketPropertyCodes()  : array<string|int, mixed>|null
Unified method to get properties added to basket.
getDetailPageShowProperties()  : array<string|int, mixed>|null
getDetailPageShowPropertyCodes()  : array<string|int, mixed>|null
Returns iblock properties identifiers (ID or CODE), showed on detail element page.
getIndex()  : string
Returns unique feature index for search.
getListPageShowPropertyCodes()  : array<string|int, mixed>|null
Returns iblock properties identifiers (ID or CODE), showed in element list.
getOfferTreePropertyCodes()  : array<string|int, mixed>|null
Unified method for obtaining properties used to select offers.
getPropertyFeatureList()  : array<string|int, mixed>
Build a list of available features for a property.
handlerPropertyFeatureBuildList()  : EventResult
Event handler. Returns catalog feature list for iblock.
isEnabledFeatures()  : bool
Returns three if the feature engine is enabled.
isPropertyFeaturesExist()  : bool
Returns true, if property features exist.
parseIndex()  : array<string|int, mixed>|null
Parses the index into parts.
setFeatures()  : Result
Replace property features.
updateFeatures()  : Result
Upsert features for exist property.

Constants

EVENT_ID_FEATURE_LIST

public mixed EVENT_ID_FEATURE_LIST = 'OnPropertyFeatureBuildList'

FEATURE_ID_DETAIL_PAGE_SHOW

public mixed FEATURE_ID_DETAIL_PAGE_SHOW = 'DETAIL_PAGE_SHOW'

FEATURE_ID_LIST_PAGE_SHOW

public mixed FEATURE_ID_LIST_PAGE_SHOW = 'LIST_PAGE_SHOW'

Methods

addFeatures()

Add features for new property. Do not check features in database.

public static addFeatures(int $propertyId, array<string|int, mixed> $features) : Result
Parameters
$propertyId : int

Property id.

$features : array<string|int, mixed>

Feature list.

Return values
Result

getBasketPropertyCodes()

Unified method to get properties added to basket.

public static getBasketPropertyCodes(int $iblockId[, array<string|int, mixed> $parameters = [] ]) : array<string|int, mixed>|null
Parameters
$iblockId : int

Iblock identifier.

$parameters : array<string|int, mixed> = []

Options keys are case sensitive:

  • CODE Return symbolic code as identifier (Y/N, default N).
Tags
throws
ArgumentException
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
throws
ObjectPropertyException
throws
SystemException
Return values
array<string|int, mixed>|null

getDetailPageShowProperties()

public static getDetailPageShowProperties(int $iblockId[, array<string|int, mixed> $parameters = [] ]) : array<string|int, mixed>|null

deprecated since iblock 19.0.0

Parameters
$iblockId : int

Iblock identifier.

$parameters : array<string|int, mixed> = []

Options keys are case sensitive:

  • CODE Return symbolic code as identifier (Y/N, default N).
Tags
see
self::getDetailPageShowPropertyCodes
Return values
array<string|int, mixed>|null

getDetailPageShowPropertyCodes()

Returns iblock properties identifiers (ID or CODE), showed on detail element page.

public static getDetailPageShowPropertyCodes(int $iblockId[, array<string|int, mixed> $parameters = [] ]) : array<string|int, mixed>|null
Parameters
$iblockId : int

Iblock identifier.

$parameters : array<string|int, mixed> = []

Options keys are case sensitive:

  • CODE Return symbolic code as identifier (Y/N, default N).
Return values
array<string|int, mixed>|null

getIndex()

Returns unique feature index for search.

public static getIndex(array<string|int, mixed> $feature) : string
Parameters
$feature : array<string|int, mixed>

Normalize feature parameters.

Return values
string

getListPageShowPropertyCodes()

Returns iblock properties identifiers (ID or CODE), showed in element list.

public static getListPageShowPropertyCodes(int $iblockId[, array<string|int, mixed> $parameters = [] ]) : array<string|int, mixed>|null
Parameters
$iblockId : int

Iblock identifier.

$parameters : array<string|int, mixed> = []

Options keys are case sensitive:

  • CODE Return symbolic code as identifier (Y/N, default N).
Return values
array<string|int, mixed>|null

getOfferTreePropertyCodes()

Unified method for obtaining properties used to select offers.

public static getOfferTreePropertyCodes(int $iblockId[, array<string|int, mixed> $parameters = [] ]) : array<string|int, mixed>|null
Parameters
$iblockId : int

Iblock identifier.

$parameters : array<string|int, mixed> = []

Options keys are case sensitive:

  • CODE Return symbolic code as identifier (Y/N, default N).
Tags
throws
ArgumentException
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
throws
ObjectPropertyException
throws
SystemException
Return values
array<string|int, mixed>|null

getPropertyFeatureList()

Build a list of available features for a property.

public static getPropertyFeatureList(array<string|int, mixed> $property[, array<string|int, mixed> $description = [] ]) : array<string|int, mixed>
Parameters
$property : array<string|int, mixed>

Property description.

$description : array<string|int, mixed> = []

Additional description.

Return values
array<string|int, mixed>

handlerPropertyFeatureBuildList()

Event handler. Returns catalog feature list for iblock.

public static handlerPropertyFeatureBuildList(Event $event) : EventResult
Parameters
$event : Event

Event data.

Return values
EventResult

isEnabledFeatures()

Returns three if the feature engine is enabled.

public static isEnabledFeatures() : bool
Return values
bool

isPropertyFeaturesExist()

Returns true, if property features exist.

public static isPropertyFeaturesExist() : bool
Return values
bool

parseIndex()

Parses the index into parts.

public static parseIndex(string $index) : array<string|int, mixed>|null
Parameters
$index : string
Return values
array<string|int, mixed>|null —

if index correct, return array in format [MODULE_ID => , FEATURE_ID =>]

setFeatures()

Replace property features.

public static setFeatures(int $propertyId, array<string|int, mixed> $features) : Result
Parameters
$propertyId : int

Property id.

$features : array<string|int, mixed>

Feature list.

Return values
Result

updateFeatures()

Upsert features for exist property.

public static updateFeatures(int $propertyId, array<string|int, mixed> $features) : Result
Parameters
$propertyId : int

Property id.

$features : array<string|int, mixed>

Feature list.

Return values
Result 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results