Class CourseController

Controller responsible for handling all course-related HTTP requests. Provides endpoints for course management, student enrollment, and grade operations.

Index

Constructors

constructor

Methods

addStudentGrade createCourse deleteStudentGrade destroyCourse editStudentGrade enrollStudent findCoursesByStudent findCoursesByTeacher getCourse getStudentsForCourse submitGrades

Constructors

constructor

new CourseController(courseService: CourseService): CourseController
Creates an instance of CourseController.
Parameters
- courseService: CourseService
  Service for handling course-related business logic
Returns CourseController
- Defined in course/course.controller.ts:163

Methods

addStudentGrade

addStudentGrade(
req: any,
addStudentGradeDto: AddStudentGradeDto,
): Promise<{ date: Date; grade: number; id: number }>
Adds a grade for a student in a course. Only accessible to users with Teacher role. Protected by JWT authentication.
Parameters
- req: any
  The HTTP request containing the authenticated user (teacher)
- addStudentGradeDto: AddStudentGradeDto
  Contains course ID, student email, and grade value
Returns Promise<{ date: Date; grade: number; id: number }>
The newly created grade object
- Defined in course/course.controller.ts:289

createCourse

createCourse(createCourseDto: CreateCourseDto): Promise<Course>
Creates a new course. Only accessible to users with Teacher role.
Parameters
- createCourseDto: CreateCourseDto
  Contains course title, description, and teacher email
Returns Promise<Course>
The newly created course entity
- Defined in course/course.controller.ts:177

deleteStudentGrade

deleteStudentGrade(req: any, dto: DeleteStudentGradeDto): Promise<boolean>
Deletes (soft delete) an existing grade for a student. Only accessible to users with Teacher role who own the course. Protected by JWT authentication.
Parameters
- req: any
  The HTTP request containing the authenticated user (teacher)
- dto: DeleteStudentGradeDto
  Contains the grade ID to delete
Returns Promise<boolean>
A boolean indicating success
- Defined in course/course.controller.ts:330

destroyCourse

destroyCourse(destroyCourseDto: DestroyCourseDto): Promise<{ message: string }>
Deletes an existing course. Only accessible to users with Teacher role who own the course.
Parameters
- destroyCourseDto: DestroyCourseDto
  Contains course title and teacher email
Returns Promise<{ message: string }>
A success message upon successful deletion
- Defined in course/course.controller.ts:195

editStudentGrade

editStudentGrade(req: any, dto: EditStudentGradeDto): Promise<boolean>
Edits an existing grade for a student. Only accessible to users with Teacher role who own the course. Protected by JWT authentication.
Parameters
- req: any
  The HTTP request containing the authenticated user (teacher)
- dto: EditStudentGradeDto
  Contains grade ID and the new grade value
Returns Promise<boolean>
A boolean indicating success
- Defined in course/course.controller.ts:310

enrollStudent

enrollStudent(enrollStudentDto: EnrollStudentDto): Promise<{ message: string }>
Enrolls a student in a course. Only accessible to users with Teacher role.
Parameters
- enrollStudentDto: EnrollStudentDto
  Contains course title, student email, and teacher email
Returns Promise<{ message: string }>
A success message upon successful enrollment
- Defined in course/course.controller.ts:212

findCoursesByStudent

findCoursesByStudent(
    findCoursesByStudentDto: FindCoursesByStudentDto,
): Promise<
    {
        description: string;
        grades: { date: Date; grade: number; id: number }[];
        id: number;
        students: StudentCourse[];
        teacher: {
            email: string;
            firstName: string;
            image: string;
            lastName: string;
            role: UserRole;
        };
        title: string;
    }[],
>
Retrieves all courses in which a specific student is enrolled. Protected by JWT authentication.
Parameters
- findCoursesByStudentDto: FindCoursesByStudentDto
  Contains the student's email
Returns Promise<
    {
        description: string;
        grades: { date: Date; grade: number; id: number }[];
        id: number;
        students: StudentCourse[];
        teacher: {
            email: string;
            firstName: string;
            image: string;
            lastName: string;
            role: UserRole;
        };
        title: string;
    }[],
>
An array of courses in which the student is enrolled
- Defined in course/course.controller.ts:242

findCoursesByTeacher

findCoursesByTeacher(
    findCoursesByTeacherDto: FindCoursesByTeacherDto,
): Promise<
    {
        description: string;
        id: number;
        students: {
            email: string;
            firstName: string;
            image: string;
            lastName: string;
            role: UserRole;
        }[];
        teacher: {
            email: string;
            firstName: string;
            image: string;
            lastName: string;
            role: UserRole;
        };
        title: string;
    }[],
>
Retrieves all courses taught by a specific teacher. Protected by JWT authentication.
Parameters
- findCoursesByTeacherDto: FindCoursesByTeacherDto
  Contains the teacher's email
