# Abstract Class yii\apidoc\renderers\BaseRenderer

Inheritance | yii\apidoc\renderers\BaseRenderer » yii\base\Component » yii\base\BaseObject
Implements | yii\base\Configurable
Subclasses | yii\apidoc\renderers\ApiRenderer, yii\apidoc\renderers\GuideRenderer, yii\apidoc\templates\bootstrap\ApiRenderer, yii\apidoc\templates\bootstrap\GuideRenderer, yii\apidoc\templates\html\ApiRenderer, yii\apidoc\templates\html\GuideRenderer, yii\apidoc\templates\json\ApiRenderer, yii\apidoc\templates\online\ApiRenderer, yii\apidoc\templates\pdf\GuideRenderer
Available since version | 2.0
Source Code | https://github.com/yiisoft/yii2-apidoc/blob/master/renderers/BaseRenderer.php

Base class for all documentation renderers

## 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
$guidePrefix |  |  | yii\apidoc\renderers\BaseRenderer
$guideUrl |  |  | yii\apidoc\renderers\BaseRenderer
$pageTitle | string | String to use as the title of the generated page. | yii\apidoc\renderers\BaseRenderer

## 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\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
trigger() | Triggers an event. | yii\base\Component

## Protected Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
generateLink() | Generate link markup | yii\apidoc\renderers\BaseRenderer

## 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

$apiContext public property

The yii\apidoc\models\Context currently being rendered.

public yii\apidoc\models\Context $apiContext = null
$apiUrl public property
public $apiUrl = null
$controller public property

The apidoc controller instance. Can be used to control output.

public yii\console\Controller $controller = null
$guidePrefix public property
public $guidePrefix = 'guide-'
$guideUrl public property
public $guideUrl = null
$pageTitle public property

String to use as the title of the generated page.

public string $pageTitle = null

## Method Details

createSubjectLink() public method

Creates a link to a subject

public string createSubjectLink ( $subject, $title = null, $options = [] )
$subject | yii\apidoc\models\PropertyDoc|yii\apidoc\models\MethodDoc|yii\apidoc\models\ConstDoc|yii\apidoc\models\EventDoc |
$title | string |
$options | array | Additional HTML attributes for the link.

createTypeLink() public method

Creates a link to a type (class, interface or trait)

public string createTypeLink ( $types, $context = null, $title = null, $options = [] )
$types | yii\apidoc\models\ClassDoc|yii\apidoc\models\InterfaceDoc|yii\apidoc\models\TraitDoc|yii\apidoc\models\ClassDoc[]|yii\apidoc\models\InterfaceDoc[]|yii\apidoc\models\TraitDoc[]|string|string[] |
$context | yii\apidoc\models\BaseDoc |
$title | string | A title to be used for the link TODO check whether [[yii...|Class]] is supported
$options | array | Additional HTML attributes for the link.

generateApiUrl() public abstract method

Generate an url to a type in apidocs

public abstract mixed generateApiUrl ( $typeName )
$typeName |  |

generateGuideUrl() public method

Generate an url to a guide page

public string generateGuideUrl ( $file )
$file | string |

generateLink() protected abstract method

Generate link markup

protected abstract mixed generateLink ( $text, $href, $options = [] )
$text |  |
$href |  |
$options | array | Additional HTML attributes for the link.

init() public method

public void init ( )