Class Dompdf\FrameDecorator\Page

`extends`	`AbstractFrameDecorator`

Decorates frames for page layout

Dompdf\Frame
- Dompdf\FrameDecorator\AbstractFrameDecorator
  - Dompdf\FrameDecorator\Page

Methods


					
	public

__construct(Frame $frame, Dompdf $dompdf)

Class constructor

Parameters

`$frame`	the frame to decorate
`$dompdf`	The Dompdf object

Overrides

Dompdf\FrameDecorator\AbstractFrameDecorator::__construct()


					
	public

set_renderer(Renderer $renderer)

Set the renderer used for this pdf

Parameters

$renderer

the renderer to use


					
	public

get_renderer(): Renderer

Return the renderer used for this pdf


					
	public

calculate_bottom_page_edge(): void

Calculate the bottom edge of the page area after margins have been applied for the current page.


					
	public

is_full(): bool

Returns true if the page is full and is no longer accepting frames.


					
	public

next_page()

Start a new page by resetting the full flag.


					
	public

table_reflow_start()

Indicate to the page that a table is currently being reflowed.


					
	public

table_reflow_end()

Indicate to the page that table reflow is finished.


					
	public

in_nested_table(): bool

Return whether we are currently in a nested table or not


					
	public

check_forced_page_break(AbstractFrameDecorator $frame): bool

Check if a forced page break is required before $frame. This uses the frame's page_break_before property as well as…

Check if a forced page break is required before $frame. This uses the frame's page_break_before property as well as the preceding frame's page_break_after property.

Parameters

$frame

the frame to check

Returns

true if a page break occurred


					
	protected

hasGap(float $childPos, Frame $frame): bool

Check for a gap between the top content edge of a frame and its child content.

Additionally, the top margin, border, and padding of the frame must fit on the current page.

Parameters

`$childPos`	The top margin or line-box edge of the child content.
`$frame`	The parent frame to check.


					
	protected

_page_break_allowed(AbstractFrameDecorator $frame): bool

Determine if a page break is allowed before $frame http://www.w3.org/TR/CSS21/page.html#allowed-page-breaks

In the normal flow, page breaks can occur at the following places:

In the vertical margin between block boxes. When an unforced page break occurs here, the used values of the relevant 'margin-top' and 'margin-bottom' properties are set to '0'. When a forced page break occurs here, the used value of the relevant 'margin-bottom' property is set to '0'; the relevant 'margin-top' used value may either be set to '0' or retained. 2. Between line boxes inside a block container box. 3. Between the content edge of a block container box and the outer edges of its child content (margin edges of block-level children or line box edges for inline-level children) if there is a (non-zero) gap between them.

These breaks are subject to the following rules:

Rule A: Breaking at (1) is allowed only if the 'page-break-after' and 'page-break-before' properties of all the elements generating boxes that meet at this margin allow it, which is when at least one of them has the value 'always', 'left', or 'right', or when all of them are 'auto'.
Rule B: However, if all of them are 'auto' and a common ancestor of all the elements has a 'page-break-inside' value of 'avoid', then breaking here is not allowed.
Rule C: Breaking at (2) is allowed only if the number of line boxes between the break and the start of the enclosing block box is the value of 'orphans' or more, and the number of line boxes between the break and the end of the box is the value of 'widows' or more.
Rule D: In addition, breaking at (2) or (3) is allowed only if the 'page-break-inside' property of the element and all its ancestors is 'auto'.

If the above does not provide enough break points to keep content from overflowing the page boxes, then rules A, B and D are dropped in order to find additional breakpoints.

If that still does not lead to sufficient break points, rule C is dropped as well, to find still more break points.

We also allow breaks between table rows.

Parameters

$frame

the frame to check

Returns

true if a break is allowed, false otherwise


					
	public

check_page_break(AbstractFrameDecorator $frame): bool

Check if $frame will fit on the page. If the frame does not fit, the frame tree is modified so that a page break…

Check if $frame will fit on the page. If the frame does not fit, the frame tree is modified so that a page break occurs in the correct location.

Parameters

$frame

the frame to check


					
	public

split(?Frame $child = null, bool $page_break = false, bool $forced = false): void

Split this frame at $child. The current frame is cloned and $child and all children following $child are added to the…

