Bitrix API

Member extends BaseTable

Table of Contents

Constants

COMMUNICATION_TYPE_MAIL  = 'EMAIL'
COMMUNICATION_TYPE_PHONE  = 'PHONE'

Properties

$internalClass  : string
Internal class.

Methods

add()  : AddResult
Creates new record and return it new result.
callback()  : void
Registers calllback for internal table.
create()  : bool
Creates member for document, returns true on success.
delete()  : Result
Deletes exists record.
downloadDocument()  : bool
getCommunications()  : array<string|int, mixed>
Returns member communications.
getCommunicationType()  : string|null
Returns member communication type.
getCommunicationValue()  : string|null
Returns member communication value.
getContactId()  : int
Returns member contact id.
getContactName()  : string|null
Returns member contact name.
getDateDocumentDownload()  : DateTime|null
getDateDocumentVerify()  : DateTime|null
getDateSign()  : DateTime|null
getDocument()  : Document
Returns Document instance of member.
getDocumentMembers()  : array<string|int, self>
Returns document's members.
getDownloadUrl()  : string
Returns sign url for member.
getHash()  : string
Returns hash.
getId()  : int
Returns row id.
getIp()  : string|null
getList()  : Result
Returns records of table.
getMap()  : array<string|int, mixed>
Returns table's map.
getMeta()  : mixed
Returns meta information if exists.
getPart()  : int
Returns member part index.
getSignatureFile()  : File|null
Returns File instance of signature.
getSignUrl()  : string
Returns sign url for member.
getStampFile()  : File|null
Returns File instance of stamp.
getTimeZoneOffset()  : int|null
getUserData()  : mixed
Returns user data if exists.
hasSignatureFile()  : bool
Returns true if signature exists.
hasStampFile()  : bool
Returns true if stamp exists.
isInitiator()  : bool
Returns true if member is doc initiator.
isMuted()  : bool
Returns true, if this member is no allow to receive any messages.
isSigned()  : bool
Returns true if member signed.
isThirdParty()  : bool
Returns true if member is third party.
isVerified()  : bool
Returns true if member verified.
mute()  : bool
Mutes member (not send any letters to member).
setCommunication()  : bool
Saves communication's type and value.
setData()  : bool
Updates entity data.
setSignatureFile()  : bool
Saves File signature to Member.
setStampFile()  : bool
Saves File stamp to Member.
setUserData()  : bool
Saves some user data.
toArray()  : array<string|int, mixed>
Returns current instance as simple array.
unMute()  : bool
Unmutes member (send letters to member).
update()  : Result
Updates exists record.
verify()  : bool
Member is verified throw communication channel.
verifyDocument()  : mixed

Constants

COMMUNICATION_TYPE_MAIL

public mixed COMMUNICATION_TYPE_MAIL = 'EMAIL'

COMMUNICATION_TYPE_PHONE

public mixed COMMUNICATION_TYPE_PHONE = 'PHONE'

Properties

$internalClass

Internal class.

public static string $internalClass = 'MemberTable'

Methods

add()

Creates new record and return it new result.

public static add(array<string|int, mixed> $fields) : AddResult
Parameters
$fields : array<string|int, mixed>

Fields array.

Return values
AddResult

callback()

Registers calllback for internal table.

public static callback(string $code, callable $callback) : void
Parameters
$code : string

Type of callback.

$callback : callable

Callback.

create()

Creates member for document, returns true on success.

public static create(Document $document, int $contactId, int $part) : bool
Parameters
$document : Document

Document instance.

$contactId : int

Contact id.

$part : int

Part index.

Return values
bool

delete()

Deletes exists record.

public static delete(int $id) : Result
Parameters
$id : int

Record key.

Return values
Result

downloadDocument()

public downloadDocument() : bool
Return values
bool

getCommunications()

Returns member communications.

public getCommunications() : array<string|int, mixed>
Return values
array<string|int, mixed>

getCommunicationType()

Returns member communication type.

public getCommunicationType() : string|null
Return values
string|null

