getOptionsDescription() public method

public getOptionsDescription ( ) : array
return array
Example #1
0
 public function testOptionsDescriptionIsMutable()
 {
     $route = new Route('foo', 'foo bar');
     $options = ['foo' => 'foolalalala', 'bar' => 'none'];
     $route->setOptionsDescription($options);
     $this->assertEquals($options, $route->getOptionsDescription());
 }
 /**
  * Display the usage message for an individual route
  *
  * @param Route $route
  */
 protected function showUsageMessageForRoute(Route $route, $log = false)
 {
     $console = $this->console;
     $console->writeLine('Usage:', Color::GREEN);
     $console->writeLine(' ' . $route->getRoute());
     $console->writeLine('');
     $options = $route->getOptionsDescription();
     if (!empty($options)) {
         $console->writeLine('Arguments:', Color::GREEN);
         $maxSpaces = $this->calcMaxString(array_keys($options)) + 2;
         foreach ($options as $name => $description) {
             $spaces = $maxSpaces - strlen($name);
             $console->write(' ' . $name, Color::GREEN);
             $console->writeLine(str_repeat(' ', $spaces) . $description);
         }
         $console->writeLine('');
     }
     $description = $route->getDescription();
     if (!empty($description)) {
         $console->writeLine('Help:', Color::GREEN);
         $console->writeLine('');
         $console->writeLine($description);
     }
 }
Example #3
0
 /**
  * Display the usage message for an individual route
  *
  * @param Route $route
  */
 protected function showUsageMessageForRoute(Route $route, $log = false)
 {
     $console = $this->console;
     $console->writeLine('Usage:', Color::GREEN);
     $console->writeLine(' ' . $route->getRoute());
     $console->writeLine('');
     $options = $route->getOptionsDescription();
     if (!empty($options)) {
         $console->writeLine('Arguments:', Color::GREEN);
         foreach ($options as $name => $description) {
             $tabs = ceil((15 - strlen($name)) / 8);
             $console->write(' ' . $name, Color::GREEN);
             $console->writeLine(str_repeat("\t", $tabs) . $description);
         }
         $console->writeLine('');
     }
     $description = $route->getDescription();
     if (!empty($description)) {
         $console->writeLine('Help:', Color::GREEN);
         $console->writeLine('');
         $console->writeLine($description);
     }
 }