PHP Class BookStack\Chapter

Inheritance: extends Entity
ファイルを表示 Open project: ssddanbrown/bookstack Class Usage Examples

Protected Properties

Property Type Description
$fillable

Public Methods

Method Description
book ( ) : BelongsTo Get the book this chapter is within.
getExcerpt ( integer $length = 100 ) : string Get an excerpt of this chapter's description to the specified length or less.
getUrl ( string | boolean $path = false ) : string Get the url of this chapter.
pages ( ) : mixed Get the pages that this chapter contains.

Method Details

book() public method

Get the book this chapter is within.
public book ( ) : BelongsTo
return Illuminate\Database\Eloquent\Relations\BelongsTo

getExcerpt() public method

Get an excerpt of this chapter's description to the specified length or less.
public getExcerpt ( integer $length = 100 ) : string
$length integer
return string

getUrl() public method

Get the url of this chapter.
public getUrl ( string | boolean $path = false ) : string
$path string | boolean
return string

pages() public method

Get the pages that this chapter contains.
public pages ( ) : mixed
return mixed

Property Details

$fillable protected_oe property

protected $fillable