BookStack/app/Entities/PageRevision.php

85 lines
2.0 KiB
PHP
Raw Normal View History

<?php namespace BookStack\Entities;
use BookStack\Auth\User;
use BookStack\Model;
use Carbon\Carbon;
2015-08-09 07:06:52 -04:00
/**
* Class PageRevision
* @property int $page_id
* @property string $slug
* @property string $book_slug
* @property int $created_by
* @property Carbon $created_at
* @property string $type
* @property string $summary
* @property string $markdown
* @property string $html
* @property int $revision_number
*/
2015-08-09 07:06:52 -04:00
class PageRevision extends Model
{
2016-07-07 14:53:43 -04:00
protected $fillable = ['name', 'html', 'text', 'markdown', 'summary'];
2015-08-09 07:06:52 -04:00
/**
* Get the user that created the page revision
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
2015-08-09 07:06:52 -04:00
public function createdBy()
{
return $this->belongsTo(User::class, 'created_by');
2015-08-09 07:06:52 -04:00
}
/**
* Get the page this revision originates from.
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
2015-08-09 07:06:52 -04:00
public function page()
{
return $this->belongsTo(Page::class);
2015-08-09 07:06:52 -04:00
}
/**
* Get the url for this revision.
* @param null|string $path
* @return string
*/
public function getUrl($path = null)
2015-08-09 07:06:52 -04:00
{
$url = $this->page->getUrl() . '/revisions/' . $this->id;
if ($path) {
return $url . '/' . trim($path, '/');
}
return $url;
2015-08-09 07:06:52 -04:00
}
2016-07-07 13:42:21 -04:00
/**
* Get the previous revision for the same page if existing
* @return \BookStack\Entities\PageRevision|null
2016-07-07 13:42:21 -04:00
*/
public function getPrevious()
{
$id = static::newQuery()->where('page_id', '=', $this->page_id)
->where('id', '<', $this->id)
->max('id');
if ($id) {
return static::query()->find($id);
2016-07-07 13:42:21 -04:00
}
return null;
2016-07-07 13:42:21 -04:00
}
/**
* Allows checking of the exact class, Used to check entity type.
* Included here to align with entities in similar use cases.
* (Yup, Bit of an awkward hack)
* @param $type
* @return bool
*/
public static function isA($type)
{
return $type === 'revision';
}
2015-08-09 07:06:52 -04:00
}