PHP Class BookStack\Page

Inheritance: extends Entity
Afficher le fichier Open project: ssddanbrown/bookstack Class Usage Examples

Protected Properties

Свойство Type Description
$fillable
$simpleAttributes

Méthodes publiques

Méthode 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.

Method Details

attachments() public méthode

Get the attachments assigned to this page.
public attachments ( ) : Illuminate\Database\Eloquent\Relations\HasMany
Résultat Illuminate\Database\Eloquent\Relations\HasMany

book() public méthode

Get the book this page sits in.
public book ( ) : BelongsTo
Résultat Illuminate\Database\Eloquent\Relations\BelongsTo

chapter() public méthode

Get the chapter that this page is in, If applicable.
public chapter ( ) : BelongsTo
Résultat Illuminate\Database\Eloquent\Relations\BelongsTo

getExcerpt() public méthode

Get an excerpt of this page's content to the specified length.
public getExcerpt ( integer $length = 100 ) : mixed
$length integer
Résultat mixed

getUrl() public méthode

Get the url for this page.
public getUrl ( string | boolean $path = false ) : string
$path string | boolean
Résultat string

hasChapter() public méthode

Check if this page has a chapter.
public hasChapter ( ) : boolean
Résultat boolean

revisions() public méthode

Get the associated page revisions, ordered by created date.
public revisions ( ) : mixed
Résultat mixed

toSimpleArray() public méthode

Converts this page into a simplified array.
public toSimpleArray ( ) : mixed
Résultat mixed

Property Details

$fillable protected_oe property

protected $fillable

$simpleAttributes protected_oe property

protected $simpleAttributes