plunner\Employee

Complexity

Total Complexity

22

Size/Duplication

Total Lines	179
Duplicated Lines	0 %

Coupling/Cohesion

Components	5
Dependencies	8

Test Coverage

Coverage

81.58%

Importance

Changes	7
Bugs	3	Features	2

15 Methods

Rating	Name	Duplication	Size	Complexity
A	getIsPlannerAttribute()	0	4	1
A	company()	0	4	1
A	groups()	0	4	1
A	calendars()	0	4	1
A	meetings()	0	4	1
B	getEmailForPasswordReset()	0	14	6
A	belongsToGroup()	0	5	2
A	verifyGroup()	0	4	1
A	verifyEmployee()	0	4	1
A	verifyCompany()	0	4	1
A	verifyCalendar()	0	5	1
A	verifyTimeslot()	0	5	1
A	verifyMeeting()	0	6	2
A	verifyMeetingTimeslot()	0	5	1
A	groupsManagedRelationship()	0	4	1

<?php

namespace plunner;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Auth\Authenticatable;
use Illuminate\Auth\Passwords\CanResetPassword;
use Illuminate\Contracts\Auth\Access\Authorizable as AuthorizableContract;
use Illuminate\Contracts\Auth\Authenticatable as AuthenticatableContract;
use Illuminate\Contracts\Auth\CanResetPassword as CanResetPasswordContract;
use Illuminate\Foundation\Auth\Access\Authorizable;

/**
 * Class Employee
 *
 * @package plunner
 * @author Claudio Cardinale <cardi@thecsea.it>
 * @copyright 2015 Claudio Cardinale
 * @version 1.0.0
 * @property integer $id
 * @property string $name
 * @property string $email
 * @property string $password
 * @property integer $company_id
 * @property string $remember_token
 * @property \Carbon\Carbon $created_at
 * @property \Carbon\Carbon $updated_at
 * @property-read \plunner\Company $company
 * @property-read \Illuminate\Database\Eloquent\Collection|\plunner\Group[] $groups
 * @property-read \Illuminate\Database\Eloquent\Collection|\plunner\Meeting[] $meetings
 * @property-read \Illuminate\Database\Eloquent\Collection|\plunner\Calendar[] $calendars
 * @method static \Illuminate\Database\Query\Builder|\plunner\Employee whereId($value)
 * @method static \Illuminate\Database\Query\Builder|\plunner\Employee whereName($value)
 * @method static \Illuminate\Database\Query\Builder|\plunner\Employee whereEmail($value)
 * @method static \Illuminate\Database\Query\Builder|\plunner\Employee wherePassword($value)
 * @method static \Illuminate\Database\Query\Builder|\plunner\Employee whereCompanyId($value)
 * @method static \Illuminate\Database\Query\Builder|\plunner\Employee whereRememberToken($value)
 * @method static \Illuminate\Database\Query\Builder|\plunner\Employee whereCreatedAt($value)
 * @method static \Illuminate\Database\Query\Builder|\plunner\Employee whereUpdatedAt($value)
 * @property-read mixed $is_planner
 */
class Employee extends Model implements AuthenticatableContract,
                                        AuthorizableContract,
                                        CanResetPasswordContract,
                                        PolicyCheckable
{
    use Authenticatable, Authorizable, CanResetPassword;

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

    /**
     * The attributes excluded from the model's JSON form.
     *
     * @var array
     */
    protected $hidden = ['password', 'remember_token', 'pivot'];

    /**
     * @var array
     */
    protected $appends = ['is_planner'];

    public function getIsPlannerAttribute()
    {
        return !($this->groupsManagedRelationship()->get()->isEmpty());
    }

    /**
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function company()
    {
        return $this->belongsTo('plunner\Company');
    }

    /**
     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
     */
    public function groups()
    {
        return $this->belongsToMany('plunner\Group', 'employee_group', 'employee_id'); //needed for planner model
    }

    /**
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    public function calendars()
    {
        return $this->hasMany('plunner\Calendar');
    }

    /**
     * meetings where the user participates
     * to get all meetings where the user can go user groups with meetings
     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
     */
    public function meetings(){
        //TODO durign the inserting chek if the meeting is of a group of the user
        return $this->belongsToMany(Meeting::class);
    }

    /**
     * Get the e-mail address where password reset links are sent.
     * This is needed for multiple user type login
     *
     * Make email unique
     *
     * @return string
     */
    public function getEmailForPasswordReset()
    {
        list(, $caller) = debug_backtrace(false);
        if(isset($caller['class']))
            $caller = explode('\\', $caller['class']);
        else
            $caller = '';

        //check if this function is called by email sender
        if ((count($caller) && $caller[count($caller) - 1] == 'PasswordBroker') || (defined('HHVM_VERSION') && $caller == ''))
            return $this->email;
        //return unique identify for token repository
        return $this->email . $this->company->id;
    }

    /**
     * @param Group $group
     * @return bool
     */
    public function belongsToGroup(Group $group)
    {
        $group = $this->groups()->where('id', $group->id)->first();
        return (is_object($group) && $group->exists);
    }

    /*
     * for a normal employee the policyCheckable methods say if the employee can se or not the element
     */

    /**
     * @param Group $group
     * @return bool
     */
    public function verifyGroup(Group $group)
    {
        return $this->belongsToGroup($group);
    }

    /**
     * @param Employee $employee
     * @return bool
     */
    public function verifyEmployee(Employee $employee)
    {
        return $employee->company_id === $this->company_id;
    }

    /**
     * @param Company $company
     * @return bool
     */
    public function verifyCompany(Company $company)
    {
        return $company->id === $this->company_id;
    }

    /**
     * the employee can modify a calendar
     * @param Calendar $calendar
     * @return bool
     */
    public function verifyCalendar(Calendar $calendar)
    {
        //TODO test this
        return $calendar->employee_id == $this->id;
    }

    /**
     * @param Timeslot $timeslot
     * @return bool
     */
    public function verifyTimeslot(Timeslot $timeslot)
    {
        //TODO test this
        return $timeslot->calendar->employee_id == $this->id;

The property calendar does not seem to exist. Did you mean calendar_id?

    }

    /**
     * @param Meeting $meeting
     * @return bool
     */
    public function verifyMeeting(Meeting $meeting)
    {
        //TODO test this
        $meeting = $this->meetings()->whereId($meeting->id)->first();
        return (is_object($meeting) && $meeting->exists);
    }

    /**
     * @param MeetingTimeslot $meetingTimeslot
     * @return bool
     */
    public function verifyMeetingTimeslot(MeetingTimeslot $meetingTimeslot)
    {
        //TODO implement and test this
        return false;
    }

    /**
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    protected function groupsManagedRelationship()
    {
        return $this->HasMany(Group::class, 'planner_id');
    }
}