class automessage_template extends deprecated_item

Traits

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

FILEMANAGEROPTIONS_ATTACHMENT

TRIGGER_EVENT

TRIGGER_INTERVAL

TRIGGER_RUNONCE

TRIGGER_MANUAL

TRIGGER_RELATIVEDATE

TRIGGER_EVENT_FIRST

TRIGGER_EVENT_EACH

TRIGGER_INTERVAL_REPEAT_DAILY

TRIGGER_INTERVAL_REPEAT_WEEKLY

TRIGGER_INTERVAL_REPEAT_YEARLY

TRIGGER_INTERVAL_LIMIT_FIRST

TRIGGER_INTERVAL_LIMIT_EACH

TRIGGER_INTERVAL_LIMIT_30_DAYS

TRIGGER_INTERVAL_LIMIT_60_DAYS

TRIGGER_INTERVAL_LIMIT_90_DAYS

TRIGGER_RELATIVEDATE_BEFORE_COURSE_STARTDATE

TRIGGER_RELATIVEDATE_AFTER_COURSE_STARTDATE

TRIGGER_RELATIVEDATE_BEFORE_COURSE_ENDDATE

TRIGGER_RELATIVEDATE_AFTER_COURSE_ENDDATE

TRIGGER_RELATIVEDATE_BEFORE_ENROL_STARTDATE

TRIGGER_RELATIVEDATE_AFTER_ENROL_STARTDATE

TRIGGER_RELATIVEDATE_BEFORE_ENROL_ENDDATE

TRIGGER_RELATIVEDATE_AFTER_ENROL_ENDDATE

Properties

$id
$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
$parent from  deprecated_item
$fullname
string $shortname
$idnumber from  deprecated_item
$description
$descriptionformat from  deprecated_item
$status
int $visible
$guid from  deprecated_item
$sortorder from  deprecated_item
$version from  deprecated_item
$usermodified from  deprecated_item
string[] $sendtype
$filter
$triggertype
$triggerconfig
$lasttrigger
$nexttrigger
$triggerconfigevent
$triggerconfigeventrepeat
$triggerconfigeventcontexts
$triggerconfigeventcontextsjson
$triggerconfigintervalrepeat
$triggerconfigintervaljoinresults
$triggerconfigintervaleach
$triggerconfigintervalstartdate
$triggerconfigintervalenddate
$triggerconfigintervallimit
$triggerconfigrelativedatetype
$triggerconfigrelativedatevalue
$automessage_trigger

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.

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

Generate a webhook URL.

__construct($id = null)

No description

__clone()

No description

string|null
get_path()

No description

string|null
get_table()

No description

string
get_table_metadata()

No description

update(array $formdata = [])

Update the model with form data.

bool
delete()

No description

array
all()

No description

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

No description

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

No description

mixed
get_meta(string $meta_key)

Get metadata value by key.

array
get_all_metadata()

No description

void
set_meta(string $meta_key, mixed $meta_value)

Set metadata key-value pair.

void
set_metas(array $metas)

Set multiple metadata key-value pairs.

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

Get file associated with the model.

static mixed
get_fileurl(object $file)

Get file URL.

false|mixed|stdClass
get($id)

Get record by ID.

false|mixed|stdClass
get_by_idnumber($idnumber)

Get record by idnumber.

save()

No description

from_record(stdClass $r)

No description

void
load(bool $reload = false)

No description

bool
enabled()

No description

bool
disabled()

No description

bool
deleted()

No description

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

No description

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

array
preview()

No description

array
get_content($userid, $courseid = null)

No description

display_presend()

No description

bool
sendtest()

No description

static array|string
get_options_status($status = false)

No description

display_status()

No description

static array|string
get_options_trigger($trigger = false)

No description

display_trigger()

No description

static array|string
get_options_trigger_event($option = false)

No description

string
display_trigger_event()

No description

bool|null
check_trigger_event()

No description

bool
check_context(int $contextid)

No description

array
get_contexts_trigger_event()

No description

array
static array|string
get_options_trigger_interval_repeats($option = false)

No description

static array|int
get_values_trigger_interval_repeats($option = false)

No description

static array|string
get_options_trigger_interval_limit($option = false)

No description

void
set_trigger_interval()

No description

calculate_trigger_interval()

No description

string
static array|string
get_options_trigger_relativedate($option = false)

No description

string
display_trigger_relativedate()

No description

array
filter_trigger_relativedate(mixed $userids)

No description

float|int
static 
get_options_sendtype($option = false)

No description

string
display_sentype()

No description

array
get_attachments()

No description

save_attachment($attachment)

No description

clone()

No description

void
set_automessage_trigger($id)

No description

get_automessage_trigger()

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

at line 179
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 255
array preview()

No description

Return Value

array

at line 280
array get_content($userid, $courseid = null)

No description

Parameters

$userid
$courseid

Return Value

array

at line 314
display_presend()

No description

at line 333
bool sendtest()

No description

Return Value

bool

at line 354
static array|string get_options_status($status = false)

No description

Parameters

$status

Return Value

array|string

at line 371
display_status()

No description

at line 385
static array|string get_options_trigger($trigger = false)

No description

Parameters

$trigger

Return Value

array|string

at line 402
display_trigger()

No description

at line 412
static array|string get_options_trigger_event($option = false)

No description

Parameters

$option

Return Value

array|string

at line 426
string display_trigger_event()

No description

Return Value

string

at line 461
bool|null check_trigger_event()

No description

Return Value

bool|null

at line 474
bool check_context(int $contextid)

No description

Parameters

int $contextid

Return Value

bool

at line 496
array get_contexts_trigger_event()

No description

Return Value

array

at line 520
array get_contexts_name_trigger_event()

No description

Return Value

array

Exceptions

coding_exception

at line 532
static array|string get_options_trigger_interval_repeats($option = false)

No description

Parameters

$option

Return Value

array|string

at line 547
static array|int get_values_trigger_interval_repeats($option = false)

No description

Parameters

$option

Return Value

array|int

at line 562
static array|string get_options_trigger_interval_limit($option = false)

No description

Parameters

$option

Return Value

array|string

at line 579
void set_trigger_interval()

No description

Return Value

void

at line 590
calculate_trigger_interval()

No description

at line 613
string display_trigger_interval_repeats()

No description

Return Value

string

at line 659
static array|string get_options_trigger_relativedate($option = false)

No description

Parameters

$option

Return Value

array|string

at line 679
string display_trigger_relativedate()

No description

Return Value

string

at line 708
array filter_trigger_relativedate(mixed $userids)

No description

Parameters

mixed $userids

Return Value

array

at line 802
float|int calculate_tolerance_trigger_relativedate($value)

No description

Parameters

$value

Return Value

float|int

at line 821
static get_options_sendtype($option = false)

No description

Parameters

$option

at line 848
string display_sentype()

No description

Return Value

string

at line 865
array get_attachments()

No description

Return Value

array

at line 889
stdClass save_attachment($attachment)

No description

Parameters

$attachment

Return Value

stdClass

at line 901
automessage_template clone()

No description

Return Value

automessage_template

at line 921
void set_automessage_trigger($id)

No description

Parameters

$id

Return Value

void

at line 926
get_automessage_trigger()

No description