Documentation

ModuleAssignmentOverride
in package

Module Assignment Override Class

Module Assignment Overrides allow applying modules to specific students or sections within a course. When active overrides exist on a module, only students who have an applicable override can access the module and are assigned its items.

This is a data model class that represents a Module Assignment Override object. The actual API operations are available through the Module class:

  • Module::listOverrides()
  • Module::bulkUpdateOverrides()

Table of Contents

Properties

$contextModuleId  : int
The ID of the module the override applies to
$courseSection  : array<string|int, mixed>|null
The override's target section (present only if the override targets a section)
$group  : array<string|int, mixed>|null
The override's target group (present only if the override targets a group and Differentiation Tags are enabled)
$id  : int
The ID of the assignment override
$students  : array<string|int, mixed>|null
An array of the override's target students (present only if the override targets an adhoc set of students)
$title  : string
The title of the override

Methods

__construct()  : mixed
Constructor
getContextModuleId()  : int
getCourseSection()  : array<string|int, mixed>|null
getGroup()  : array<string|int, mixed>|null
getId()  : int
getStudents()  : array<string|int, mixed>|null
getTitle()  : string
setContextModuleId()  : void
setCourseSection()  : void
setGroup()  : void
setId()  : void
setStudents()  : void
setTitle()  : void

Properties

$courseSection

The override's target section (present only if the override targets a section)

public array<string|int, mixed>|null $courseSection

$group

The override's target group (present only if the override targets a group and Differentiation Tags are enabled)

public array<string|int, mixed>|null $group

$students

An array of the override's target students (present only if the override targets an adhoc set of students)

public array<string|int, mixed>|null $students

Methods

__construct()

Constructor

public __construct([array<string|int, mixed> $data = [] ]) : mixed
Parameters
$data : array<string|int, mixed> = []

getCourseSection()

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

getGroup()

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

getStudents()

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

setContextModuleId()

public setContextModuleId(int $contextModuleId) : void
Parameters
$contextModuleId : int

setCourseSection()

public setCourseSection(array<string|int, mixed>|null $courseSection) : void
Parameters
$courseSection : array<string|int, mixed>|null

setGroup()

public setGroup(array<string|int, mixed>|null $group) : void
Parameters
$group : array<string|int, mixed>|null

setStudents()

public setStudents(array<string|int, mixed>|null $students) : void
Parameters
$students : array<string|int, mixed>|null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results