PHP Class BookStack\Book

Inheritance: extends Entity

Show file Open project: ssddanbrown/bookstack Class Usage Examples

Protected Properties

Property	Type	Description
$fillable

Public Methods

Method	Description
chapters ( ) : Illuminate\Database\Eloquent\Relations\HasMany	Get all chapters within this book.
getEditUrl ( )	* Get the edit url for this book.
getExcerpt ( integer $length = 100 ) : string	Get an excerpt of this book's description to the specified length or less.
getUrl ( string \| boolean $path = false ) : string	Get the url for this book.
pages ( ) : Illuminate\Database\Eloquent\Relations\HasMany	Get all pages within this book.

Method Details

chapters() public method

Get all chapters within this book.

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

getEditUrl() public method

* Get the edit url for this book.

public getEditUrl ( )

getExcerpt() public method

Get an excerpt of this book's description to the specified length or less.

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

getUrl() public method

Get the url for this book.

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

pages() public method

Get all pages within this book.

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

Property Details

$fillable protected property

protected $fillable