getCommunicationValue()

Returns member communication value.

public getCommunicationValue() : string|null
Return values
string|null

getContactId()

Returns member contact id.

public getContactId() : int

CONTACT_ID is deprecated in v2 documents, look at entity

Return values
int

getContactName()

Returns member contact name.

public getContactName() : string|null
Return values
string|null

getDocument()

Returns Document instance of member.

public getDocument() : Document
Return values
Document

getDocumentMembers()

Returns document's members.

public static getDocumentMembers(Document $document[, bool $asArray = false ]) : array<string|int, self>
Parameters
$document : Document

Document instance.

$asArray : bool = false

Returns list as simple array.

Return values
array<string|int, self>

getDownloadUrl()

Returns sign url for member.

public getDownloadUrl() : string
Return values
string

getHash()

Returns hash.

public getHash() : string
Return values
string

getId()

Returns row id.

public getId() : int
Return values
int

getIp()

public getIp() : string|null
Return values
string|null

getList()

Returns records of table.

public static getList([array<string|int, mixed> $params = [] ]) : Result
Parameters
$params : array<string|int, mixed> = []

Params array like ORM style.

Return values
Result

getMap()

Returns table's map.

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

getMeta()

Returns meta information if exists.

public getMeta() : mixed

getPart()

Returns member part index.

public getPart() : int
Return values
int

getSignatureFile()

Returns File instance of signature.

public getSignatureFile() : File|null
Return values
File|null

getSignUrl()

Returns sign url for member.

public getSignUrl() : string
Return values
string

getStampFile()

Returns File instance of stamp.

public getStampFile() : File|null
Return values
File|null

getTimeZoneOffset()

public getTimeZoneOffset() : int|null
Return values
int|null

getUserData()

Returns user data if exists.

public getUserData() : mixed

hasSignatureFile()

Returns true if signature exists.

public hasSignatureFile() : bool
Return values
bool

hasStampFile()

Returns true if stamp exists.

public hasStampFile() : bool
Return values
bool

isInitiator()

Returns true if member is doc initiator.

public isInitiator() : bool
Return values
bool

isMuted()

Returns true, if this member is no allow to receive any messages.

public isMuted() : bool
Return values
bool

isSigned()

Returns true if member signed.

public isSigned() : bool
Return values
bool

isThirdParty()

Returns true if member is third party.

public isThirdParty() : bool
Return values
bool

isVerified()

Returns true if member verified.

public isVerified() : bool
Return values
bool

mute()

Mutes member (not send any letters to member).

public mute([bool $flag = true ]) : bool
Parameters
$flag : bool = true

Mute if true, unmute in other way.

Return values
bool

setCommunication()

Saves communication's type and value.

public setCommunication(string $type, string $value) : bool
Parameters
$type : string

Communication type.

$value : string

Communication value.

Return values
bool

setData()

Updates entity data.

public setData(array<string|int, mixed> $data) : bool
Parameters
$data : array<string|int, mixed>

New blank data.

Return values
bool

setSignatureFile()

Saves File signature to Member.

public setSignatureFile(File $file) : bool
Parameters
$file : File

File instance.

Return values
bool

setStampFile()

Saves File stamp to Member.

public setStampFile(File $file) : bool
Parameters
$file : File

File instance.

Return values
bool

setUserData()

Saves some user data.

public setUserData(array<string|int, mixed> $data[, bool $skipSend = false ]) : bool
Parameters
$data : array<string|int, mixed>

User data.

$skipSend : bool = false

Skip sending to safe.

Return values
bool

toArray()

Returns current instance as simple array.

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

unMute()

Unmutes member (send letters to member).

public unMute() : bool
Return values
bool

update()

Updates exists record.

public static update(int $id[, array<string|int, mixed> $fields = [] ]) : Result
Parameters
$id : int

Record key.

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

Fields array.

Return values
Result

verify()

Member is verified throw communication channel.

public verify() : bool
Return values
bool

verifyDocument()

public verifyDocument() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results