Bitrix API

Template implements Recyclebinable

Table of Contents

Interfaces

Recyclebinable

Methods

getAdditionalData()  : array<string|int, mixed>
getDeleteMessage()  : string
getNotifyMessages()  : array<string|int, mixed>
moveFromRecyclebin()  : bool
OnBeforeDelete()  : Result
previewFromRecyclebin()  : void
removeFromRecyclebin()  : bool
Removes entity from recycle bin

Methods

getAdditionalData()

public static getAdditionalData() : array<string|int, mixed>
Tags
throws
ObjectPropertyException
throws
SystemException
Return values
array<string|int, mixed>

getDeleteMessage()

public static getDeleteMessage([int $userId = 0 ]) : string
Parameters
$userId : int = 0
Return values
string

getNotifyMessages()

public static getNotifyMessages() : array<string|int, mixed>
Return values
array<string|int, mixed> —

[ 'NOTIFY'=> [ 'RESTORE' => Loc::getMessage(''), 'REMOVE' => Loc::getMessage(''), ], 'CONFIRM' => [ 'RESTORE' => Loc::getMessage(''), 'REMOVE' => Loc::getMessage('') ]

moveFromRecyclebin()

public static moveFromRecyclebin(Entity $entity) : bool
Parameters
$entity : Entity
Return values
bool

OnBeforeDelete()

public static OnBeforeDelete(mixed $templateId[, array<string|int, mixed> $template = [] ]) : Result
Parameters
$templateId : mixed
$template : array<string|int, mixed> = []
Return values
Result

previewFromRecyclebin()

public static previewFromRecyclebin(Entity $entity) : void

and will be removed since recyclebin 23.0.0

Parameters
$entity : Entity
Tags
throws
NotImplementedException

removeFromRecyclebin()

Removes entity from recycle bin

public static removeFromRecyclebin(Entity $entity[, array<string|int, mixed> $params = [] ]) : bool
Parameters
$entity : Entity
$params : array<string|int, mixed> = []
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results