-
(mixed) getConfig ($key = null, $default = null, (Boolean) $escaped = false)
Browse code
| $key |
A key string
|
| $default |
The default value if the key does not exist
|
| $escaped |
Whether to escape single quote (false by default)
|
Returns the configuration value for a given key.
If the key is null, the method returns all the configuration array.
returns The configuration value associated with the key
-
Gets the flag associated with the field.
The flag will be
* = for a link * _ for a partial * ~ for a component
returns The flag
-
Returns the name of the field.
returns The field name
-
(mixed) getRenderer ()
Browse code
Gets the list renderer for the field.
returns A PHP callable
-
(array) getRendererArguments ()
Browse code
Gets the list renderer arguments for the field.
returns An array of arguments to pass to the renderer
-
Returns the type of the field.
returns The field type
-
(boolean) isComponent ()
Browse code
Returns true if the column is a component.
returns true if the column is a component, false otherwise
-
Returns true if the column has a link.
returns true if the column has a link, false otherwise
-
(boolean) isPartial ()
Browse code
Returns true if the column is a partial.
returns true if the column is a partial, false otherwise
-
Returns true if the column maps a database column.
returns true if the column maps a database column, false otherwise
-
setComponent ((Boolean) $boolean)
Browse code
| $boolean |
true if the field is a component, false otherwise
|
Sets or unsets the component flag.
-
Sets a flag.
The flag can be =, _, or ~.
-
setLink ((Boolean) $boolean)
Browse code
| $boolean |
true if the field is a link, false otherwise
|
Sets or unsets the link flag.
-
setPartial ((Boolean) $boolean)
Browse code
| $boolean |
true if the field is a partial, false otherwise
|
Sets or unsets the partial flag.
-
setRenderer ($renderer)
Browse code
Sets the list renderer for the field.
-
setRendererArguments ($arguments)
Browse code
| $arguments |
An array of arguments to pass to the renderer
|
Sets the list renderer arguments for the field.
-
splitFieldWithFlag ($field)
Browse code
-
__construct ($name, $config)
Browse code
| $name |
The field name
|
| $config |
The configuration for this field
|
Constructor.