FormSetUser
extends Element
in package
Uses
ElementTrait, LocationFormFieldsTrait
This is the 'FormSetUser' class, a DTO class for the form configuration data.
The items stored in this class will remain immutable (only get methods are available).
This class extends SDK\Core\Dtos\Element, see this class.
Tags
Table of Contents
| ADDRESSBOOK_FIELDS | = 'addressbookFields' | |
|---|---|---|
| AVAILABLE_CUSTOM_TAG_POSITIONS | = 'availableCustomTagPositions' | |
| AVAILABLE_FIELDS_FAST_REGISTER | = 'availableFieldsFastRegister' | |
| AVAILABLE_FIELDS_ONLY_WITH_LOGIN | = 'availableFieldsOnlyWithLogin' | |
| DEFAULT_USER_TYPE | = 'defaultUserType' | |
| UNAVAILABLE_FIELDS_WITH_LOGIN | = 'unavailableFieldsWithLogin' | |
| USER_FIELDS | = 'userFields' | |
| getAddressbookFields() | This method returns the array with the addressbook fields. | : FormSetUserFields|null |
| getAvailableCustomTagPositions() | This method returns the available custom tag positions to show in the form. | : array<string|int, mixed> |
| getAvailableFieldsFastRegister() | This method returns the FormFieldsSetUser with the available fields for fast register . | : FormFieldsSetUser|null |
| getAvailableFieldsOnlyWithLogin() | This method returns the FormFieldsSetUser with the available fields to show when the user has login. | : FormFieldsSetUser|null |
| getDefaultUserType() | This method returns the default user type to show in the form. | : string |
| getUnavailableFieldsWithLogin() | This method returns the FormFieldsSetUser with the unavailable fields to show when the user has login. | : FormFieldsSetUser|null |
| getUserFields() | This method returns the array with the user fields. | : FormSetUserFields|null |
Constants
ADDRESSBOOK_FIELDS
public
mixed
ADDRESSBOOK_FIELDS
= 'addressbookFields'
AVAILABLE_CUSTOM_TAG_POSITIONS
public
mixed
AVAILABLE_CUSTOM_TAG_POSITIONS
= 'availableCustomTagPositions'
AVAILABLE_FIELDS_FAST_REGISTER
public
mixed
AVAILABLE_FIELDS_FAST_REGISTER
= 'availableFieldsFastRegister'
AVAILABLE_FIELDS_ONLY_WITH_LOGIN
public
mixed
AVAILABLE_FIELDS_ONLY_WITH_LOGIN
= 'availableFieldsOnlyWithLogin'
DEFAULT_USER_TYPE
public
mixed
DEFAULT_USER_TYPE
= 'defaultUserType'
UNAVAILABLE_FIELDS_WITH_LOGIN
public
mixed
UNAVAILABLE_FIELDS_WITH_LOGIN
= 'unavailableFieldsWithLogin'
USER_FIELDS
public
mixed
USER_FIELDS
= 'userFields'
Methods
getAddressbookFields()
This method returns the array with the addressbook fields.
public
getAddressbookFields() : FormSetUserFields|null
Return values
FormSetUserFields|null —getAvailableCustomTagPositions()
This method returns the available custom tag positions to show in the form.
public
getAvailableCustomTagPositions() : array<string|int, mixed>
Return values
array<string|int, mixed> —getAvailableFieldsFastRegister()
This method returns the FormFieldsSetUser with the available fields for fast register .
public
getAvailableFieldsFastRegister() : FormFieldsSetUser|null
Return values
FormFieldsSetUser|null —getAvailableFieldsOnlyWithLogin()
This method returns the FormFieldsSetUser with the available fields to show when the user has login.
public
getAvailableFieldsOnlyWithLogin() : FormFieldsSetUser|null
Return values
FormFieldsSetUser|null —getDefaultUserType()
This method returns the default user type to show in the form.
public
getDefaultUserType() : string
Return values
string —getUnavailableFieldsWithLogin()
This method returns the FormFieldsSetUser with the unavailable fields to show when the user has login.
public
getUnavailableFieldsWithLogin() : FormFieldsSetUser|null
Return values
FormFieldsSetUser|null —getUserFields()
This method returns the array with the user fields.
public
getUserFields() : FormSetUserFields|null