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