/**
* @param ApiMain $main
- * @param ApiFormatBase |null $errorFallback Object to fall back on for errors
+ * @param ApiFormatBase|null $errorFallback Object to fall back on for errors
*/
public function __construct( ApiMain $main, ApiFormatBase $errorFallback = null ) {
parent::__construct( $main, 'raw' );
}
/**
- * Fetch the next row from the given result object, in object form.
- * Fields can be retrieved with $row->fieldname, with fields acting like
- * member variables.
+ * Fetch the next row from the given result object, in object form. Fields can be retrieved with
+ * $row->fieldname, with fields acting like member variables. If no more rows are available,
+ * false is returned.
*
- * @return stdClass
+ * @return stdClass|bool
* @throws DBUnexpectedError Thrown if the database returns an error
*/
function fetchObject() {
}
/**
- * Fetch the next row from the given result object, in associative array
- * form. Fields are retrieved with $row['fieldname'].
+ * Fetch the next row from the given result object, in associative array form. Fields are
+ * retrieved with $row['fieldname']. If no more rows are available, false is returned.
*
- * @return array
+ * @return array|bool
* @throws DBUnexpectedError Thrown if the database returns an error
*/
function fetchRow() {
/**
* Gets list of names of modules this module depends on.
- * @param ResourceLoaderContext context
+ * @param ResourceLoaderContext|null $context
* @return array List of module names
*/
public function getDependencies( ResourceLoaderContext $context = null ) {
/**
* Clean up HTML
*
- * @param string HTML document fragment to clean up
- * @param string The corrected HTML output
+ * @param string $text HTML document fragment to clean up
+ * @return string The corrected HTML output
*/
abstract public function tidy( $text );
}