Merge pull request #2009 from humanmade/late-render-partials

Store partials internally as full objects
phpDocumentor · Aug 11, 2018 · cf2ef3c · cf2ef3c
2 parents 4212ab6 + cf05f18
commit cf2ef3c
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 57 deletions.
diff --git a/src/phpDocumentor/Partials/Collection.php b/src/phpDocumentor/Partials/Collection.php
diff --git a/src/phpDocumentor/Partials/Partial.php b/src/phpDocumentor/Partials/Partial.php
@@ -37,6 +37,9 @@ class Partial
      */
     protected $link;
 
+    /** @var \Parsedown $parser */
+    protected $parser = null;
+
     /**
      * @return mixed
      */
@@ -84,4 +87,35 @@ public function setName(string $name): void
     {
         $this->name = $name;
     }
+
+    /**
+     * Constructs a new collection object.
+     *
+     * @param \Parsedown $parser
+     */
+    public function setParser($parser)
+    {
+        $this->parser = $parser;
+    }
+
+    /**
+     * Renders the partial to a string.
+     *
+     * @return string
+     */
+    public function __toString()
+    {
+        $content = '';
+        if ($this->getContent()) {
+            $content = $partial->getContent();
+        } elseif ($this->getLink()) {
+            if (! is_readable($this->getLink())) {
+                // Handled in ServiceProvider.
+                continue;
+            }
+
+            $content = file_get_contents($this->getLink());
+        }
+        return $this->parser->text($content);
+    }
 }
diff --git a/src/phpDocumentor/Partials/ServiceProvider.php b/src/phpDocumentor/Partials/ServiceProvider.php
@@ -16,7 +16,7 @@
 namespace phpDocumentor\Partials;
 
 use Parsedown;
-use phpDocumentor\Partials\Collection as PartialsCollection;
+use phpDocumentor\Descriptor\Collection;
 use phpDocumentor\Partials\Exception\MissingNameForPartialException;
 use Pimple\Container;
 use Pimple\ServiceProviderInterface;
@@ -44,7 +44,7 @@ public function register(Container $app): void
             return Parsedown::instance();
         };
 
-        $partialsCollection = new PartialsCollection($app['markdown']);
+        $partialsCollection = new Collection();
         $app['partials'] = $partialsCollection;
 
         /** @var Partial[] $partials */
@@ -55,21 +55,17 @@ public function register(Container $app): void
                     throw new MissingNameForPartialException('The name of the partial to load is missing');
                 }
 
-                $content = '';
-                if ($partial->getContent()) {
-                    $content = $partial->getContent();
-                } elseif ($partial->getLink()) {
+                $partial->setParser($app['markdown']);
+                if (!$partial->getContent() && $partial->getLink()) {
                     if (! is_readable($partial->getLink())) {
                         $app['monolog']->error(
                             sprintf($translator->translate('PPCPP:EXC-NOPARTIAL'), $partial->getLink())
                         );
                         continue;
                     }
-
-                    $content = file_get_contents($partial->getLink());
                 }
 
-                $partialsCollection->set($partial->getName(), $content);
+                $partialsCollection->set($partial->getName(), $partial);
             }
         }
     }