BookStack/app/Chapter.php

55 lines
1.5 KiB
PHP
Raw Normal View History

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