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 a string or an integer, and both can be present in the same array. Some arrays can be used as an input. These will typically have required indexes that will be specified in the documentation. Index names use the same convention as variables.
dt_String. Describes a date, time, or both, in MySQL format. Times are in 24h notation (for example, ‘2018-01-31’ or ‘2018-12-31 15:35:00’).
can_Boolean. Used to describe whether something can happen. Boolean values for the SDK should be set to an integer of 1 or 0.
f_Real number. Stored as a floating-point value.
has_Boolean. Used to describe whether an entity has some value. Boolean values for the SDK should be set to an integer of 1 or 0.
html_String. This string has been parsed by htmlspecialchars() to prevent cross-site scripting.
i_Integer.
id_Positive integer. This will correspond to a constant defined in the SDK.
is_Boolean. Used to describe whether an entity is of a certain type. Boolean values for the SDK should be set to an integer of 1 or 0.
k_Key. This is a string containing an integer that describes a key in a table of the database (for example, k_business = ‘123’). Keys will always be positive. 
m_Money. This is a floating-point number stored as a string describing an amount of money (for example, m_deposit=’3.50′;). This variable only represents the numerical quantity of money. A separate variable will be used to specify the currency, if specified.
s_String. Typically, this prefix is used to denote string values that aren’t expected to be read directly (for example, HTML color codes).
text_String. Intended to be a human-readable value.
uid_Key. This follows the same rules as the k_prefix but is used specifically to refer to user IDs.
url_String. This describes a URL.
x_Variable type. Different types of variables can be assigned depending on the needs of the program.
xml_String. This can contain HTML tags and is intended to be displayed on a web page.
z_String. This is compressed by PHP’s compress() function.