mirror of
https://github.com/BookStackApp/BookStack.git
synced 2024-11-26 10:13:38 +08:00
3625f12abe
Creates a new organsied formatting system for webhook data, with interfaces for extending with custom model formatting rules. Allows easy usage & extension of the default bookstack formatting behaviour when customizing webhook events via theme system, and keeps default data customizations organised. This also makes the following webhook data changes: - owned_by/created_by/updated_by user details are loaded for events with Entity details. (POTENTIALLY BREAKING CHANGE). - current_revision details are loaded for page update/create events. Added testing to cover added model formatting rules. For #3279 and #3218
85 lines
2.0 KiB
PHP
85 lines
2.0 KiB
PHP
<?php
|
|
|
|
namespace BookStack\Entities\Models;
|
|
|
|
use BookStack\Auth\User;
|
|
use BookStack\Model;
|
|
use Carbon\Carbon;
|
|
use Illuminate\Database\Eloquent\Relations\BelongsTo;
|
|
|
|
/**
|
|
* Class PageRevision.
|
|
*
|
|
* @property mixed $id
|
|
* @property int $page_id
|
|
* @property string $slug
|
|
* @property string $book_slug
|
|
* @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 int $revision_number
|
|
* @property Page $page
|
|
* @property-read ?User $createdBy
|
|
*/
|
|
class PageRevision extends Model
|
|
{
|
|
protected $fillable = ['name', 'html', 'text', 'markdown', 'summary'];
|
|
protected $hidden = ['html', 'markdown', 'restricted', 'text'];
|
|
|
|
/**
|
|
* Get the user that created the page revision.
|
|
*/
|
|
public function createdBy(): BelongsTo
|
|
{
|
|
return $this->belongsTo(User::class, 'created_by');
|
|
}
|
|
|
|
/**
|
|
* Get the page this revision originates from.
|
|
*/
|
|
public function page(): BelongsTo
|
|
{
|
|
return $this->belongsTo(Page::class);
|
|
}
|
|
|
|
/**
|
|
* Get the url for this revision.
|
|
*/
|
|
public function getUrl(string $path = ''): string
|
|
{
|
|
return $this->page->getUrl('/revisions/' . $this->id . '/' . ltrim($path, '/'));
|
|
}
|
|
|
|
/**
|
|
* Get the previous revision for the same page if existing.
|
|
*/
|
|
public function getPrevious(): ?PageRevision
|
|
{
|
|
$id = static::newQuery()->where('page_id', '=', $this->page_id)
|
|
->where('id', '<', $this->id)
|
|
->max('id');
|
|
|
|
if ($id) {
|
|
return static::query()->find($id);
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* 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).
|
|
*
|
|
* @deprecated Use instanceof instead.
|
|
*/
|
|
public static function isA(string $type): bool
|
|
{
|
|
return $type === 'revision';
|
|
}
|
|
}
|