1. class
  2. local_middag
  3. \
  4. extensions
  5. \
  6. customform
  7. \
  8. model
  9. \
  10. actions
  11. \
  12. base_action

base_action

abstract class base_action extends deprecated_item

Abstract base class for all custom form actions.

Traits

url_generator

Trait url_generator.

Constants

PERPAGE

STATUS_ACTIVE

STATUS_CANCELED

STATUS_COMPLETED

STATUS_DELETED

STATUS_DISABLED

STATUS_DISAPPROVED

STATUS_ENABLED

STATUS_EXPIRED

STATUS_FAILED

STATUS_FINISH

STATUS_INACTIVE

STATUS_INPROGRESS

STATUS_NEW

STATUS_PAUSED

STATUS_PLAYED

STATUS_SYNC

TYPE

Action type (must be defined in the child class).
PARAM_TYPE_FORMFIELD

PARAM_TYPE_DEFAULT

PARAM_TYPE_CUSTOM

ACTION_NAME

Properties

$id from  deprecated_item
$type from  deprecated_item
$timecreated from  deprecated_model
$timemodified from  deprecated_model
protected $table from  deprecated_item
protected $table_metadata from  deprecated_item
protected $fillable
$contextid from  deprecated_item
$courseid from  deprecated_item
$userid from  deprecated_item
mixed $parent
$fullname from  deprecated_item
string $shortname
$idnumber
$description from  deprecated_item
$descriptionformat from  deprecated_item
$status from  deprecated_item
$visible from  deprecated_item
$guid from  deprecated_item
$sortorder from  deprecated_item
$version from  deprecated_item
$usermodified from  deprecated_item
$nodes

Methods

static moodle_url
url_generator(string $route, array $parameters = [], int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH)

Generate a URL based on the Symfony route name and parameters.

from  url_generator
static moodle_url
webhook_url_generator(string $route, array $parameters = [], int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH)

Generate a webhook URL.

from  url_generator
__construct($id = null)

No description

__clone()

No description

from  deprecated_model
string|null
get_path()

No description

from  deprecated_model
string|null
get_table()

No description

from  deprecated_model
string
get_table_metadata()

No description

from  deprecated_model
deprecated_model_interface
update(array $formdata = [])

Update the model with form data.

from  deprecated_model
bool
delete()

No description

from  deprecated_model
array
all()

No description

from  deprecated_model
array
get_records(array $searchcriteria, int $page, int $totalcount, string $sort = '', int $perpage = 0)

No description

from  deprecated_model
array
get_items(array $searchcriteria, int $page, int $totalcount, string $sort = '', bool $includedeleted = false, int $perpage = 0)

No description

from  deprecated_model
mixed
get_meta(string $meta_key)

Get metadata value by key.

from  deprecated_model
array
get_all_metadata()

No description

from  deprecated_model
void
set_meta(string $meta_key, mixed $meta_value)

Set metadata key-value pair.

from  deprecated_model
void
set_metas(array $metas)

Set multiple metadata key-value pairs.

from  deprecated_model
mixed
get_file(object $context, string $component, string $filearea, bool $validimage = false)

Get file associated with the model.

from  deprecated_model
static mixed
get_fileurl(object $file)

Get file URL.

from  deprecated_model
false|mixed|stdClass
get($id)

Get record by ID.

from  deprecated_model
false|mixed|stdClass
get_by_idnumber($idnumber)

Get record by idnumber.

from  deprecated_model
save()

No description

from  deprecated_model
static deprecated_model
from_record(stdClass $r)

No description

from  deprecated_model
void
load(bool $reload = false)

No description

from  deprecated_item
bool
enabled()

No description

from  deprecated_item
bool
disabled()

No description

from  deprecated_item
bool
deleted()

No description

from  deprecated_item
static 
get_item_or_create(int|string|null $contextid, string $type = '')

No description

from  deprecated_item
array
get_items_by_metadata(array $searchcriteriaitem, array $searchcriteriameta, int $page, int $totalcount, string|null $sort = '', bool $includedeleted = false, int $perpage = 0) deprecated

No description

from  deprecated_item
string
get_icon()

Returns the representative icon of the action.

string
get_action_name()

Returns the name of the action.

base_action
create(mixed $action, mixed $form_id)

Creates an instance of the action with the provided data.

static 
update_action($action_data, $form_id)

No description

array
get_action_info()

Returns action information such as name, parameters, and return values.

static 
get_filed_value($value, array $submission, $form)

No description

bool|string
get_form_field_name(string $value, object $form)

Retrieves the form field name or its identifier based on the given value and form data.

mixed
execute(array $data)

Executes the action with the provided parameters.

static base_action|bool
get_field_by_shortname($shortname, $parent)

No description

static 
resolve_param_value($value, array $submission, $form)

No description

Details

in url_generator at line 42
static moodle_url url_generator(string $route, array $parameters = [], int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH)

Generate a URL based on the Symfony route name and parameters.

Parameters

string $route
array $parameters
int $referenceType

Return Value

moodle_url

in url_generator at line 56
static moodle_url webhook_url_generator(string $route, array $parameters = [], int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH)

Generate a webhook URL.

Parameters

string $route
array $parameters
int $referenceType

Return Value

moodle_url

at line 58
__construct($id = null)

No description

Parameters

$id

Exceptions

Exception

