MIDDAG for Moodle

automessage_template extends deprecated_item

Legacy item deprecated_model class.

Table of Contents

Constants

FILEMANAGEROPTIONS_ATTACHMENT  = ['maxbytes' => 1024, 'subdirs' => 0, 'maxfiles' => 1, 'accepted_types' => '*']
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'
TRIGGER_EVENT  = 'event'
TRIGGER_EVENT_EACH  = 2
TRIGGER_EVENT_FIRST  = 1
TRIGGER_INTERVAL  = 'interval'
TRIGGER_INTERVAL_LIMIT_30_DAYS  = 30
TRIGGER_INTERVAL_LIMIT_60_DAYS  = 60
TRIGGER_INTERVAL_LIMIT_90_DAYS  = 90
TRIGGER_INTERVAL_LIMIT_EACH  = 2
TRIGGER_INTERVAL_LIMIT_FIRST  = 1
TRIGGER_INTERVAL_REPEAT_DAILY  = 1
TRIGGER_INTERVAL_REPEAT_WEEKLY  = 2
TRIGGER_INTERVAL_REPEAT_YEARLY  = 4
TRIGGER_MANUAL  = 'manual'
TRIGGER_RELATIVEDATE  = 'relativedate'
TRIGGER_RELATIVEDATE_AFTER_COURSE_ENDDATE  = 4
TRIGGER_RELATIVEDATE_AFTER_COURSE_STARTDATE  = 2
TRIGGER_RELATIVEDATE_AFTER_ENROL_ENDDATE  = 8
TRIGGER_RELATIVEDATE_AFTER_ENROL_STARTDATE  = 6
TRIGGER_RELATIVEDATE_BEFORE_COURSE_ENDDATE  = 3
TRIGGER_RELATIVEDATE_BEFORE_COURSE_STARTDATE  = 1
TRIGGER_RELATIVEDATE_BEFORE_ENROL_ENDDATE  = 7
TRIGGER_RELATIVEDATE_BEFORE_ENROL_STARTDATE  = 5
TRIGGER_RUNONCE  = 'runonce'
TYPE  = 'automessage_template'

Properties

$automessage_trigger  : mixed
$contextid  : mixed
$courseid  : mixed
$description  : mixed
$descriptionformat  : mixed
$filter  : mixed
$fullname  : mixed
$guid  : mixed
$id  : mixed
$idnumber  : mixed
$lasttrigger  : mixed
$nexttrigger  : mixed
$parent  : mixed
$sendtype  : array<string|int, string>
$shortname  : string
$sortorder  : mixed
$status  : mixed
$timecreated  : mixed
$timemodified  : mixed
$triggerconfig  : mixed
$triggerconfigevent  : mixed
$triggerconfigeventcontexts  : mixed
$triggerconfigeventcontextsjson  : mixed
$triggerconfigeventrepeat  : mixed
$triggerconfigintervaleach  : mixed
$triggerconfigintervalenddate  : mixed
$triggerconfigintervaljoinresults  : mixed
$triggerconfigintervallimit  : mixed
$triggerconfigintervalrepeat  : mixed
$triggerconfigintervalstartdate  : mixed
$triggerconfigrelativedatetype  : mixed
$triggerconfigrelativedatevalue  : mixed
$triggertype  : mixed
$type  : mixed
$userid  : mixed
$usermodified  : mixed
$version  : mixed
$visible  : int
$fillable  : mixed
$table  : mixed
$table_metadata  : mixed

Methods

