App\Judite\Models\Student

Complexity

Total Complexity

19

Size/Duplication

Total Lines	232
Duplicated Lines	0 %

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	isEnrolledInCourse()	0	3	1
A	scopeWhereNumber()	0	3	1
A	getEnrollmentInCourse()	0	5	1
A	unenroll()	0	13	3
A	join()	0	12	2
A	isMemberOfGroupInCourse()	0	3	1
A	proposedExchanges()	0	9	1
A	enroll()	0	11	2
A	getMembershipInGroup()	0	5	1
A	user()	0	3	1
A	invitations()	0	3	1
A	requestedExchanges()	0	9	1
A	memberships()	0	3	1
A	leave()	0	3	1
A	enrollments()	0	3	1

<?php

namespace App\Judite\Models;

use Illuminate\Database\Eloquent\Model;
use App\Exceptions\EnrollmentCannotBeDeleted;
use App\Exceptions\UserHasAlreadyGroupInCourseException;
use App\Exceptions\StudentIsNotEnrolledInCourseException;
use App\Exceptions\UserIsAlreadyEnrolledInCourseException;

class Student extends Model
{
    /**
     * The relations to eager load on every query.
     *
     * @var array
     */
    protected $with = ['user'];

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = ['student_number'];

    /**
     * Get user who owns this student.
     *
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function user()
    {
        return $this->belongsTo(User::class);
    }

    /**
     * Get exchanges requested by this student.
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function requestedExchanges()
    {
        $enrollmentsRelationship = $this->enrollments();
        $enrollmentsKeyName = $enrollmentsRelationship->getRelated()->getKeyName();
        $enrollmentsIdsQuery = $enrollmentsRelationship
            ->select($enrollmentsKeyName)
            ->getBaseQuery();

        return Exchange::whereFromEnrollmentIn($enrollmentsIdsQuery);
    }

    /**
     * Get exchanges proposed to this student.
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function proposedExchanges()
    {
        $enrollmentsRelationship = $this->enrollments();
        $enrollmentsKeyName = $enrollmentsRelationship->getRelated()->getKeyName();
        $enrollmentsIdsQuery = $enrollmentsRelationship
            ->select($enrollmentsKeyName)
            ->getBaseQuery();

        return Exchange::whereToEnrollmentIn($enrollmentsIdsQuery);
    }

    /**
     * Get enrollments of this student.
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    public function enrollments()
    {
        return $this->hasMany(Enrollment::class);
    }

    /**
     * Get enrollment of this student in a given course.
     *
     * @param \App\Judite\Models\Course $course
     *
     * @return \App\Judite\Models\Enrollment|null
     */
    public function getEnrollmentInCourse(Course $course)
    {
        return $this->enrollments()
            ->where('course_id', $course->id)
            ->first();
    }

    /**
     * Enroll this student with a given course.
     *
     * @param \App\Judite\Models\Course $course
     *
     * @throws \App\Exceptions\UserIsAlreadyEnrolledInCourseException
     *
     * @return \App\Judite\Models\Enrollment
     */
    public function enroll(Course $course): Enrollment
    {
        if ($this->isEnrolledInCourse($course)) {
            throw new UserIsAlreadyEnrolledInCourseException($course);
        }

        $enrollment = $this->enrollments()->make();
        $enrollment->course()->associate($course);
        $enrollment->save();

        return $enrollment;
    }

    /**
     * Check if this student is enrolled in a course.
     *
     * @param \App\Judite\Models\Course $course
     *
     * @return bool
     */
    public function isEnrolledInCourse(Course $course): bool
    {
        return $this->enrollments()->where('course_id', $course->id)->exists();
    }

    /**
     * Remove enrollment in the given course.
     *
     * @param \App\Judite\Models\Course $course
     *
     * @throws \App\Exceptions\StudentIsNotEnrolledInCourseException|\App\Exceptions\EnrollmentCannotBeDeleted
     *
     * @return bool
     */
    public function unenroll(Course $course): bool
    {
        $enrollment = $this->getEnrollmentInCourse($course);

        if (is_null($enrollment)) {
            throw new StudentIsNotEnrolledInCourseException($course);
        }

        if (! ($enrollment->isDeletable())) {
            throw new EnrollmentCannotBeDeleted($enrollment);
        }

        return $enrollment->delete();

The expression return $enrollment->delete() could return the type null which is incompatible with the type-hinted return boolean. Consider adding an additional type-check to rule them out.

    }

    /**
     * Scope a query to only include users with the given student number.
     *
     * @param \Illuminate\Database\Eloquent\Builder $query
     * @param string                                $studentNumber
     *
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeWhereNumber($query, $studentNumber)
    {
        return $query->where('student_number', $studentNumber);
    }

    /**
     * Get memberships of this student.
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    public function memberships()
    {
        return $this->hasMany(Membership::class);
    }

    /**
     * Make this student member of a given group.
     *
     * @param \App\Judite\Models\Group $group
     *
     * @throws \App\Exceptions\UserHasAlreadyGroupInCourseException
     *
     * @return \App\Judite\Models\Group
     */
    public function join(Group $group): Membership
    {
        if ($this->isMemberOfGroupInCourse($group->course_id)) {
            throw new UserHasAlreadyGroupInCourseException();
        }

        $membership = $this->memberships()->make();
        $membership->group()->associate($group);
        $membership->course_id = $group->course_id;
        $membership->save();

        return $membership;
    }

    /**
     * Check if this student is member of a group in a course.
     *
     * @param $course_id
     *
     * @return bool
     */
    public function isMemberOfGroupInCourse($courseId): bool
    {
        return $this->memberships()->where('course_id', $courseId)->exists();
    }

    /**
     * Remove membership in the given group.
     *
     * @param \App\Judite\Models\Group $group
     *
     * @return bool
     */
    public function leave(Group $group): bool
    {
        return $this->getMembershipInGroup($group)->delete();

The expression return $this->getMembershipInGroup($group)->delete() could return the type null which is incompatible with the type-hinted return boolean. Consider adding an additional type-check to rule them out.

    }

    /**
     * Get membership of this student in a given course.
     *
     * @param \App\Judite\Models\Group $group
     *
     * @return \App\Judite\Models\Membership|null
     */
    public function getMembershipInGroup(Group $group)
    {
        return $this->memberships()
            ->where('group_id', $group->id)
            ->first();
    }

    /**
     * Get invitations of this student.
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    public function invitations()
    {
        return $this->hasMany(Invitation::class);
    }
}