MarkdownPage
in package
The Markdown Page Object
Passed to the app.blade.php view through the DocumentationController, the MarkdownPage object contains information about the Page. It holds data such as the page title and the Markdown contents.
Tags
Table of Contents
- $markdown : string
- The converted Markdown as HTML
- $order : int
- The generated sidebar priority.
- $slug : string
- The page slug
- $title : string
- The page title
- __construct() : mixed
- Construct the page object
- getConvertedMarkdown() : string
- Convert the Markdown to HTML
- getOrder() : int
- Get the index of the slug.
- getTitle() : string
- Create the title from the slug
Properties
$markdown
The converted Markdown as HTML
public
string
$markdown
$order
The generated sidebar priority.
public
int
$order
Lower values are shown first.
$slug
The page slug
public
string
$slug
$title
The page title
public
string
$title
Methods
__construct()
Construct the page object
public
__construct([string $slug = 'index' ][, bool $isRealtimeRequest = false ]) : mixed
Parameters
- $slug : string = 'index'
-
of the page. Defaults to 'index'
- $isRealtimeRequest : bool = false
-
for on-the-fly generation?
Return values
mixed —getConvertedMarkdown()
Convert the Markdown to HTML
private
getConvertedMarkdown() : string
Return values
string —getOrder()
Get the index of the slug.
private
getOrder() : int
This is used to determine the priority (order) of sidebar links.
Tags
Return values
int —getTitle()
Create the title from the slug
private
getTitle() : string