Properties

$api

(array) The entire API as a data set.

$packages

(array) All package groupings as a data set.

$_Solar_Cli_MakeDocs

(array) Default configuration values.

$_class_dir

(string) Write class API files to this directory.

$_classes_list

(array) Summary list of all classes.

$_config

(array) Collection point for configuration values.

Inherited from Solar_Base.

Note that you do not define config defaults in $_config directly.

<?php
// DO NOT DO THIS
protected $_config = array(
    'foo' => 'bar',
    'baz' => 'dib',
);

Instead, define config defaults in a protected property named for the class, withan underscore prefix.

For exmple, a "Vendor_Class_Name" class would define the default config array in "$_Vendor_Class_Name". This convention lets child classes inherit parent config keys and values.

<?php
// DO THIS INSTEAD
protected $_Vendor_Class_Name = array(
    'foo' => 'bar',
    'baz' => 'dib',
);

$_console

(Solar_Controller_Console) The Solar_Controller_Console object (if any) that invoked this command.

Inherited from Solar_Controller_Command.

$_docbook_dir

(string) Write DocBook files to this directory.

$_getopt

(Solar_Getopt) A Solar_Getopt object to manage options and parameters.

Inherited from Solar_Controller_Command.

$_options

(array) Option flags and values extracted from the command-line arguments.

Inherited from Solar_Controller_Command.

$_package_dir

(string) Write package files to this directory.

$_source

(string) The source code directory, typically the 'include' directory.

$_stderr

(resource) File handle pointing to STDERR for error output.

Inherited from Solar_Controller_Command.

$_stdout

(resource) File handle pointing to STDOUT for normal output.

Inherited from Solar_Controller_Command.