CourseNickname
in package
Course Nickname object
Represents a user's custom nickname for a course in Canvas LMS. Users can set custom names for courses to help them organize and identify courses.
Table of Contents
Properties
- $courseId : int
- $courseName : string|null
- $name : string
Methods
- __construct() : mixed
- Constructor
- getDisplayName() : string
- Get display name (nickname or original name)
- getOriginalName() : string|null
- Get original course name
- isCustomized() : bool
- Check if nickname is different from original course name
- toArray() : array<string, mixed>
- Convert to array
Properties
$courseId
public
int
$courseId
Course ID
$courseName
public
string|null
$courseName
= null
The course's original name
$name
public
string
$name
The user's custom nickname for the course
Methods
__construct()
Constructor
public
__construct([array<string, mixed> $data = [] ]) : mixed
Parameters
- $data : array<string, mixed> = []
getDisplayName()
Get display name (nickname or original name)
public
getDisplayName() : string
Return values
stringgetOriginalName()
Get original course name
public
getOriginalName() : string|null
Return values
string|nullisCustomized()
Check if nickname is different from original course name
public
isCustomized() : bool
Return values
booltoArray()
Convert to array
public
toArray() : array<string, mixed>