# Class yii\apidoc\templates\bootstrap\GuideRenderer

Inheritance | yii\apidoc\templates\bootstrap\GuideRenderer » yii\apidoc\templates\html\GuideRenderer » yii\apidoc\renderers\GuideRenderer » yii\apidoc\renderers\BaseRenderer » yii\base\Component » yii\base\BaseObject
Implements | yii\base\Configurable
Uses Traits | yii\apidoc\templates\bootstrap\RendererTrait
Available since version | 2.0
Source Code | https://github.com/yiisoft/yii2-apidoc/blob/master/templates/bootstrap/GuideRenderer.php

## Public Properties

Hide inherited properties

Property | Type | Description | Defined By
--- | --- | --- | ---
$apiContext | yii\apidoc\models\Context | The yii\apidoc\models\Context currently being rendered. | yii\apidoc\renderers\BaseRenderer
$apiUrl |  |  | yii\apidoc\renderers\BaseRenderer
$behaviors | yii\base\Behavior[] | List of behaviors attached to this component. This property is read-only. | yii\base\Component
$controller | yii\console\Controller | The apidoc controller instance. | yii\apidoc\renderers\BaseRenderer
$extensions | array | Official Yii extensions | yii\apidoc\templates\bootstrap\RendererTrait
$guidePrefix |  |  | yii\apidoc\renderers\BaseRenderer
$guideReferences |  |  | yii\apidoc\templates\html\GuideRenderer
$guideUrl |  |  | yii\apidoc\renderers\BaseRenderer
$layout |  |  | yii\apidoc\templates\bootstrap\GuideRenderer
$pageTitle | string | String to use as the title of the generated page. | yii\apidoc\renderers\BaseRenderer
$view | yii\web\View | The view instance. This property is read-only. | yii\apidoc\templates\html\GuideRenderer

## Public Methods

Hide inherited methods

Method | Description | Defined 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\BaseObject
__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\BaseObject
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\templates\html\GuideRenderer
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
getGuideReferences() |  | yii\apidoc\templates\html\GuideRenderer
getNavTypes() | Returns nav TypeDocs | yii\apidoc\templates\bootstrap\RendererTrait
getView() |  | yii\apidoc\templates\html\GuideRenderer
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\templates\html\GuideRenderer
off() | Detaches an existing event handler from this component. | yii\base\Component
on() | Attaches an event handler to an event. | yii\base\Component
render() | Renders a set of files given into target directory. | yii\apidoc\templates\bootstrap\GuideRenderer
trigger() | Triggers an event. | yii\base\Component

## Protected Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
afterMarkdownProcess() | Callback that is called after markdown is processed. | yii\apidoc\templates\html\GuideRenderer
filterTypes() | Returns types of a given class | yii\apidoc\templates\bootstrap\RendererTrait
fixMarkdownLinks() | Adds guide name to link URLs in markdown | yii\apidoc\templates\html\GuideRenderer
generateGuideFileName() | Given markdown file name generates resulting html file name | yii\apidoc\templates\html\GuideRenderer
generateLink() | Generate link markup | yii\apidoc\templates\html\GuideRenderer
getTypeCategory() | Returns category of TypeDoc | yii\apidoc\templates\bootstrap\RendererTrait
loadGuideStructure() | Loads guide structure from a set of files | yii\apidoc\renderers\GuideRenderer

## Constants

Hide inherited constants

Constant | Value | Description | Defined By
--- | --- | --- | ---
GUIDE_PREFIX | 'guide-' | Deprecated since 2.0.1 use $guidePrefix instead which allows configuring this options | yii\apidoc\renderers\BaseRenderer

## Property Details

$layout public property
public $layout = '@yii/apidoc/templates/bootstrap/layouts/guide.php'

## Method Details

render() public method

Renders a set of files given into target directory.

public void render ( $files, $targetDir )
$files | array |
$targetDir | string |