ApiFormatYaml Class Reference

API YAML output formatter. More...

Inheritance diagram for ApiFormatYaml:

Collaboration diagram for ApiFormatYaml:

List of all members.

Public Member Functions
	getDescription ()
	Returns the description string for this module.
	getMimeType ()
	Overriding class returns the mime type that should be sent to the client.
	getVersion ()
	Returns a string that identifies the version of the extending class.

---

Detailed Description

API YAML output formatter.

Definition at line 31 of file ApiFormatYaml.php.

---

Member Function Documentation

ApiFormatYaml::getDescription

(

)

Returns the description string for this module.

Returns:

mixed string or array of strings

Reimplemented from ApiFormatJson.

Definition at line 37 of file ApiFormatYaml.php.

ApiFormatYaml::getMimeType

(

)

Overriding class returns the mime type that should be sent to the client.

This method is not called if getIsHtml() returns true.

Returns:

string

Reimplemented from ApiFormatJson.

Definition at line 33 of file ApiFormatYaml.php.

ApiFormatYaml::getVersion

(

)

Returns a string that identifies the version of the extending class.

Typically includes the class name, the svn revision, timestamp, and last author. Usually done with SVN's Id keyword

Returns:

string

Reimplemented from ApiFormatJson.

Definition at line 41 of file ApiFormatYaml.php.

---

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

• includes/api/ApiFormatYaml.php