BookStack/app/Entities/Models/PageRevision.php

93 lines
2.3 KiB
PHP
Raw Normal View History

2021-06-26 17:23:15 +02:00
<?php
namespace BookStack\Entities\Models;
2023-05-17 18:56:55 +02:00
use BookStack\Activity\Models\Loggable;
use BookStack\App\Model;
use BookStack\Users\Models\User;
use Carbon\Carbon;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
2015-08-09 13:06:52 +02:00
/**
2021-06-26 17:23:15 +02:00
* Class PageRevision.
*
2022-03-26 21:38:03 +01:00
* @property mixed $id
2021-06-26 17:23:15 +02:00
* @property int $page_id
* @property string $name
* @property string $slug
* @property string $book_slug
2021-06-26 17:23:15 +02:00
* @property int $created_by
* @property Carbon $created_at
* @property Carbon $updated_at
* @property string $type
* @property string $summary
* @property string $markdown
* @property string $html
* @property string $text
2021-06-26 17:23:15 +02:00
* @property int $revision_number
* @property Page $page
2021-11-06 01:32:01 +01:00
* @property-read ?User $createdBy
*/
class PageRevision extends Model implements Loggable
2015-08-09 13:06:52 +02:00
{
protected $fillable = ['name', 'text', 'summary'];
protected $hidden = ['html', 'markdown', 'text'];
2015-08-09 13:06:52 +02:00
/**
2021-06-26 17:23:15 +02:00
* Get the user that created the page revision.
*/
public function createdBy(): BelongsTo
2015-08-09 13:06:52 +02:00
{
return $this->belongsTo(User::class, 'created_by');
2015-08-09 13:06:52 +02:00
}
/**
* Get the page this revision originates from.
*/
public function page(): BelongsTo
2015-08-09 13:06:52 +02:00
{
return $this->belongsTo(Page::class);
2015-08-09 13:06:52 +02:00
}
/**
* Get the url for this revision.
*/
public function getUrl(string $path = ''): string
2015-08-09 13:06:52 +02:00
{
return $this->page->getUrl('/revisions/' . $this->id . '/' . ltrim($path, '/'));
2015-08-09 13:06:52 +02:00
}
2016-07-07 19:42:21 +02:00
/**
2021-06-26 17:23:15 +02:00
* Get the previous revision for the same page if existing.
2016-07-07 19:42:21 +02:00
*/
public function getPrevious(): ?PageRevision
2016-07-07 19:42:21 +02:00
{
$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 19:42:21 +02:00
}
return null;
2016-07-07 19:42:21 +02:00
}
/**
* Allows checking of the exact class, Used to check entity type.
* Included here to align with entities in similar use cases.
2021-06-26 17:23:15 +02:00
* (Yup, Bit of an awkward hack).
*
* @deprecated Use instanceof instead.
*/
public static function isA(string $type): bool
{
return $type === 'revision';
}
public function logDescriptor(): string
{
return "Revision #{$this->revision_number} (ID: {$this->id}) for page ID {$this->page_id}";
}
2015-08-09 13:06:52 +02:00
}