fix markdown in descriptions

[mdref/mdref] / mdref / RefEntry.php

diff --git a/mdref/RefEntry.php b/mdref/RefEntry.php
index 32ef3ceb6c9a0fdc432bc65938cbc3343a64e068..6c54674cedad30a1b8b545ae596c4ea4dd9f63c6 100644 (file)
--- a/mdref/RefEntry.php
+++ b/mdref/RefEntry.php
@@ -2,6 +2,9 @@
 
 namespace mdref;
 
+/**
+ * The RefEntry class represents a reference entry, i.e. a .md file
+ */
 class RefEntry
 {
        /**
@@ -19,17 +22,28 @@ class RefEntry
         */
        protected $file;
        
+       /**
+        * @param \mdref\Path $path
+        * @param type $entry
+        */
        function __construct(Path $path, $entry = null) {
                $this->path = $path;
                $this->entry = trim($entry ?: $path->getPathName(), DIRECTORY_SEPARATOR);
        }
        
+       /**
+        * Clean up the file handle
+        */
        function __destruct() {
                if (is_resource($this->file)) {
                        fclose($this->file);
                }
        }
        
+       /**
+        * Format as URL
+        * @return string
+        */
        function formatUrl() {
                return htmlspecialchars($this->entry);
        }
@@ -42,18 +56,25 @@ class RefEntry
                                continue;
                        }
                        if (strlen($link)) {
-                               if ($upper && !ctype_upper($parts[$i][0])) {
+                               if ($parts[$i][0] === ":") {
+                                       $link = "";
+                               } elseif ($upper && !ctype_upper($parts[$i][0])) {
                                        $link .= "::";
                                } else {
                                        $link .= "\\";
                                }
                        }
-                       $link .= $parts[$i];
+                       $link .= trim($parts[$i], ": ");
                        $upper = ctype_upper($parts[$i][0]);
                }
                return $link;
        }
 
+       /**
+        * Format as link text
+        * @param bool $basename whether to use the basename only
+        * @return string
+        */
        function formatLink($basename = false) {
                $link = "";
                if (strlen($this->entry)) {
@@ -63,6 +84,10 @@ class RefEntry
                return htmlspecialchars($link);
        }
        
+       /**
+        * Create a consolidated Path of this entry
+        * @return \mdref\Path
+        */
        function getPath() {
                $path = $this->path;
                $file = $path($this->entry);
@@ -74,28 +99,43 @@ class RefEntry
                        $file = $this->getPath();
                        
                        if (!$file->isFile()) {
-                               throw new \Exception("Not a file: '{$this->entry}'");
+                               throw new \Exception("Not a file: '{$file}'");
                        }
                        if (!$this->file = fopen($file->getFullPath(".md"), "r")) {
-                               throw new \Exception("Could not open {$this->entry}");
+                               throw new \Exception("Could not open {$file}");
                        }
                }
        }
        
+       /**
+        * Read the title of the refentry
+        * @return string
+        */
        function readTitle() {
                $this->openFile();
                fseek($this->file, 1, SEEK_SET);
-               return htmlspecialchars(fgets($this->file));
+               return fgets($this->file);
        }
        
+       /**
+        * Read the description of the refentry
+        * @return string
+        */
        function readDescription() {
                $this->openFile();
                fseek($this->file, 0, SEEK_SET);
                fgets($this->file);
                fgets($this->file);
-               return htmlspecialchars(fgets($this->file));
+               return fgets($this->file);
        }
        
+       /**
+        * Format a "Edit me" URL. The project reference top directory needs a 
+        * »name«.mdref file besides its »name«.md entry point with the edit URL
+        * printf template as content. The sole printf argument is the relative 
+        * path of the entry.
+        * @return string
+        */
        function formatEditUrl() {
                $path = $this->path;
                $base = current(explode(DIRECTORY_SEPARATOR, $path->getPathName()));
@@ -105,4 +145,20 @@ class RefEntry
                                        $this->entry);
                }
        }
-}
\ No newline at end of file
+       
+       /**
+        * Recurse into the reference tree
+        * @param \mdref\Finder $refs
+        * @param string $pattern
+        * @param callable $cb
+        */
+       function recurse(Finder $refs, $pattern, callable $cb) {
+               $path = $refs->find($refs->getBaseUrl()->mod($this->entry));
+               foreach (new RefListing($path, $refs->glob($path, $pattern)) as $entry) {
+                       /* @var $entry RefEntry */
+                       $cb($entry, $pattern, function($entry, $pattern) use ($refs, $cb) {
+                               $entry->recurse($refs, $pattern, $cb);
+                       });
+               }
+       }
+}