yii\console\Controller::getActionHelpSummary PHP Method

getActionHelpSummary() public method

Returns a one-line short summary describing the specified action.
public getActionHelpSummary ( Action $action ) : string
$action yii\base\Action action to get summary for
return string a one-line short summary describing the specified action.
    public function getActionHelpSummary($action)
    {
        return $this->parseDocCommentSummary($this->getActionMethodReflection($action));
    }

Usage Example

 /**
  * @inheritdoc
  */
 public function getActionHelpSummary($action)
 {
     if ($action instanceof InlineAction) {
         return parent::getActionHelpSummary($action);
     } else {
         /** @var $action GenerateAction */
         return $action->generator->getName();
     }
 }