ok
Direktori : /home2/selectio/www/salemgovtitialumni.in/pdf/src/FrameDecorator/ |
Current File : /home2/selectio/www/salemgovtitialumni.in/pdf/src/FrameDecorator/AbstractFrameDecorator.php |
<?php namespace Dompdf\FrameDecorator; use DOMElement; use DOMNode; use DOMText; use Dompdf\Helpers; use Dompdf\Dompdf; use Dompdf\Frame; use Dompdf\Frame\FrameTreeList; use Dompdf\Frame\Factory; use Dompdf\FrameReflower\AbstractFrameReflower; use Dompdf\Css\Style; use Dompdf\Positioner\AbstractPositioner; use Dompdf\Exception; /** * @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 AbstractFrameDecorator class * * @package dompdf */ abstract class AbstractFrameDecorator extends Frame { const DEFAULT_COUNTER = "-dompdf-default-counter"; public $_counters = []; // 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; /** * AbstractPositioner object used to position this frame (Strategy pattern) * * @var AbstractPositioner */ protected $_positioner; /** * Reflower object used to calculate frame dimensions (Strategy pattern) * * @var \Dompdf\FrameReflower\AbstractFrameReflower */ protected $_reflower; /** * Reference to the current dompdf instance * * @var Dompdf */ protected $_dompdf; /** * First block parent * * @var Block */ private $_block_parent; /** * First positionned parent (position: relative | absolute | fixed) * * @var AbstractFrameDecorator */ private $_positionned_parent; /** * Cache for the get_parent while loop results * * @var Frame */ private $_cached_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 Factory::decorate_frame($frame, $this->_dompdf, $this->_root); } /** * Create a deep copy: copy this node and all children * * @return Frame */ function deep_copy() { $node = $this->_frame->get_node(); if ($node instanceof DOMElement && $node->hasAttribute("id")) { $node->setAttribute("data-dompdf-original-id", $node->getAttribute("id")); $node->removeAttribute("id"); } $frame = new Frame($node->cloneNode()); $frame->set_style(clone $this->_frame->get_original_style()); $deco = 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 = []; $this->_cached_parent = null; //clear get_parent() cache // Reset all children foreach ($this->get_children() as $child) { $child->reset(); } } // Getters ----------- /** * @return string */ 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_content_box() { return $this->_frame->get_content_box(); } /** * @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 bool */ function is_auto_height() { return $this->_frame->is_auto_height(); } /** * @return bool */ function is_auto_width() { return $this->_frame->is_auto_width(); } /** * @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 AbstractFrameDecorator) { $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 AbstractFrameDecorator) { $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 AbstractFrameDecorator) { $new_child = $new_child->_frame; } if ($ref instanceof AbstractFrameDecorator) { $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) { $insert_frame = $new_child; while ($insert_frame instanceof AbstractFrameDecorator) { $insert_frame = $insert_frame->_frame; } $reference_frame = $ref; while ($reference_frame instanceof AbstractFrameDecorator) { $reference_frame = $reference_frame->_frame; } $this->_frame->insert_child_after($insert_frame, $reference_frame, $update_node); } /** * @param Frame $child * @param bool $update_node * * @return Frame */ function remove_child(Frame $child, $update_node = true) { while ($child instanceof AbstractFrameDecorator) { $child = $child->_frame; } return $this->_frame->remove_child($child, $update_node); } /** * @param bool $use_cache * @return AbstractFrameDecorator */ function get_parent($use_cache = true) { if ($use_cache && $this->_cached_parent) { return $this->_cached_parent; } $p = $this->_frame->get_parent(); if ($p && $deco = $p->get_decorator()) { while ($tmp = $deco->get_decorator()) { $deco = $tmp; } return $this->_cached_parent = $deco; } else { return $this->_cached_parent = $p; } } /** * @return AbstractFrameDecorator */ 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 AbstractFrameDecorator */ 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 AbstractFrameDecorator */ 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 AbstractFrameDecorator */ 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(AbstractPositioner $posn) { $this->_positioner = $posn; if ($this->_frame instanceof AbstractFrameDecorator) { $this->_frame->set_positioner($posn); } } function set_reflower(AbstractFrameReflower $reflower) { $this->_reflower = $reflower; if ($this->_frame instanceof AbstractFrameDecorator) { $this->_frame->set_reflower($reflower); } } /** * @return \Dompdf\FrameReflower\AbstractFrameReflower */ function get_reflower() { return $this->_reflower; } /** * @param Frame $root */ function set_root(Frame $root) { $this->_root = $root; if ($this->_frame instanceof AbstractFrameDecorator) { $this->_frame->set_root($root); } } /** * @return Page */ function get_root() { return $this->_root; } /** * @return Block */ 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 AbstractFrameDecorator */ 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 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 AbstractFrameReflower::_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 Exception("Unable to split: frame is not a child of this one."); } $node = $this->_frame->get_node(); if ($node instanceof DOMElement && $node->hasAttribute("id")) { $node->setAttribute("data-dompdf-original-id", $node->getAttribute("id")); $node->removeAttribute("id"); } $split = $this->copy($node->cloneNode()); $split->reset(); $split->get_original_style()->text_indent = 0; $split->_splitted = true; $split->_already_pushed = 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; $orig_style->page_break_before = "auto"; } // recalculate the float offsets after paging $this->get_parent()->insert_child_after($split, $this); if ($this instanceof Block) { foreach ($this->get_line_boxes() as $index => $line_box) { $line_box->get_float_offsets(); } } // Add $frame and all following siblings to the new split node $iter = $child; while ($iter) { $frame = $iter; $iter = $iter->get_next_sibling(); $frame->reset(); $frame->_parent = $split; $split->append_child($frame); // recalculate the float offsets if ($frame instanceof Block) { foreach ($frame->get_line_boxes() as $index => $line_box) { $line_box->get_float_offsets(); } } } $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]]; } } /** * @param string $id * @param int $value */ function reset_counter($id = self::DEFAULT_COUNTER, $value = 0) { $this->get_parent()->_counters[$id] = intval($value); } /** * @param $counters */ function decrement_counters($counters) { foreach ($counters as $id => $increment) { $this->increment_counter($id, intval($increment) * -1); } } /** * @param $counters */ function increment_counters($counters) { foreach ($counters as $id => $increment) { $this->increment_counter($id, intval($increment)); } } /** * @param string $id * @param int $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; } } /** * @param string $id * @return AbstractFrameDecorator|null */ 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; } return null; } /** * @param string $id * @param string $type * @return bool|string * * TODO: What version is the best : this one or the one in ListBullet ? */ 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", STR_PAD_LEFT); case "lower-roman": return Helpers::dec2roman($value); case "upper-roman": return mb_strtoupper(Helpers::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 Helpers::unichr($value + 944); case "upper-greek": return Helpers::unichr($value + 912); } } /** * */ final function position() { $this->_positioner->position($this); } /** * @param $offset_x * @param $offset_y * @param bool $ignore_self */ final function move($offset_x, $offset_y, $ignore_self = false) { $this->_positioner->move($this, $offset_x, $offset_y, $ignore_self); } /** * @param Block|null $block */ final function reflow(Block $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); } /** * @return array */ final function get_min_max_width() { return $this->_reflower->get_min_max_width(); } /** * Determine current frame width based on contents * * @return float */ final function calculate_auto_width() { return $this->_reflower->calculate_auto_width(); } }