Class: iConverter

A Converter takes output from the Parser and converts it to template-friendly output. A converter for the standard phpDocumentor template, HTMLConverter, is provided with this release. Future releases will have support for other formats and templates, including DocBook, XML, and possibly other HTML templates. The converter takes output directly from NewRender and using walk() it "walks" over an array of phpDocumentor elements, as represented by descendants of parserElement

a converter must define the abstract function Convert (an example is HTMLConverter::Convert()), a function that takes a passed object and uses it to generate structures for an output template, or directly generates output. Since all elements have their DocBlocks linked directly, this allows for more logical parsing than earlier versions of phpDocumentor.

A Converter is passed several data structures in its constructor, all of which are optional in output and may be handled in any way the converter would like. These structures are arrays:

• array of methods by class (see NewRender::$methods)
• array of variables by class (see NewRender::$vars)
• array of links to documented elements (see NewRender::$links)
• array of class parents by name (see NewRender::$classtree)
• array of class packages by classname (see NewRender::$classpackages)
• array of packages to document (see NewRender::$packageoutput)
• array of extended classes by parent classname (see NewRender::$class_children)
• array of all documented elements by name (see NewRender::$elements)
• array of all documented elements by name, split by package (see NewRender::$pkg_elements)
• boolean option, set to true to parse all elements marked @access private (see NewRender::$parsePrivate)
• boolean option, set to true to stop informative output while parsing (good for cron jobs) (see NewRender::$quietMode)

walk   [line 37]