Search moodle.org's
Developer Documentation
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.
Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401] [Versions 400 and 401] [Versions 401 and 402] [Versions 401 and 403]
(no description)
| File Size: | 908 lines (28 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
PageSetup:: (42 methods):
__construct()
getPaperSize()
setPaperSize()
getPaperSizeDefault()
setPaperSizeDefault()
getOrientation()
setOrientation()
getOrientationDefault()
setOrientationDefault()
getScale()
setScale()
getFitToPage()
setFitToPage()
getFitToHeight()
setFitToHeight()
getFitToWidth()
setFitToWidth()
isColumnsToRepeatAtLeftSet()
getColumnsToRepeatAtLeft()
setColumnsToRepeatAtLeft()
setColumnsToRepeatAtLeftByStartAndEnd()
isRowsToRepeatAtTopSet()
getRowsToRepeatAtTop()
setRowsToRepeatAtTop()
setRowsToRepeatAtTopByStartAndEnd()
getHorizontalCentered()
setHorizontalCentered()
getVerticalCentered()
setVerticalCentered()
getPrintArea()
isPrintAreaSet()
clearPrintArea()
setPrintArea()
addPrintArea()
setPrintAreaByColumnAndRow()
addPrintAreaByColumnAndRow()
getFirstPageNumber()
setFirstPageNumber()
resetFirstPageNumber()
getPageOrder()
setPageOrder()
__clone()
<code>
Paper size taken from Office Open XML Part 4 - Markup Language Reference, page 1988:.
1 = Letter paper (8.5 in. by 11 in.)
2 = Letter small paper (8.5 in. by 11 in.)
3 = Tabloid paper (11 in. by 17 in.)
4 = Ledger paper (17 in. by 11 in.)
5 = Legal paper (8.5 in. by 14 in.)
6 = Statement paper (5.5 in. by 8.5 in.)
7 = Executive paper (7.25 in. by 10.5 in.)
8 = A3 paper (297 mm by 420 mm)
9 = A4 paper (210 mm by 297 mm)
10 = A4 small paper (210 mm by 297 mm)
11 = A5 paper (148 mm by 210 mm)
12 = B4 paper (250 mm by 353 mm)
13 = B5 paper (176 mm by 250 mm)
14 = Folio paper (8.5 in. by 13 in.)
15 = Quarto paper (215 mm by 275 mm)
16 = Standard paper (10 in. by 14 in.)
17 = Standard paper (11 in. by 17 in.)
18 = Note paper (8.5 in. by 11 in.)
19 = #9 envelope (3.875 in. by 8.875 in.)
20 = #10 envelope (4.125 in. by 9.5 in.)
21 = #11 envelope (4.5 in. by 10.375 in.)
22 = #12 envelope (4.75 in. by 11 in.)
23 = #14 envelope (5 in. by 11.5 in.)
24 = C paper (17 in. by 22 in.)
25 = D paper (22 in. by 34 in.)
26 = E paper (34 in. by 44 in.)
27 = DL envelope (110 mm by 220 mm)
28 = C5 envelope (162 mm by 229 mm)
29 = C3 envelope (324 mm by 458 mm)
30 = C4 envelope (229 mm by 324 mm)
31 = C6 envelope (114 mm by 162 mm)
32 = C65 envelope (114 mm by 229 mm)
33 = B4 envelope (250 mm by 353 mm)
34 = B5 envelope (176 mm by 250 mm)
35 = B6 envelope (176 mm by 125 mm)
36 = Italy envelope (110 mm by 230 mm)
37 = Monarch envelope (3.875 in. by 7.5 in.).
38 = 6 3/4 envelope (3.625 in. by 6.5 in.)
39 = US standard fanfold (14.875 in. by 11 in.)
40 = German standard fanfold (8.5 in. by 12 in.)
41 = German legal fanfold (8.5 in. by 13 in.)
42 = ISO B4 (250 mm by 353 mm)
43 = Japanese double postcard (200 mm by 148 mm)
44 = Standard paper (9 in. by 11 in.)
45 = Standard paper (10 in. by 11 in.)
46 = Standard paper (15 in. by 11 in.)
47 = Invite envelope (220 mm by 220 mm)
50 = Letter extra paper (9.275 in. by 12 in.)
51 = Legal extra paper (9.275 in. by 15 in.)
52 = Tabloid extra paper (11.69 in. by 18 in.)
53 = A4 extra paper (236 mm by 322 mm)
54 = Letter transverse paper (8.275 in. by 11 in.)
55 = A4 transverse paper (210 mm by 297 mm)
56 = Letter extra transverse paper (9.275 in. by 12 in.)
57 = SuperA/SuperA/A4 paper (227 mm by 356 mm)
58 = SuperB/SuperB/A3 paper (305 mm by 487 mm)
59 = Letter plus paper (8.5 in. by 12.69 in.)
60 = A4 plus paper (210 mm by 330 mm)
61 = A5 transverse paper (148 mm by 210 mm)
62 = JIS B5 transverse paper (182 mm by 257 mm)
63 = A3 extra paper (322 mm by 445 mm)
64 = A5 extra paper (174 mm by 235 mm)
65 = ISO B5 extra paper (201 mm by 276 mm)
66 = A2 paper (420 mm by 594 mm)
67 = A3 transverse paper (297 mm by 420 mm)
68 = A3 extra transverse paper (322 mm by 445 mm)
</code>
Paper size taken from Office Open XML Part 4 - Markup Language Reference, page 1988:.
1 = Letter paper (8.5 in. by 11 in.)
2 = Letter small paper (8.5 in. by 11 in.)
3 = Tabloid paper (11 in. by 17 in.)
4 = Ledger paper (17 in. by 11 in.)
5 = Legal paper (8.5 in. by 14 in.)
6 = Statement paper (5.5 in. by 8.5 in.)
7 = Executive paper (7.25 in. by 10.5 in.)
8 = A3 paper (297 mm by 420 mm)
9 = A4 paper (210 mm by 297 mm)
10 = A4 small paper (210 mm by 297 mm)
11 = A5 paper (148 mm by 210 mm)
12 = B4 paper (250 mm by 353 mm)
13 = B5 paper (176 mm by 250 mm)
14 = Folio paper (8.5 in. by 13 in.)
15 = Quarto paper (215 mm by 275 mm)
16 = Standard paper (10 in. by 14 in.)
17 = Standard paper (11 in. by 17 in.)
18 = Note paper (8.5 in. by 11 in.)
19 = #9 envelope (3.875 in. by 8.875 in.)
20 = #10 envelope (4.125 in. by 9.5 in.)
21 = #11 envelope (4.5 in. by 10.375 in.)
22 = #12 envelope (4.75 in. by 11 in.)
23 = #14 envelope (5 in. by 11.5 in.)
24 = C paper (17 in. by 22 in.)
25 = D paper (22 in. by 34 in.)
26 = E paper (34 in. by 44 in.)
27 = DL envelope (110 mm by 220 mm)
28 = C5 envelope (162 mm by 229 mm)
29 = C3 envelope (324 mm by 458 mm)
30 = C4 envelope (229 mm by 324 mm)
31 = C6 envelope (114 mm by 162 mm)
32 = C65 envelope (114 mm by 229 mm)
33 = B4 envelope (250 mm by 353 mm)
34 = B5 envelope (176 mm by 250 mm)
35 = B6 envelope (176 mm by 125 mm)
36 = Italy envelope (110 mm by 230 mm)
37 = Monarch envelope (3.875 in. by 7.5 in.).
38 = 6 3/4 envelope (3.625 in. by 6.5 in.)
39 = US standard fanfold (14.875 in. by 11 in.)
40 = German standard fanfold (8.5 in. by 12 in.)
41 = German legal fanfold (8.5 in. by 13 in.)
42 = ISO B4 (250 mm by 353 mm)
43 = Japanese double postcard (200 mm by 148 mm)
44 = Standard paper (9 in. by 11 in.)
45 = Standard paper (10 in. by 11 in.)
46 = Standard paper (15 in. by 11 in.)
47 = Invite envelope (220 mm by 220 mm)
50 = Letter extra paper (9.275 in. by 12 in.)
51 = Legal extra paper (9.275 in. by 15 in.)
52 = Tabloid extra paper (11.69 in. by 18 in.)
53 = A4 extra paper (236 mm by 322 mm)
54 = Letter transverse paper (8.275 in. by 11 in.)
55 = A4 transverse paper (210 mm by 297 mm)
56 = Letter extra transverse paper (9.275 in. by 12 in.)
57 = SuperA/SuperA/A4 paper (227 mm by 356 mm)
58 = SuperB/SuperB/A3 paper (305 mm by 487 mm)
59 = Letter plus paper (8.5 in. by 12.69 in.)
60 = A4 plus paper (210 mm by 330 mm)
61 = A5 transverse paper (148 mm by 210 mm)
62 = JIS B5 transverse paper (182 mm by 257 mm)
63 = A3 extra paper (322 mm by 445 mm)
64 = A5 extra paper (174 mm by 235 mm)
65 = ISO B5 extra paper (201 mm by 276 mm)
66 = A2 paper (420 mm by 594 mm)
67 = A3 transverse paper (297 mm by 420 mm)
68 = A3 extra transverse paper (322 mm by 445 mm)
</code>
| __construct() X-Ref |
| Create a new PageSetup. |
| getPaperSize() X-Ref |
| Get Paper Size. return: int |
| setPaperSize($paperSize) X-Ref |
| Set Paper Size. param: int $paperSize see self::PAPERSIZE_* return: $this |
| getPaperSizeDefault() X-Ref |
| Get Paper Size default. |
| setPaperSizeDefault(int $paperSize) X-Ref |
| Set Paper Size Default. |
| getOrientation() X-Ref |
| Get Orientation. return: string |
| setOrientation($orientation) X-Ref |
| Set Orientation. param: string $orientation see self::ORIENTATION_* return: $this |
| getOrientationDefault() X-Ref |
| No description |
| setOrientationDefault(string $orientation) X-Ref |
| No description |
| getScale() X-Ref |
| Get Scale. return: null|int |
| setScale($scale, $update = true) X-Ref |
| Set Scale. Print scaling. Valid values range from 10 to 400 This setting is overridden when fitToWidth and/or fitToHeight are in use. param: null|int $scale param: bool $update Update fitToPage so scaling applies rather than fitToHeight / fitToWidth return: $this |
| getFitToPage() X-Ref |
| Get Fit To Page. return: bool |
| setFitToPage($fitToPage) X-Ref |
| Set Fit To Page. param: bool $fitToPage return: $this |
| getFitToHeight() X-Ref |
| Get Fit To Height. return: null|int |
| setFitToHeight($fitToHeight, $update = true) X-Ref |
| Set Fit To Height. param: null|int $fitToHeight param: bool $update Update fitToPage so it applies rather than scaling return: $this |
| getFitToWidth() X-Ref |
| Get Fit To Width. return: null|int |
| setFitToWidth($value, $update = true) X-Ref |
| Set Fit To Width. param: null|int $value param: bool $update Update fitToPage so it applies rather than scaling return: $this |
| isColumnsToRepeatAtLeftSet() X-Ref |
| Is Columns to repeat at left set? return: bool |
| getColumnsToRepeatAtLeft() X-Ref |
| Get Columns to repeat at left. return: array Containing start column and end column, empty array if option unset |
| setColumnsToRepeatAtLeft(array $columnsToRepeatAtLeft) X-Ref |
| Set Columns to repeat at left. param: array $columnsToRepeatAtLeft Containing start column and end column, empty array if option unset return: $this |
| setColumnsToRepeatAtLeftByStartAndEnd($start, $end) X-Ref |
| Set Columns to repeat at left by start and end. param: string $start eg: 'A' param: string $end eg: 'B' return: $this |
| isRowsToRepeatAtTopSet() X-Ref |
| Is Rows to repeat at top set? return: bool |
| getRowsToRepeatAtTop() X-Ref |
| Get Rows to repeat at top. return: array Containing start column and end column, empty array if option unset |
| setRowsToRepeatAtTop(array $rowsToRepeatAtTop) X-Ref |
| Set Rows to repeat at top. param: array $rowsToRepeatAtTop Containing start column and end column, empty array if option unset return: $this |
| setRowsToRepeatAtTopByStartAndEnd($start, $end) X-Ref |
| Set Rows to repeat at top by start and end. param: int $start eg: 1 param: int $end eg: 1 return: $this |
| getHorizontalCentered() X-Ref |
| Get center page horizontally. return: bool |
| setHorizontalCentered($value) X-Ref |
| Set center page horizontally. param: bool $value return: $this |
| getVerticalCentered() X-Ref |
| Get center page vertically. return: bool |
| setVerticalCentered($value) X-Ref |
| Set center page vertically. param: bool $value return: $this |
| getPrintArea($index = 0) X-Ref |
| Get print area. param: int $index Identifier for a specific print area range if several ranges have been set return: string |
| isPrintAreaSet($index = 0) X-Ref |
| Is print area set? param: int $index Identifier for a specific print area range if several ranges have been set return: bool |
| clearPrintArea($index = 0) X-Ref |
| Clear a print area. param: int $index Identifier for a specific print area range if several ranges have been set return: $this |
| setPrintArea($value, $index = 0, $method = self::SETPRINTRANGE_OVERWRITE) X-Ref |
| Set print area. e.g. 'A1:D10' or 'A1:D10,G5:M20'. param: string $value param: int $index Identifier for a specific print area range allowing several ranges to be set param: string $method Determines the method used when setting multiple print areas return: $this |
| addPrintArea($value, $index = -1) X-Ref |
| Add a new print area (e.g. 'A1:D10' or 'A1:D10,G5:M20') to the list of print areas. param: string $value param: int $index Identifier for a specific print area range allowing several ranges to be set return: $this |
| setPrintAreaByColumnAndRow($column1, $row1, $column2, $row2, $index = 0, $method = self::SETPRINTRANGE_OVERWRITE) X-Ref |
| Set print area. param: int $column1 Column 1 param: int $row1 Row 1 param: int $column2 Column 2 param: int $row2 Row 2 param: int $index Identifier for a specific print area range allowing several ranges to be set param: string $method Determines the method used when setting multiple print areas return: $this |
| addPrintAreaByColumnAndRow($column1, $row1, $column2, $row2, $index = -1) X-Ref |
| Add a new print area to the list of print areas. param: int $column1 Start Column for the print area param: int $row1 Start Row for the print area param: int $column2 End Column for the print area param: int $row2 End Row for the print area param: int $index Identifier for a specific print area range allowing several ranges to be set return: $this |
| getFirstPageNumber() X-Ref |
| Get first page number. return: ?int |
| setFirstPageNumber($value) X-Ref |
| Set first page number. param: ?int $value return: $this |
| resetFirstPageNumber() X-Ref |
| Reset first page number. return: $this |
| getPageOrder() X-Ref |
| No description |
| setPageOrder(?string $pageOrder) X-Ref |
| No description |
| __clone() X-Ref |
| Implement PHP __clone to create a deep clone, not just a shallow copy. |
