PHP Class FOF30\Generator\Command\Command

Show file Open project: akeeba/fof

Protected Properties

Property Type Description
$component string Name of the component
$composer stdClass Parsed contents of composer.json
$input JInput Input coming from the CLI

Public Methods

Method Description
__construct ( $composer, $input )
execute ( ) This is where we execute the whole logic of the command
setDevServer ( boolean $force = false ) Load the Joomla Configuration from a dev site

Protected Methods

Method Description
getComponent ( object $composer ) : string Get the Component name from the composer file
getComponentName ( $composer ) : string Get the component's name from the user
getViewName ( object $input ) : string Get the view name from the input
in ( ) Proxy the in() call to the application
out ( string $content ) : JApplicationCli Proxy the out() call to the application

Method Details

__construct() public method

public __construct ( $composer, $input )

execute() abstract public method

This is where we execute the whole logic of the command
abstract public execute ( )

getComponent() protected method

Get the Component name from the composer file
protected getComponent ( object $composer ) : string
$composer object The composer.json info
return string The component name

getComponentName() protected method

Get the component's name from the user
protected getComponentName ( $composer ) : string
return string The name of the component (com_foobar)

getViewName() protected method

Get the view name from the input
protected getViewName ( object $input ) : string
$input object The input object
return string The view name

in() protected method

Proxy the in() call to the application
protected in ( )

out() protected method

Proxy the out() call to the application
protected out ( string $content ) : JApplicationCli
$content string Outputs some text on the console
return JApplicationCli

setDevServer() public method

Load the Joomla Configuration from a dev site
public setDevServer ( boolean $force = false )
$force boolean Should we ask the user even if we have a .fof file?

Property Details

$component protected property

Name of the component
protected string $component
return string

$composer protected property

Parsed contents of composer.json
protected stdClass $composer
return stdClass

$input protected property

Input coming from the CLI
protected JInput $input
return JInput