/usr/share/php/dompdf/include/frame_decorator.cls.php is in php-dompdf 0.6.2+dfsg-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 | <?php
/**
* @package dompdf
* @link http://dompdf.github.com/
* @author Benj Carson <benjcarson@digitaljunkies.ca>
* @license http://www.gnu.org/copyleft/lesser.html GNU Lesser General Public License
*/
/**
* Base Frame_Decorator class
*
* @access private
* @package dompdf
*/
abstract class Frame_Decorator extends Frame {
const DEFAULT_COUNTER = "-dompdf-default-counter";
public $_counters = array(); // array([id] => counter_value) (for generated content)
/**
* The root node of the DOM tree
*
* @var Frame
*/
protected $_root;
/**
* The decorated frame
*
* @var Frame
*/
protected $_frame;
/**
* Positioner object used to position this frame (Strategy pattern)
*
* @var Positioner
*/
protected $_positioner;
/**
* Reflower object used to calculate frame dimensions (Strategy pattern)
*
* @var Frame_Reflower
*/
protected $_reflower;
/**
* Reference to the current dompdf instance
*
* @var DOMPDF
*/
protected $_dompdf;
/**
* First block parent
*
* @var Block_Frame_Decorator
*/
private $_block_parent;
/**
* First positionned parent (position: relative | absolute | fixed)
*
* @var Frame_Decorator
*/
private $_positionned_parent;
/**
* Class constructor
*
* @param Frame $frame The decoration target
* @param DOMPDF $dompdf The DOMPDF object
*/
function __construct(Frame $frame, DOMPDF $dompdf) {
$this->_frame = $frame;
$this->_root = null;
$this->_dompdf = $dompdf;
$frame->set_decorator($this);
}
/**
* "Destructor": foribly free all references held by this object
*
* @param bool $recursive if true, call dispose on all children
*/
function dispose($recursive = false) {
if ( $recursive ) {
while ( $child = $this->get_first_child() ) {
$child->dispose(true);
}
}
$this->_root = null;
unset($this->_root);
$this->_frame->dispose(true);
$this->_frame = null;
unset($this->_frame);
$this->_positioner = null;
unset($this->_positioner);
$this->_reflower = null;
unset($this->_reflower);
}
/**
* Return a copy of this frame with $node as its node
*
* @param DOMNode $node
*
* @return Frame
*/
function copy(DOMNode $node) {
$frame = new Frame($node);
$frame->set_style(clone $this->_frame->get_original_style());
return Frame_Factory::decorate_frame($frame, $this->_dompdf, $this->_root);
}
/**
* Create a deep copy: copy this node and all children
*
* @return Frame
*/
function deep_copy() {
$frame = new Frame($this->get_node()->cloneNode());
$frame->set_style(clone $this->_frame->get_original_style());
$deco = Frame_Factory::decorate_frame($frame, $this->_dompdf, $this->_root);
foreach ($this->get_children() as $child) {
$deco->append_child($child->deep_copy());
}
return $deco;
}
/**
* Delegate calls to decorated frame object
*/
function reset() {
$this->_frame->reset();
$this->_counters = array();
// Reset all children
foreach ($this->get_children() as $child) {
$child->reset();
}
}
// Getters -----------
function get_id() {
return $this->_frame->get_id();
}
/**
* @return Frame
*/
function get_frame() {
return $this->_frame;
}
/**
* @return DOMElement|DOMText
*/
function get_node() {
return $this->_frame->get_node();
}
/**
* @return Style
*/
function get_style() {
return $this->_frame->get_style();
}
/**
* @return Style
*/
function get_original_style() {
return $this->_frame->get_original_style();
}
/**
* @param integer $i
*
* @return array|float
*/
function get_containing_block($i = null) {
return $this->_frame->get_containing_block($i);
}
/**
* @param integer $i
*
* @return array|float
*/
function get_position($i = null) {
return $this->_frame->get_position($i);
}
/**
* @return DOMPDF
*/
function get_dompdf() {
return $this->_dompdf;
}
/**
* @return float
*/
function get_margin_height() {
return $this->_frame->get_margin_height();
}
/**
* @return float
*/
function get_margin_width() {
return $this->_frame->get_margin_width();
}
/**
* @return array
*/
function get_padding_box() {
return $this->_frame->get_padding_box();
}
/**
* @return array
*/
function get_border_box() {
return $this->_frame->get_border_box();
}
/**
* @param integer $id
*/
function set_id($id) {
$this->_frame->set_id($id);
}
/**
* @param Style $style
*/
function set_style(Style $style) {
$this->_frame->set_style($style);
}
/**
* @param float $x
* @param float $y
* @param float $w
* @param float $h
*/
function set_containing_block($x = null, $y = null, $w = null, $h = null) {
$this->_frame->set_containing_block($x, $y, $w, $h);
}
/**
* @param float $x
* @param float $y
*/
function set_position($x = null, $y = null) {
$this->_frame->set_position($x, $y);
}
/**
* @return string
*/
function __toString() {
return $this->_frame->__toString();
}
/**
* @param Frame $child
* @param bool $update_node
*/
function prepend_child(Frame $child, $update_node = true) {
while ( $child instanceof Frame_Decorator ) {
$child = $child->_frame;
}
$this->_frame->prepend_child($child, $update_node);
}
/**
* @param Frame $child
* @param bool $update_node
*/
function append_child(Frame $child, $update_node = true) {
while ( $child instanceof Frame_Decorator ) {
$child = $child->_frame;
}
$this->_frame->append_child($child, $update_node);
}
/**
* @param Frame $new_child
* @param Frame $ref
* @param bool $update_node
*/
function insert_child_before(Frame $new_child, Frame $ref, $update_node = true) {
while ( $new_child instanceof Frame_Decorator ) {
$new_child = $new_child->_frame;
}
if ( $ref instanceof Frame_Decorator ) {
$ref = $ref->_frame;
}
$this->_frame->insert_child_before($new_child, $ref, $update_node);
}
/**
* @param Frame $new_child
* @param Frame $ref
* @param bool $update_node
*/
function insert_child_after(Frame $new_child, Frame $ref, $update_node = true) {
while ( $new_child instanceof Frame_Decorator ) {
$new_child = $new_child->_frame;
}
while ( $ref instanceof Frame_Decorator ) {
$ref = $ref->_frame;
}
$this->_frame->insert_child_after($new_child, $ref, $update_node);
}
/**
* @param Frame $child
* @param bool $update_node
*
* @return Frame
*/
function remove_child(Frame $child, $update_node = true) {
while ( $child instanceof Frame_Decorator ) {
$child = $child->_frame;
}
return $this->_frame->remove_child($child, $update_node);
}
/**
* @return Frame_Decorator
*/
function get_parent() {
$p = $this->_frame->get_parent();
if ( $p && $deco = $p->get_decorator() ) {
while ( $tmp = $deco->get_decorator() ) {
$deco = $tmp;
}
return $deco;
}
else if ( $p ) {
return $p;
}
return null;
}
/**
* @return Frame_Decorator
*/
function get_first_child() {
$c = $this->_frame->get_first_child();
if ( $c && $deco = $c->get_decorator() ) {
while ( $tmp = $deco->get_decorator() ) {
$deco = $tmp;
}
return $deco;
}
else if ( $c ) {
return $c;
}
return null;
}
/**
* @return Frame_Decorator
*/
function get_last_child() {
$c = $this->_frame->get_last_child();
if ( $c && $deco = $c->get_decorator() ) {
while ( $tmp = $deco->get_decorator() ) {
$deco = $tmp;
}
return $deco;
}
else if ( $c ) {
return $c;
}
return null;
}
/**
* @return Frame_Decorator
*/
function get_prev_sibling() {
$s = $this->_frame->get_prev_sibling();
if ( $s && $deco = $s->get_decorator() ) {
while ( $tmp = $deco->get_decorator() ) {
$deco = $tmp;
}
return $deco;
}
else if ( $s ) {
return $s;
}
return null;
}
/**
* @return Frame_Decorator
*/
function get_next_sibling() {
$s = $this->_frame->get_next_sibling();
if ( $s && $deco = $s->get_decorator() ) {
while ( $tmp = $deco->get_decorator() ) {
$deco = $tmp;
}
return $deco;
}
else if ( $s ) {
return $s;
}
return null;
}
/**
* @return FrameTreeList
*/
function get_subtree() {
return new FrameTreeList($this);
}
function set_positioner(Positioner $posn) {
$this->_positioner = $posn;
if ( $this->_frame instanceof Frame_Decorator ) {
$this->_frame->set_positioner($posn);
}
}
function set_reflower(Frame_Reflower $reflower) {
$this->_reflower = $reflower;
if ( $this->_frame instanceof Frame_Decorator ) {
$this->_frame->set_reflower( $reflower );
}
}
/**
* @return Frame_Reflower
*/
function get_reflower() {
return $this->_reflower;
}
/**
* @param Frame $root
*/
function set_root(Frame $root) {
$this->_root = $root;
if ( $this->_frame instanceof Frame_Decorator ) {
$this->_frame->set_root($root);
}
}
/**
* @return Page_Frame_Decorator
*/
function get_root() {
return $this->_root;
}
/**
* @return Block_Frame_Decorator
*/
function find_block_parent() {
// Find our nearest block level parent
$p = $this->get_parent();
while ( $p ) {
if ( $p->is_block() ) {
break;
}
$p = $p->get_parent();
}
return $this->_block_parent = $p;
}
/**
* @return Frame_Decorator
*/
function find_positionned_parent() {
// Find our nearest relative positionned parent
$p = $this->get_parent();
while ( $p ) {
if ( $p->is_positionned() ) {
break;
}
$p = $p->get_parent();
}
if ( !$p ) {
$p = $this->_root->get_first_child(); // <body>
}
return $this->_positionned_parent = $p;
}
/**
* 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.
*
* @param Frame $child
* @param boolean $force_pagebreak
*
* @throws DOMPDF_Exception
* @return void
*/
function split(Frame $child = null, $force_pagebreak = false) {
// decrement any counters that were incremented on the current node, unless that node is the body
$style = $this->_frame->get_style();
if ( $this->_frame->get_node()->nodeName !== "body" && $style->counter_increment && ($decrement = $style->counter_increment) !== "none" ) {
$this->decrement_counters($decrement);
}
if ( is_null( $child ) ) {
// check for counter increment on :before content (always a child of the selected element @link Frame_Reflower::_set_content)
// this can push the current node to the next page before counter rules have bubbled up (but only if
// it's been rendered, thus the position check)
if ( !$this->is_text_node() && $this->get_node()->hasAttribute("dompdf_before_frame_id") ) {
foreach($this->_frame->get_children() as $child) {
if ( $this->get_node()->getAttribute("dompdf_before_frame_id") == $child->get_id() && $child->get_position('x') !== NULL ) {
$style = $child->get_style();
if ( $style->counter_increment && ($decrement = $style->counter_increment) !== "none" ) {
$this->decrement_counters($decrement);
}
}
}
}
$this->get_parent()->split($this, $force_pagebreak);
return;
}
if ( $child->get_parent() !== $this ) {
throw new DOMPDF_Exception("Unable to split: frame is not a child of this one.");
}
$node = $this->_frame->get_node();
$split = $this->copy( $node->cloneNode() );
$split->reset();
$split->get_original_style()->text_indent = 0;
$split->_splitted = true;
// The body's properties must be kept
if ( $node->nodeName !== "body" ) {
// Style reset on the first and second parts
$style = $this->_frame->get_style();
$style->margin_bottom = 0;
$style->padding_bottom = 0;
$style->border_bottom = 0;
// second
$orig_style = $split->get_original_style();
$orig_style->text_indent = 0;
$orig_style->margin_top = 0;
$orig_style->padding_top = 0;
$orig_style->border_top = 0;
}
$this->get_parent()->insert_child_after($split, $this);
// Add $frame and all following siblings to the new split node
$iter = $child;
while ($iter) {
$frame = $iter;
$iter = $iter->get_next_sibling();
$frame->reset();
$split->append_child($frame);
}
$this->get_parent()->split($split, $force_pagebreak);
// If this node resets a counter save the current value to use when rendering on the next page
if ( $style->counter_reset && ( $reset = $style->counter_reset ) !== "none" ) {
$vars = preg_split( '/\s+/' , trim( $reset ) , 2 );
$split->_counters[ '__' . $vars[0] ] = $this->lookup_counter_frame( $vars[0] )->_counters[$vars[0]];
}
}
function reset_counter($id = self::DEFAULT_COUNTER, $value = 0) {
$this->get_parent()->_counters[$id] = intval($value);
}
function decrement_counters($counters) {
foreach($counters as $id => $increment) {
$this->increment_counter($id, intval($increment) * -1);
}
}
function increment_counters($counters) {
foreach($counters as $id => $increment) {
$this->increment_counter($id, intval($increment));
}
}
function increment_counter($id = self::DEFAULT_COUNTER, $increment = 1) {
$counter_frame = $this->lookup_counter_frame($id);
if ( $counter_frame ) {
if ( !isset($counter_frame->_counters[$id]) ) {
$counter_frame->_counters[$id] = 0;
}
$counter_frame->_counters[$id] += $increment;
}
}
function lookup_counter_frame($id = self::DEFAULT_COUNTER) {
$f = $this->get_parent();
while( $f ) {
if( isset($f->_counters[$id]) ) {
return $f;
}
$fp = $f->get_parent();
if ( !$fp ) {
return $f;
}
$f = $fp;
}
}
// TODO: What version is the best : this one or the one in List_Bullet_Renderer ?
function counter_value($id = self::DEFAULT_COUNTER, $type = "decimal") {
$type = mb_strtolower($type);
if ( !isset($this->_counters[$id]) ) {
$this->_counters[$id] = 0;
}
$value = $this->_counters[$id];
switch ($type) {
default:
case "decimal":
return $value;
case "decimal-leading-zero":
return str_pad($value, 2, "0");
case "lower-roman":
return dec2roman($value);
case "upper-roman":
return mb_strtoupper(dec2roman($value));
case "lower-latin":
case "lower-alpha":
return chr( ($value % 26) + ord('a') - 1);
case "upper-latin":
case "upper-alpha":
return chr( ($value % 26) + ord('A') - 1);
case "lower-greek":
return unichr($value + 944);
case "upper-greek":
return unichr($value + 912);
}
}
final function position() {
$this->_positioner->position();
}
final function move($offset_x, $offset_y, $ignore_self = false) {
$this->_positioner->move($offset_x, $offset_y, $ignore_self);
}
final function reflow(Block_Frame_Decorator $block = null) {
// Uncomment this to see the frames before they're laid out, instead of
// during rendering.
//echo $this->_frame; flush();
$this->_reflower->reflow($block);
}
final function get_min_max_width() {
return $this->_reflower->get_min_max_width();
}
}
|