Employee::getRouteKeyName() - Code Metrics - Inspection of "Refactor Transformers" - bkintanar/HRis - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — api/develop ( d18cde...f05f55 )

by Bertrand
created 2016-02-29 03:49 UTC
Employee::getRouteKeyName() A

↳ Parent: Project
Complexity

Conditions	1
Paths	1
Size

Total Lines	4
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	2
CRAP Score	1
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
c	1
b	0
f	0
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
cc	1
eloc	2
nc	1
nop	0
crap	1
<?php

/**
 * This file is part of the HRis Software package.
 *
 * HRis - Human Resource and Payroll System
 *
 * @link http://github.com/HB-Co/HRis
 */
namespace HRis\Api\Eloquent;

use Carbon\Carbon;
use Illuminate\Database\Eloquent\Model;
use Swagger\Annotations as SWG;

/**
 * Class Employee.
 *
 * @SWG\Definition(definition="Employee", required={"id", "employee_id"})
 * @SWG\Property(property="id", type="integer", format="int64", default=1, description="Unique identifier for the employee")
 * @SWG\Property(property="employee_id", type="string", default="HRis-0001", description="ID of the employee")
 * @SWG\Property(property="marital_status_id", type="integer", format="int64", default="2", description="Marital Status ID of the employee")
 * @SWG\Property(property="nationality_id", type="integer", format="int64", default="62", description="Nationality ID of the employee")
 * @SWG\Property(property="first_name", type="string", default="Bertrand", description="First name of the employee")
 * @SWG\Property(property="middle_name", type="string", default="Son", description="Middle name of the employee")
 * @SWG\Property(property="last_name", type="string", default="Kintanar", description="Last name of the employee")
 * @SWG\Property(property="avatar", type="string", default="default/0.png", description="Avatar of the employee")
 * @SWG\Property(property="gender", type="string", default="M", description="Gender of the employee")
 * @SWG\Property(property="address_1", type="string", default="Judge Pedro Son Compound", description="Street address 1 of the employee")
 * @SWG\Property(property="address_2", type="string", default="Miñoza St. Talamban", description="Street address 2 of the employee")
 * @SWG\Property(property="address_city_id", type="integer", format="int64", default=439, description="Street address city ID of the employee")
 * @SWG\Property(property="address_province_id", type="integer", format="int64", default=25, description="Street address province ID of the employee")
 * @SWG\Property(property="address_country_id", type="integer", format="int64", default=185, description="Street address country ID of the employee")
 * @SWG\Property(property="postal_code", type="string", default="6000", description="Street address postal code of the employee")
 * @SWG\Property(property="home_phone", type="string", default="032 520 2160", description="Home phone of the employee")
 * @SWG\Property(property="mobile_phone", type="string", default="0949 704 7136", description="Mobile phone of the employee")
 * @SWG\Property(property="work_email", type="string", default="[email protected]", description="Work email of the employee")
 * @SWG\Property(property="other_email", type="string", default="[email protected]", description="Other email of the employee")
 * @SWG\Property(property="birth_date", type="string", default="1985-10-31", description="Birth date of the employee")
 */
class Employee extends Model
{
    /**
     * Indicates if the model should be timestamped.
     *
     * @var bool
     */
    public $timestamps = false;

    /**
     * Additional fields to treat as Carbon instances.
     *
     * @var array
     */
    protected $dates = ['birth_date', 'resign_date'];

    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = [
        'employee_id',
        'user_id',
        'face_id',
        'first_name',
        'middle_name',
        'last_name',
        'gender',
        'birth_date',
        'social_security',
        'tax_identification',
        'philhealth',
        'hdmf_pagibig',
        'marital_status_id',
        'nationality_id',
        'address_1',
        'address_2',
        'address_city_id',
        'address_province_id',
        'address_country_id',
        'address_postal_code',
        'home_phone',
        'mobile_phone',
        'work_email',
        'other_email',
        'joined_date',
        'probation_end_date',
        'permanency_date',
        'resign_date',
    ];

    /**
     * The database table used by the model.
     *
     * @var string
     */
    protected $table = 'employees';

    /**
     * Get the route key for the model.
     *
     * @return string
     *
     * @author Bertrand Kintanar <[email protected]>
     */
    public function getRouteKeyName()
    {
        return 'employee_id';
    }

    /**
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     *
     * @author Bertrand Kintanar <[email protected]>
     */
    public function city()
    {
        return $this->belongsTo(City::class, 'address_city_id', 'id');
    }

    /**
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     *
     * @author Bertrand Kintanar <[email protected]>
     */
    public function country()
    {
        return $this->belongsTo(Country::class, 'address_country_id', 'id');
    }

    /**
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     *
     * @author Bertrand Kintanar <[email protected]>
     */
    public function dependents()
    {
        return $this->hasMany(Dependent::class);
    }

