APIFormatter Class Reference

Base class for APIFormatters. More...

Inheritance diagram for APIFormatter:

Public Member Functions
	getClass ()
	format ($items)
	Override this function to provide your format definition. More...

Public Attributes
	$parent

Detailed Description

Base class for APIFormatters.

Extend this class and implement the format() method to provide your custom data formatter.

Author

andy

Definition at line 47 of file api_helper.inc.

Member Function Documentation

format()

APIFormatter::format (   $items )

abstract

Override this function to provide your format definition.

The results should be sent to the output buffer, via 'echo' or equivalent.

Parameters

array

$items

the list of DataItems to be formatted

Reimplemented in APITemplate, APICSVFormatter, APIExcelFormatter, APICanonicalXMLFormatter, and APIJSONFormatter.

getClass()

APIFormatter::getClass

(

)

Definition at line 51 of file api_helper.inc.

     {
          return $this->parent->class;
     }

Member Data Documentation

$parent

APIFormatter::$parent

Definition at line 49 of file api_helper.inc.

---

The documentation for this class was generated from the following file:

• C:/code/cms.sonjara.com/framework/api_helper.inc