Code Index:

package CLI::Framework::Command::Meta
- new
- get_app
- set_app
__END__
EOF

NAME

CLI::Framework::Command::Meta - Represent "metacommands" (app-aware commands)

DESCRIPTION

This class is a subclass of CLI::Framework::Command. It defines "metacommands", commands that are application-aware (and thus, implicitly aware of all other commands registered within the application). Metacommands have methods that set and retrieve a reference to the application within which they are running.

This class exists as a separate class because, with few exceptions, commands should be independent of the application they are associated with and should not affect that application. Metacommands represent the exception to that rule. In the exceptional cases, your command will inherit from this one instead of CLI::Framework::Command.

WHEN TO BUILD METACOMMANDS VS REGULAR COMMANDS

See tutorial advice (How can I create an application-aware command? in CLI::Framework::Tutorial) on this topic.

METHODS

get_app() / set_app( $app )

Retrieve or set the application object associated with a metacommand object.

    $app = $command->get_app();

    $command->set_app( $app );