A17\Twill\Models\Group

Complexity

Total Complexity

14

Size/Duplication

Total Lines	168
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	scopePublished()	0	3	1
A	getTitleInBrowserAttribute()	0	3	1
A	getEveryoneGroup()	0	3	1
A	permissionableIds()	0	3	1
A	scopeDraft()	0	3	1
A	getUsersCountAttribute()	0	3	1
A	viewableItems()	0	5	1
A	getCanPublishAttribute()	0	3	1
A	permissionableItems()	0	5	1
A	getCreatedAtAttribute()	0	3	1
A	isEveryoneGroup()	0	3	1
A	users()	0	3	1
A	scopeOnlyTrashed()	0	3	1
A	getCanEditAttribute()	0	3	1

<?php

namespace A17\Twill\Models;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\SoftDeletes;
use A17\Twill\Models\Behaviors\HasPermissions;
use A17\Twill\Models\Behaviors\IsTranslatable;
use Illuminate\Database\Eloquent\Model as BaseModel;

/**
 * Group model
 *
 * @property-read string $titleInBrowser Title
 * @property-read string $createdAt Date of creation
 * @property-read boolean $canEdit Check if the group is editable (ie. not the Everyone group)
 * @property-read boolean $canPublish Check if the group is publishable (ie. not the Everyone group)
 * @property-read string $usersCount Formatted number of users in this group (ie. '123 users')
 * @method static Builder published() Get published groups
 * @method static Builder draft() Get draft groups
 * @method static Builder onlyTrashed() Get trashed groups
 */
class Group extends BaseModel
{
    use HasPermissions, SoftDeletes, IsTranslatable;

The trait A17\Twill\Models\Behaviors\HasPermissions requires the property $permissions which is not provided by A17\Twill\Models\Group.

The trait A17\Twill\Models\Behaviors\IsTranslatable requires the property $translatedAttributes which is not provided by A17\Twill\Models\Group.

    public $timestamps = true;

    protected $fillable = [
        'name',
        'description',
        'published',
        'subdomains_access',
    ];

    protected $dates = [
        'deleted_at',
    ];

    public $checkboxes = ['published'];

    protected $casts = [
        'subdomains_access' => 'array',
    ];

    /**
     * Return the Everyone group
     *
     * @return BaseModel
     */
    public static function getEveryoneGroup()
    {
        return Group::where([['is_everyone_group', true], ['name', 'Everyone']])->firstOrFail();
    }

    /**
     * Return the group title
     *
     * @return string
     */
    public function getTitleInBrowserAttribute()
    {
        return $this->name;
    }

    /**
     * Scope published groups.
     *
     * @param Builder $query
     * @return Builder
     */
    public function scopePublished($query)
    {
        return $query->wherePublished(true);
    }

    /**
     * Scope unpublished (draft) groups.
     *
     * @param Builder $query
     * @return Builder
     */
    public function scopeDraft($query)
    {
        return $query->wherePublished(false);
    }

    /**
     * Scope trashed groups.
     *
     * @param Builder $query
     * @return Builder
     */
    public function scopeOnlyTrashed($query)
    {
        return $query->whereNotNull('deleted_at');
    }

    /**
     * User model relationship
     *
     * @return BelongsToMany|Collection|User[]

The type A17\Twill\Models\Collection was not found. Maybe you did not declare it correctly or list all dependencies?

The type A17\Twill\Models\BelongsToMany was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public function users()
    {
        return $this->belongsToMany(twillModel('user'), 'group_twill_user', 'group_id', 'twill_user_id');
    }

    /**
     * Check if current group is the Everyone group
     *
     * @return boolean
     */
    public function isEveryoneGroup()
    {
        return $this->id === $this->getEveryoneGroup()->id;
    }

    /**
     * Return the formatted created date
     *
     * @return string
     */
    public function getCreatedAtAttribute($value)
    {
        return \Carbon\Carbon::parse($value)->format('d M Y');
    }

    /**
     * Check if the group can be edited (not a system group, ie. Everyone)
     *
     * @return boolean
     */
    public function getCanEditAttribute()
    {
        return !$this->isEveryoneGroup();
    }

    /**
     * Check if the group can be published (not a system group, ie. Everyone)
     *
     * @return boolean
     */
    public function getCanPublishAttribute()
    {
        return !$this->isEveryoneGroup();
    }

    /**
     * Return the formatted number of users in this group
     *
     * @return string
     */
    public function getUsersCountAttribute()
    {
        return $this->users->count() . ' users';

The property users does not exist on A17\Twill\Models\Group. Did you mean usersCount?

    }

    /**
     * Return viewable items
     *
     * @return Collection
     */
    public function viewableItems()
    {
        return Permission::where('name', 'view-item')->whereHas('groups', function ($query) {
            $query->where('id', $this->id);
        })->with('permissionable')->get()->pluck('permissionable');
    }

    /**
     * Return ids of permissionable items
     *
     * @return int[]
     */
    public function permissionableIds()
    {
        return $this->permissions->pluck('id')->toArray();

The property permissions does not seem to exist on A17\Twill\Models\Group. Are you sure there is no database migration missing?

    }

    /**
     * Return permissionable items
     *
     * @return Collection
     */
    public function permissionableItems()
    {
        return Permission::whereHas('groups', function ($query) {
            $query->where('id', $this->id);
        })->with('permissionable')->get()->pluck('permissionable');
    }
}