enrol_user_action extends base_action
Abstract base class for all custom form actions.
Table of Contents
Constants
- ACTION_NAME = 'enrolUser'
- PARAM_TYPE_CUSTOM = 'custom'
- PARAM_TYPE_DEFAULT = 'default'
- PARAM_TYPE_FORMFIELD = 'formField'
- PERPAGE = 50
- STATUS_ACTIVE = 'active'
- STATUS_CANCELED = 'canceled'
- STATUS_COMPLETED = 'completed'
- STATUS_DELETED = 'deleted'
- STATUS_DISABLED = 'disabled'
- STATUS_DISAPPROVED = 'disapproved'
- STATUS_ENABLED = 'enabled'
- STATUS_EXPIRED = 'expired'
- STATUS_FAILED = 'failed'
- STATUS_FINISH = 'finish'
- STATUS_INACTIVE = 'inactive'
- STATUS_INPROGRESS = 'inprogress'
- STATUS_NEW = 'new'
- STATUS_PAUSED = 'paused'
- STATUS_PLAYED = 'played'
- STATUS_SYNC = 'sync'
- TYPE = 'customform_enrol_user_action'
- Action type (must be defined in the child class).
Properties
- $contextid : mixed
- $courseid : mixed
- $description : mixed
- $descriptionformat : mixed
- $fullname : mixed
- $guid : mixed
- $id : mixed
- $idnumber : mixed
- $nodes : mixed
- $parent : mixed
- $shortname : string
- $sortorder : mixed
- $status : mixed
- $timecreated : mixed
- $timemodified : mixed
- $type : mixed
- $userid : mixed
- $usermodified : mixed
- $version : mixed
- $visible : mixed
- $fillable : mixed
- $table : mixed
- $table_metadata : mixed
Methods
- __clone() : mixed
- __construct() : mixed
- Constructor.
- all() : array<string|int, mixed>
- create() : base_action
- Creates an instance of the action with the provided data.
- delete() : bool
- deleted() : bool
- disabled() : bool
- enabled() : bool
- execute() : mixed
- Executes the action with the provided parameters.
- get_action_info() : array<string|int, mixed>
- Returns action information such as name, parameters, and return values.
- get_action_name() : string
- Returns the name of the action.
- get_all_metadata() : array<string, mixed>
- get_file() : mixed
- Get file associated with the model.
- get_filed_value() : mixed
- get_fileurl() : mixed
- Get file URL.
- get_form_field_name() : bool|string
- Retrieves the form field name or its identifier based on the given value and form data.
- get_icon() : string
- Returns the representative icon of the action.
- get_item_or_create() : deprecated_item
- Factory method to get existing or create a new item.
- get_items() : array<string|int, deprecated_item>
- get_items_by_metadata() : array<string|int, mixed>
- get_meta() : mixed
- Get metadata value by key.
- get_path() : string|null
- get_records() : array<string|int, deprecated_model_interface>
- get_table() : string|null
- get_table_metadata() : string
- load() : void
- set_meta() : void
- Set metadata key-value pair.
- set_metas() : void
- Set multiple metadata key-value pairs.
- update() : static
- Update the model with form data.
- update_action() : mixed
- url_generator() : moodle_url
- Generate a URL based on the Symfony route name and parameters.
- webhook_url_generator() : moodle_url
- Generate a webhook URL.
- from_record() : static
- get() : false|mixed|stdClass
- Get record by ID.
- get_by_idnumber() : false|mixed|stdClass
- Get record by idnumber.
- get_field_by_shortname() : base_action|bool
- resolve_param_value() : mixed
- save() : mixed
Constants
ACTION_NAME
public
mixed
ACTION_NAME
= 'enrolUser'
PARAM_TYPE_CUSTOM
public
mixed
PARAM_TYPE_CUSTOM
= 'custom'
PARAM_TYPE_DEFAULT
public
mixed
PARAM_TYPE_DEFAULT
= 'default'
PARAM_TYPE_FORMFIELD
public
mixed
PARAM_TYPE_FORMFIELD
= 'formField'
PERPAGE
public
mixed
PERPAGE
= 50
STATUS_ACTIVE
public
mixed
STATUS_ACTIVE
= 'active'
STATUS_CANCELED
public
mixed
STATUS_CANCELED
= 'canceled'
STATUS_COMPLETED
public
mixed
STATUS_COMPLETED
= 'completed'
STATUS_DELETED
public
mixed
STATUS_DELETED
= 'deleted'
STATUS_DISABLED
public
mixed
STATUS_DISABLED
= 'disabled'
STATUS_DISAPPROVED
public
mixed
STATUS_DISAPPROVED
= 'disapproved'
STATUS_ENABLED
public
mixed
STATUS_ENABLED
= 'enabled'
STATUS_EXPIRED
public
mixed
STATUS_EXPIRED
= 'expired'
STATUS_FAILED
public
mixed
STATUS_FAILED
= 'failed'
STATUS_FINISH
public
mixed
STATUS_FINISH
= 'finish'
STATUS_INACTIVE
public
mixed
STATUS_INACTIVE
= 'inactive'
STATUS_INPROGRESS
public
mixed
STATUS_INPROGRESS
= 'inprogress'
STATUS_NEW
public
mixed
STATUS_NEW
= 'new'
STATUS_PAUSED
public
mixed
STATUS_PAUSED
= 'paused'
STATUS_PLAYED
public
mixed
STATUS_PLAYED
= 'played'
STATUS_SYNC
public
mixed
STATUS_SYNC
= 'sync'
TYPE
Action type (must be defined in the child class).
public
mixed
TYPE
= 'customform_enrol_user_action'
Properties
$contextid
public
mixed
$contextid
$courseid
public
mixed
$courseid
$description
public
mixed
$description
$descriptionformat
public
mixed
$descriptionformat
= 0
$fullname
public
mixed
$fullname
$guid
public
mixed
$guid
$id
public
mixed
$id
$idnumber
public
mixed
$idnumber
$nodes
public
mixed
$nodes
$parent
public
mixed
$parent
$shortname
public
string
$shortname
$sortorder
public
mixed
$sortorder
= 0
$status
public
mixed
$status
= ''
$timecreated
public
mixed
$timecreated
= 0
$timemodified
public
mixed
$timemodified
= 0
$type
public
mixed
$type
$userid
public
mixed
$userid
$usermodified
public
mixed
$usermodified
$version
public
mixed
$version
$visible
public
mixed
$visible
= 1
$fillable
protected
mixed
$fillable
= ['nodes']
$table
protected
mixed
$table
= 'middag_items'
$table_metadata
protected
mixed
$table_metadata
= 'middag_itemmeta'
Methods
__clone()
public
__clone() : mixed
__construct()
Constructor.
public
__construct([mixed $id = null ]) : mixed
Parameters
- $id : mixed = null
all()
public
all() : array<string|int, mixed>
Return values
array<string|int, mixed>create()
Creates an instance of the action with the provided data.
public
create(mixed $action, mixed $form_id) : base_action
Parameters
- $action : mixed
- $form_id : mixed
Return values
base_action —the created action
delete()
public
delete() : bool
Return values
booldeleted()
public
deleted() : bool
Tags
Return values
booldisabled()
public
disabled() : bool
Return values
boolenabled()
public
enabled() : bool
Return values
boolexecute()
Executes the action with the provided parameters.
public
execute(array<string|int, mixed> $data) : mixed
Parameters
- $data : array<string|int, mixed>
Return values
mixed —the result of the action, if any
get_action_info()
Returns action information such as name, parameters, and return values.
public
get_action_info() : array<string|int, mixed>
Return values
array<string|int, mixed> —action details
get_action_name()
Returns the name of the action.
public
get_action_name() : string
Return values
string —action name
get_all_metadata()
public
get_all_metadata() : array<string, mixed>
Return values
array<string, mixed>get_file()
Get file associated with the model.
public
get_file(mixed $context, mixed $component, mixed $filearea[, mixed $validimage = false ]) : mixed
Parameters
- $context : mixed
- $component : mixed
- $filearea : mixed
- $validimage : mixed = false
Tags
get_filed_value()
public
static get_filed_value(mixed $value, array<string|int, mixed> $submission, mixed $form) : mixed
Parameters
- $value : mixed
- $submission : array<string|int, mixed>
- $form : mixed
get_fileurl()
Get file URL.
public
static get_fileurl(mixed $file) : mixed
Parameters
- $file : mixed
get_form_field_name()
Retrieves the form field name or its identifier based on the given value and form data.
public
get_form_field_name(string $value, object $form) : bool|string
Parameters
- $value : string
-
the value to evaluate, which may include a prefix separated by a colon
- $form : object
-
the form object containing fields to search within
Return values
bool|string —returns the field identifier string if found, otherwise returns false
get_icon()
Returns the representative icon of the action.
public
get_icon() : string
Return values
string —path or icon code
get_item_or_create()
Factory method to get existing or create a new item.
public
static get_item_or_create(null|int|string $contextid[, string $type = '' ]) : deprecated_item
Parameters
- $contextid : null|int|string
- $type : string = ''
Tags
Return values
deprecated_itemget_items()
public
get_items(mixed $searchcriteria, mixed $page, mixed &$totalcount[, mixed $sort = '' ][, mixed $includedeleted = false ][, mixed $perpage = 0 ]) : array<string|int, deprecated_item>
Parameters
- $searchcriteria : mixed
- $page : mixed
- $totalcount : mixed
- $sort : mixed = ''
- $includedeleted : mixed = false
- $perpage : mixed = 0
Tags
Return values
array<string|int, deprecated_item>get_items_by_metadata()
public
get_items_by_metadata(array<string|int, mixed> $searchcriteriaitem, array<string|int, mixed> $searchcriteriameta, int $page, int &$totalcount[, null|string $sort = '' ][, bool $includedeleted = false ][, int $perpage = 0 ]) : array<string|int, mixed>
Migrate to core\repository\item_search_repository
Parameters
- $searchcriteriaitem : array<string|int, mixed>
- $searchcriteriameta : array<string|int, mixed>
- $page : int
- $totalcount : int
- $sort : null|string = ''
- $includedeleted : bool = false
- $perpage : int = 0
Tags
Return values
array<string|int, mixed>get_meta()
Get metadata value by key.
public
get_meta(mixed $meta_key) : mixed
Parameters
- $meta_key : mixed
Tags
get_path()
public
get_path() : string|null
Return values
string|nullget_records()
public
get_records(mixed $searchcriteria, mixed $page, mixed &$totalcount[, mixed $sort = '' ][, mixed $perpage = 0 ]) : array<string|int, deprecated_model_interface>
Parameters
- $searchcriteria : mixed
- $page : mixed
- $totalcount : mixed
- $sort : mixed = ''
- $perpage : mixed = 0
Tags
Return values
array<string|int, deprecated_model_interface>get_table()
public
get_table() : string|null
Return values
string|nullget_table_metadata()
public
get_table_metadata() : string
Return values
stringload()
public
load([mixed $reload = false ]) : void
Parameters
- $reload : mixed = false
set_meta()
Set metadata key-value pair.
public
set_meta(mixed $meta_key, mixed $meta_value) : void
Parameters
- $meta_key : mixed
- $meta_value : mixed
Tags
set_metas()
Set multiple metadata key-value pairs.
public
set_metas(array<string, mixed> $metas) : void
Parameters
- $metas : array<string, mixed>
update()
Update the model with form data.
public
update([array<string, mixed> $formdata = [] ]) : static
Parameters
- $formdata : array<string, mixed> = []
Return values
staticupdate_action()
public
static update_action(mixed $action_data, mixed $form_id) : mixed
Parameters
- $action_data : mixed
- $form_id : mixed
url_generator()
Generate a URL based on the Symfony route name and parameters.
public
static url_generator(string $route[, array<string|int, mixed> $parameters = [] ][, int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH ]) : moodle_url
Parameters
- $route : string
- $parameters : array<string|int, mixed> = []
- $referenceType : int = UrlGeneratorInterface::ABSOLUTE_PATH
Return values
moodle_urlwebhook_url_generator()
Generate a webhook URL.
public
static webhook_url_generator(string $route[, array<string|int, mixed> $parameters = [] ][, int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH ]) : moodle_url
Parameters
- $route : string
- $parameters : array<string|int, mixed> = []
- $referenceType : int = UrlGeneratorInterface::ABSOLUTE_PATH
Return values
moodle_urlfrom_record()
protected
static from_record(stdClass $r) : static
Parameters
- $r : stdClass
Return values
staticget()
Get record by ID.
protected
get(mixed $id) : false|mixed|stdClass
Parameters
- $id : mixed
Tags
Return values
false|mixed|stdClassget_by_idnumber()
Get record by idnumber.
protected
get_by_idnumber(mixed $idnumber) : false|mixed|stdClass
Parameters
- $idnumber : mixed
Tags
Return values
false|mixed|stdClassget_field_by_shortname()
protected
static get_field_by_shortname(mixed $shortname, mixed $parent) : base_action|bool
Parameters
- $shortname : mixed
- $parent : mixed
Return values
base_action|boolresolve_param_value()
protected
static resolve_param_value(mixed $value, array<string|int, mixed> $submission, mixed $form) : mixed
Parameters
- $value : mixed
- $submission : array<string|int, mixed>
- $form : mixed
save()
protected
save() : mixed