Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/dataformat/pdf/classes/ -> writer.php (source)

[Source view]

pdf data format writer

Copyright: 2019 Shamim Rezaie <shamim@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 223 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

writer:: (12 methods):
  __construct()
  send_http_headers()
  start_output_to_file()
  start_output()
  start_sheet()
  supports_html()
  export_html_image_source()
  write_record()
  close_output()
  close_output_to_file()
  print_heading()
  get_heading_height()


Class: writer  - X-Ref

pdf data format writer

__construct()   X-Ref
writer constructor.


send_http_headers()   X-Ref
No description

start_output_to_file()   X-Ref
Start output to file, note that the actual writing of the file is done in {@see close_output_to_file()}


start_output()   X-Ref
No description

start_sheet($columns)   X-Ref
No description

supports_html()   X-Ref
Method to define whether the dataformat supports export of HTML

return: bool

export_html_image_source(\stored_file $file)   X-Ref
When exporting images, we need to return their Base64 encoded content. Otherwise TCPDF will create a HTTP
request for them, which will lead to the login page (i.e. not the image it expects) and throw an exception

Note: ideally we would copy the file to a temp location and return it's path, but a bug in TCPDF currently
prevents that

param: \stored_file $file
return: string|null

write_record($record, $rownum)   X-Ref
Write a single record

param: array $record
param: int $rownum

close_output()   X-Ref
No description

close_output_to_file()   X-Ref
Write data to disk

return: bool

print_heading(\pdf $pdf)   X-Ref
Prints the heading row for a given PDF.

param: \pdf $pdf A pdf to print headings in

get_heading_height()   X-Ref
Returns the heading height.

return: int