Class schmunk42\markdocs\Module

Inheritanceschmunk42\markdocs\Module » yii\base\Module

Markdown parser module

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$cachingTime integer Value in seconds, how long to cache generated HTML schmunk42\markdocs\Module
$defaultIndexFile string Default markdown index file schmunk42\markdocs\Module
$defaultRoute schmunk42\markdocs\Module
$enableEmojis bool Whether to convert emoji syntax to images schmunk42\markdocs\Module
$forkUrl string URL for fork link on bottom of page schmunk42\markdocs\Module
$markdownUrl string Url or local alias with markdown files schmunk42\markdocs\Module

Public Methods

Hide inherited methods

MethodDescriptionDefined By
behaviors() Restrict access permissions to admin user and users with auth-item 'module[_controller[_action]]' schmunk42\markdocs\Module
init() Try configuration from settings module, if a value is not set schmunk42\markdocs\Module

Property Details

$cachingTime public property

Value in seconds, how long to cache generated HTML

public integer $cachingTime 1
$defaultIndexFile public property

Default markdown index file

public string $defaultIndexFile null
$defaultRoute public property
public $defaultRoute 'default/index'
$enableEmojis public property

Whether to convert emoji syntax to images

public bool $enableEmojis false
$forkUrl public property

URL for fork link on bottom of page

public string $forkUrl null
$markdownUrl public property

Url or local alias with markdown files

public string $markdownUrl null

Method Details

behaviors() public method

Restrict access permissions to admin user and users with auth-item 'module[_controller[_action]]'

public void behaviors ( )
init() public method

Try configuration from settings module, if a value is not set

public void init ( )