Methods
All methods in the Solar_Docs_Apiref class.
Public
-
__construct() -
Constructor.
-
__destruct() -
Default destructor; does nothing other than provide a safe fallback for calls to parent::__destruct().
-
addClass() -
Adds a class to the API docs.
-
addFiles() -
Adds classes from a file hierarchy.
-
dump() -
Convenience method for getting a dump the whole object, or one of its properties, or an external variable.
-
locale() -
Looks up class-specific locale strings based on a key.
Protected
-
_addConfigKeys() -
Adds the Solar configuration keys for a given class.
-
_addConstants() -
Adds the constant reflections for a given class.
-
_addMethods() -
Adds the method reflections for a given class.
-
_addParents() -
Adds the inheritance hierarchy for a given class.
-
_addProperties() -
Adds the property reflections for a given class.
-
_buildConfig() -
Builds and returns the default config for a class, including all configs inherited from its parents.
-
_exception() -
Convenience method for returning exceptions with localized text.
-
_getParameters() -
Returns the parameters for a ReflectionMethod.
-
_isInheritedMethod() -
Reports the class, if any, a method is inherited from and identical to.
-
_isInheritedProperty() -
Reports the class, if any, a property is inherited from and identical to.
-
_log() -
Saves a message to the log.
-
_postConfig() -
A hook that activates after _buildConfig() in the constructor.
-
_postConstruct() -
Post-construction tasks to complete object construction.
-
_preConfig() -
A hook that activates before _buildConfig() in the constructor.
Private
None.