2015-09-11 02:31:09 +08:00
|
|
|
<?php namespace BookStack;
|
2015-07-28 03:17:08 +08:00
|
|
|
|
|
|
|
|
2015-08-16 21:51:45 +08:00
|
|
|
class Chapter extends Entity
|
2015-07-28 03:17:08 +08:00
|
|
|
{
|
|
|
|
protected $fillable = ['name', 'description', 'priority', 'book_id'];
|
|
|
|
|
2017-01-02 00:05:44 +08:00
|
|
|
protected $with = ['book'];
|
|
|
|
|
2016-05-02 04:20:50 +08:00
|
|
|
/**
|
|
|
|
* Get the book this chapter is within.
|
|
|
|
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
|
|
|
|
*/
|
2015-07-28 03:17:08 +08:00
|
|
|
public function book()
|
|
|
|
{
|
2016-05-02 04:20:50 +08:00
|
|
|
return $this->belongsTo(Book::class);
|
2015-07-28 03:17:08 +08:00
|
|
|
}
|
|
|
|
|
2016-05-02 04:20:50 +08:00
|
|
|
/**
|
|
|
|
* Get the pages that this chapter contains.
|
2017-01-02 19:07:27 +08:00
|
|
|
* @param string $dir
|
2016-05-02 04:20:50 +08:00
|
|
|
* @return mixed
|
|
|
|
*/
|
2017-01-02 19:07:27 +08:00
|
|
|
public function pages($dir = 'ASC')
|
2015-07-28 03:17:08 +08:00
|
|
|
{
|
2017-01-02 19:07:27 +08:00
|
|
|
return $this->hasMany(Page::class)->orderBy('priority', $dir);
|
2015-07-28 03:17:08 +08:00
|
|
|
}
|
|
|
|
|
2016-05-02 04:20:50 +08:00
|
|
|
/**
|
|
|
|
* Get the url of this chapter.
|
2016-08-14 19:29:35 +08:00
|
|
|
* @param string|bool $path
|
2016-05-02 04:20:50 +08:00
|
|
|
* @return string
|
|
|
|
*/
|
2016-08-14 19:29:35 +08:00
|
|
|
public function getUrl($path = false)
|
2015-07-28 03:17:08 +08:00
|
|
|
{
|
2015-11-30 01:33:25 +08:00
|
|
|
$bookSlug = $this->getAttribute('bookSlug') ? $this->getAttribute('bookSlug') : $this->book->slug;
|
2016-08-14 19:29:35 +08:00
|
|
|
if ($path !== false) {
|
2016-11-13 01:16:52 +08:00
|
|
|
return baseUrl('/books/' . urlencode($bookSlug) . '/chapter/' . urlencode($this->slug) . '/' . trim($path, '/'));
|
2016-08-14 19:29:35 +08:00
|
|
|
}
|
2016-11-13 01:16:52 +08:00
|
|
|
return baseUrl('/books/' . urlencode($bookSlug) . '/chapter/' . urlencode($this->slug));
|
2015-07-28 03:17:08 +08:00
|
|
|
}
|
|
|
|
|
2016-05-02 04:20:50 +08:00
|
|
|
/**
|
|
|
|
* Get an excerpt of this chapter's description to the specified length or less.
|
|
|
|
* @param int $length
|
|
|
|
* @return string
|
|
|
|
*/
|
2015-07-31 05:27:35 +08:00
|
|
|
public function getExcerpt($length = 100)
|
|
|
|
{
|
2016-05-02 04:20:50 +08:00
|
|
|
$description = $this->description;
|
|
|
|
return strlen($description) > $length ? substr($description, 0, $length-3) . '...' : $description;
|
2015-07-31 05:27:35 +08:00
|
|
|
}
|
|
|
|
|
2015-07-28 03:17:08 +08:00
|
|
|
}
|