init

.gitignore

@@ -0,0 +1,4 @@
+/.idea
+/vendor
+/composer.lock
+/.env

composer.json

@@ -0,0 +1,23 @@
+{
+    "name": "luticate/doc",
+    "description": "Luticate documentation generator",
+    "authors": [
+        {
+            "name": "Robin THONI",
+            "email": "robin@rthoni.com"
+        }
+    ],
+    "repositories": [{
+      "type": "vcs",
+      "url":  "https://git.rthoni.com/luticate/utils.git"
+    }],
+    "require": {
+      "luticate/utils": "*"
+    },
+    "autoload": {
+      "psr-4": {
+        "Luticate\\": "src/"
+      }
+    },
+    "minimum-stability": "dev"
+}

src/Doc/Business/DocBlock.php

@@ -0,0 +1,110 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: robin
+ * Date: 10/22/15
+ * Time: 9:59 PM
+ */
+
+namespace Luticate\Doc\Business;
+
+use Exception;
+
+class DocBlock {
+
+    public $docblock,
+        $description = null,
+        $all_params = array();
+
+    /**
+     * Parses a docblock;
+     */
+    function __construct($docblock) {
+        if( !is_string($docblock) ) {
+            throw new Exception("DocBlock expects first parameter to be a string");
+        }
+
+        $this->docblock = $docblock;
+        $this->parse_block();
+    }
+
+    /**
+     * An alias to __call();
+     * allows a better DSL
+     *
+     * @param string $param_name
+     * @return mixed
+     */
+    public function __get($param_name) {
+        return $this->$param_name();
+    }
+
+    /**
+     * Checks if the param exists
+     *
+     * @param string $param_name
+     * @return mixed
+     */
+    public function __call($param_name, $values = null) {
+        if( $param_name == "description" ) {
+            return $this->description;
+        }else if( isset($this->all_params[$param_name]) ) {
+            $params = $this->all_params[$param_name];
+
+            if( count($params) == 1 ) {
+                return $params[0];
+            }else {
+                return $params;
+            }
+        }
+
+        return null;
+    }
+
+    /**
+     * Parse each line in the docblock
+     * and store the params in `$this->all_params`
+     * and the rest in `$this->description`
+     */
+    private function parse_block() {
+        // split at each line
+        foreach(preg_split("/(\r?\n)/", $this->docblock) as $line){
+
+            // if starts with an asterisk
+            if( preg_match('/^(?=\s+?\*[^\/])(.+)/', $line, $matches) ) {
+
+                $info = $matches[1];
+
+                // remove wrapping whitespace
+                $info = trim($info);
+
+                // remove leading asterisk
+                $info = preg_replace('/^(\*\s+?)/', '', $info);
+
+                // if it doesn't start with an "@" symbol
+                // then add to the description
+                if( $info[0] !== "@" ) {
+                    $this->description .= "\n$info";
+                    continue;
+                }else {
+                    // get the name of the param
+                    preg_match('/@(\w+)/', $info, $matches);
+                    $param_name = $matches[1];
+
+                    // remove the param from the string
+                    $value = str_replace("@$param_name ", '', $info);
+
+                    // if the param hasn't been added yet, create a key for it
+                    if( !isset($this->all_params[$param_name]) ) {
+                        $this->all_params[$param_name] = array();
+                    }
+
+                    // push the param value into place
+                    $this->all_params[$param_name][] = $value;
+
+                    continue;
+                }
+            }
+        }
+    }
+}

src/Doc/Business/LuDocBusiness.php

@@ -0,0 +1,133 @@
+<?php
+/**
+ * Created by PhpStorm.
+ * User: robin
+ * Date: 10/22/15
+ * Time: 8:24 PM
+ */
+
+namespace Luticate\Doc\Business;
+
+use Luticate\Utils\LuRoute;
+use Luticate\Utils\LuRouteDbo;
+use ReflectionMethod;
+
+class LuDocBusiness
+{
+    private static function getBusinesses()
+    {
+        $route = LuRoute::getInstance();
+
+        $businesses = [];
+        foreach ($route->getRoutes() as $r) {
+
+            if (!isset($businesses[$r->getBusinessClass()])) {
+                $businesses[$r->getBusinessClass()] = [];
+            }
+            $businesses[$r->getBusinessClass()][] = $r;
+        }
+        return $businesses;
+    }
+
+    /**
+     * @param $business string
+     * @return string
+     */
+    private static function getBusinessName($business)
+    {
+        $tab = explode("\\", $business);
+        return array_pop($tab);
+    }
+
+    /**
+     * @param $business string
+     * @return string
+     */
+    private static function getBusinessHyphen($business)
+    {
+        return str_replace("\\", "-", $business);
+    }
+
+    /**
+     * @param $business string
+     * @return string
+     */
+    private static function getBusinessFromHyphen($business)
+    {
+        return str_replace("-", "\\", $business);
+    }
+
+    /**
+     * Print the help page
+     */
+    public static function index()
+    {
+        $businesses_ = self::getBusinesses();
+        /**
+         * @var $businesses LuRouteDbo[]
+         */
+        foreach ($businesses_ as $businesses) {
+            $businessHyphen = self::getBusinessHyphen($businesses[0]->getBusinessClass());
+            $businessName = self::getBusinessName($businesses[0]->getBusinessClass());
+            echo '<a href="doc/' . $businessHyphen . '"><h1>' . $businessName . "</h1></a>";
+
+            foreach ($businesses as $business) {
+                echo '<a href="doc/' . $businessHyphen . '/' . $business->getBusinessMethod()
+                    . '">' . $business->getMethod() . " " . $business->getUrl() . "</a><br />";
+            }
+        }
+        exit;
+    }
+
+
+    /**
+     * Print the help page for the selected business.
+     * The business must have the full namespace, hyphen separated
+     * eg: App-Http-Business-MyBusinessClass
+     * @param $businessHyphen string The business to print help
+     */
+    public static function business($businessHyphen)
+    {
+        $businesses_ = self::getBusinesses();
+        /**
+         * @var $businesses LuRouteDbo[]
+         */
+        $businesses = $businesses_[self::getBusinessFromHyphen($businessHyphen)];
+        $businessName = self::getBusinessName($businesses[0]->getBusinessClass());
+        echo '<a href="' . $businessHyphen . '"><h1>' . $businessName . "</h1></a>";
+
+        foreach ($businesses as $business) {
+            echo '<a href="' . $businessHyphen . '/' . $business->getBusinessMethod()
+                . '">' . $business->getMethod() . " " . $business->getUrl() . "</a><br />";
+        }
+        exit;
+    }
+
+    /**
+     * Print the help page for the selected business method.
+     * The business must have the full namespace, hyphen separated
+     * eg: App-Http-Business-MyBusinessClass
+     * @param $businessHyphen string The business to print help
+     * @param $method string The method to print help
+     */
+    public static function method($businessHyphen, $method)
+    {
+        $businesses_ = self::getBusinesses();
+        $businessName = self::getBusinessFromHyphen($businessHyphen);
+        /**
+         * @var $businesses LuRouteDbo[]
+         */
+        $businesses = $businesses_[$businessName];
+        $business = null;
+        foreach ($businesses as $b) {
+            if ($b->getBusinessMethod() == $method) {
+                $business = $b;
+            }
+        }
+        echo "<h1>" . $business->getMethod() . " " . $business->getUrl() . "</h1>";
+
+        $reflection = new ReflectionMethod($businessName, $method);
+        echo str_replace("\n", "<br />", $reflection->getDocComment());
+        exit;
+    }
+}