__clone()  : mixed
__construct()  : mixed
Constructor.
all()  : array<string|int, mixed>
calculate_tolerance_trigger_relativedate()  : float|int
calculate_trigger_interval()  : mixed
check_context()  : bool
check_trigger_event()  : bool|null
clone()  : static
delete()  : bool
deleted()  : bool
disabled()  : bool
display_presend()  : mixed
display_sentype()  : string
display_status()  : mixed
display_trigger()  : mixed
display_trigger_event()  : string
display_trigger_interval_repeats()  : string
display_trigger_relativedate()  : string
enabled()  : bool
filter_trigger_relativedate()  : array<string|int, mixed>
get_all_metadata()  : array<string, mixed>
get_attachments()  : array<int, mixed>
get_automessage_trigger()  : mixed
get_content()  : array<string|int, mixed>
get_contexts_name_trigger_event()  : array<string|int, mixed>
get_contexts_trigger_event()  : array<string|int, context>
get_file()  : mixed
Get file associated with the model.
get_fileurl()  : mixed
Get file URL.
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_options_sendtype()  : mixed
get_options_status()  : array<string|int, mixed>|string
get_options_trigger()  : array<string|int, mixed>|string
get_options_trigger_event()  : array<string|int, mixed>|string
get_options_trigger_interval_limit()  : array<string|int, mixed>|string
get_options_trigger_interval_repeats()  : array<string|int, mixed>|string
get_options_trigger_relativedate()  : array<string|int, mixed>|string
get_path()  : string|null
get_records()  : array<string|int, deprecated_model_interface>
get_table()  : string|null
get_table_metadata()  : string
get_values_trigger_interval_repeats()  : array<string|int, mixed>|int
load()  : void
preview()  : array<string|int, mixed>
save_attachment()  : stdClass
sendtest()  : bool
set_automessage_trigger()  : void
set_meta()  : void
Set metadata key-value pair.
set_metas()  : void
Set multiple metadata key-value pairs.
set_trigger_interval()  : void
update()  : static
Update the model with form data.
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.
save()  : mixed

Constants

FILEMANAGEROPTIONS_ATTACHMENT

public mixed FILEMANAGEROPTIONS_ATTACHMENT = ['maxbytes' => 1024, 'subdirs' => 0, 'maxfiles' => 1, 'accepted_types' => '*']

TRIGGER_RELATIVEDATE_AFTER_COURSE_ENDDATE

public mixed TRIGGER_RELATIVEDATE_AFTER_COURSE_ENDDATE = 4

TRIGGER_RELATIVEDATE_AFTER_COURSE_STARTDATE

public mixed TRIGGER_RELATIVEDATE_AFTER_COURSE_STARTDATE = 2

TRIGGER_RELATIVEDATE_AFTER_ENROL_ENDDATE

public mixed TRIGGER_RELATIVEDATE_AFTER_ENROL_ENDDATE = 8

TRIGGER_RELATIVEDATE_AFTER_ENROL_STARTDATE

public mixed TRIGGER_RELATIVEDATE_AFTER_ENROL_STARTDATE = 6

TRIGGER_RELATIVEDATE_BEFORE_COURSE_ENDDATE

public mixed TRIGGER_RELATIVEDATE_BEFORE_COURSE_ENDDATE = 3

TRIGGER_RELATIVEDATE_BEFORE_COURSE_STARTDATE

public mixed TRIGGER_RELATIVEDATE_BEFORE_COURSE_STARTDATE = 1

TRIGGER_RELATIVEDATE_BEFORE_ENROL_ENDDATE

public mixed TRIGGER_RELATIVEDATE_BEFORE_ENROL_ENDDATE = 7

TRIGGER_RELATIVEDATE_BEFORE_ENROL_STARTDATE

public mixed TRIGGER_RELATIVEDATE_BEFORE_ENROL_STARTDATE = 5

Properties

$fillable

protected mixed $fillable = ['sendtype', 'filter', 'triggertype', 'triggerconfig', 'lasttrigger', 'nexttrigger', 'triggerconfigevent', 'triggerconfigeventrepeat', 'triggerconfigeventcontextsjson', 'triggerconfigintervalrepeat', 'triggerconfigintervaleach', 'triggerconfigintervalstartdate', 'triggerconfigintervalenddate', 'triggerconfigintervaljoinresults', 'triggerconfigintervallimit', 'triggerconfigrelativedatetype', 'triggerconfigrelativedatevalue', 'automessage_trigger']

Methods

__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>

calculate_tolerance_trigger_relativedate()

public calculate_tolerance_trigger_relativedate(mixed $value) : float|int
Parameters
$value : mixed
Return values
float|int

check_context()

public check_context(int $contextid) : bool
Parameters
$contextid : int
Return values
bool

deleted()

public deleted() : bool
Tags
throws
dml_exception
Return values
bool

