Reference __construct(
string
$name, Entity
$entity, [string
$caption = ''], [bool
$display = TRUE], [bool
$required = FALSE]
)
|
|
Parameters:
string |
$name: |
Parameter name |
Entity |
$entity: |
Referenced entity |
string |
$caption: |
Parameter of referenced entity displayed as a caption |
bool |
$display: |
Render it in templates |
bool |
$required: |
Require non-empty value 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:
Redefinition of:
- Param::display()
- Renders param value display in a correct way
string display_input(
[mixed
$value = NULL], [string
$prefix = ''], [int
$exclude = NULL]
)
|
|
Renders param input display in a correct way
Parameters:
mixed |
$value: |
|
string |
$prefix: |
Input name prefix |
int |
$exclude: |
Exclude this item from list (usually self) |
API Tags:
See: | Param::title, Param::hint |
Access: | public |
Redefinition of:
- Param::display_input()
- Renders param input display in a correct way
array get_item(
int
$value
)
|
|
Gets a result row for referenced item which you can pass to constructor of exact class
Parameters:
int |
$value: |
Reference key value |
API Tags:
Return: | SQL result row |
Access: | public |
Refreshes key/value cache for the reference
API Tags: