Student::leave() - Code Metrics - Inspection of "Add groups to courses" - Hackathonners/swap - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — develop (#11)

unknown

created 2018-08-29 09:50 UTC

Student::leave() A

↳ Parent: Student

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	1
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?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();

    }

    /**
     * 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();

    }

    /**
     * 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);
    }
}


1			<?php
2
3			namespace App\Judite\Models;
4
5			use Illuminate\Database\Eloquent\Model;
6			use App\Exceptions\EnrollmentCannotBeDeleted;
7			use App\Exceptions\UserHasAlreadyGroupInCourseException;
8			use App\Exceptions\StudentIsNotEnrolledInCourseException;
9			use App\Exceptions\UserIsAlreadyEnrolledInCourseException;
10
11			class Student extends Model
12			{
13			/**
14			* The relations to eager load on every query.
15			*
16			* @var array
17			*/
18			protected $with = ['user'];
19
20			/**
21			* The attributes that are mass assignable.
22			*
23			* @var array
24			*/
25			protected $fillable = ['student_number'];
26
27			/**
28			* Get user who owns this student.
29			*
30			* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
31			*/
32			public function user()
33			{
34			return $this->belongsTo(User::class);
35			}
36
37			/**
38			* Get exchanges requested by this student.
39			*
40			* @return \Illuminate\Database\Eloquent\Builder
41			*/
42			public function requestedExchanges()
43			{
44			$enrollmentsRelationship = $this->enrollments();
45			$enrollmentsKeyName = $enrollmentsRelationship->getRelated()->getKeyName();
46			$enrollmentsIdsQuery = $enrollmentsRelationship
47			->select($enrollmentsKeyName)
48			->getBaseQuery();
49
50			return Exchange::whereFromEnrollmentIn($enrollmentsIdsQuery);
51			}
52
53			/**
54			* Get exchanges proposed to this student.
55			*
56			* @return \Illuminate\Database\Eloquent\Builder
57			*/
58			public function proposedExchanges()
59			{
60			$enrollmentsRelationship = $this->enrollments();
61			$enrollmentsKeyName = $enrollmentsRelationship->getRelated()->getKeyName();
62			$enrollmentsIdsQuery = $enrollmentsRelationship
63			->select($enrollmentsKeyName)
64			->getBaseQuery();
65
66			return Exchange::whereToEnrollmentIn($enrollmentsIdsQuery);
67			}
68
69			/**
70			* Get enrollments of this student.
71			*
72			* @return \Illuminate\Database\Eloquent\Relations\HasMany
73			*/
74			public function enrollments()
75			{
76			return $this->hasMany(Enrollment::class);
77			}
78
79			/**
80			* Get enrollment of this student in a given course.
81			*
82			* @param \App\Judite\Models\Course $course
83			*
84			* @return \App\Judite\Models\Enrollment\|null
85			*/
86			public function getEnrollmentInCourse(Course $course)
87			{
88			return $this->enrollments()
89			->where('course_id', $course->id)
90			->first();
91			}
92
93			/**
94			* Enroll this student with a given course.
95			*
96			* @param \App\Judite\Models\Course $course
97			*
98			* @throws \App\Exceptions\UserIsAlreadyEnrolledInCourseException
99			*
100			* @return \App\Judite\Models\Enrollment
101			*/
102			public function enroll(Course $course): Enrollment
103			{
104			if ($this->isEnrolledInCourse($course)) {
105			throw new UserIsAlreadyEnrolledInCourseException($course);
106			}
107
108			$enrollment = $this->enrollments()->make();
109			$enrollment->course()->associate($course);
110			$enrollment->save();
111
112			return $enrollment;
113			}
114
115			/**
116			* Check if this student is enrolled in a course.
117			*
118			* @param \App\Judite\Models\Course $course
119			*
120			* @return bool
121			*/
122			public function isEnrolledInCourse(Course $course): bool
123			{
124			return $this->enrollments()->where('course_id', $course->id)->exists();
125			}
126
127			/**
128			* Remove enrollment in the given course.
129			*
130			* @param \App\Judite\Models\Course $course
131			*
132			* @throws \App\Exceptions\StudentIsNotEnrolledInCourseException\|\App\Exceptions\EnrollmentCannotBeDeleted
133			*
134			* @return bool
135			*/
136			public function unenroll(Course $course): bool
137			{
138			$enrollment = $this->getEnrollmentInCourse($course);
139
140			if (is_null($enrollment)) {
141			throw new StudentIsNotEnrolledInCourseException($course);
142			}
143
144			if (! ($enrollment->isDeletable())) {
145			throw new EnrollmentCannotBeDeleted($enrollment);
146			}
147
148			return $enrollment->delete();
			0 ignored issues – show Bug Best Practice introduced 2017-09-26 13:32 UTC by Report Bug Copy Issue Report 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. Loading history...
149			}
150
151			/**
152			* Scope a query to only include users with the given student number.
153			*
154			* @param \Illuminate\Database\Eloquent\Builder $query
155			* @param string $studentNumber
156			*
157			* @return \Illuminate\Database\Eloquent\Builder
158			*/
159			public function scopeWhereNumber($query, $studentNumber)
160			{
161			return $query->where('student_number', $studentNumber);
162			}
163
164			/**
165			* Get memberships of this student.
166			*
167			* @return \Illuminate\Database\Eloquent\Relations\HasMany
168			*/
169			public function memberships()
170			{
171			return $this->hasMany(Membership::class);
172			}
173
174			/**
175			* Make this student member of a given group.
176			*
177			* @param \App\Judite\Models\Group $group
178			*
179			* @throws \App\Exceptions\UserHasAlreadyGroupInCourseException
180			*
181			* @return \App\Judite\Models\Group
182			*/
183			public function join(Group $group): Membership
184			{
185			if ($this->isMemberOfGroupInCourse($group->course_id)) {
186			throw new UserHasAlreadyGroupInCourseException();
187			}
188
189			$membership = $this->memberships()->make();
190			$membership->group()->associate($group);
191			$membership->course_id = $group->course_id;
192			$membership->save();
193
194			return $membership;
195			}
196
197			/**
198			* Check if this student is member of a group in a course.
199			*
200			* @param $course_id
201			*
202			* @return bool
203			*/
204			public function isMemberOfGroupInCourse($courseId): bool
205			{
206			return $this->memberships()->where('course_id', $courseId)->exists();
207			}
208
209			/**
210			* Remove membership in the given group.
211			*
212			* @param \App\Judite\Models\Group $group
213			*
214			* @return bool
215			*/
216			public function leave(Group $group): bool
217			{
218			return $this->getMembershipInGroup($group)->delete();
			0 ignored issues – show Bug Best Practice introduced 2018-07-23 18:57 UTC by Report Bug Copy Issue Report The expression `return $this->getMembers...Group($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. Loading history...
219			}
220
221			/**
222			* Get membership of this student in a given course.
223			*
224			* @param \App\Judite\Models\Group $group
225			*
226			* @return \App\Judite\Models\Membership\|null
227			*/
228			public function getMembershipInGroup(Group $group)
229			{
230			return $this->memberships()
231			->where('group_id', $group->id)
232			->first();
233			}
234
235			/**
236			* Get invitations of this student.
237			*
238			* @return \Illuminate\Database\Eloquent\Relations\HasMany
239			*/
240			public function invitations()
241			{
242			return $this->hasMany(Invitation::class);
243			}
244			}
245

Hackathonners / swap

Pull Request — develop (#11)

Student::leave() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like