display_trigger_interval_repeats()

public display_trigger_interval_repeats() : string
Return values
string

display_trigger_relativedate()

public display_trigger_relativedate() : string
Return values
string

filter_trigger_relativedate()

public filter_trigger_relativedate(mixed $userids) : array<string|int, mixed>
Parameters
$userids : mixed
Return values
array<string|int, mixed>

get_all_metadata()

public get_all_metadata() : array<string, mixed>
Return values
array<string, mixed>

get_attachments()

public get_attachments() : array<int, mixed>
Return values
array<int, mixed>

get_content()

public get_content(mixed $userid[, mixed $courseid = null ]) : array<string|int, mixed>
Parameters
$userid : mixed
$courseid : mixed = null
Return values
array<string|int, mixed>

get_contexts_name_trigger_event()

public get_contexts_name_trigger_event() : array<string|int, mixed>
Tags
throws
coding_exception
Return values
array<string|int, 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
throws
coding_exception

get_fileurl()

Get file URL.

public static get_fileurl(mixed $file) : mixed
Parameters
$file : mixed

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
throws
dml_exception
Return values
deprecated_item

get_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
throws
coding_exception
throws
dml_exception
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
throws
coding_exception
throws
dml_exception
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
throws
dml_exception

get_options_sendtype()

public static get_options_sendtype([mixed $option = false ]) : mixed
Parameters
$option : mixed = false

get_options_status()

public static get_options_status([mixed $status = false ]) : array<string|int, mixed>|string
Parameters
$status : mixed = false
Return values
array<string|int, mixed>|string

get_options_trigger()

public static get_options_trigger([mixed $trigger = false ]) : array<string|int, mixed>|string
Parameters
$trigger : mixed = false
Return values
array<string|int, mixed>|string

get_options_trigger_event()

public static get_options_trigger_event([mixed $option = false ]) : array<string|int, mixed>|string
Parameters
$option : mixed = false
Return values
array<string|int, mixed>|string

get_options_trigger_interval_limit()

public static get_options_trigger_interval_limit([mixed $option = false ]) : array<string|int, mixed>|string
Parameters
$option : mixed = false
Return values
array<string|int, mixed>|string

get_options_trigger_interval_repeats()

public static get_options_trigger_interval_repeats([mixed $option = false ]) : array<string|int, mixed>|string
Parameters
$option : mixed = false
Return values
array<string|int, mixed>|string

get_options_trigger_relativedate()

public static get_options_trigger_relativedate([mixed $option = false ]) : array<string|int, mixed>|string
Parameters
$option : mixed = false
Return values
array<string|int, mixed>|string

get_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
throws
coding_exception
throws
dml_exception
Return values
array<string|int, deprecated_model_interface>

get_table_metadata()

public get_table_metadata() : string
Return values
string

get_values_trigger_interval_repeats()

public static get_values_trigger_interval_repeats([mixed $option = false ]) : array<string|int, mixed>|int
Parameters
$option : mixed = false
Return values
array<string|int, mixed>|int

load()

public load([mixed $reload = false ]) : void
Parameters
$reload : mixed = false

preview()

public preview() : array<string|int, mixed>
Return values
array<string|int, mixed>

save_attachment()

public save_attachment(mixed $attachment) : stdClass
Parameters
$attachment : mixed
Return values
stdClass

set_automessage_trigger()

public set_automessage_trigger(mixed $id) : void
Parameters
$id : mixed

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
throws
dml_exception

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([mixed $formdata = [] ]) : static
Parameters
$formdata : mixed = []
Return values
static

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_url

webhook_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_url

from_record()

protected static from_record(stdClass $r) : static
Parameters
$r : stdClass
Return values
static

get()

Get record by ID.

protected get(mixed $id) : false|mixed|stdClass
Parameters
$id : mixed
Tags
throws
dml_exception
Return values
false|mixed|stdClass

get_by_idnumber()

Get record by idnumber.

protected get_by_idnumber(mixed $idnumber) : false|mixed|stdClass
Parameters
$idnumber : mixed
Tags
throws
dml_exception
Return values
false|mixed|stdClass

        
On this page

Search results