Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
core_courseformat\local\baseactions Class Reference
Inheritance diagram for core_courseformat\local\baseactions:
core_courseformat\local\cmactions core_courseformat\local\courseactions core_courseformat\local\sectionactions

Public Member Functions

 __construct (stdClass $course)
 Constructor.
 

Protected Member Functions

 get_cm_info ($cmid)
 Get the cm info.
 
 get_course ()
 Get the course.
 
 get_format ()
 Get the course format.
 
 get_section_info ($sectionid, int $strictness=IGNORE_MISSING)
 Get the section info.
 

Protected Attributes

stdClass stdClass $course
 the course object.
 

Constructor & Destructor Documentation

◆ __construct()

core_courseformat\local\baseactions::__construct ( stdClass $course)

Constructor.

Parameters
stdClass$coursethe course object.

Member Function Documentation

◆ get_cm_info()

core_courseformat\local\baseactions::get_cm_info ( $cmid)
protected

Get the cm info.

Parameters
int$cmidthe cm id.
Return values
cm_info|nullInformation for numbered cm or null if not found

◆ get_course()

core_courseformat\local\baseactions::get_course ( )
protected

Get the course.

Return values
stdClassthe course object.

◆ get_format()

core_courseformat\local\baseactions::get_format ( )
protected

Get the course format.

Return values
course_formatthe course format.

◆ get_section_info()

core_courseformat\local\baseactions::get_section_info ( $sectionid,
int $strictness = IGNORE_MISSING )
protected

Get the section info.

Parameters
int$sectionidthe section id.
int$strictnessUse MUST_EXIST to throw exception if it doesn't
Return values
section_info|nullInformation for numbered section or null if not found

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