Previous Page
Constants

Properties

Public

$api

(array) The entire API as a structured array.

<?php
$api = array(
    classname => array(
        summ => string,
        narr => string,
        tech => array(...),
        from => array(...),
        constants => array(
            constantname => array(
                type => string,
                value => string,
            ), // constantname
        ), // constants
        properties => array(
            propertyname => array(
                name => string,
                summ => string,
                narr => string,
                tech => array(...),
                type => string,
                access => string,
                static => bool,
                from => string,
            ), // propertyname
        ), // properties
        methods => array(
            methodname => array(
                name => string,
                summ => string,
                narr => string,
                tech => array(...),
                access => string,
                static => bool,
                final => bool,
                return => string,
                from => string,
                params => array(
                    paramname => array(
                        name => string,
                        type => string,
                        summ => string,
                        byref => bool,
                        optional => bool,
                        default => mixed,
                    ), // paramname
                ), // params
            ), // methodname
        ), // methods
    ), // classname
); // $this->api
?>

$packages

(array) An array of all packages discovered.

Key is the package name, value is an array of all classes in that package.

$subpackages

(array) An array of all subpackages discovered.

Key is the subpackage name, value is an array of all classes in that subpackage.

Protected

$_Solar_Docs_Apiref

(array) User-defined configuration values.

Keys are ...

phpdoc: (dependency) A Solar_Docs_Phpdoc dependency.
log: (dependency) A Solar_Log dependency.
unknown: (string) When a type is unknown or not specified, use this value instead.

$_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',
);
?>

$_ignore

(string) When generating log notices, ignore these class methods and properties.

$_log

(Solar_Log) Solar_Log instance.

$_phpdoc

(Solar_Docs_Phpdoc) Class for parsing PHPDoc comment blocks.

Private

None.