<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class Directory extends Model
{
    /**
     * @var bool $timstamps have created_at and updated_at fields
     */
    public $timestamps = true;
    protected $fillable = [
        'name',
        'description',
        'parent_id',
        'user_id',
        'hidden'
    ];
    protected $guarded = [];

    /**
     * Relationship with parent/sub directories
     *
     * @param bool $includeHidden
     *
     * @return \Illuminate\Database\Eloquent\Relations\HasMany
     */
    public function subdirectories($includeHidden = false)
    {

        $subdirectories = Directory::where('parent_id', $this->id);

        if (!$includeHidden) {
            $subdirectories = $subdirectories->where('hidden', 0);

        }

        return $subdirectories->get();

    }
}