MDL-67547 dataformat: allow plugins to declare support for HTML.

This commit is contained in:
Paul Holden 2019-12-18 21:38:40 +00:00
parent a09eb2697f
commit 118a109499
6 changed files with 62 additions and 10 deletions

View file

@ -145,6 +145,27 @@ abstract class base {
// Override me if needed.
}
/**
* Method to define whether the dataformat supports export of HTML
*
* @return bool
*/
public function supports_html(): bool {
return false;
}
/**
* Apply formatting to the cells of a given record
*
* @param array|\stdClass $record
* @return array
*/
protected function format_record($record): array {
$record = (array)$record;
return $record;
}
/**
* Write a single record
*

View file

@ -116,11 +116,11 @@ abstract class spout_base extends \core\dataformat\base {
/**
* Write a single record
*
* @param object $record
* @param array $record
* @param int $rownum
*/
public function write_record($record, $rownum) {
$row = \Box\Spout\Writer\Common\Creator\WriterEntityFactory::createRowFromArray((array)$record);
$row = \Box\Spout\Writer\Common\Creator\WriterEntityFactory::createRowFromArray($this->format_record($record));
$this->writer->addRow($row);
}

View file

@ -2012,7 +2012,7 @@ class table_default_export_format_parent {
*/
class table_dataformat_export_format extends table_default_export_format_parent {
/** @var $dataformat */
/** @var \core\dataformat\base $dataformat */
protected $dataformat;
/** @var $rownum */
@ -2047,6 +2047,15 @@ class table_dataformat_export_format extends table_default_export_format_parent
\core\session\manager::write_close();
}
/**
* Whether the current dataformat supports export of HTML
*
* @return bool
*/
public function supports_html(): bool {
return $this->dataformat->supports_html();
}
/**
* Start document
*