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.

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401]

(no description)

File Size: 490 lines (11 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class


Class: HeaderFooter  - X-Ref

<code>
Header/Footer Formatting Syntax taken from Office Open XML Part 4 - Markup Language Reference, page 1970:.

There are a number of formatting codes that can be written inline with the actual header / footer text, which
affect the formatting in the header or footer.

Example: This example shows the text "Center Bold Header" on the first line (center section), and the date on
the second line (center section).
&CCenter &"-,Bold"Bold&"-,Regular"Header_x000A_&D

General Rules:
There is no required order in which these codes must appear.

The first occurrence of the following codes turns the formatting ON, the second occurrence turns it OFF again:
- strikethrough
- superscript
- subscript
Superscript and subscript cannot both be ON at same time. Whichever comes first wins and the other is ignored,
while the first is ON.
&L - code for "left section" (there are three header / footer locations, "left", "center", and "right"). When
two or more occurrences of this section marker exist, the contents from all markers are concatenated, in the
order of appearance, and placed into the left section.
&P - code for "current page #"
&N - code for "total pages"
&font size - code for "text font size", where font size is a font size in points.
&K - code for "text font color"
RGB Color is specified as RRGGBB
Theme Color is specifed as TTSNN where TT is the theme color Id, S is either "+" or "-" of the tint/shade
value, NN is the tint/shade value.
&S - code for "text strikethrough" on / off
&X - code for "text super script" on / off
&Y - code for "text subscript" on / off
&C - code for "center section". When two or more occurrences of this section marker exist, the contents
from all markers are concatenated, in the order of appearance, and placed into the center section.

&D - code for "date"
&T - code for "time"
&G - code for "picture as background"
&U - code for "text single underline"
&E - code for "double underline"
&R - code for "right section". When two or more occurrences of this section marker exist, the contents
from all markers are concatenated, in the order of appearance, and placed into the right section.
&Z - code for "this workbook's file path"
&F - code for "this workbook's file name"
&A - code for "sheet tab name"
&+ - code for add to page #.
&- - code for subtract from page #.
&"font name,font type" - code for "text font name" and "text font type", where font name and font type
are strings specifying the name and type of the font, separated by a comma. When a hyphen appears in font
name, it means "none specified". Both of font name and font type can be localized values.
&"-,Bold" - code for "bold font style"
&B - also means "bold font style".
&"-,Regular" - code for "regular font style"
&"-,Italic" - code for "italic font style"
&I - also means "italic font style"
&"-,Bold Italic" code for "bold italic font style"
&O - code for "outline style"
&H - code for "shadow style"
</code>
__construct()   X-Ref
Create a new HeaderFooter.


getOddHeader()   X-Ref
Get OddHeader.

return: string

setOddHeader($oddHeader)   X-Ref
Set OddHeader.

param: string $oddHeader
return: $this

getOddFooter()   X-Ref
Get OddFooter.

return: string

setOddFooter($oddFooter)   X-Ref
Set OddFooter.

param: string $oddFooter
return: $this

getEvenHeader()   X-Ref
Get EvenHeader.

return: string

setEvenHeader($eventHeader)   X-Ref
Set EvenHeader.

param: string $eventHeader
return: $this

getEvenFooter()   X-Ref
Get EvenFooter.

return: string

setEvenFooter($evenFooter)   X-Ref
Set EvenFooter.

param: string $evenFooter
return: $this

getFirstHeader()   X-Ref
Get FirstHeader.

return: string

setFirstHeader($firstHeader)   X-Ref
Set FirstHeader.

param: string $firstHeader
return: $this

getFirstFooter()   X-Ref
Get FirstFooter.

return: string

setFirstFooter($firstFooter)   X-Ref
Set FirstFooter.

param: string $firstFooter
return: $this

getDifferentOddEven()   X-Ref
Get DifferentOddEven.

return: bool

setDifferentOddEven($differentOddEvent)   X-Ref
Set DifferentOddEven.

param: bool $differentOddEvent
return: $this

getDifferentFirst()   X-Ref
Get DifferentFirst.

return: bool

setDifferentFirst($differentFirst)   X-Ref
Set DifferentFirst.

param: bool $differentFirst
return: $this

getScaleWithDocument()   X-Ref
Get ScaleWithDocument.

return: bool

setScaleWithDocument($scaleWithDocument)   X-Ref
Set ScaleWithDocument.

param: bool $scaleWithDocument
return: $this

getAlignWithMargins()   X-Ref
Get AlignWithMargins.

return: bool

setAlignWithMargins($alignWithMargins)   X-Ref
Set AlignWithMargins.

param: bool $alignWithMargins
return: $this

addImage(HeaderFooterDrawing $image, $location = self::IMAGE_HEADER_LEFT)   X-Ref
Add header/footer image.

param: string $location
return: $this

removeImage($location = self::IMAGE_HEADER_LEFT)   X-Ref
Remove header/footer image.

param: string $location
return: $this

setImages(array $images)   X-Ref
Set header/footer images.

param: HeaderFooterDrawing[] $images
return: $this

getImages()   X-Ref
Get header/footer images.

return: HeaderFooterDrawing[]

__clone()   X-Ref
Implement PHP __clone to create a deep clone, not just a shallow copy.