Search moodle.org's
Developer Documentation
Developer Documentation
See Release Notes
Long Term Support Release
- Bug fixes for general core bugs in 3.9.x will end* 10 May 2021 (12 months).
- Bug fixes for security issues in 3.9.x will end* 8 May 2023 (36 months).
- PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
Differences Between: [Versions 39 and 311] [Versions 39 and 400] [Versions 39 and 401] [Versions 39 and 402] [Versions 39 and 403]
(no description)
| File Size: | 1688 lines (58 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
Html:: (41 methods):
__construct()
save()
mapVAlign()
mapHAlign()
mapBorderStyle()
getSheetIndex()
setSheetIndex()
getGenerateSheetNavigationBlock()
setGenerateSheetNavigationBlock()
writeAllSheets()
generateHTMLHeader()
generateSheetData()
generateNavigation()
extendRowsForChartsAndImages()
writeImageInCell()
writeChartInCell()
generateStyles()
buildCSS()
createCSSStyle()
createCSSStyleAlignment()
createCSSStyleFont()
createCSSStyleBorders()
createCSSStyleBorder()
createCSSStyleFill()
generateHTMLFooter()
generateTableHeader()
generateTableFooter()
generateRow()
assembleCSS()
getImagesRoot()
setImagesRoot()
getEmbedImages()
setEmbedImages()
getUseInlineCss()
setUseInlineCss()
getUseEmbeddedCSS()
setUseEmbeddedCSS()
formatColor()
calculateSpans()
setMargins()
writeComment()
| __construct(Spreadsheet $spreadsheet) X-Ref |
| Create a new HTML. param: Spreadsheet $spreadsheet |
| save($pFilename) X-Ref |
| Save Spreadsheet to file. param: string $pFilename |
| mapVAlign($vAlign) X-Ref |
| Map VAlign. param: string $vAlign Vertical alignment return: string |
| mapHAlign($hAlign) X-Ref |
| Map HAlign. param: string $hAlign Horizontal alignment return: false|string |
| mapBorderStyle($borderStyle) X-Ref |
| Map border style. param: int $borderStyle Sheet index return: string |
| getSheetIndex() X-Ref |
| Get sheet index. return: int |
| setSheetIndex($pValue) X-Ref |
| Set sheet index. param: int $pValue Sheet index return: HTML |
| getGenerateSheetNavigationBlock() X-Ref |
| Get sheet index. return: bool |
| setGenerateSheetNavigationBlock($pValue) X-Ref |
| Set sheet index. param: bool $pValue Flag indicating whether the sheet navigation block should be generated or not return: HTML |
| writeAllSheets() X-Ref |
| Write all sheets (resets sheetIndex to NULL). |
| generateHTMLHeader($pIncludeStyles = false) X-Ref |
| Generate HTML header. param: bool $pIncludeStyles Include styles? return: string |
| generateSheetData() X-Ref |
| Generate sheet data. return: string |
| generateNavigation() X-Ref |
| Generate sheet tabs. return: string |
| extendRowsForChartsAndImages(Worksheet $pSheet, $row) X-Ref |
| No description |
| writeImageInCell(Worksheet $pSheet, $coordinates) X-Ref |
| Generate image tag in cell. param: Worksheet $pSheet \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet param: string $coordinates Cell coordinates return: string |
| writeChartInCell(Worksheet $pSheet, $coordinates) X-Ref |
| Generate chart tag in cell. param: Worksheet $pSheet \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet param: string $coordinates Cell coordinates return: string |
| generateStyles($generateSurroundingHTML = true) X-Ref |
| Generate CSS styles. param: bool $generateSurroundingHTML Generate surrounding HTML tags? (<style> and </style>) return: string |
| buildCSS($generateSurroundingHTML = true) X-Ref |
| Build CSS styles. param: bool $generateSurroundingHTML Generate surrounding HTML style? (html { }) return: array |
| createCSSStyle(Style $pStyle) X-Ref |
| Create CSS style. param: Style $pStyle return: array |
| createCSSStyleAlignment(Alignment $pStyle) X-Ref |
| Create CSS style (\PhpOffice\PhpSpreadsheet\Style\Alignment). param: Alignment $pStyle \PhpOffice\PhpSpreadsheet\Style\Alignment return: array |
| createCSSStyleFont(Font $pStyle) X-Ref |
| Create CSS style (\PhpOffice\PhpSpreadsheet\Style\Font). param: Font $pStyle return: array |
| createCSSStyleBorders(Borders $pStyle) X-Ref |
| Create CSS style (Borders). param: Borders $pStyle Borders return: array |
| createCSSStyleBorder(Border $pStyle) X-Ref |
| Create CSS style (Border). param: Border $pStyle Border return: string |
| createCSSStyleFill(Fill $pStyle) X-Ref |
| Create CSS style (Fill). param: Fill $pStyle Fill return: array |
| generateHTMLFooter() X-Ref |
| Generate HTML footer. |
| generateTableHeader($pSheet) X-Ref |
| Generate table header. param: Worksheet $pSheet The worksheet for the table we are writing return: string |
| generateTableFooter() X-Ref |
| Generate table footer. |
| generateRow(Worksheet $pSheet, array $pValues, $pRow, $cellType) X-Ref |
| Generate row. param: Worksheet $pSheet \PhpOffice\PhpSpreadsheet\Worksheet\Worksheet param: array $pValues Array containing cells in a row param: int $pRow Row number (0-based) param: string $cellType eg: 'td' return: string |
| assembleCSS(array $pValue = []) X-Ref |
| Takes array where of CSS properties / values and converts to CSS string. param: array $pValue return: string |
| getImagesRoot() X-Ref |
| Get images root. return: string |
| setImagesRoot($pValue) X-Ref |
| Set images root. param: string $pValue return: HTML |
| getEmbedImages() X-Ref |
| Get embed images. return: bool |
| setEmbedImages($pValue) X-Ref |
| Set embed images. param: bool $pValue return: HTML |
| getUseInlineCss() X-Ref |
| Get use inline CSS? return: bool |
| setUseInlineCss($pValue) X-Ref |
| Set use inline CSS? param: bool $pValue return: HTML |
| getUseEmbeddedCSS() X-Ref |
| Get use embedded CSS? return: bool |
| setUseEmbeddedCSS($pValue) X-Ref |
| Set use embedded CSS? param: bool $pValue return: HTML |
| formatColor($pValue, $pFormat) X-Ref |
| Add color to formatted string as inline style. param: string $pValue Plain formatted value without color param: string $pFormat Format code return: string |
| calculateSpans() X-Ref |
| Calculate information about HTML colspan and rowspan which is not always the same as Excel's. |
| setMargins(Worksheet $pSheet) X-Ref |
| No description |
| writeComment(Worksheet $pSheet, $coordinate) X-Ref |
| Write a comment in the same format as LibreOffice. param: Worksheet $pSheet param: string $coordinate return: string |
