Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
core_courseformat\formatactions Class Reference

Static Public Member Functions

static cm ($courseorid)
 Returns an instance of the actions class for the given course format.
 
static course ($courseorid)
 Returns an instance of the actions class for the given course format.
 
static instance (int|stdClass $courseorid)
 Get a course action loader instance.
 
static section ($courseorid)
 Returns an instance of the actions class for the given course format.
 

Public Attributes

cmactions cmactions $cm
 cmactions instance.
 
courseactions null courseactions $course
 courseactions instance.
 
sectionactions sectionactions $section
 sectionactions instance.
 

Protected Member Functions

 __construct (base $format)
 Returns an instance of the actions class for the given course format.
 

Constructor & Destructor Documentation

◆ __construct()

core_courseformat\formatactions::__construct ( base $format)
protected

Returns an instance of the actions class for the given course format.

Parameters
base$formatthe course format.

Member Function Documentation

◆ cm()

static core_courseformat\formatactions::cm ( $courseorid)
static

Returns an instance of the actions class for the given course format.

Parameters
int | stdClass$courseoridcourse id or record.
Return values
cmactions

◆ course()

static core_courseformat\formatactions::course ( $courseorid)
static

Returns an instance of the actions class for the given course format.

Parameters
int | stdClass$courseoridcourse id or record.
Return values
courseactions

◆ instance()

static core_courseformat\formatactions::instance ( int|stdClass $courseorid)
static

Get a course action loader instance.

Parameters
int | stdClass$courseoridcourse id or course.
Return values
self

◆ section()

static core_courseformat\formatactions::section ( $courseorid)
static

Returns an instance of the actions class for the given course format.

Parameters
int | stdClass$courseoridcourse id or record.
Return values
sectionactions

The documentation for this class was generated from the following file: