VoteUserType
Table of Contents
Constants
- NEW_VOTE_PREFIX = 'n'
- TYPE_NEW_ATTACH = 'NewAttach'
- TYPE_SAVED_ATTACH = 'SavedAttach'
Methods
- checkFields() : array<string|int, mixed>
- Checks fields of vote date before saving.
- checkSettings() : bool
- Checks CHANNEL or creates add vote group.
- detectType() : array<string|int, mixed>
- Detect: this is already exists attachedObject or new object.
- getAdminListEditHTML() : string
- getAdminListEditHTMLMulty() : string
- getAdminListViewHTML() : string
- getDBColumnType() : string
- getEditFormHTML() : string
- getFilterHTML() : string
- getPublicViewHTML() : string
- getSettingsHTML() : string
- Shows data form in admin part when you edit or add usertype.
- getUserTypeDescription() : array<string|int, mixed>
- onBeforeCopy() : array<string|int, mixed>|int|string
- onBeforePostUserFieldUpdate() : void
- onBeforeSave() : int|string
- Called in all cases Mutiple=Y and Multiple=N
- onDelete() : void
- onSearchIndex() : string
- prepareSettings() : array<string|int, mixed>
- Prepares data("SETTINGS") for serialization in functions CUserTypeEntity::Add & CUserTypeEntity::Update
Constants
NEW_VOTE_PREFIX
public
mixed
NEW_VOTE_PREFIX
= 'n'
TYPE_NEW_ATTACH
public
mixed
TYPE_NEW_ATTACH
= 'NewAttach'
TYPE_SAVED_ATTACH
public
mixed
TYPE_SAVED_ATTACH
= 'SavedAttach'
Methods
checkFields()
Checks fields of vote date before saving.
public
static checkFields(array<string|int, mixed> $userField, mixed $value[, bool $userId = false ]) : array<string|int, mixed>
Parameters
- $userField : array<string|int, mixed>
-
UserFiled array.
- $value : mixed
-
Always singular value.
- $userId : bool = false
-
False means current user id.
Return values
array<string|int, mixed>checkSettings()
Checks CHANNEL or creates add vote group.
public
static checkSettings(array<string|int, mixed> &$params) : bool
Parameters
- $params : array<string|int, mixed>
-
Settings array.
Return values
booldetectType()
Detect: this is already exists attachedObject or new object.
public
static detectType(mixed $value) : array<string|int, mixed>
Parameters
- $value : mixed
-
Integer if it ia an attach or n1, n2 in case unsaved attach.
Return values
array<string|int, mixed>getAdminListEditHTML()
public
static getAdminListEditHTML(array<string|int, mixed> $userField, array<string|int, mixed> $htmlControl) : string
Parameters
- $userField : array<string|int, mixed>
-
UserField array.
- $htmlControl : array<string|int, mixed>
-
HTML Control.
Return values
stringgetAdminListEditHTMLMulty()
public
static getAdminListEditHTMLMulty(array<string|int, mixed> $userField, array<string|int, mixed> $htmlControl) : string
Parameters
- $userField : array<string|int, mixed>
-
UserField array.
- $htmlControl : array<string|int, mixed>
-
HTML Control.
Return values
stringgetAdminListViewHTML()
public
static getAdminListViewHTML(array<string|int, mixed> $userField, array<string|int, mixed> $htmlControl) : string
Parameters
- $userField : array<string|int, mixed>
-
UserField array.
- $htmlControl : array<string|int, mixed>
-
HTML Control.
Return values
stringgetDBColumnType()
public
static getDBColumnType(mixed $userField) : string
Parameters
- $userField : mixed
Return values
stringgetEditFormHTML()
public
static getEditFormHTML(array<string|int, mixed> $userField, array<string|int, mixed> $value[, mixed $bVarsFromForm = false ]) : string
Parameters
- $userField : array<string|int, mixed>
-
UserField array.
- $value : array<string|int, mixed>
-
Value.
- $bVarsFromForm : mixed = false
Return values
stringgetFilterHTML()
public
static getFilterHTML() : string
Return values
stringgetPublicViewHTML()
public
static getPublicViewHTML(array<string|int, mixed> $userField, mixed $value) : string
Parameters
- $userField : array<string|int, mixed>
-
UserField array.
- $value : mixed
-
Value for Vote.
Return values
stringgetSettingsHTML()
Shows data form in admin part when you edit or add usertype.
public
static getSettingsHTML(bool $userField, string $htmlControl, bool $varsFromForm) : string
Parameters
- $userField : bool
-
UserField array.
- $htmlControl : string
-
HtmlControl.
- $varsFromForm : bool
-
Get params from $_REQUEST.
Return values
stringgetUserTypeDescription()
public
static getUserTypeDescription() : array<string|int, mixed>
Return values
array<string|int, mixed>onBeforeCopy()
public
static onBeforeCopy(array<string|int, mixed> $userField, int $newEntityId, mixed $attachedId, object $implementer[, bool $userId = false ]) : array<string|int, mixed>|int|string
Parameters
- $userField : array<string|int, mixed>
- $newEntityId : int
- $attachedId : mixed
- $implementer : object
- $userId : bool = false
Tags
Return values
array<string|int, mixed>|int|stringonBeforePostUserFieldUpdate()
public
static onBeforePostUserFieldUpdate(string $entityId, int $ID, array<string|int, mixed> $fields) : void
Parameters
- $entityId : string
-
BLOG_POST.
- $ID : int
-
Blog ID.
- $fields : array<string|int, mixed>
-
Array ( [ID] => 29, [URL] => "", [BLOG] => "", ...).
onBeforeSave()
Called in all cases Mutiple=Y and Multiple=N
public
static onBeforeSave(array<string|int, mixed> $userField, string $value[, int $userId = false ]) : int|string
Parameters
- $userField : array<string|int, mixed>
-
UserFiled array.
- $value : string
-
Number of attach or n0, n1...
- $userId : int = false
-
User ID.
Return values
int|stringonDelete()
public
static onDelete(array<string|int, mixed> $userField, string $value) : void
Parameters
- $userField : array<string|int, mixed>
-
UserFiled array.
- $value : string
-
Number of attach or n0, n1...
onSearchIndex()
public
static onSearchIndex(array<string|int, mixed> $userField) : string
Parameters
- $userField : array<string|int, mixed>
-
UserFiled array.
Return values
stringprepareSettings()
Prepares data("SETTINGS") for serialization in functions CUserTypeEntity::Add & CUserTypeEntity::Update
public
static prepareSettings(array<string|int, mixed> $userField) : array<string|int, mixed>
Parameters
- $userField : 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] => 40 [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)).