UserAdminCustomFieldUpdate
extends BaseComponent
in package
Object that describes the custom field to be created
Table of Contents
Properties
- $bit_value : bool|null
- $data_type_id : int
- $date_value : string|null
- $decimal_value : float|null
- $field_id : int
- $id : string|null
- $int_value : int|null
- $text_value : string|null
- $fields : array<string|int, string>
Properties
$bit_value
public
bool|null
$bit_value
If field format is Yes/No or Checkbox, use this property for the value of the custom field. Values must be 'true" or 'false'.
$data_type_id
public
int
$data_type_id
The ID of the data type of the custom field. This value is returned from Core custom fields.
$date_value
public
string|null
$date_value
If field format is Date, use this property for the value of the custom field. Values must be formatted YYYY/MM/DD.
$decimal_value
public
float|null
$decimal_value
If the field format is Currency, use this property for the value of the custom field. Values must be between 0.00 and 99,999,999.99.
$field_id
public
int
$field_id
The ID of the custom field to update. This value is returned from Core custom fields.
$id
public
string|null
$id
The id of that instance of the custom field for the specified user. This value is returned from Users custom fields by user.
$int_value
public
int|null
$int_value
If the field format is Number, use this property for the value of the custom field. Values must be a whole number (positive or negative). If the field format is Dropdown or Checkbox List, use this property for the value of the custom field. The value is the table value ID returned from Core custom fields.
$text_value
public
string|null
$text_value
If the field format is Text input or Text paragraph, use this property for the value of the custom field.
$fields
protected
static array<string|int, string>
$fields
= ["id" => "string", "field_id" => "int", "data_type_id" => "int", "int_value" => "int", "text_value" => "string", "decimal_value" => "float", "date_value" => "string", "bit_value" => "bool"]