PHP Class Devise\Pages\Docs\Creator

Show file Open project: devisephp/cms

Public Methods

Method Description
__construct ( LiveSpan $LiveSpan, Framework $Framework, CommonMarkConverter $MarkdownConverter ) [__construct description]
deviseDocs ( string $viewPath ) : string Returns devise docs for the sidebar for this view path

Protected Methods

Method Description
getDocView ( string $viewPath ) : View Returns the doc view if there is one

Method Details

__construct() public method

[__construct description]
public __construct ( LiveSpan $LiveSpan, Framework $Framework, CommonMarkConverter $MarkdownConverter )
$LiveSpan LiveSpan
$Framework Devise\Support\Framework
$MarkdownConverter League\CommonMark\CommonMarkConverter

deviseDocs() public method

Returns devise docs for the sidebar for this view path
public deviseDocs ( string $viewPath ) : string
$viewPath string
return string

getDocView() protected method

Returns the doc view if there is one
protected getDocView ( string $viewPath ) : View
$viewPath string
return View