2021-06-26 11:23:15 -04:00
|
|
|
<?php
|
|
|
|
|
|
|
|
namespace BookStack\Entities\Models;
|
2015-07-27 15:17:08 -04:00
|
|
|
|
2019-10-05 07:55:01 -04:00
|
|
|
use Illuminate\Support\Collection;
|
2019-09-19 19:18:28 -04:00
|
|
|
|
2019-10-05 07:55:01 -04:00
|
|
|
/**
|
2021-06-26 11:23:15 -04:00
|
|
|
* Class Chapter.
|
|
|
|
*
|
2019-10-05 07:55:01 -04:00
|
|
|
* @property Collection<Page> $pages
|
2021-06-22 16:02:18 -04:00
|
|
|
* @property mixed description
|
2019-10-05 07:55:01 -04:00
|
|
|
*/
|
2019-09-19 19:18:28 -04:00
|
|
|
class Chapter extends BookChild
|
2015-07-27 15:17:08 -04:00
|
|
|
{
|
2018-03-24 14:46:31 -04:00
|
|
|
public $searchFactor = 1.3;
|
|
|
|
|
2015-07-27 15:17:08 -04:00
|
|
|
protected $fillable = ['name', 'description', 'priority', 'book_id'];
|
2020-11-28 10:21:54 -05:00
|
|
|
protected $hidden = ['restricted', 'pivot', 'deleted_at'];
|
2015-07-27 15:17:08 -04:00
|
|
|
|
2016-05-01 16:20:50 -04:00
|
|
|
/**
|
|
|
|
* Get the pages that this chapter contains.
|
2021-06-26 11:23:15 -04:00
|
|
|
*
|
2017-01-02 06:07:27 -05:00
|
|
|
* @param string $dir
|
2021-06-26 11:23:15 -04:00
|
|
|
*
|
2016-05-01 16:20:50 -04:00
|
|
|
* @return mixed
|
|
|
|
*/
|
2017-01-02 06:07:27 -05:00
|
|
|
public function pages($dir = 'ASC')
|
2015-07-27 15:17:08 -04:00
|
|
|
{
|
2017-01-02 06:07:27 -05:00
|
|
|
return $this->hasMany(Page::class)->orderBy('priority', $dir);
|
2015-07-27 15:17:08 -04:00
|
|
|
}
|
|
|
|
|
2016-05-01 16:20:50 -04:00
|
|
|
/**
|
|
|
|
* Get the url of this chapter.
|
|
|
|
*/
|
2020-11-21 20:20:38 -05:00
|
|
|
public function getUrl($path = ''): string
|
2015-07-27 15:17:08 -04:00
|
|
|
{
|
2020-11-21 20:20:38 -05:00
|
|
|
$parts = [
|
|
|
|
'books',
|
2021-08-21 14:58:19 -04:00
|
|
|
urlencode($this->book_slug ?? $this->book->slug),
|
2020-11-21 20:20:38 -05:00
|
|
|
'chapter',
|
|
|
|
urlencode($this->slug),
|
|
|
|
trim($path, '/'),
|
|
|
|
];
|
|
|
|
|
|
|
|
return url('/' . implode('/', $parts));
|
2015-07-30 17:27:35 -04:00
|
|
|
}
|
|
|
|
|
2019-03-17 11:07:03 -04:00
|
|
|
/**
|
2019-10-05 07:55:01 -04:00
|
|
|
* Get the visible pages in this chapter.
|
2019-03-17 11:07:03 -04:00
|
|
|
*/
|
2019-10-05 07:55:01 -04:00
|
|
|
public function getVisiblePages(): Collection
|
2019-03-17 11:07:03 -04:00
|
|
|
{
|
2019-10-05 07:55:01 -04:00
|
|
|
return $this->pages()->visible()
|
|
|
|
->orderBy('draft', 'desc')
|
|
|
|
->orderBy('priority', 'asc')
|
|
|
|
->get();
|
2019-03-17 11:07:03 -04:00
|
|
|
}
|
2015-07-27 15:17:08 -04:00
|
|
|
}
|