Class yii\console\controllers\ServeController

继承yii\console\controllers\ServeController » yii\console\Controller » yii\base\Controller » yii\base\Component » yii\base\BaseObject
实现yii\base\Configurable, yii\base\ViewContextInterface
可用自版本2.0.7
源代码 https://github.com/yiisoft/yii2/blob/master/framework/console/controllers/ServeController.php

Runs PHP built-in web server.

In order to access server from remote machines use 0.0.0.0:8000. That is especially useful when running server in a virtual machine.

公共属性

隐藏继承的属性

属性类型描述定义在
$action yii\base\Action The action that is currently being executed. yii\base\Controller
$behaviors yii\base\Behavior[] 附加到此组件的行为列表. yii\base\Component
$color boolean 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
$docroot string Path or path alias to directory to serve yii\console\controllers\ServeController
$help boolean Whether to display help information about current command. yii\console\Controller
$helpSummary string 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
$modules yii\base\Module[] All ancestor modules that this controller is located within. yii\base\Controller
$passedOptionValues array The properties corresponding to the passed options yii\console\Controller
$passedOptions array The names of the options passed during execution yii\console\Controller
$port integer Port to serve on. yii\console\controllers\ServeController
$route string The route (module ID, controller ID and action ID) of the current request. yii\base\Controller
$router string Path to router script. yii\console\controllers\ServeController
$uniqueId string The controller ID that is prefixed with the module ID (if any). yii\base\Controller
$view yii\base\View|yii\web\View The view object that can be used to render views or view files. yii\base\Controller
$viewPath string The directory containing the view files for this controller. yii\base\Controller

公共方法

隐藏继承的方法

方法描述定义在
__call() 调用不是类方法的指定的方法. yii\base\Component
__clone() 在通过克隆现有对象创建对象之后调用此方法. yii\base\Component
__construct() yii\base\Controller
__get() 返回组件属性的值. yii\base\Component
__isset() 检查属性是否已设置, 即已定义且不为null. yii\base\Component
__set() 设置组件属性的值. yii\base\Component
__unset() 将组件属性设置为null. yii\base\Component
actionIndex() Runs PHP built-in web server. yii\console\controllers\ServeController
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() 将行为附加到此组件. yii\base\Component
attachBehaviors() 将行为列表附加到组件. yii\base\Component
beforeAction() This method is invoked right before an action is executed. yii\base\Controller
behaviors() 返回此组件应该具有的行为列表. yii\base\Component
bindActionParams() Binds the parameters to the action. yii\console\Controller
canGetProperty() 返回一个值, 指示属性是否可读取. yii\base\Component
canSetProperty() 返回一个值, 指示属性是否可设置. yii\base\Component
className() 返回此类的完全限定名称. 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() 从组件中分离一个行为. yii\base\Component
detachBehaviors() 分离组件中的所有行为. yii\base\Component
ensureBehaviors() 确保在 behaviors() 中声明的行为已附加到此组件. 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() 返回指定的行为对象. yii\base\Component
getBehaviors() 返回附加到此组件的所有行为. 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() Returns the directory containing view files for this controller. yii\base\Controller
hasEventHandlers() 返回一个值, 指示是否有任何处理程序附加到指定的事件. yii\base\Component
hasMethod() 返回一个值, 指示方法是否已定义. yii\base\Component
hasProperty() 返回一个值, 指示属性是否已定义. yii\base\Component
init() 初始化对象. yii\base\BaseObject
isColorEnabled() Returns a value indicating whether ANSI color is enabled. yii\console\Controller
off() 从该组件分离现有的事件处理程序. yii\base\Component
on() 将事件处理程序附加到事件. yii\base\Component
optionAliases() Returns option alias names. yii\console\controllers\ServeController
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\console\controllers\ServeController
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() 触发事件. yii\base\Component

事件

隐藏继承的事件

事件类型描述定义在
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

常量

隐藏继承的常量

常量描述定义在
EXIT_CODE_ADDRESS_TAKEN_BY_ANOTHER_PROCESS 5 yii\console\controllers\ServeController
EXIT_CODE_ADDRESS_TAKEN_BY_ANOTHER_SERVER 4 yii\console\controllers\ServeController
EXIT_CODE_ERROR 1 Deprecated since 2.0.13. Use \yii\console\controllers\ExitCode::UNSPECIFIED_ERROR instead. yii\console\Controller
EXIT_CODE_NORMAL 0 Deprecated since 2.0.13. Use \yii\console\controllers\ExitCode::OK instead. yii\console\Controller
EXIT_CODE_NO_DOCUMENT_ROOT 2 yii\console\controllers\ServeController
EXIT_CODE_NO_ROUTING_FILE 3 yii\console\controllers\ServeController

属性详情

$docroot public 属性

Path or path alias to directory to serve

public string $docroot '@app/web'
$port public 属性

Port to serve on.

public integer $port 8080
$router public 属性
public string $router null

方法详情

actionIndex() public 方法

Runs PHP built-in web server.

public integer actionIndex ( $address 'localhost' )
$address string

Address to serve on. Either "host" or "host:port".

isAddressTaken() protected 方法

protected boolean isAddressTaken ( $address )
$address string

Server address

return boolean

If address is already in use

optionAliases() public 方法 (可用自版本: 2.0.8)

Returns option alias names.

Child classes may override this method to specify alias options.

public array optionAliases ( )
return array

The options alias names valid for the action where the keys is alias name for option and value is option name.

options() public 方法

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