Enum __construct(
int
$type, string
$name, array
$values, [string
$default = NULL], [bool
$display = TRUE], [bool
$required = FALSE]
)
|
|
Parameter constructor
Parameters:
int |
$type: |
Value type |
string |
$name: |
Parameter name |
array |
$values: |
Value alternatives |
string |
$default: |
Default value |
bool |
$display: |
Render it in templates |
bool |
$required: |
Require it from user input |
API Tags:
Redefinition of:
- Param::__construct()
- Constructs parameter object
string display(
mixed
$value
)
|
|
Renders param value display in a correct way
Parameters:
API Tags:
Return: | Rendered display element |
Access: | public |
Redefinition of:
- Param::display()
- Renders param value display in a correct way
Redefined in descendants as:
string display_input(
[mixed
$value = NULL], [string
$prefix = '']
)
|
|
Renders param input display in a correct way
Parameters:
mixed |
$value: |
|
string |
$prefix: |
Input name prefix |
API Tags:
See: | Param::title, Param::hint |
Access: | public |
Redefinition of:
- Param::display_input()
- Renders param input display in a correct way
Redefined in descendants as:
array get_alternatives(
)
|
|
Gets an array of acceptable alternative values for this enumeration
API Tags:
Return: | Possible values |
Access: | public |
mixed import(
[string
$method = 'P'], [string
$prefix = '']
)
|
|
Imports parameter value from user input
Parameters:
string |
$method: |
Request method: P - post, G - get. |
string |
$prefix: |
Input name prefix |
API Tags:
Return: | Value on success or NULL if validation failed |
Access: | public |
Redefinition of:
- Param::import()
- Imports parameter value from user input
Redefined in descendants as: