Interface ConsoleBannerProviderInterface

Summary

Fully Qualified Name: Zend\ModuleManager\Feature\ConsoleBannerProviderInterface

Description

Methods

Name Description Defined By
getConsoleBanner() Returns a string containing a banner text, that describes the module and/or the application. ConsoleBannerProviderInterface

Method Details

getConsoleBanner()

Returns a string containing a banner text, that describes the module and/or the application.

The banner is shown in the console window, when the user supplies invalid command-line parameters or invokes the application with no parameters.

The method is called with active Zend\Console\Adapter\AdapterInterface that can be used to directly access Console and send output.

Parameter Name Type Description
$console \AdapterInterface

Returns: string|null

Top