vendor/dompdf/dompdf/src/Frame/Factory.php line 202

Open in your IDE?
  1. <?php
  2. /**
  3.  * @package dompdf
  4.  * @link    http://dompdf.github.com/
  5.  * @author  Benj Carson <benjcarson@digitaljunkies.ca>
  6.  * @license http://www.gnu.org/copyleft/lesser.html GNU Lesser General Public License
  7.  */
  8. namespace Dompdf\Frame;
  10. use Dompdf\Dompdf;
  11. use Dompdf\Exception;
  12. use Dompdf\Frame;
  13. use Dompdf\FrameDecorator\AbstractFrameDecorator;
  14. use DOMXPath;
  15. use Dompdf\FrameDecorator\Page as PageFrameDecorator;
  16. use Dompdf\FrameReflower\Page as PageFrameReflower;
  17. use Dompdf\Positioner\AbstractPositioner;
  19. /**
  20.  * Contains frame decorating logic
  21.  *
  22.  * This class is responsible for assigning the correct {@link AbstractFrameDecorator},
  23.  * {@link AbstractPositioner}, and {@link AbstractFrameReflower} objects to {@link Frame}
  24.  * objects.  This is determined primarily by the Frame's display type, but
  25.  * also by the Frame's node's type (e.g. DomElement vs. #text)
  26.  *
  27.  * @access  private
  28.  * @package dompdf
  29.  */
  30. class Factory
  31. {
  33.      /**
  34.      * Array of positioners for specific frame types
  35.      *
  36.      * @var AbstractPositioner[]
  37.      */
  38.     protected static $_positioners;
  40.     /**
  41.      * Decorate the root Frame
  42.      *
  43.      * @param $root   Frame The frame to decorate
  44.      * @param $dompdf Dompdf The dompdf instance
  45.      *
  46.      * @return PageFrameDecorator
  47.      */
  48.     static function decorate_root(Frame $root, Dompdf $dompdf)
  49.     {
  50.         $frame = new PageFrameDecorator($root, $dompdf);
  51.         $frame->set_reflower(new PageFrameReflower($frame));
  52.         $root->set_decorator($frame);
  54.         return $frame;
  55.     }
  57.     /**
  58.      * Decorate a Frame
  59.      *
  60.      * @param Frame $frame   The frame to decorate
  61.      * @param Dompdf $dompdf The dompdf instance
  62.      * @param Frame $root    The root of the frame
  63.      *
  64.      * @throws Exception
  65.      * @return AbstractFrameDecorator
  66.      * FIXME: this is admittedly a little smelly...
  67.      */
  68.     static function decorate_frame(Frame $frame, Dompdf $dompdf, Frame $root = null)
  69.     {
  70.         $style = $frame->get_style();
  71.         $display = $style->display;
  73.         switch ($display) {
  75.             case "block":
  76.                 $positioner = "Block";
  77.                 $decorator = "Block";
  78.                 $reflower = "Block";
  79.                 break;
  81.             case "inline-block":
  82.                 $positioner = "Inline";
  83.                 $decorator = "Block";
  84.                 $reflower = "Block";
  85.                 break;
  87.             case "inline":
  88.                 $positioner = "Inline";
  89.                 if ($frame->is_text_node()) {
  90.                     $decorator = "Text";
  91.                     $reflower = "Text";
  92.                 } else {
  93.                     $decorator = "Inline";
  94.                     $reflower = "Inline";
  95.                 }
  96.                 break;
  98.             case "table":
  99.                 $positioner = "Block";
  100.                 $decorator = "Table";
  101.                 $reflower = "Table";
  102.                 break;
  104.             case "inline-table":
  105.                 $positioner = "Inline";
  106.                 $decorator = "Table";
  107.                 $reflower = "Table";
  108.                 break;
  110.             case "table-row-group":
  111.             case "table-header-group":
  112.             case "table-footer-group":
  113.                 $positioner = "NullPositioner";
  114.                 $decorator = "TableRowGroup";
  115.                 $reflower = "TableRowGroup";
  116.                 break;
  118.             case "table-row":
  119.                 $positioner = "NullPositioner";
  120.                 $decorator = "TableRow";
  121.                 $reflower = "TableRow";
  122.                 break;
  124.             case "table-cell":
  125.                 $positioner = "TableCell";
  126.                 $decorator = "TableCell";
  127.                 $reflower = "TableCell";
  128.                 break;
  130.             case "list-item":
  131.                 $positioner = "Block";
  132.                 $decorator = "Block";
  133.                 $reflower = "Block";
  134.                 break;
  136.             case "-dompdf-list-bullet":
  137.                 if ($style->list_style_position === "inside") {
  138.                     $positioner = "Inline";
  139.                 } else {
  140.                     $positioner = "ListBullet";
  141.                 }
  143.                 if ($style->list_style_image !== "none") {
  144.                     $decorator = "ListBulletImage";
  145.                 } else {
  146.                     $decorator = "ListBullet";
  147.                 }
  149.                 $reflower = "ListBullet";
  150.                 break;
  152.             case "-dompdf-image":
  153.                 $positioner = "Inline";
  154.                 $decorator = "Image";
  155.                 $reflower = "Image";
  156.                 break;
  158.             case "-dompdf-br":
  159.                 $positioner = "Inline";
  160.                 $decorator = "Inline";
  161.                 $reflower = "Inline";
  162.                 break;
  164.             default:
  165.             case "none":
  166.                 if ($style->_dompdf_keep !== "yes") {
  167.                     // Remove the node and the frame
  168.                     $frame->get_parent()->remove_child($frame);
  169.                     return;
  170.                 }
  172.                 $positioner = "NullPositioner";
  173.                 $decorator = "NullFrameDecorator";
  174.                 $reflower = "NullFrameReflower";
  175.                 break;
  176.         }
  178.         // Handle CSS position
  179.         $position = $style->position;
  181.         if ($position === "absolute") {
  182.             $positioner = "Absolute";
  183.         } else {
  184.             if ($position === "fixed") {
  185.                 $positioner = "Fixed";
  186.             }
  187.         }
  189.         $node = $frame->get_node();
  191.         // Handle nodeName
  192.         if ($node->nodeName === "img") {
  193.             $style->set_prop("display", "-dompdf-image");
  194.             $decorator = "Image";
  195.             $reflower = "Image";
  196.         }
  198.         $decorator  = "Dompdf\\FrameDecorator\\$decorator";
  199.         $reflower   = "Dompdf\\FrameReflower\\$reflower";
  201.         /** @var AbstractFrameDecorator $deco */
  202.         $deco = new $decorator($frame, $dompdf);
  204.         $deco->set_positioner(self::getPositionerInstance($positioner));
  205.         $deco->set_reflower(new $reflower($deco, $dompdf->getFontMetrics()));
  207.         if ($root) {
  208.             $deco->set_root($root);
  209.         }
  211.         if ($display === "list-item") {
  212.             // Insert a list-bullet frame
  213.             $xml = $dompdf->getDom();
  214.             $bullet_node = $xml->createElement("bullet"); // arbitrary choice
  215.             $b_f = new Frame($bullet_node);
  217.             $node = $frame->get_node();
  218.             $parent_node = $node->parentNode;
  220.             if ($parent_node) {
  221.                 if (!$parent_node->hasAttribute("dompdf-children-count")) {
  222.                     $xpath = new DOMXPath($xml);
  223.                     $count = $xpath->query("li", $parent_node)->length;
  224.                     $parent_node->setAttribute("dompdf-children-count", $count);
  225.                 }
  227.                 if (is_numeric($node->getAttribute("value"))) {
  228.                     $index = intval($node->getAttribute("value"));
  229.                 } else {
  230.                     if (!$parent_node->hasAttribute("dompdf-counter")) {
  231.                         $index = ($parent_node->hasAttribute("start") ? $parent_node->getAttribute("start") : 1);
  232.                     } else {
  233.                         $index = (int)$parent_node->getAttribute("dompdf-counter") + 1;
  234.                     }
  235.                 }
  237.                 $parent_node->setAttribute("dompdf-counter", $index);
  238.                 $bullet_node->setAttribute("dompdf-counter", $index);
  239.             }
  241.             $new_style = $dompdf->getCss()->create_style();
  242.             $new_style->set_prop("display", "-dompdf-list-bullet");
  243.             $new_style->inherit($style);
  244.             $b_f->set_style($new_style);
  246.             $deco->prepend_child(Factory::decorate_frame($b_f, $dompdf, $root));
  247.         }
  249.         return $deco;
  250.     }
  252.     /**
  253.      * Creates Positioners
  254.      *
  255.      * @param string $type type of positioner to use
  256.      * @return AbstractPositioner
  257.      */
  258.     protected static function getPositionerInstance($type)
  259.     {
  260.         if (!isset(self::$_positioners[$type])) {
  261.             $class = '\\Dompdf\\Positioner\\'.$type;
  262.             self::$_positioners[$type] = new $class();
  263.         }
  264.         return self::$_positioners[$type];
  265.     }
  266. }