Abstract Class yii\apidoc\renderers\GuideRenderer

Inheritanceyii\apidoc\renderers\GuideRenderer » yii\apidoc\renderers\BaseRenderer » yii\base\Component » yii\base\Object
Implementsyii\base\Configurable
Subclassesyii\apidoc\templates\bootstrap\GuideRenderer, yii\apidoc\templates\html\GuideRenderer, yii\apidoc\templates\pdf\GuideRenderer
Available since version2.0
Source Code https://github.com/yiisoft/yii2-apidoc/blob/master/renderers/GuideRenderer.php

Base class for all Guide documentation renderers

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\Component
__clone() This method is called after the object is created by cloning an existing one. yii\base\Component
__construct() Constructor. yii\base\Object
__get() Returns the value of a component property. yii\base\Component
__isset() Checks if a property is set, i.e. defined and not null. yii\base\Component
__set() Sets the value of a component property. yii\base\Component
__unset() Sets a component property to be null. yii\base\Component
attachBehavior() Attaches a behavior to this component. yii\base\Component
attachBehaviors() Attaches a list of behaviors to the component. yii\base\Component
behaviors() Returns a list of behaviors that this component should behave as. yii\base\Component
canGetProperty() Returns a value indicating whether a property can be read. yii\base\Component
canSetProperty() Returns a value indicating whether a property can be set. yii\base\Component
className() Returns the fully qualified name of this class. yii\base\Object
createSubjectLink() Creates a link to a subject yii\apidoc\renderers\BaseRenderer
createTypeLink() Creates a link to a type (class, interface or trait) yii\apidoc\renderers\BaseRenderer
detachBehavior() Detaches a behavior from the component. yii\base\Component
detachBehaviors() Detaches all behaviors from the component. yii\base\Component
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component. yii\base\Component
generateApiUrl() Generate an url to a type in apidocs yii\apidoc\renderers\BaseRenderer
generateGuideUrl() Generate an url to a guide page yii\apidoc\renderers\BaseRenderer
getBehavior() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
hasEventHandlers() Returns a value indicating whether there is any handler attached to the named event. yii\base\Component
hasMethod() Returns a value indicating whether a method is defined. yii\base\Component
hasProperty() Returns a value indicating whether a property is defined for this component. yii\base\Component
init() yii\apidoc\renderers\BaseRenderer
off() Detaches an existing event handler from this component. yii\base\Component
on() Attaches an event handler to an event. yii\base\Component
render() Render markdown files yii\apidoc\renderers\GuideRenderer
trigger() Triggers an event. yii\base\Component

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
generateLink() Generate link markup yii\apidoc\renderers\BaseRenderer
loadGuideStructure() Loads guide structure from a set of files yii\apidoc\renderers\GuideRenderer

Constants

Hide inherited constants

ConstantValueDescriptionDefined By
GUIDE_PREFIX 'guide-' Deprecated since 2.0.1 use $guidePrefix instead which allows configuring this options yii\apidoc\renderers\BaseRenderer

Method Details

loadGuideStructure() protected method

Loads guide structure from a set of files

protected array loadGuideStructure ( $files )
$files array
render() public abstract method

Render markdown files

public abstract void render ( $files, $targetDir )
$files array

List of markdown files to render

$targetDir