block basics

examples/scripts/02-blocks.php

@@ -0,0 +1,14 @@
+<?php
+require "bootstrap.php";
+
+use DocxTemplate\TemplateFactory;
+
+$doc = new ExampleDoc("02-blocks.docx");
+$template = TemplateFactory::load($doc->getOriginalPath());
+
+$block = $template->extractBlock("block");
+$template->assign([
+    "block_placement" => $block
+]);
+
+$template->save($doc->getProcessedPath());

src/DocxTemplate/Content/DocBlock.php

@@ -0,0 +1,26 @@
+<?php
+namespace DocxTemplate\Content;
+
+class DocBlock implements UnescapedValueInterface
+{
+    /**
+     * @var string
+     */
+    private $content;
+
+    /**
+     * @param string $content
+     */
+    public function __construct($content)
+    {
+        $this->content = $content;
+    }
+
+    /**
+     * @return string
+     */
+    public function getUnescapedValue()
+    {
+        return $this->content;
+    }
+}

src/DocxTemplate/Content/UnescapedValue.php

@@ -0,0 +1,26 @@
+<?php
+namespace DocxTemplate\Content;
+
+class UnescapedValue implements UnescapedValueInterface
+{
+    /**
+     * @var string
+     */
+    private $value;
+
+    /**
+     * @param string $value
+     */
+    public function __construct($value)
+    {
+        $this->value = $value;
+    }
+
+    /**
+     * @return string
+     */
+    public function getUnescapedValue()
+    {
+        return $this->value;
+    }
+}

src/DocxTemplate/Content/UnescapedValueInterface.php

@@ -0,0 +1,10 @@
+<?php
+namespace DocxTemplate\Content;
+
+interface UnescapedValueInterface
+{
+    /**
+     * @return string
+     */
+    public function getUnescapedValue();
+}

src/DocxTemplate/Matcher.php

@@ -1,6 +1,8 @@
 <?php
 namespace DocxTemplate;
 
+use DocxTemplate\Content\UnescapedValueInterface;
+
 class Matcher
 {
     const MARK_DEFAULT_PATTERN = '{{%s}}'; // how to display mark in template (printf format, where %s - mark name)
@@ -12,11 +14,17 @@ class Matcher
      */
     private $replaceRegexp;
 
+    /**
+     * @var string
+     */
+    private $markPattern;
+
     /**
      * @param string $markPattern
      */
     public function __construct($markPattern = self::MARK_DEFAULT_PATTERN)
     {
+        $this->markPattern = $markPattern;
         $this->replaceRegexp = $this->convertPattern($markPattern);
     }
 
@@ -44,15 +52,19 @@ private function convertPattern($pattern)
 
     /**
      * @param  string $key
-     * @param  string $value
+     * @param  string|UnescapedValueInterface $value
      * @param  string $text
      * @return string
      */
     public function replaceMark($key, $value, $text)
     {
-        $pattern = sprintf($this->replaceRegexp, preg_quote($key));
-        $value = htmlspecialchars($value, ENT_QUOTES | ENT_XML1, 'UTF-8');
+        if ($value instanceof UnescapedValueInterface) {
+            $value = $value->getUnescapedValue();
+        } else {
+            $value = htmlspecialchars($value, ENT_QUOTES | ENT_XML1, 'UTF-8');
+        }
 
+        $pattern = sprintf($this->replaceRegexp, preg_quote($key));
         $replace = function ($matches) use ($value) {
             $space = $matches[1] == ' ' ? '&#160;' : ''; /** save space @see convertPattern */
 
@@ -87,4 +99,13 @@ public function getMarks($text)
 
         return array_unique($matches['mark']);
     }
+
+    /**
+     * @param string $name
+     * @return string
+     */
+    public function toMark($name)
+    {
+        return sprintf($this->markPattern, $name);
+    }
 }

src/DocxTemplate/Template.php

@@ -1,6 +1,8 @@
 <?php
 namespace DocxTemplate;
 
+use DocxTemplate\Content\DocBlock;
+
 class Template
 {
     /**
@@ -72,6 +74,53 @@ public function assign($key, $value = null)
         return $this;
     }
 
+    /**
+     * @param string|string[] $key
+     * @param bool|string $placeMark
+     * @return DocBlock
+     */
+    public function extractBlock($key, $placeMark = true)
+    {
+        if (is_array($key)) {
+            $blockStart = $key[0];
+            $blockEnd = $key[1];
+        } else {
+            $blockStart = $key . "_start";
+            $blockEnd = $key . "_end";
+        }
+
+        if (is_bool($placeMark) && $placeMark) {
+            $placeMark = is_string($key) ? $key : $blockStart;
+        }
+
+        $uniqId = uniqid();
+        $this->assign([
+            $blockStart => "BLOCK_OPEN" . $uniqId,
+            $blockEnd   => "BLOCK_CLOSE" . $uniqId
+        ]);
+
+        $pattern = "/BLOCK_OPEN{$uniqId}(.*)BLOCK_CLOSE{$uniqId}/";
+        $blockContent = "";
+        $content = preg_replace_callback($pattern, function ($matches) use (&$blockContent, $placeMark) {
+            if (isset($matches[1])) {
+                $blockContent = $matches[1];
+            }
+
+            if ($placeMark) {
+                return $this->matcher->toMark($placeMark);
+            } else {
+                return "";
+            }
+
+        }, $this->doc->getContent());
+
+        $this->doc->setContent($content);
+
+        // todo clean $blockContent
+
+        return new DocBlock($blockContent);
+    }
+
     /**
      * @param string $key
      * @param string $value