in deprecated_model at line 116
__clone()

No description

in deprecated_model at line 121
string|null get_path()

No description

Return Value

string|null

in deprecated_model at line 128
string|null get_table()

No description

Return Value

string|null

in deprecated_model at line 137
string get_table_metadata()

No description

Return Value

string

in deprecated_model at line 151
deprecated_model_interface update(array $formdata = [])

Update the model with form data.

Parameters

array $formdata

Return Value

deprecated_model_interface

in deprecated_model at line 165
bool delete()

No description

Return Value

bool

in deprecated_model at line 172
array all()

No description

Return Value

array

in deprecated_model at line 193
array get_records(array $searchcriteria, int $page, int $totalcount, string $sort = '', int $perpage = 0)

No description

Parameters

array $searchcriteria
int $page
int $totalcount

Output parameter
string $sort
int $perpage

Return Value

array

Exceptions

coding_exception
dml_exception

in deprecated_model at line 302
array get_items(array $searchcriteria, int $page, int $totalcount, string $sort = '', bool $includedeleted = false, int $perpage = 0)

No description

Parameters

array $searchcriteria
int $page
int $totalcount
string $sort
bool $includedeleted
int $perpage

Return Value

array

Exceptions

coding_exception
dml_exception

in deprecated_model at line 414
mixed get_meta(string $meta_key)

Get metadata value by key.

Parameters

string $meta_key

Return Value

mixed

Exceptions

dml_exception

in deprecated_model at line 428
array get_all_metadata()

No description

Return Value

array

in deprecated_model at line 456
void set_meta(string $meta_key, mixed $meta_value)

Set metadata key-value pair.

Parameters

string $meta_key
mixed $meta_value

Return Value

void

Exceptions

dml_exception

in deprecated_model at line 478
void set_metas(array $metas)

Set multiple metadata key-value pairs.

Parameters

array $metas

Return Value

void

in deprecated_model at line 497
mixed get_file(object $context, string $component, string $filearea, bool $validimage = false)

Get file associated with the model.

Parameters

object $context
string $component
string $filearea
bool $validimage

Return Value

mixed

Exceptions

coding_exception

in deprecated_model at line 523
static mixed get_fileurl(object $file)

Get file URL.

Parameters

object $file

Return Value

mixed

in deprecated_model at line 544
protected false|mixed|stdClass get($id)

Get record by ID.

Parameters

$id

Return Value

false|mixed|stdClass

Exceptions

dml_exception

in deprecated_model at line 560
protected false|mixed|stdClass get_by_idnumber($idnumber)

Get record by idnumber.

Parameters

$idnumber

Return Value

false|mixed|stdClass

Exceptions

dml_exception

in deprecated_model at line 575
protected save()

No description

in deprecated_model at line 616
static protected deprecated_model from_record(stdClass $r)

No description

Parameters

stdClass $r

Return Value

deprecated_model

in deprecated_item at line 105
void load(bool $reload = false)

No description

Parameters

bool $reload

Return Value

void

in deprecated_item at line 116
bool enabled()

No description

Return Value

bool

in deprecated_item at line 121
bool disabled()

No description

Return Value

bool

in deprecated_item at line 129
bool deleted()

No description

Return Value

bool

Exceptions

dml_exception

in deprecated_item at line 148
static get_item_or_create(int|string|null $contextid, string $type = '')

No description

Parameters

int|string|null $contextid
string $type

Exceptions

dml_exception

in deprecated_item at line 190
array get_items_by_metadata(array $searchcriteriaitem, array $searchcriteriameta, int $page, int $totalcount, string|null $sort = '', bool $includedeleted = false, int $perpage = 0) deprecated

deprecated Migrate to core\repository\item_search_repository

No description

Parameters

array $searchcriteriaitem
array $searchcriteriameta
int $page
int $totalcount
string|null $sort
bool $includedeleted
int $perpage

Return Value

array

Exceptions

coding_exception
dml_exception

at line 71
abstract string get_icon()

Returns the representative icon of the action.

Return Value

string

path or icon code

at line 78
abstract string get_action_name()

Returns the name of the action.

Return Value

string

action name

at line 89
base_action create(mixed $action, mixed $form_id)

Creates an instance of the action with the provided data.

Parameters

mixed $action
mixed $form_id

Return Value

base_action

the created action

at line 103
static update_action($action_data, $form_id)

No description

Parameters

$action_data
$form_id

at line 127
abstract array get_action_info()

Returns action information such as name, parameters, and return values.

Return Value

array

action details

at line 129
static get_filed_value($value, array $submission, $form)

No description

Parameters

$value
array $submission
$form

at line 152
bool|string get_form_field_name(string $value, object $form)

Retrieves the form field name or its identifier based on the given value and form data.

Parameters

string $value

the value to evaluate, which may include a prefix separated by a colon
object $form

the form object containing fields to search within

Return Value

bool|string

returns the field identifier string if found, otherwise returns false

at line 179
abstract mixed execute(array $data)

Executes the action with the provided parameters.

Parameters

array $data

Return Value

mixed

the result of the action, if any

at line 181
static protected base_action|bool get_field_by_shortname($shortname, $parent)

No description

Parameters

$shortname
$parent

Return Value

base_action|bool

at line 193
static protected resolve_param_value($value, array $submission, $form)

No description

Parameters

$value
array $submission
$form