Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
- Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
- PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
(no description)
| File Size: | 225 lines (9 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
CommentsManager:: (8 methods):
__construct()
createWorksheetCommentFiles()
closeWorksheetCommentFiles()
addComments()
getCommentsFilePath()
getDrawingFilePath()
addXmlComment()
addVmlComment()
Class: CommentsManager - X-Ref
| __construct(string $xlFolder, Escaper\XLSX $stringsEscaper) X-Ref |
param: string $xlFolder Path to the "xl" folder |
| createWorksheetCommentFiles(Worksheet $sheet) X-Ref |
| Create the two comment-files for the given worksheet. |
| closeWorksheetCommentFiles(Worksheet $sheet) X-Ref |
| Close the two comment-files for the given worksheet. |
| addComments(Worksheet $worksheet, Row $row) X-Ref |
| No description |
| getCommentsFilePath(Worksheet $sheet) X-Ref |
return: string The file path where the comments for the given sheet will be stored |
| getDrawingFilePath(Worksheet $sheet) X-Ref |
return: string The file path where the VML comments for the given sheet will be stored |
| addXmlComment(int $sheetId, int $rowIndexZeroBased, int $columnIndexZeroBased, Comment $comment) X-Ref |
| Add a comment to the commentsX.xml file. param: int $sheetId The id of the sheet (starting with 1) param: int $rowIndexZeroBased The row index, starting at 0, of the cell with the comment param: int $columnIndexZeroBased The column index, starting at 0, of the cell with the comment param: Comment $comment The actual comment |
| addVmlComment(int $sheetId, int $rowIndexZeroBased, int $columnIndexZeroBased, Comment $comment) X-Ref |
| Add a comment to the vmlDrawingX.vml file. param: int $sheetId The id of the sheet (starting with 1) param: int $rowIndexZeroBased The row index, starting at 0, of the cell with the comment param: int $columnIndexZeroBased The column index, starting at 0, of the cell with the comment param: Comment $comment The actual comment |
