Class category.
More...
|
static | create (int $id, stdClass $record=null, handler $handler=null) |
| Creates an instance of category_controller.
|
|
|
| __construct (int $id=0, stdClass $record=null) |
| category constructor.
|
|
◆ __construct()
core_customfield\category_controller::__construct |
( |
int | $id = 0, |
|
|
stdClass | $record = null ) |
|
protected |
category constructor.
This class is not abstract, however the constructor was made protected to be consistent with field_controller and data_controller
- Parameters
-
int | $id | |
stdClass | null | $record | |
◆ add_field()
Adds a child field.
- Parameters
-
◆ create()
static core_customfield\category_controller::create |
( |
int | $id, |
|
|
stdClass | $record = null, |
|
|
handler | $handler = null ) |
|
static |
Creates an instance of category_controller.
Either $id or $record or $handler need to be specified If handler is known pass it to constructor to avoid retrieving it later Component, area and itemid must not conflict with the ones in handler
- Parameters
-
int | $id | |
stdClass | null | $record | |
handler | null | $handler | |
- Return values
-
- Exceptions
-
◆ delete()
core_customfield\category_controller::delete |
( |
| ) |
|
|
final |
Persistent delete parser.
- Return values
-
◆ get()
core_customfield\category_controller::get |
( |
| $property | ) |
|
|
final |
Persistent getter parser.
- Parameters
-
- Return values
-
◆ get_fields()
core_customfield\category_controller::get_fields |
( |
| ) |
|
Return an array of field objects associated with this category.
- Return values
-
◆ get_formatted_name()
core_customfield\category_controller::get_formatted_name |
( |
| ) |
|
Returns the category name formatted according to configuration context.
- Return values
-
◆ get_handler()
core_customfield\category_controller::get_handler |
( |
| ) |
|
Gets a handler, if not known retrieve it.
- Return values
-
◆ save()
core_customfield\category_controller::save |
( |
| ) |
|
|
final |
Persistent save parser.
- Return values
-
◆ set()
core_customfield\category_controller::set |
( |
| $property, |
|
|
| $value ) |
|
final |
Persistent setter parser.
- Parameters
-
string | $property | |
mixed | $value | |
◆ set_handler()
core_customfield\category_controller::set_handler |
( |
handler | $handler | ) |
|
Allows to set handler so we don't need to retrieve it later.
- Parameters
-
- Exceptions
-
◆ to_record()
core_customfield\category_controller::to_record |
( |
| ) |
|
|
final |
Persistent to_record parser.
- Return values
-
The documentation for this class was generated from the following file:
- customfield/classes/category_controller.php