VuFind API Documentation

ThemeCommand extends AbstractThemeCommand
in package

Theme generator command.

Tags
category

VuFind

author

Demian Katz demian.katz@villanova.edu

license

http://opensource.org/licenses/gpl-2.0.php GNU General Public License

link

Wiki

Table of Contents

$config  : Config
Configuration from config.ini
$extraSuccessMessage  : string
Extra text to append to the output when generation is successful.
$generator  : GeneratorInterface
Theme resource generator
$type  : string
Type of resource being generated (used in help messages)
__construct()  : mixed
Constructor
configure()  : void
Configure the command.
execute()  : int
Run the command.
generate()  : bool
Run the generator.

Properties

$config

Configuration from config.ini

protected Config $config

$extraSuccessMessage

Extra text to append to the output when generation is successful.

protected string $extraSuccessMessage = ''

$type

Type of resource being generated (used in help messages)

protected string $type = 'theme'

Methods

__construct()

Constructor

public __construct(ThemeGenerator $generator, Config $config[, string|null $name = null ]) : mixed
Parameters
$generator : ThemeGenerator

Generator to call

$config : Config

Configuration from config.ini

$name : string|null = null

The name of the command; passing null means it must be set in configure()

Return values
mixed

execute()

Run the command.

protected execute(InputInterface $input, OutputInterface $output) : int
Parameters
$input : InputInterface

Input object

$output : OutputInterface

Output object

Return values
int

0 for success

generate()

Run the generator.

protected generate(string $name) : bool
Parameters
$name : string

Name of resource to generate

Return values
bool

Search results