App\Models\Lookup\Department

Complexity

Total Complexity

5

Size/Duplication

Total Lines	53
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	department_translations()	0	3	1
A	toApiArray()	0	10	2
A	job_posters()	0	3	1
A	managers()	0	3	1

<?php

/**
 * Created by Reliese Model.
 * Date: Thu, 12 Jul 2018 22:39:27 +0000.
 */

namespace App\Models\Lookup;

use App\Models\BaseModel;

use Backpack\CRUD\CrudTrait;
use Backpack\CRUD\ModelTraits\SpatieTranslatable\HasTranslations;

/**
 * Class Department
 * @property int $id
 * @property string $name
 * @property string $impact
 * @property string $preference
 *
 * @property \Jenssegers\Date\Date $created_at
 * @property \Jenssegers\Date\Date $updated_at
 *
 * @property \Illuminate\Database\Eloquent\Collection $managers
 * @property \Illuminate\Database\Eloquent\Collection $job_posters
 *
 * Localized Properties:
 * @property string $name
 * @property string $impact
 * @property string $preference
 *
 * Methods
 * @method mixed[] toApiArray()
 */
class Department extends BaseModel
{
    use CrudTrait;

The trait Backpack\CRUD\CrudTrait requires some properties which are not provided by App\Models\Lookup\Department: $Type, $fakeColumns

    use HasTranslations;

    /**
     * @var $translatable string[]

The doc comment $translatable at position 0 could not be parsed: Unknown type name '$translatable' at position 0 in $translatable.

     * */
    public $translatable = [
        'name',
        'impact',
        'preference',
    ];

    /**
     * @var $fillable string[]

The doc comment $fillable at position 0 could not be parsed: Unknown type name '$fillable' at position 0 in $fillable.

     * */
    protected $fillable = [
        'name',
        'impact',
        'preference',
    ];

    public function managers() // phpcs:ignore
    {
        return $this->hasMany(\App\Models\Manager::class);
    }

    public function department_translations() // phpcs:ignore
    {
        return $this->hasMany(\App\Models\Lookup\DepartmentTranslation::class);
    }

    public function job_posters() // phpcs:ignore
    {
        return $this->hasMany(\App\Models\JobPoster::class);
    }

    /**
     * Return the array of values used to represent this object in an api response.
     *
     * @return mixed[]
     */
    public function toApiArray()

Method \App\Models\Lookup\Department::toApiArray() does not have return type hint for its return value but it should be possible to add it based on @return annotation "mixed[]".

    {
        $deptArray = ['id' => $this->id];
        foreach (['en', 'fr'] as $locale) {
            $deptArray[$locale] = [
                'name' => $this->getTranslation('name', $locale),
                'impact' => $this->getTranslation('impact', $locale),
            ];
        }
        return $deptArray;
    }
}