    /**
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     *
     * @author Bertrand Kintanar <[email protected]>
     */
    public function emergencyContacts()
    {
        return $this->hasMany(EmergencyContact::class);
    }

    /**
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     *
     * @author Bertrand Kintanar <[email protected]>
     */
    public function customFieldValues()
    {
        return $this->hasMany(CustomFieldValue::class);
    }

    /**
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     *
     * @author Bertrand Kintanar <[email protected]>
     */
    public function educations()
    {
        return $this->hasMany(Education::class);
    }

    /**
     * @return mixed
     *
     * @author Jim Callanta
     */
    public function employeeSalaryComponent()
    {
        return $this->hasMany(EmployeeSalaryComponent::class)
            ->with('salaryComponent')
            ->orderBy('id', 'desc')
            ->orderBy('effective_date', 'desc')
            ->take(4);
    }

    /**
     * @param $employee_id
     * @param $user_id
     *
     * @return mixed
     *
     * @author Bertrand Kintanar <[email protected]>
     */
    public function getEmployeeById($employee_id, $user_id)
    {
        if ($employee_id) {
            $employee = self::whereEmployeeId($employee_id)->with([
                'user', 'country', 'province', 'city', 'jobHistories', 'emergencyContacts', 'dependents', 'employeeWorkShift', 'customFieldValues', 'workExperiences', 'educations', 'employeeSkills',
            ])->first();
            $employee->job_history = $employee->jobHistory();

            return $employee;
        }

        $employee = self::whereUserId($user_id)->with([
            'user', 'country', 'province', 'city', 'jobHistories', 'emergencyContacts', 'dependents', 'employeeWorkShift', 'customFieldValues', 'workExperiences', 'educations', 'employeeSkills',
        ])->first();
        $employee->job_history = $employee->jobHistory();

        return $employee;
    }

    /**
     * @param bool   $paginate
     * @param string $sort
     * @param string $direction
     *
     * @return mixed
     *
     * @author Bertrand Kintanar <[email protected]>
     */
    public function getEmployeeList($paginate = true, $sort = 'employees.id', $direction = 'asc')
    {
        $employees = $this->select('employees.id', 'employees.employee_id', 'employees.first_name',
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
            'employees.last_name', 'job_titles.name as job', 'employment_statuses.name as status',
            'employment_statuses.class');
        $employees->leftJoin(
            \DB::raw('(SELECT `employee_id`, `job_title_id`, `employment_status_id`, `effective_date` FROM `job_histories` AS `jh` WHERE `effective_date` = (SELECT MAX(`effective_date`) FROM `job_histories` AS `jh2` WHERE `jh`.`employee_id` = `jh2`.`employee_id`) group by `employee_id` ) AS `jh`'),
            'employees.id', '=', 'jh.employee_id');
        $employees->leftJoin('job_titles', 'jh.job_title_id', '=', 'job_titles.id');
        $employees->leftJoin('employment_statuses', 'jh.employment_status_id', '=', 'employment_statuses.id');
        $employees->orderBy($sort, $direction);

        if ($paginate) {
            return $employees->paginate(ROWS_PER_PAGE);
        }

        return $employees;
    }

    /**
     * @param $employee_id
     * @param $user_employee_id
     *
     * @return mixed
     *
     * @author Jim Callanta
     */
    public function getEmployeeSalaryDetails($employee_id, $user_employee_id)
    {
        if ($employee_id) {
            return self::whereEmployeeId($employee_id)->with('employeeSalaryComponent', 'dependents')->first();
        }

        return self::whereId($user_employee_id)->with('employeeSalaryComponent', 'dependents')->first();
    }

