Bitrix API

Manager

FinalYes

Table of Contents

Methods

__construct()  : mixed
Constructor of UserFieldManager.
belongsToEntity()  : bool
Checks attitude attached object to entity.
getConnectorDataByEntityType()  : array<string|int, mixed>|null
Gets data which describes specific connector by entity type.
getConnectors()  : array<string|int, mixed>
Returns full list of available connectors for attached objects.
getErrors()  : array<string|int, mixed>
Getting array of errors.
getInstance()  : Manager
Returns instance of Manager.
loadEmptyObject()  : Attach
loadFromAttachId()  : Attach
Returns attached object by id.
loadFromEntity()  : array<string|int, Attach>
loadFromVoteId()  : Attach
Returns vote object by id.
showEdit()  : void
Shows component to edit vote.
showView()  : void
Shows component to participate in vote

Methods

__construct()

Constructor of UserFieldManager.

public __construct(array<string|int, mixed> $params) : mixed
Parameters
$params : array<string|int, mixed>

belongsToEntity()

Checks attitude attached object to entity.

public belongsToEntity(Attach $attachedObject, string $entityType, int $entityId) : bool
Parameters
$attachedObject : Attach

Attached object.

$entityType : string

Entity type (ex. blog_post).

$entityId : int

Id of entity.

Return values
bool

getConnectorDataByEntityType()

Gets data which describes specific connector by entity type.

public getConnectorDataByEntityType(string $entityType) : array<string|int, mixed>|null
Parameters
$entityType : string

Entity type (ex. sonet_comment).

Return values
array<string|int, mixed>|null —

Array with two elements: connector class and module.

getConnectors()

Returns full list of available connectors for attached objects.

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

getErrors()

Getting array of errors.

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

getInstance()

Returns instance of Manager.

public static getInstance(array<string|int, mixed> $params) : Manager
Parameters
$params : array<string|int, mixed>

Array ( [ID] => 29 [ENTITY_ID] => BLOG_POST [FIELD_NAME] => UF_BLOG_POST_VOTE [USER_TYPE_ID] => vote [XML_ID] => UF_BLOG_POST_VOTE [SORT] => 100 [MULTIPLE] => N [MANDATORY] => N [SHOW_FILTER] => N [SHOW_IN_LIST] => Y [EDIT_IN_LIST] => Y [IS_SEARCHABLE] => N [SETTINGS] => Array ( [CHANNEL_ID] => 1 [UNIQUE] => 8 [UNIQUE_IP_DELAY] => Array ( [DELAY] => [DELAY_TYPE] => S )

[NOTIFY] => I )

[EDIT_FORM_LABEL] => UF_BLOG_POST_VOTE [LIST_COLUMN_LABEL] => [LIST_FILTER_LABEL] => [ERROR_MESSAGE] => [HELP_MESSAGE] => [USER_TYPE] => Array ( [USER_TYPE_ID] => vote [CLASS_NAME] => Bitrix\Vote\Uf\VoteUserType [DESCRIPTION] => "Vote" [BASE_TYPE] => int )

[VALUE] => 27 [ENTITY_VALUE_ID] => 247)).

Return values
Manager

loadEmptyObject()

public loadEmptyObject() : Attach
Return values
Attach

loadFromAttachId()

Returns attached object by id.

public loadFromAttachId(int $id) : Attach
Parameters
$id : int

Id of attached object.

Return values
Attach

loadFromEntity()

public loadFromEntity() : array<string|int, Attach>
Return values
array<string|int, Attach>

loadFromVoteId()

Returns vote object by id.

public loadFromVoteId(int $id) : Attach
Parameters
$id : int

Id of vote.

Return values
Attach

showEdit()

Shows component to edit vote.

public showEdit(array<string|int, mixed> &$params, array<string|int, mixed> &$result[, null $component = null ]) : void
Parameters
$params : array<string|int, mixed>

Component parameters.

$result : array<string|int, mixed>

Component results.

$component : null = null

Component.

showView()

Shows component to participate in vote

public showView(array<string|int, mixed> &$params, array<string|int, mixed> &$result[, null $component = null ]) : void
Parameters
$params : array<string|int, mixed>

Component parameters.

$result : array<string|int, mixed>

Component results.

$component : null = null

Component.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results