PHP Class BookStack\Page

Inheritance: extends Entity

Protected Properties

Property	Type	Description
$fillable
$simpleAttributes

Method	Description
attachments ( ) : Illuminate\Database\Eloquent\Relations\HasMany	Get the attachments assigned to this page.
book ( ) : BelongsTo	Get the book this page sits in.
chapter ( ) : BelongsTo	Get the chapter that this page is in, If applicable.
getExcerpt ( integer $length = 100 ) : mixed	Get an excerpt of this page's content to the specified length.
getUrl ( string \| boolean $path = false ) : string	Get the url for this page.
hasChapter ( ) : boolean	Check if this page has a chapter.
revisions ( ) : mixed	Get the associated page revisions, ordered by created date.
toSimpleArray ( ) : mixed	Converts this page into a simplified array.

Get the attachments assigned to this page.

public attachments ( ) : Illuminate\Database\Eloquent\Relations\HasMany
return	Illuminate\Database\Eloquent\Relations\HasMany

Get the book this page sits in.

public book ( ) : BelongsTo
return	Illuminate\Database\Eloquent\Relations\BelongsTo

Get the chapter that this page is in, If applicable.

public chapter ( ) : BelongsTo
return	Illuminate\Database\Eloquent\Relations\BelongsTo

Get an excerpt of this page's content to the specified length.

public getExcerpt ( integer $length = 100 ) : mixed
$length	integer
return	mixed

Get the url for this page.

public getUrl ( string \| boolean $path = false ) : string
$path	string \| boolean
return	string

Check if this page has a chapter.

public hasChapter ( ) : boolean
return	boolean

Get the associated page revisions, ordered by created date.

public revisions ( ) : mixed
return	mixed

Converts this page into a simplified array.

public toSimpleArray ( ) : mixed
return	mixed

protected $fillable

protected $simpleAttributes