Split this frame at $child. The current frame is cloned and $child and all children following $child are added to the clone. The clone is then passed to the current frame's parent->split() method.

Parameters

$forced

Whether the page break is forced.

Overrides

Dompdf\FrameDecorator\AbstractFrameDecorator::split()


					
	public

add_floating_frame(Frame $frame): void

Add a floating frame


					
	public

get_floating_frames(): Frame[]


					
	public

remove_floating_frame($key)


					
	public

get_lowest_float_offset(Frame $child): int|mixed

Methods inherited from Dompdf\FrameDecorator\AbstractFrameDecorator
dispose(), copy(), deep_copy(), create_anonymous_child(), reset(), reset_generated_content(), revert_counter_increment(), get_id(), get_frame(), get_node(), get_style(), get_original_style(), get_containing_block(), get_position(), get_dompdf(), get_margin_width(), get_margin_height(), get_content_box(), get_padding_box(), get_border_box(), set_id(), set_style(), set_containing_block(), set_position(), is_auto_height(), is_auto_width(), __toString(), prepend_child(), append_child(), insert_child_before(), insert_child_after(), remove_child(), get_parent(), get_first_child(), get_last_child(), get_prev_sibling(), get_next_sibling(), get_children(), get_subtree(), set_positioner(), set_reflower(), get_positioner(), get_reflower(), set_root(), get_root(), find_block_parent(), find_positioned_parent(), reset_counters(), reset_counter(), decrement_counters(), increment_counters(), increment_counter(), lookup_counter_frame(), counter_value(), position(), move(), reflow(), get_min_max_width()

Methods inherited from Dompdf\FrameDecorator\AbstractFrameDecorator

dispose(), copy(), deep_copy(), create_anonymous_child(), reset(), reset_generated_content(), revert_counter_increment(), get_id(), get_frame(), get_node(), get_style(), get_original_style(), get_containing_block(), get_position(), get_dompdf(), get_margin_width(), get_margin_height(), get_content_box(), get_padding_box(), get_border_box(), set_id(), set_style(), set_containing_block(), set_position(), is_auto_height(), is_auto_width(), __toString(), prepend_child(), append_child(), insert_child_before(), insert_child_after(), remove_child(), get_parent(), get_first_child(), get_last_child(), get_prev_sibling(), get_next_sibling(), get_children(), get_subtree(), set_positioner(), set_reflower(), get_positioner(), get_reflower(), set_root(), get_root(), find_block_parent(), find_positioned_parent(), reset_counters(), reset_counter(), decrement_counters(), increment_counters(), increment_counter(), lookup_counter_frame(), counter_value(), position(), move(), reflow(), get_min_max_width()

Methods inherited from Dompdf\Frame
`ws_trim(), ws_keep(), ws_is_text(), get_decorator(), get_opacity(), get_containing_line(), set_decorator(), set_opacity(), set_containing_line(), is_text_node(), is_positioned(), is_absolute(), is_block(), is_block_level(), is_inline_level(), is_in_flow(), is_pre(), is_table(),`

Constants inherited from Dompdf\FrameDecorator\AbstractFrameDecorator
`DEFAULT_COUNTER`

Constants inherited from Dompdf\Frame
`WS_TEXT, WS_SPACE`

Properties
`protected`	`float`	`$bottom_page_edge`	#
`protected`	`bool`	`$_page_full`	#
`protected`	`int`	`$_in_table`	#
`protected`	`Renderer`	`$_renderer`	#
`protected`	`array`	`$_floating_frames = []`	#

Properties inherited from Dompdf\FrameDecorator\AbstractFrameDecorator
`$_counters, $_root, $_frame, $_positioner, $_reflower, $_dompdf, $_block_parent, $_positioned_parent, $_cached_parent, $content_set, $is_split, $is_split_off`

Properties inherited from Dompdf\Frame
`$_node, $_id, $ID_COUNTER, $_style, $_parent, $_first_child, $_last_child, $_prev_sibling, $_next_sibling, $_containing_block, $_position, $_opacity, $_decorator, $_containing_line, $_is_cache, $_already_pushed, $_float_next_line, $_ws_state`

Namespaces

Classes

Class Dompdf\FrameDecorator\Page

Parameters

Overrides

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Parameters

Overrides