interface/modules/zend_modules/library/Zend/ModuleManager/Feature/ConsoleUsageProviderInterface.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\ModuleManager\Feature;
  11
  12 use Zend\Console\Adapter\AdapterInterface;
  13
  14 interface ConsoleUsageProviderInterface
  15 {
  16     /**
  17      * Returns an array or a string containing usage information for this module's Console commands.
  18      * The method is called with active Zend\Console\Adapter\AdapterInterface that can be used to directly access
  19      * Console and send output.
  20      *
  21      * If the result is a string it will be shown directly in the console window.
  22      * If the result is an array, its contents will be formatted to console window width. The array must
  23      * have the following format:
  24      *
  25      *     return array(
  26      *                'Usage information line that should be shown as-is',
  27      *                'Another line of usage info',
  28      *
  29      *                '--parameter'        =>   'A short description of that parameter',
  30      *                '-another-parameter' =>   'A short description of another parameter',
  31      *                ...
  32      *            )
  33      *
  34      * @param AdapterInterface $console
  35      * @return array|string|null
  36      */
  37     public function getConsoleUsage(AdapterInterface $console);
  38 }