Home /Resources/Prefix codes
Prefix codes

The SDK uses a version of Hungarian notation to denote the type of data a variable can hold.

CodeDescription
a_Array. Arrays in PHP are associative; an array index can be either a string or an integer, and both can appear in the same array. Some arrays are used as input, and these typically have required indexes, which will be specified in the documentation. Index names follow the same convention as variables.
dt_Date/Time. Represents a date, time, or both in MySQL format (e.g., 2018-01-31 or 2018-12-31 15:35:00). Times are in 24-hour notation.
can_Boolean. Describes whether something can happen. Boolean values for the SDK should be represented as integers (1 for true, 0 for false).
f_Float. Represents a real number stored as a floating-point value.
has_Boolean. Indicates whether an entity has a certain value. Boolean values for the SDK should be set to integers (1 for true, 0 for false).
html_String. This string has been processed by htmlspecialchars() to prevent cross-site scripting (XSS).
i_Integer. Represents an integer value.
id_Positive Integer. Represents a positive integer corresponding to a constant defined in the SDK.
is_Boolean. Used to indicate whether an entity is of a specific type. Boolean values should be set to integers (1 for true, 0 for false).
k_Key. A string containing an integer that represents a key in a database table. Keys are always positive integers.
m_Money. Represents a floating-point number stored as a string, describing an amount of money. This variable represents the numerical quantity of money only; a separate variable is used to specify the currency if needed.
s_String. Typically used for string values that aren’t expected to be directly read (e.g., HTML color codes).
text_String. Intended to store human-readable text.
uid_User ID Key. Follows the same rules as the k_ prefix but is used specifically for user IDs.
url_String. Represents a URL.
x_Variable Type. A placeholder for different variable types, assigned depending on the needs of the program.
xml_String. Contains HTML tags and is intended to be displayed on a web page.
z_String. A string that has been compressed using PHP’s compress() function.