-<?php namespace BookStack\Entities\Models;
+<?php
+
+namespace BookStack\Entities\Models;
use BookStack\Auth\User;
-use BookStack\Entities\Models\Page;
use BookStack\Model;
use Carbon\Carbon;
/**
- * Class PageRevision
- * @property int $page_id
+ * Class PageRevision.
+ *
+ * @property int $page_id
* @property string $slug
* @property string $book_slug
- * @property int $created_by
+ * @property int $created_by
* @property Carbon $created_at
* @property string $type
* @property string $summary
* @property string $markdown
* @property string $html
- * @property int $revision_number
+ * @property int $revision_number
*/
class PageRevision extends Model
{
protected $fillable = ['name', 'html', 'text', 'markdown', 'summary'];
/**
- * Get the user that created the page revision
+ * Get the user that created the page revision.
+ *
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
public function createdBy()
/**
* Get the page this revision originates from.
+ *
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
public function page()
/**
* Get the url for this revision.
+ *
* @param null|string $path
+ *
* @return string
*/
public function getUrl($path = null)
if ($path) {
return $url . '/' . trim($path, '/');
}
+
return $url;
}
/**
- * Get the previous revision for the same page if existing
+ * Get the previous revision for the same page if existing.
+ *
* @return \BookStack\Entities\PageRevision|null
*/
public function getPrevious()
/**
* 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)
+ * (Yup, Bit of an awkward hack).
+ *
* @param $type
+ *
* @return bool
*/
public static function isA($type)