    /**
     * @return string
     *
     * @author Bertrand Kintanar <[email protected]>
     */
    public function getFullNameAttribute()
    {
        return $this->first_name.' '.($this->middle_name ? $this->middle_name.' ' : '').$this->last_name.($this->suffix_name ? ' '.$this->suffix_name : '');
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    /**
     * @param $start_date
     *
     * @return array
     *
     * @author Bertrand Kintanar <[email protected]>
     */
    public function getTimelog($start_date)
    {
        $work_shift = $this->employeeWorkShift()->first();

        $wstp = $work_shift->getWorkShiftRange($start_date);
        $time_in = $this->timelogs()->whereSwipeDate($wstp['from_datetime']->toDateString())->where('swipe_time', '>=',
            $wstp['from_datetime']->toTimeString())->first();
        $time_out = $this->timelogs()->whereSwipeDate($wstp['to_datetime']->toDateString())->where('swipe_time', '<=',
            $wstp['to_datetime']->toTimeString())->orderBy('id', 'desc')->first();

        // If employee logs out more than one hour after the work shift schedule check for extended time
        if ($time_out === null && $time_in !== null) {
            $time_out = $this->timelogs()->where('swipe_datetime', '<=',
                $wstp['to_datetime']->addHours(4)->toDateTimeString())->orderBy('id', 'desc')->first();

            if ($time_out !== null && $wstp['from_datetime']->addHours(24)->toDateTimeString() < $time_out->swipe_datetime) {
                $time_out = null;
            }

            if ($time_in->id == $time_out->id) {
                $time_out = null;
            }
        }

        // Checks for failure to Login or Logout
        if ($time_out && $time_in) {
            if ($time_out->swipe_time == $time_in->swipe_time) {
                if ($time_out->swipe_datetime >= $wstp['to_datetime']->subHour(1)->toDateTimeString() && $time_out->swipe_datetime <= $wstp['to_datetime']->addHours(4)->toDateTimeString()) {
                    $time_in = null;
                } else {
                    $time_out = null;
                }
            }
        }

        return [
            'in_time'  => $time_in ? $time_in->swipe_time : null,
            'out_time' => $time_out ? $time_out->swipe_time : null,
        ];
    }

    /**
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     *
     * @author Bertrand Kintanar <[email protected]>
     */
    public function employeeWorkShift()
    {
        return $this->hasMany(EmployeeWorkShift::class)->with('workShift')
            ->orderBy('effective_date', 'desc')
            ->orderBy('id', 'desc');
    }

    /**
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     *
     * @author Bertrand Kintanar <[email protected]>
     */
    public function timelogs()
    {
        return $this->hasMany(Timelog::class);
    }

    /**
     * @return mixed
     *
     * @author Bertrand Kintanar <[email protected]>
     */
    public function jobHistory()
    {
        return $this->jobHistories()->first();
    }

    /**
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     *
     * @author Bertrand Kintanar <[email protected]>
     */
    public function jobHistories()
    {
        return $this->hasMany(JobHistory::class)->with('jobTitle', 'department', 'workShift',
            'location')->orderBy('job_histories.id', 'desc');
    }

    /**
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     *
     * @author Bertrand Kintanar <[email protected]>
     */
    public function province()
    {
        return $this->belongsTo(Province::class, 'address_province_id', 'id');
    }

    /**
     * @param $birth_date
     *
     * @author Bertrand Kintanar <[email protected]>
     */
    public function setBirthDateAttribute($birth_date)
    {
        $this->attributes['birth_date'] = Carbon::parse($birth_date) ?: null;
    }

    /**
     * @param $employee_id
     *
     * @author Bertrand Kintanar <[email protected]>
     */
    public function setEmployeeIdAttribute($employee_id)
    {
        $this->attributes['employee_id'] = $employee_id ?: null;
    }

    /**
     * @param $face_id
     *
     * @author Bertrand Kintanar <[email protected]>
     */
    public function setFaceIdAttribute($face_id)
    {
        $this->attributes['face_id'] = $face_id ?: null;
    }

    /**
     * @param $hdmf_pagibig
     *
     * @author Bertrand Kintanar <[email protected]>
     */
    public function setHdmfPagibigAttribute($hdmf_pagibig)
    {
        $this->attributes['hdmf_pagibig'] = $hdmf_pagibig ?: null;
    }

    /**
     * @param $marital_status_id
     *
     * @author Bertrand Kintanar <[email protected]>
     */
    public function setMaritalStatusIdAttribute($marital_status_id)
    {
        $this->attributes['marital_status_id'] = $marital_status_id ?: null;
    }

    /**
     * @param $philhealth
     *
     * @author Bertrand Kintanar <[email protected]>
     */
    public function setPhilHealthAttribute($philhealth)
    {
        $this->attributes['philhealth'] = $philhealth ?: null;
    }

    /**
     * @param $resign_date
     *
     * @author Bertrand Kintanar <[email protected]>
     */
    public function setResignDateAttribute($resign_date)
    {
        $this->attributes['resign_date'] = Carbon::parse($resign_date) ?: null;
    }

    /**
     * @param $user_id
     *
     * @author Bertrand Kintanar <[email protected]>
     */
    public function setUserIdAttribute($user_id)
    {
        $this->attributes['user_id'] = $user_id ?: null;
    }

    /**
     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
     *
     * @author Bertrand Kintanar <[email protected]>
     */
    public function skills()
    {
        return $this->belongsToMany(Skill::class);
    }

    /**
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     *
     * @author Bertrand Kintanar <[email protected]>
     */
    public function employeeSkills()
    {
        return $this->hasMany(EmployeeSkill::class);
    }

    /**
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     *
     * @author Bertrand Kintanar <[email protected]>
     */
    public function user()
    {
        return $this->belongsTo(User::class);
    }

    /**
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     *
     * @author Bertrand Kintanar <[email protected]>
     */
    public function workExperiences()
    {
        return $this->hasMany(WorkExperience::class);
    }
}

bkintanar / HRis

Push — api/develop ( d18cde...f05f55 )

Employee::getRouteKeyName() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
