List hooks by category

mkdocs.yml

@@ -79,6 +79,7 @@ pages:
   # APIv3 Changes: api/changes.md
 - Hooks:
   - Using hooks: hooks/index.md
+  - All hooks: hooks/list.md
   - Setup:
     - Hooks with Symfony: hooks/setup/symfony.md
     - Hooks with Joomla: hooks/setup/joomla.md

tools/composer.json

 {
     "require": {
         "symfony/console": "^3.3",
-        "symfony/yaml": "^3.3"
+        "symfony/yaml": "^3.3",
+        "twig/twig": "~1.0"
     },
     "autoload": {
         "psr-4": {

tools/composer.lock

@@ -4,7 +4,7 @@
         "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file",
         "This file is @generated automatically"
     ],
-    "content-hash": "2ab7e9af936c5a1de589c4b1208a77ff",
+    "content-hash": "b8d46fa7002eaadc5ca17bdbe3a8e5cf",
     "packages": [
         {
             "name": "psr/log",
@@ -291,6 +291,71 @@
             "description": "Symfony Yaml Component",
             "homepage": "https://symfony.com",
             "time": "2017-06-02T22:05:06+00:00"
+        },
+        {
+            "name": "twig/twig",
+            "version": "v1.34.3",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/twigphp/Twig.git",
+                "reference": "451c6f4197e113e24c1c85bc3fc8c2d77adeff2e"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/twigphp/Twig/zipball/451c6f4197e113e24c1c85bc3fc8c2d77adeff2e",
+                "reference": "451c6f4197e113e24c1c85bc3fc8c2d77adeff2e",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=5.3.3"
+            },
+            "require-dev": {
+                "psr/container": "^1.0",
+                "symfony/debug": "~2.7",
+                "symfony/phpunit-bridge": "~3.3@dev"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "1.34-dev"
+                }
+            },
+            "autoload": {
+                "psr-0": {
+                    "Twig_": "lib/"
+                },
+                "psr-4": {
+                    "Twig\\": "src/"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "BSD-3-Clause"
+            ],
+            "authors": [
+                {
+                    "name": "Fabien Potencier",
+                    "email": "fabien@symfony.com",
+                    "homepage": "http://fabien.potencier.org",
+                    "role": "Lead Developer"
+                },
+                {
+                    "name": "Armin Ronacher",
+                    "email": "armin.ronacher@active-4.com",
+                    "role": "Project Founder"
+                },
+                {
+                    "name": "Twig Team",
+                    "homepage": "http://twig.sensiolabs.org/contributors",
+                    "role": "Contributors"
+                }
+            ],
+            "description": "Twig, the flexible, fast, and secure template language for PHP",
+            "homepage": "http://twig.sensiolabs.org",
+            "keywords": [
+                "templating"
+            ],
+            "time": "2017-06-07T18:45:17+00:00"
         }
     ],
     "packages-dev": [],

tools/src/AppBundle/Command/HookListCommand.php

@@ -5,10 +5,17 @@ namespace AppBundle\Command;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
+use Twig_Environment;
+use Twig_Loader_Filesystem;
 use AppBundle\Utils\Book;
 
 class HookListCommand extends Command {
 
+  /*
+   * Data about all hooks, sorted by category
+   */
+  protected $categories = array();
+
   protected function configure() {
     $this
       ->setName('generate:hook-list')
@@ -16,9 +23,59 @@ class HookListCommand extends Command {
   }
 
   protected function execute(InputInterface $input, OutputInterface $output) {
-    $hooks = Book::pages()['Hooks'];
+    $this->loadList();
+    $this->loadHookSummaries();
+    $this->writeOut();
+  }
+
+  /**
+   * Populate $this->categories with data
+   */
+  protected function loadList() {
+    // Get data from mkdocs.yml file under the 'Hooks' element
+    $categories = Book::pages()['Hooks'];
+
+    // Remove pages which are not about specific hooks
+    $categories = array_map(function ($pages) {
+      if (is_array($pages)) {
+        return array_filter($pages, function ($page_url) {
+          return preg_match('/hook_civicrm_/', $page_url);
+        });
+      }
+      else {
+        return FALSE;
+      }
+    }, $categories);
+
+    // Remove empty categories
+    $categories = array_filter($categories);
+
+    $this->categories = $categories;
+  }
+
+  /**
+   * Write the file with markdown content
+   */
+  protected function writeOut() {
+    $loader = new Twig_Loader_Filesystem(__DIR__ . '/../Resources/views');
+    $twig = new Twig_Environment($loader);
+    $content = htmlspecialchars_decode($twig->render(
+      "hook_list.md.twig",
+      array(
+        'categories' => $this->categories,
+        'command' => './bin/tools ' . $this->getName()
+      )
+    ));
+    file_put_contents(__DIR__ . '/../../../../docs/hooks/list.md', $content);
+  }
+  
+  protected function loadHookSummaries() {
+    foreach ($this->categories as $category => $hooks) {
+
+    }
+  }
 
-    //$output->write(var_export($hooks, TRUE));
+  protected function loadHookSummary($hookUrl) {
 
   }
 

tools/src/AppBundle/Resources/views/category.md.twig

+## {{ category }}
+
+{% for hook_name, hook_url in hooks %}
+* [{{ hook_name }}](/{{ hook_url }})
+{% endfor %}

tools/src/AppBundle/Resources/views/hook_list.md.twig

+# All hooks
+
+{% include 'no_edit_notice.md.twig' %}
+
+This is an overview list of all available hooks, listed by category.
+
+{% for category, hooks in categories %}
+
+  {%- include 'category.md.twig' %}
+
+{% endfor %}
+

tools/src/AppBundle/Resources/views/no_edit_notice.md.twig

+<!--
+  -- DO NOT EDIT
+  --
+  -- This entire page is auto-generated
+{%- if command %} by the following command:
+  -- {{ command }}
+{% endif %}
+  --
+  -->
+