Returns Promise<
    {
        description: string;
        id: number;
        students: {
            email: string;
            firstName: string;
            image: string;
            lastName: string;
            role: UserRole;
        }[];
        teacher: {
            email: string;
            firstName: string;
            image: string;
            lastName: string;
            role: UserRole;
        };
        title: string;
    }[],
>
An array of courses taught by the specified teacher
- Defined in course/course.controller.ts:229

getCourse

getCourse(
    req: any,
    id: number,
): Promise<
    {
        description: string;
        grades: undefined
        | StudentCourseGrade[];
        id: number;
        students:
            | undefined
            | {
                email: string;
                firstName: string;
                grades: { date: Date; grade: number; id: number }[];
                image: string;
                lastName: string;
                role: UserRole;
            }[];
        teacher: {
            email: string;
            firstName: string;
            image: string;
            lastName: string;
            role: UserRole;
        };
        title: string;
    },
>
Retrieves detailed information about a specific course. Access control is handled in the service based on the user's role. Protected by JWT authentication.
Parameters
- req: any
  The HTTP request containing the authenticated user
- id: number
  The ID of the course to retrieve
Returns Promise<
    {
        description: string;
        grades: undefined
        | StudentCourseGrade[];
        id: number;
        students:
            | undefined
            | {
                email: string;
                firstName: string;
                grades: { date: Date; grade: number; id: number }[];
                image: string;
                lastName: string;
                role: UserRole;
            }[];
        teacher: {
            email: string;
            firstName: string;
            image: string;
            lastName: string;
            role: UserRole;
        };
        title: string;
    },
>
Detailed information about the course, including teacher info and conditionally students/grades
- Defined in course/course.controller.ts:270

getStudentsForCourse

getStudentsForCourse(
    getStudentsForCourseDto: GetStudentsForCourseDto,
): Promise<
    {
        email: string;
        firstName: string;
        image: string;
        lastName: string;
        role: UserRole;
    }[],
>
Retrieves the list of students enrolled in a specific course. Protected by JWT authentication.
Parameters
- getStudentsForCourseDto: GetStudentsForCourseDto
  Contains the course title
Returns Promise<
    {
        email: string;
        firstName: string;
        image: string;
        lastName: string;
        role: UserRole;
    }[],
>
An array of students enrolled in the specified course
- Defined in course/course.controller.ts:255

submitGrades

submitGrades(
req: any,
submitGradesDto: SubmitGradesDto,
): Promise<{ message: string }>
Submits multiple grades for students in a course at once. Only accessible to users with Teacher role who own the course. Protected by JWT authentication.
Parameters
- req: any
  The HTTP request containing the authenticated user (teacher)
- submitGradesDto: SubmitGradesDto
  Contains course ID and an array of student emails with grades
Returns Promise<{ message: string }>
A success message upon successful submission
- Defined in course/course.controller.ts:349

Class CourseController

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CourseController

Methods

addStudentGrade

Parameters

Returns Promise<{ date: Date; grade: number; id: number }>

createCourse

Parameters

Returns Promise<Course>

deleteStudentGrade

Parameters

Returns Promise<boolean>

destroyCourse

Parameters

Returns Promise<{ message: string }>

editStudentGrade

Parameters

Returns Promise<boolean>

enrollStudent

Parameters

Returns Promise<{ message: string }>

findCoursesByStudent

Parameters

Returns Promise< { description: string; grades: { date: Date; grade: number; id: number }[]; id: number; students: StudentCourse[]; teacher: { email: string; firstName: string; image: string; lastName: string; role: UserRole; }; title: string; }[],>

findCoursesByTeacher

Parameters

Returns Promise< { description: string; id: number; students: { email: string; firstName: string; image: string; lastName: string; role: UserRole; }[]; teacher: { email: string; firstName: string; image: string; lastName: string; role: UserRole; }; title: string; }[],>

getCourse

Parameters

getStudentsForCourse

Parameters

Returns Promise< { email: string; firstName: string; image: string; lastName: string; role: UserRole; }[],>

submitGrades

Parameters

Returns Promise<{ message: string }>

Settings

On This Page

Returns Promise<
{
description: string;
grades: { date: Date; grade: number; id: number }[];
id: number;
students: StudentCourse[];
teacher: {
email: string;
firstName: string;
image: string;
lastName: string;
role: UserRole;
};
title: string;
}[],
>

Returns Promise<
{
description: string;
id: number;
students: {
email: string;
firstName: string;
image: string;
lastName: string;
role: UserRole;
}[];
teacher: {
email: string;
firstName: string;
image: string;
lastName: string;
role: UserRole;
};
title: string;
}[],
>

Returns Promise<
{
email: string;
firstName: string;
image: string;
lastName: string;
role: UserRole;
}[],
>