bristol-su / upload-file

app/Models/File.php

<?php

Missing file doc comment

namespace BristolSU\Module\UploadFile\Models;

use BristolSU\Support\ActivityInstance\ActivityInstance;
use BristolSU\Support\ActivityInstance\Contracts\ActivityInstanceRepository;
use BristolSU\Support\Authentication\HasResource;
use BristolSU\ControlDB\Contracts\Repositories\User as UserRepository;
use BristolSU\Support\ModuleInstance\Contracts\ModuleInstanceRepository;
use BristolSU\Support\ModuleInstance\ModuleInstance;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Support\Facades\Config;

class File extends Model

Missing doc comment for class File

{
    use SoftDeletes, HasResource;

    protected $table = 'uploadfile_files';
    
    protected $appends = ['status'];
    
    protected $fillable = [
        'title',
        'description',
        'filename',
        'mime',
        'path',
        'size',
        'uploaded_by',
        'module_instance_id',
        'activity_instance_id',
        'tags'
    ];
    
    protected $casts = [
        'tags' => 'array'
    ];

    public function getUploadedByAttribute($uploadedById)

Missing doc comment for function getUploadedByAttribute()

    {
        return app()->make(UserRepository::class)->getById($uploadedById);
    }

    public function scopeWithTag(Builder $query, string $tag)

Missing doc comment for function scopeWithTag()

    {
        $activityInstanceRepository = app(ActivityInstanceRepository::class);
        $activityInstance = $activityInstanceRepository->getById(static::activityInstanceId());
        $activityInstanceIds = $activityInstanceRepository
            ->allForResource($activityInstance->resource_type, $activityInstance->resource_id)
            ->map(function(ActivityInstance $activityInstance) {

The opening parenthesis of a multi-line function call should be the last content on the line.

Expected 1 space after FUNCTION keyword; 0 found

                return $activityInstance->id;
            });

For multi-line function calls, the closing parenthesis should be on a new line.

        return $query->whereIn('activity_instance_id', $activityInstanceIds->toArray())
            ->where('tags', 'LIKE', '%"' . $tag . '"%');
    }   
    
    /**

Missing short description in doc comment

     * @return ModuleInstance
     */
    public function moduleInstance()
    {
        return app(ModuleInstanceRepository::class)->getById($this->module_instance_id);
    }

    /**

Missing short description in doc comment

     * @return ActivityInstance
     */
    public function activityInstance()
    {
        return app(ActivityInstanceRepository::class)->getById($this->activity_instance_id);
    }

    public function statuses()

Missing doc comment for function statuses()

    {
        return $this->hasMany(FileStatus::class);
    }

    public function getStatusAttribute()

Missing doc comment for function getStatusAttribute()

    {
        if($this->statuses()->count() > 0) {

Expected "if (...) {\n"; found "if(...) {\n"

            return $this->statuses()->latest('created_at')->first()->status;
        }
        
        $statuses = Config::get('uploadfile.statuses');
        if(!is_array($statuses) || count($statuses) === 0) {

Expected "if (...) {\n"; found "if(...) {\n"

            $default = 'Awaiting Approval';
        } else {
            $default = $statuses[0];
        }
        
        return $this->moduleInstance()->setting('initial_status', $default);
    }

    public function comments()

Missing doc comment for function comments()

    {
        return $this->hasMany(Comment::class);
    }

}