Methods

Public

__construct()

Constructor.

__destruct()

Destructor; closes STDOUT and STDERR file handles.

dump()

Convenience method for getting a dump the whole object, or one of its properties, or an external variable.

exec()

Public interface to execute the command.

getInfoHelp()

Returns the help text for this command.

getInfoOptions()

Returns an array of option flags and descriptions for this command.

locale()

Looks up class-specific locale strings based on a key.

setConsoleController()

Injects the console-controller object (if any) that invoked this command.

Protected

_buildConfig()

Builds and returns the default config for a class, including all configs inherited from its parents.

_buildFoundation()

Writes the top-level apidoc DocBook files.

_convertClass()

Converts a single wiki-based class file set to DocBook.

_convertClassIndex()

Converts the wiki-based class index to DocBook.

_convertClassToc()

Converts all wiki-based class files to DocBook.

_convertClasses()

Converts all wiki-based class files to DocBook.

_convertPackage()

Converts a single wiki-based package file to DocBook.

_convertPackageIndex()

Converts the wiki-based package index to DocBook.

_convertPackageToc()

Converts the wiki-based package table of contents to DocBook.

_convertPackages()

Converts all wiki-based package docs to DocBook.

_err()

Prints text to STDERR without a trailing newline.

_errln()

Prints text to STDERR and appends a newline.

_exception()

Convenience method for returning exceptions with localized text.

_exec()

Main action: parse the classes and write documentation.

_fetchGetoptOptions()

Gets the option settings from the class hierarchy.

_loadTemplates()

Loads DocBook template files from the Data directory.

_out()

Prints text to STDOUT without a trailing newline.

_outln()

Prints text to STDOUT and appends a newline.

_postConfig()

A hook that activates after _buildConfig() in the constructor.

_postConstruct()

Post-construction tasks to complete object construction.

_postExec()

Runs just after the main _exec() method.

_preConfig()

A hook that activates before _buildConfig() in the constructor.

_preExec()

Runs just before the main _exec() method.

_save()

Writes a file to the target directory.

_saveMarkdown()

Transforms from wiki markup to DocBook, and saves it to the target directory.

_setDirs()

Sets directory paths for reading and writing.

_setup()

Post-construction setup logic.

Private

None.