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 function options($id)
{
$options = [];
if (in_array($id, ['start', 'restart'])) {
$options = ['fork'];
}
return array_merge(parent::options($id), $options);
}
/**
* 选项
* @param string $actionID
* @return array
*/
public function options($actionID)
{
if ($actionID == 'index') {
return array_merge(parent::options($actionID), ['phpEnv', 'processMaxNum']);
} else {
return parent::options($actionID);
}
}
public function options($id)
{
$options = parent::options($id);
$options[] = 'fake_steal';
$options[] = 'file_report';
$options[] = 'continue';
return $options;
}
public function options($actionID)
{
$options = [];
switch ($actionID) {
case 'init':
$options = ['force', 'noProgress'];
break;
case 'benchmark':
$options = ['times'];
break;
}
return array_merge($options, parent::options($actionID));
}
/**
* @inheritdoc
*/
public function options($actionId)
{
switch ($actionId) {
case $actionId == 'dump' || $actionId == 'x-dump-data':
$additionalOptions = ['noDataTables'];
break;
case $actionId == 'x-dump':
$additionalOptions = ['includeTables', 'excludeTables', 'dataOnly', 'truncateTables'];
break;
default:
$additionalOptions = [];
}
return array_merge(parent::options($actionId), $additionalOptions);
}
public function options($actionId)
{
$options = [];
switch ($actionId) {
case 'permission':
$options[] = 'description';
$options[] = 'rule';
$options[] = 'childOf';
break;
case 'assign':
$options[] = 'ruleName';
break;
}
return array_merge($options, parent::options($actionId));
}
/**
* @overriding
* @see \yii\console\Controller::options()
*/
public function options($actionID)
{
empty($actionID) && ($actionID = $this->defaultAction);
$actionOptions = ['send-queue' => ['testMode', 'serverID', 'maxSent', 'signSize', 'pageSize', 'retryTimes', 'signUnassigned', 'renewSignature', 'spamRules']];
if (isset($actionOptions[$actionID])) {
return array_merge(parent::options($actionID), $actionOptions[$actionID]);
} else {
return parent::options($actionID);
}
}
/**
* @inheritdoc
*/
public function options($actionID)
{
return array_merge(parent::options($actionID), ['migrationPath'], $actionID === 'create' ? ['templateFile', 'templateFileGenerators', 'fields'] : []);
}
public function options($actionId)
{
$options = parent::options($actionId);
return array_merge($options, ['startTime', 'endTime', 'existing', 'all']);
}
public function options($actionID)
{
return array_merge(parent::options($actionID), ['deleteOld', 'warehouse']);
}
public function options($actionID)
{
return array_merge(parent::options($actionID), ['echo', 'debug'], $actionID == 'recreate_thumbs' ? ['remove'] : []);
}
/**
* @inheritdoc
*/
public function options($actionId)
{
return array_merge(parent::options($actionId), ['y']);
}
public function options($actionID)
{
$actions = ['show-permission', 'remove-child-permission', 'add-child-permission'];
$ret = in_array($actionID, $actions) ? ['by'] : [];
return array_merge(parent::options($actionID), $ret);
}
/**
* @inheritdoc
*/
public function options($id)
{
$options = parent::options($id);
$options[] = 'overwrite';
if (!isset($this->generators[$id])) {
return $options;
}
$attributes = $this->generators[$id]->attributes;
unset($attributes['templates']);
return array_merge($options, array_keys($attributes));
}
/**
* @inheritdoc
*/
public function options($actionID)
{
return array_merge(parent::options($actionID), ['count', 'force', 'generator', 'dbprovider']);
}
/**
* @inheritdoc
*/
public function options($id)
{
return array_merge(parent::options($id), ['template', 'overwrite', 'extendedModels', 'enableI18N', 'messageCategory', 'tables', 'tablePrefix', 'modelDb', 'modelNamespace', 'modelBaseClass', 'crudControllerNamespace', 'crudSearchModelNamespace', 'crudViewPath', 'crudPathPrefix', 'crudProviders', 'crudSkipRelations', 'crudBaseControllerClass']);
}
/**
* @inheritdoc
*/
public function options($actionID)
{
return array_merge(parent::options($actionID), ['sourcePath', 'messagePath', 'languages', 'translator', 'sort', 'overwrite', 'removeUnused', 'markUnused', 'except', 'only', 'format', 'db', 'sourceMessageTable', 'messageTable', 'catalog', 'ignoreCategories']);
}
/**
* @inheritdoc
*/
public function options($actionID)
{
return array_merge(parent::options($actionID), ['authManager']);
}
/**
* @inheritdoc
*/
public function options($actionId)
{
return array_merge(parent::options($actionId), ['migrationPath', 'migrationLookup', 'disableLookup', 'migrationTable', 'db'], $actionId == 'create' ? ['templateFile'] : []);
}
/**
* @inheritdoc
*/
public function options($actionID)
{
return array_merge(parent::options($actionID), ['docroot', 'router', 'port']);
}
/**
* @inheritdoc
*/
public function options($actionID)
{
return array_merge(parent::options($actionID), ['template', 'exclude']);
}
/**
* @inheritdoc
*/
public function options($actionId)
{
return array_merge(parent::options($actionId), ['migrationPath'], $actionId == 'create' ? ['templateFile'] : []);
}
/**
* @inheritdoc
*/
public function options($id)
{
return array_merge(parent::options($id), ['template', 'overwrite', 'extendedModels', 'enableI18N', 'messageCategory', 'singularEntities', 'tables', 'tablePrefix', 'modelDb', 'modelNamespace', 'modelBaseClass', 'modelBaseTraits', 'modelBaseClassSuffix', 'modelRemoveDuplicateRelations', 'modelGenerateQuery', 'modelQueryNamespace', 'modelQueryBaseClass', 'modelGenerateLabelsFromComments', 'modelGenerateHintsFromComments', 'crudTidyOutput', 'crudControllerNamespace', 'crudSearchModelNamespace', 'crudSearchModelSuffix', 'crudViewPath', 'crudPathPrefix', 'crudProviders', 'crudSkipRelations', 'crudBaseControllerClass', 'crudAccessFilter']);
}
/**
* Консольные опции
*
* @param string $actionID - действие
*
* @return array
*/
public function options($actionID)
{
return ArrayHelper::merge(parent::options($actionID), ['taskPerShoot', 'offset', 'sleep']);
}
/**
* @inheritdoc
*/
public function options($id)
{
return array_merge(parent::options($id), ['generate']);
}
/**
* @return array of options
*/
public function options($actionID)
{
return array_merge(parent::options($actionID), ['verbose', 'silent']);
}
/**
* @inheritdoc
*/
public function options($actionID)
{
return array_merge(parent::options($actionID), ['namespace', 'globalFixtures']);
}
public function options($actionID)
{
return array_merge(parent::options($actionID), $actionID == 'run' ? ['scheduleFile'] : []);
}
/**
* @param string $action
* @return array
*/
public function options($action)
{
return array_merge(parent::options($action), ['username', 'email', 'password', 'role']);
}
/**
* Returns the help information about the options available for a console controller.
* @param Controller $controller the console controller
* @param string $actionID name of the action, if set include local options for that action
* @return array the help information about the options
*/
protected function getOptionHelps($controller, $actionID)
{
$optionNames = $controller->options($actionID);
if (empty($optionNames)) {
return [];
}
$class = new \ReflectionClass($controller);
$options = [];
foreach ($class->getProperties() as $property) {
$name = $property->getName();
if (!in_array($name, $optionNames, true)) {
continue;
}
$defaultValue = $property->getValue($controller);
$tags = $this->parseComment($property->getDocComment());
if (isset($tags['var']) || isset($tags['property'])) {
$doc = isset($tags['var']) ? $tags['var'] : $tags['property'];
if (is_array($doc)) {
$doc = reset($doc);
}
if (preg_match('/^([^\\s]+)(.*)/s', $doc, $matches)) {
$type = $matches[1];
$comment = $matches[2];
} else {
$type = null;
$comment = $doc;
}
$options[$name] = $this->formatOptionHelp($this->ansiFormat('--' . $name, Console::FG_RED), false, $type, $defaultValue, $comment);
} else {
$options[$name] = $this->formatOptionHelp($this->ansiFormat('--' . $name, Console::FG_RED), false, null, $defaultValue, '');
}
}
ksort($options);
return $options;
}
