<?php /** * Zend Framework (http://framework.zend.com/) * * @link http://github.com/zendframework/zf2 for the canonical source repository * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) * @license http://framework.zend.com/license/new-bsd New BSD License */ namespace Zend\ModuleManager\Feature; use Zend\Console\Adapter\AdapterInterface; interface ConsoleUsageProviderInterface { /** * Returns an array or a string containing usage information for this module's Console commands. * The method is called with active Zend\Console\Adapter\AdapterInterface that can be used to directly access * Console and send output. * * If the result is a string it will be shown directly in the console window. * If the result is an array, its contents will be formatted to console window width. The array must * have the following format: * * return array( * 'Usage information line that should be shown as-is', * 'Another line of usage info', * * '--parameter' => 'A short description of that parameter', * '-another-parameter' => 'A short description of another parameter', * ... * ) * * @param AdapterInterface $console * @return array|string|null */ public function getConsoleUsage(AdapterInterface $console); }