Class yii\apidoc\commands\GuideController
| Inheritance | yii\apidoc\commands\GuideController » yii\apidoc\components\BaseController » yii\console\Controller » yii\base\Controller » yii\base\Component » yii\base\BaseObject |
|---|---|
| Implements | yii\base\Configurable, yii\base\ViewContextInterface |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2-apidoc/blob/master/commands/GuideController.php |
This command can render documentation stored as markdown files such as the yii guide or your own applications documentation setup.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $action | yii\base\Action|null | The action that is currently being executed. | yii\base\Controller |
| $apiDocs | string | Path or URL to the api docs to allow links to classes and properties/methods. | yii\apidoc\commands\GuideController |
| $color | boolean|null | Whether to enable ANSI color in the output. | yii\console\Controller |
| $defaultAction | string | The ID of the action that is used when the action ID is not specified in the request. | yii\base\Controller |
| $exclude | string|array | Files to exclude. | yii\apidoc\components\BaseController |
| $guidePrefix | string | Prefix to prepend to all output file names generated for the guide. | yii\apidoc\commands\GuideController |
| $help | boolean | Whether to display help information about current command. | yii\console\Controller |
| $id | string | The ID of this controller. | yii\base\Controller |
| $interactive | boolean | Whether to run the command interactively. | yii\console\Controller |
| $layout | null|string|false | The name of the layout to be applied to this controller's views. | yii\base\Controller |
| $module | yii\base\Module | The module that this controller belongs to. | yii\base\Controller |
| $pageTitle | string | Page title | yii\apidoc\components\BaseController |
| $request | yii\base\Request|array|string | The request. | yii\base\Controller |
| $response | yii\base\Response|array|string | The response. | yii\base\Controller |
| $silentExitOnException | boolean|null | If true - script finish with ExitCode::OK in case of exception. |
yii\console\Controller |
| $template | string | Template to use for rendering | yii\apidoc\components\BaseController |
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() | yii\base\Controller | |
| __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 |
| actionIndex() | Renders API documentation files | yii\apidoc\commands\GuideController |
| actions() | Declares external actions for the controller. | yii\base\Controller |
| afterAction() | This method is invoked right after an action is executed. | yii\base\Controller |
| ansiFormat() | Formats a string with ANSI codes. | yii\console\Controller |
| attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
| attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
| beforeAction() | {@inheritdoc} | yii\console\Controller |
| behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component |
| bindActionParams() | Binds the parameters to the action. | yii\console\Controller |
| 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 |
| confirm() | Asks user to confirm by typing y or n. | yii\console\Controller |
| createAction() | Creates an action based on the given action ID. | yii\base\Controller |
| 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 |
| findLayoutFile() | Finds the applicable layout file. | yii\base\Controller |
| getActionArgsHelp() | Returns the help information for the anonymous arguments for the action. | yii\console\Controller |
| getActionHelp() | Returns the detailed help information for the specified action. | yii\console\Controller |
| getActionHelpSummary() | Returns a one-line short summary describing the specified action. | yii\console\Controller |
| getActionOptionsHelp() | Returns the help information for the options for the action. | yii\console\Controller |
| getBehavior() | Returns the named behavior object. | yii\base\Component |
| getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
| getHelp() | Returns help information for this controller. | yii\console\Controller |
| getHelpSummary() | Returns one-line short summary describing this controller. | yii\console\Controller |
| getModules() | Returns all ancestor modules of this controller. | yii\base\Controller |
| getOptionValues() | Returns properties corresponding to the options for the action id Child classes may override this method to specify possible properties. | yii\console\Controller |
| getPassedOptionValues() | Returns the properties corresponding to the passed options. | yii\console\Controller |
| getPassedOptions() | Returns the names of valid options passed during execution. | yii\console\Controller |
| getRoute() | Returns the route of the current request. | yii\base\Controller |
| getUniqueId() | Returns the unique ID of the controller. | yii\base\Controller |
| getView() | Returns the view object that can be used to render views or view files. | yii\base\Controller |
| getViewPath() | yii\base\ViewContextInterface | |
| 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() | {@inheritdoc} | yii\base\Controller |
| isColorEnabled() | Returns a value indicating whether ANSI color is enabled. | yii\console\Controller |
| off() | Detaches an existing event handler from this component. | yii\base\Component |
| on() | Attaches an event handler to an event. | yii\base\Component |
| optionAliases() | Returns option alias names. | yii\console\Controller |
| options() | Returns the names of valid options for the action (id) An option requires the existence of a public member variable whose name is the option name. | yii\apidoc\commands\GuideController |
| prompt() | Prompts the user for input and validates it. | yii\console\Controller |
| render() | Renders a view and applies layout if available. | yii\base\Controller |
| renderContent() | Renders a static string by applying a layout. | yii\base\Controller |
| renderFile() | Renders a view file. | yii\base\Controller |
| renderPartial() | Renders a view without applying layout. | yii\base\Controller |
| run() | Runs a request specified in terms of a route. | yii\base\Controller |
| runAction() | Runs an action with the specified action ID and parameters. | yii\console\Controller |
| select() | Gives the user an option to choose from. Giving '?' as an input will show a list of options to choose from and their explanations. | yii\console\Controller |
| setView() | Sets the view object to be used by this controller. | yii\base\Controller |
| setViewPath() | Sets the directory that contains the view files. | yii\base\Controller |
| stderr() | Prints a string to STDERR. | yii\console\Controller |
| stdout() | Prints a string to STDOUT. | yii\console\Controller |
| trigger() | Triggers an event. | yii\base\Component |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| bindInjectedParams() | Fills parameters based on types and names in action method signature. | yii\base\Controller |
| findFiles() | Finds files | yii\apidoc\commands\GuideController |
| findRenderer() | yii\apidoc\commands\GuideController | |
| getActionMethodReflection() | yii\console\Controller | |
| loadContext() | Loads context from cache | yii\apidoc\components\BaseController |
| normalizeTargetDir() | Checks that target directory is valid. Asks questions in tricky cases. | yii\apidoc\components\BaseController |
| parseDocCommentDetail() | Returns full description from the docblock. | yii\console\Controller |
| parseDocCommentSummary() | Returns the first line of docblock. | yii\console\Controller |
| parseDocCommentTags() | Parses the comment block into tags. | yii\console\Controller |
| searchFiles() | Finds files to process | yii\apidoc\components\BaseController |
| storeContext() | Writes context into cache file | yii\apidoc\components\BaseController |
| updateContext() | yii\apidoc\components\BaseController |
Events
| Event | Type | Description | Defined By |
|---|---|---|---|
| EVENT_AFTER_ACTION | yii\base\ActionEvent | An event raised right after executing a controller action. | yii\base\Controller |
| EVENT_BEFORE_ACTION | yii\base\ActionEvent | An event raised right before executing a controller action. | yii\base\Controller |
Constants
| Constant | Value | Description | Defined By |
|---|---|---|---|
| EXIT_CODE_ERROR | 1 | Deprecated since 2.0.13. Use \yii\apidoc\commands\ExitCode::UNSPECIFIED_ERROR instead. | yii\console\Controller |
| EXIT_CODE_NORMAL | 0 | Deprecated since 2.0.13. Use \yii\apidoc\commands\ExitCode::OK instead. | yii\console\Controller |
Property Details
Path or URL to the api docs to allow links to classes and properties/methods.
Prefix to prepend to all output file names generated for the guide.
Method Details
Renders API documentation files
| public integer actionIndex ( array $sourceDirs, $targetDir ) | ||
| $sourceDirs | array | |
| $targetDir | string | |
| return | integer | Status code. |
|---|---|---|
Finds files
| protected array findFiles ( $path, $except = [] ) | ||
| $path | ||
| $except | array | List of names to exclude from search. |
| return | array | Files found. |
|---|---|---|
| protected yii\apidoc\renderers\GuideRenderer findRenderer ( $template ) | ||
| $template | string | |
Returns the names of valid options for the action (id) An option requires the existence of a public member variable whose name is the option name.
Child classes may override this method to specify possible options.
Note that the values setting via options are not available until beforeAction() is being called.
| public string[] options ( $actionID ) | ||
| $actionID | string | The action id of the current request |
| return | string[] | The names of the options valid for the action |
|---|---|---|