Abstract Class yii\apidoc\templates\html\GuideRenderer
| Inheritance | yii\apidoc\templates\html\GuideRenderer » yii\apidoc\renderers\GuideRenderer » yii\apidoc\renderers\BaseRenderer » yii\base\Component » yii\base\BaseObject |
|---|---|
| Implements | yii\base\Configurable |
| Subclasses | yii\apidoc\templates\bootstrap\GuideRenderer, yii\apidoc\templates\pdf\GuideRenderer |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2-apidoc/blob/master/templates/html/GuideRenderer.php |
Public 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 | ||
| $controller | yii\console\Controller | The apidoc controller instance. | yii\apidoc\renderers\BaseRenderer |
| $guidePrefix | yii\apidoc\renderers\BaseRenderer | ||
| $guideUrl | yii\apidoc\renderers\BaseRenderer | ||
| $layout | yii\apidoc\templates\html\GuideRenderer | ||
| $pageTitle | string | String to use as the title of the generated page. | yii\apidoc\renderers\BaseRenderer |
Public 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 | |
| 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\html\GuideRenderer |
| trigger() | Triggers an event. | yii\base\Component |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| afterMarkdownProcess() | Callback that is called after markdown is processed. | yii\apidoc\templates\html\GuideRenderer |
| 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 |
| loadGuideStructure() | Loads guide structure from a set of files | yii\apidoc\renderers\GuideRenderer |
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
Method Details
Callback that is called after markdown is processed.
You may override it to do some post processing. The default implementation fixes some markdown links using fixMarkdownLinks() on the output.
| protected string afterMarkdownProcess ( $file, $output, $renderer ) | ||
| $file | string | The file that has been processed. |
| $output | string | The rendered HTML output. |
| $renderer | yii\apidoc\helpers\ApiMarkdown | The renderer instance. |
Adds guide name to link URLs in markdown
| protected string fixMarkdownLinks ( $content ) | ||
| $content | string | |
Generate an url to a type in apidocs
| public mixed generateApiUrl ( $typeName ) | ||
| $typeName | ||
Given markdown file name generates resulting html file name
| protected string generateGuideFileName ( $file ) | ||
| $file | string | Markdown file name |
Generate link markup
| protected mixed generateLink ( $text, $href, $options = [] ) | ||
| $text | ||
| $href | ||
| $options | array | Additional HTML attributes for the link. |
| public void getGuideReferences ( ) |
| public yii\web\View getView ( ) | ||
| return | yii\web\View | The view instance |
|---|---|---|
| public void init ( ) |
Renders a set of files given into target directory.
| public void render ( $files, $targetDir ) | ||
| $files | array | |
| $targetDir | string | |