Bitrix API

Store

Class Store of exclusions

Table of Contents

Methods

add()  : int|null
Add exclusion.
addFromEntities()  : void
Add exclusions from entities.
addFromEntity()  : void
Add exclusions from entity.
getList()  : Result
Get list.
has()  : bool
Returns true if code is in list.
hasEmail()  : bool
Returns true if email is in list.
hasPhone()  : bool
Returns true if phone is in list.
import()  : void
Import list of exclusions.
isEntityTypeSupported()  : bool
remove()  : bool
Remove exclusion.

Methods

add()

Add exclusion.

public static add(int $typeId, string $code[, string|null $comment = null ]) : int|null
Parameters
$typeId : int

Type ID.

$code : string

Code.

$comment : string|null = null

Comment.

Return values
int|null

addFromEntities()

Add exclusions from entities.

public static addFromEntities(int $entityTypeId, array<string|int, int> $entities[, string|null $comment = null ]) : void
Parameters
$entityTypeId : int

Entity type ID.

$entities : array<string|int, int>

Entities.

$comment : string|null = null

Comment.

Tags
throws
NotSupportedException

addFromEntity()

Add exclusions from entity.

public static addFromEntity(int $entityTypeId, int $entityId[, string|null $comment = null ]) : void
Parameters
$entityTypeId : int

Entity type ID.

$entityId : int

Entity ID.

$comment : string|null = null

Comment.

Tags
throws
NotSupportedException

getList()

Get list.

public static getList(array<string|int, mixed> $parameters) : Result
Parameters
$parameters : array<string|int, mixed>

Parameters.

Return values
Result

has()

Returns true if code is in list.

public static has(int $typeId, string $code) : bool
Parameters
$typeId : int

Type ID.

$code : string

Code.

Return values
bool

hasEmail()

Returns true if email is in list.

public static hasEmail(string $email) : bool
Parameters
$email : string

Email.

Return values
bool

hasPhone()

Returns true if phone is in list.

public static hasPhone(string $phone) : bool
Parameters
$phone : string

Phone.

Return values
bool

import()

Import list of exclusions.

public static import(array<string|int, mixed> $list) : void

[ '+71112223344;Comment 1', 'example@example.com;Comment 2' ]

Parameters
$list : array<string|int, mixed>

List.

isEntityTypeSupported()

public static isEntityTypeSupported(int $entityTypeId) : bool
Parameters
$entityTypeId : int
Return values
bool

remove()

Remove exclusion.

public static remove(int $id) : bool
Parameters
$id : int

ID.

Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results