From 9c75cb4537ce042cba0ae44fac9dcdd87b8c81d8 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?O=D0=98U=D0=AFd=20da=20silva?=
 <bruno-ds@users.noreply.github.com>
Date: Tue, 21 May 2019 12:05:52 +0200
Subject: [PATCH] :note: PhpDoc generation for the public API (#63)

- generate phpdoc to a dokuwiki compatible format
- add/update the phpdoc of a selection of class methods
---
 .doc/README.md                                |   52 +
 .doc/bin/build-doc-extensions                 |    7 +
 .doc/bin/build-doc-object-manipulation        |    8 +
 .doc/phpdoc-extensions.dist.xml               |   20 +
 .doc/phpdoc-objects-manipulation.dist.xml     |   58 +
 .doc/phpdoc-templates/.placeholder            |    0
 .../combodo-wiki/class.txt.twig               |  136 +
 .../combodo-wiki/elements/constant.txt.twig   |   31 +
 .../combodo-wiki/elements/method.txt.twig     |   95 +
 .../combodo-wiki/elements/property.txt.twig   |   49 +
 .../combodo-wiki/file.source.txt.twig         |    1 +
 .../combodo-wiki/file.txt.twig                |  122 +
 .../combodo-wiki/graphs/class.html.twig       |   42 +
 .../combodo-wiki/htaccess.dist                |    5 +
 .../includes/code-examples.txt.twig           |   34 +
 .../includes/inherited-from.txt.twig          |   12 +
 .../namespace-structure-toc.html.twig         |   26 +
 .../combodo-wiki/includes/see-also.txt.twig   |   26 +
 .../includes/tag-synthesys.txt.twig           |   56 +
 .../includes/tags-with-description.txt.twig   |   20 +
 .../combodo-wiki/includes/tags.txt.twig       |   22 +
 .../combodo-wiki/includes/used-by.txt.twig    |   24 +
 .../combodo-wiki/includes/uses.txt.twig       |   24 +
 .../combodo-wiki/includes/wrap-tags.txt.twig  |   11 +
 .../combodo-wiki/interface.txt.twig           |  121 +
 .../combodo-wiki/layout.txt.twig              |    5 +
 .../combodo-wiki/namespace.txt.twig           |   51 +
 .../combodo-wiki/reports/deprecated.html.twig |   49 +
 .../combodo-wiki/template.xml                 |   27 +
 .gitignore                                    |    3 +-
 application/applicationextension.inc.php      |   11 +-
 composer.lock                                 | 3054 +++++++++++++++++
 CONTRIBUTING.md => contributing.md            |    0
 core/cmdbobject.class.inc.php                 |    2 +
 core/dbobject.class.php                       | 1441 ++++++--
 core/dbobjectsearch.class.php                 |   37 +-
 core/dbobjectset.class.php                    |  116 +-
 core/dbsearch.class.php                       |  565 ++-
 core/dbunionsearch.class.php                  |   22 +-
 core/metamodel.class.php                      |   45 +-
 Jenkinsfile => jenkinsfile                    |    0
 phpdoc.dist.xml                               |   13 -
 readme.md                                     |  140 +
 43 files changed, 6228 insertions(+), 355 deletions(-)
 create mode 100644 .doc/README.md
 create mode 100755 .doc/bin/build-doc-extensions
 create mode 100755 .doc/bin/build-doc-object-manipulation
 create mode 100755 .doc/phpdoc-extensions.dist.xml
 create mode 100755 .doc/phpdoc-objects-manipulation.dist.xml
 create mode 100644 .doc/phpdoc-templates/.placeholder
 create mode 100644 .doc/phpdoc-templates/combodo-wiki/class.txt.twig
 create mode 100644 .doc/phpdoc-templates/combodo-wiki/elements/constant.txt.twig
 create mode 100644 .doc/phpdoc-templates/combodo-wiki/elements/method.txt.twig
 create mode 100644 .doc/phpdoc-templates/combodo-wiki/elements/property.txt.twig
 create mode 100644 .doc/phpdoc-templates/combodo-wiki/file.source.txt.twig
 create mode 100644 .doc/phpdoc-templates/combodo-wiki/file.txt.twig
 create mode 100644 .doc/phpdoc-templates/combodo-wiki/graphs/class.html.twig
 create mode 100644 .doc/phpdoc-templates/combodo-wiki/htaccess.dist
 create mode 100644 .doc/phpdoc-templates/combodo-wiki/includes/code-examples.txt.twig
 create mode 100644 .doc/phpdoc-templates/combodo-wiki/includes/inherited-from.txt.twig
 create mode 100644 .doc/phpdoc-templates/combodo-wiki/includes/namespace-structure-toc.html.twig
 create mode 100644 .doc/phpdoc-templates/combodo-wiki/includes/see-also.txt.twig
 create mode 100644 .doc/phpdoc-templates/combodo-wiki/includes/tag-synthesys.txt.twig
 create mode 100644 .doc/phpdoc-templates/combodo-wiki/includes/tags-with-description.txt.twig
 create mode 100644 .doc/phpdoc-templates/combodo-wiki/includes/tags.txt.twig
 create mode 100644 .doc/phpdoc-templates/combodo-wiki/includes/used-by.txt.twig
 create mode 100644 .doc/phpdoc-templates/combodo-wiki/includes/uses.txt.twig
 create mode 100644 .doc/phpdoc-templates/combodo-wiki/includes/wrap-tags.txt.twig
 create mode 100644 .doc/phpdoc-templates/combodo-wiki/interface.txt.twig
 create mode 100644 .doc/phpdoc-templates/combodo-wiki/layout.txt.twig
 create mode 100644 .doc/phpdoc-templates/combodo-wiki/namespace.txt.twig
 create mode 100644 .doc/phpdoc-templates/combodo-wiki/reports/deprecated.html.twig
 create mode 100644 .doc/phpdoc-templates/combodo-wiki/template.xml
 create mode 100644 composer.lock
 rename CONTRIBUTING.md => contributing.md (100%)
 rename Jenkinsfile => jenkinsfile (100%)
 delete mode 100644 phpdoc.dist.xml
 create mode 100644 readme.md

diff --git a/.doc/README.md b/.doc/README.md
new file mode 100644
index 000000000..2bc851cd7
--- /dev/null
+++ b/.doc/README.md
@@ -0,0 +1,52 @@
+# phpdoc dokuwiki template
+This directory contains a template rendering iTop phpdoc as wiki pages.
+
+
+
+## special instructions
+
+some tags where added : 
+ * `@api-advanced`: it means that a method is an `@api` but mark it also as "complex" to use
+ * `@overwritable-hook`: used to mark a method as "designed to be extended"
+ * `@extension-hook`: not used for now 
+ * `@phpdoc-tunning-exclude-inherited`: tunning tag that inform this template to ignere inherited methods in the rendrering.
+
+some behaviours where added :
+ * only public `@api` and `@api-advanced` are showed
+ * class properties are hidden (subject to change, but will require to white list them using `@api` tag)
+ 
+known limitations:
+ * inline tag do not work properly
+ * links are hardcoded instead of using phpdoc routes (adding our own routes was too complex)
+ * `@see` tags must be very specific: 
+   * always prefix class members with `Class::` (ie: `DBObject::Get()`) 
+   * for methods always suffix them with `()`, 
+   * for variables, always prefix them with `$`.
+   * do not use inline @see 
+ * as spaces are used to mark code, the templates have very few indentation, thus they are awful to read (sorry)
+ * `@example` 
+   * the sentence in the first line (next to the tag) is the title, it  must be enclose by double quotes 
+   * the following lines are the sample code. 
+   * 💔 since we simply hack the official tag, this syntax must be respected carefully 💔
+    
+ 
+
+## dokuwiki requirements
+ * the templates uses the [wrap plugin](https://www.dokuwiki.org/plugin:wrap).
+ * the generated files have to be placed under an arbitrary directory of `[/path/to/dokuwiki]/data/pages`.
+ * the html as to be activated [config:htmlok](https://www.dokuwiki.org/config:htmlok)
+ * the generated files have to be in lowercase
+
+## installation
+```
+composer require phpdocumentor/phpdocumentor:~2 --dev
+```
+
+## bin
+`.doc/bin/build-doc-object-manipulation` and `.doc/bin/build-doc-extensions` contains examples of doc. generation, beware: they have to be called from iTop root directory:
+```shell
+cd /path/to/itop/
+./.doc/bin/build-doc-object-manipulation
+``` 
+
+the resulting documentation is written into `data/phpdocumentor/output`
\ No newline at end of file
diff --git a/.doc/bin/build-doc-extensions b/.doc/bin/build-doc-extensions
new file mode 100755
index 000000000..77be02873
--- /dev/null
+++ b/.doc/bin/build-doc-extensions
@@ -0,0 +1,7 @@
+#!/bin/sh -x
+
+rm -rf /tmp/phpdoc-twig-cache/ &&  rm -rf data/phpdocumentor/output/extensions/ &&  rm -rf data/phpdocumentor/temp/extensions/ && vendor/bin/phpdoc -c .doc/phpdoc-extensions.dist.xml -vvv
+
+# now wee need to lowercase every generated file because dokuwiki can't handle uppercase
+cd data/phpdocumentor/output/extensions/
+for i in $( ls | grep [A-Z] ); do mv -i $i `echo $i | tr 'A-Z' 'a-z'`; done
\ No newline at end of file
diff --git a/.doc/bin/build-doc-object-manipulation b/.doc/bin/build-doc-object-manipulation
new file mode 100755
index 000000000..ca959a26e
--- /dev/null
+++ b/.doc/bin/build-doc-object-manipulation
@@ -0,0 +1,8 @@
+#!/bin/sh -x
+
+rm -rf /tmp/phpdoc-twig-cache/ &&  rm -rf data/phpdocumentor/output/objects-manipulation/ &&  rm -rf data/phpdocumentor/temp/objects-manipulation/ && vendor/bin/phpdoc -c .doc/phpdoc-objects-manipulation.dist.xml -vvv
+
+
+# now wee need to lowercase every generated file because dokuwiki can't handle uppercase
+cd data/phpdocumentor/output/objects-manipulation/
+for i in $( ls | grep [A-Z] ); do mv -i $i `echo $i | tr 'A-Z' 'a-z'`; done
\ No newline at end of file
diff --git a/.doc/phpdoc-extensions.dist.xml b/.doc/phpdoc-extensions.dist.xml
new file mode 100755
index 000000000..826cd61f2
--- /dev/null
+++ b/.doc/phpdoc-extensions.dist.xml
@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<phpdoc>
+  <title><![CDATA[iTop extensions]]></title>
+
+  <parser>
+    <target>../data/phpdocumentor/temp/extensions</target>
+  </parser>
+
+  <transformer>
+    <target>../data/phpdocumentor/output/extensions</target>
+  </transformer>
+
+  <transformations>
+    <template name="phpdoc-templates/combodo-wiki"/>
+  </transformations>
+
+  <files>
+    <file>../application/applicationextension.inc.php</file>
+  </files>
+</phpdoc>
diff --git a/.doc/phpdoc-objects-manipulation.dist.xml b/.doc/phpdoc-objects-manipulation.dist.xml
new file mode 100755
index 000000000..cb782eca0
--- /dev/null
+++ b/.doc/phpdoc-objects-manipulation.dist.xml
@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<phpdoc>
+
+  <!--
+    /**
+    The documentation of this file can be found here : https://docs.phpdoc.org/references/configuration.html
+    it has to be completed by the CLI parameters documentation which is more comprehensive: https://docs.phpdoc.org/references/commands/project_run.html#usage
+
+    usage:
+    vendor/bin/phpdoc -c phpdoc-objects-manipulation.dist.xml
+
+    */
+  -->
+
+  <title><![CDATA[iTop's objects manipulation API]]></title>
+
+  <parser>
+    <default-package-name>iTopORM</default-package-name>
+    <target>../data/phpdocumentor/temp/objects-manipulation</target>
+    <visibility>public,protected</visibility>
+    <markers>
+      <!--<item>TODO</item>-->
+      <!--<item>FIXME</item>-->
+    </markers>
+      <extensions>
+          <extension>php</extension>
+      </extensions>
+  </parser>
+
+  <transformer>
+    <target>../data/phpdocumentor/output/objects-manipulation</target>
+  </transformer>
+
+  <transformations>
+    <template name="phpdoc-templates/combodo-wiki"/>
+  </transformations>
+
+  <!--<logging>-->
+    <!--<level>warn</level>-->
+    <!--<paths>-->
+      <!--&lt;!&ndash;<default>data/phpdocumentor/log/objects-manipulation/{DATE}.log</default>&ndash;&gt;-->
+      <!--&lt;!&ndash;<errors>data/phpdocumentor/log/objects-manipulation/{DATE}.errors.log</errors>&ndash;&gt;-->
+
+      <!--<default>{APP_ROOT}/data/log/{DATE}.log</default>-->
+      <!--<errors>{APP_ROOT}/data/log/{DATE}.errors.log</errors>-->
+    <!--</paths>-->
+  <!--</logging>-->
+
+  <files>
+    <file>../core/dbobject.class.php</file>
+    <file>../core/dbobjectsearch.class.php</file>
+    <file>../core/metamodel.class.php</file>
+    <file>../core/dbobjectset.class.php</file>
+    <file>../core/dbsearch.class.php</file>
+    <file>../core/dbunionsearch.class.php</file>
+  </files>
+
+</phpdoc>
\ No newline at end of file
diff --git a/.doc/phpdoc-templates/.placeholder b/.doc/phpdoc-templates/.placeholder
new file mode 100644
index 000000000..e69de29bb
diff --git a/.doc/phpdoc-templates/combodo-wiki/class.txt.twig b/.doc/phpdoc-templates/combodo-wiki/class.txt.twig
new file mode 100644
index 000000000..94e805173
--- /dev/null
+++ b/.doc/phpdoc-templates/combodo-wiki/class.txt.twig
@@ -0,0 +1,136 @@
+{% extends 'layout.txt.twig' %}
+
+{% block content %}
+<wrap button>[[start|🔙 Back]]</wrap>
+
+{% if node.tags['internal'] is defined %}
+====== {{ node.name }} ======
+<WRAP alert>This class is "internal", and thus is not documented!</WRAP>
+{% elseif node.tags['api'] is not defined and node.tags['api-advanced'] is not defined and node.tags['overwritable-hook'] is not defined and node.tags['extension-hook'] is not defined %}
+====== {{ node.name }} ======
+<WRAP alert>This class is neither "api", "api-advanced", "overwritable-hook" or "extension-hook", and thus is not documented!</WRAP>
+{% else %}
+
+====== {{ node.name }} ======
+
+{% if node.deprecated %}<wrap danger>deprecated</wrap>{% endif %}
+{% if node.abstract %}<wrap warning>abstract</wrap>{% endif %}
+{% if node.final %}<wrap notice>final</wrap>{% endif %}
+{% include 'includes/wrap-tags.txt.twig' with {structure:node, wrap: 'safety', wrapTags: ['api', 'api-advanced', 'overwritable-hook', 'extension-hook']} %}
+
+
+
+{% if node.deprecated %}
+=== **<del>Deprecated</del>**===
+//{{ node.tags.deprecated[0].description }}//
+{% endif %}
+
+
+== {{  node.summary|replace({"\n":""})|raw }} ==
+<html>{{ node.description|markdown|raw }}</html>
+
+
+{% include 'includes/code-examples.txt.twig' with {structure:node, title_level: '====='} %}
+
+
+{% set class = node.parent %}
+{% block hierarchy_element %}
+
+{% if class and class.name is defined and class.name|trim != '' %}
+==== parent ====
+{% set child = class %}
+{% set class = class.parent %}
+{{ block('hierarchy_element') }}
+[[{{ child.name }}|{{ child.name }}]]
+{% endif %}
+{% endblock %}
+
+
+{% for interface in node.interfaces|sort_asc %}
+{% if loop.first %}
+==== Implements ====
+{% endif %}
+{% if loop.length > 1 %}  * {% endif %}{{ interface.fullyQualifiedStructuralElementName ?: interface }}
+{% endfor %}
+
+
+{% for trait in node.usedTraits|sort_asc %}
+{% if loop.first %}
+==== Uses traits ====
+{% endif %}
+{% if loop.length > 1 %}  * {% endif %}{{ trait.fullyQualifiedStructuralElementName ?: trait }}
+{% endfor %}
+
+
+{% include 'includes/see-also.txt.twig' with {structure:node, title_level: '==='} %}
+
+{% include 'includes/tags.txt.twig' with {structure:node, title_level: '=====', blacklist:  ['link', 'see', 'abstract', 'example', 'method', 'property', 'property-read', 'property-write', 'package', 'subpackage', 'phpdoc-tunning-exclude-inherited', 'api', 'api-advanced', 'overwritable-hook', 'extension-hook', 'copyright', 'license', 'code-example']} %}
+
+{% set methods = node.inheritedMethods.merge(node.methods.merge(node.magicMethods)) %}
+{% include 'includes/tag-synthesys.txt.twig' with {methods:methods, tag:'api'} %}
+{% include 'includes/tag-synthesys.txt.twig' with {methods:methods, tag:'api-advanced'} %}
+{% include 'includes/tag-synthesys.txt.twig' with {methods:methods, tag:'overwritable-hook'} %}
+{% include 'includes/tag-synthesys.txt.twig' with {methods:methods, tag:'extension-hook'} %}
+
+
+{% include 'includes/code-examples.txt.twig' with {structure:node, title_level: '=====', sub_title_level: '=='} %}
+
+<WRAP clear />
+
+{% for method in methods|sort_asc
+    if method.visibility == 'public'
+    and (
+        method.tags['api'] is defined
+        or method.tags['api-advanced'] is defined
+        or method.tags['overwritable-hook'] is defined
+        or method.tags['extension-hook'] is defined
+    )
+    and (
+        node.tags['phpdoc-tunning-exclude-inherited'] is not defined
+        or method.parent.name == node.name
+    )
+%}
+{%- if loop.first %}
+===== Public methods =====
+{% endif %}
+{{ block('method') }}
+{% endfor %}
+{% for method in methods|sort_asc if method.visibility == 'protected' and (method.tags['overwritable-hook'] is defined or method.tags['extension-hook'] is defined) %}
+{%- if loop.first %}
+===== Protected methods =====
+{% endif %}
+{{ block('method') }}
+{% endfor %}
+
+
+
+
+
+{% set constants = node.inheritedConstants.merge(node.constants) %}
+{% if constants|length > 0 %}
+===== Constants =====
+{% for constant in constants|sort_asc %}
+{{ block('constant') }}
+{% endfor %}
+{% endif %}
+
+
+{#{% set properties = node.inheritedProperties.merge(node.properties.merge(node.magicProperties)) %}#}
+{#{% for property in properties|sort_asc if property.visibility == 'public' %}#}
+{#{%- if loop.first %}#}
+{#===== Public properties =====#}
+{#{% endif %}#}
+{#{{ block('property') }}#}
+{#{% endfor %}#}
+{#{% for property in properties|sort_asc if property.visibility == 'protected' %}#}
+{#{%- if loop.first %}#}
+{#===== Protected properties =====#}
+{#{% endif %}#}
+{#{{ block('property') }}#}
+{#{% endfor %}#}
+
+
+{%- endif %} {#{% elseif node.tags['xxx'] is not defined and ... #}
+
+<wrap button>[[start|🔙 Back]]</wrap>
+{% endblock %}
\ No newline at end of file
diff --git a/.doc/phpdoc-templates/combodo-wiki/elements/constant.txt.twig b/.doc/phpdoc-templates/combodo-wiki/elements/constant.txt.twig
new file mode 100644
index 000000000..b2e3019cb
--- /dev/null
+++ b/.doc/phpdoc-templates/combodo-wiki/elements/constant.txt.twig
@@ -0,0 +1,31 @@
+{% block constant %}
+
+<WRAP group box >
+<WRAP twothirds column >
+==== {{ constant.name }} ====
+</WRAP>{# twothirds column#}
+
+<WRAP third column>
+{% if constant.deprecated %}<wrap danger>deprecated</wrap> {% endif %}
+{% if (node.parent is not null and constant.parent.fullyQualifiedStructuralElementName != node.fullyQualifiedStructuralElementName) %}<wrap notice>inherited</wrap> {% endif %}
+</WRAP>{# third column#}
+
+== {{ constant.summary|replace({"\n":""})|raw }} ==
+<html>{{ constant.description|markdown|raw }}</html>
+
+{% if constant.deprecated %}
+=== Deprecated ===
+{{ constant.tags.deprecated[0].description|raw }}
+{% endif %}
+
+{% include 'includes/inherited-from.txt.twig' with {structure:constant} %}
+
+{% include 'includes/see-also.txt.twig' with {structure:constant, title_level: '=='} %}
+
+{% include 'includes/uses.txt.twig' with {structure:constant, title_level: '=='} %}
+
+{% include 'includes/tags.txt.twig' with {structure:constant, title_level: '==', blacklist:  ['link', 'see', 'var', 'deprecated', 'uses', 'package', 'subpackage', 'todo', 'code-example']} %}
+
+</WRAP>{# group #}
+
+{% endblock %}
diff --git a/.doc/phpdoc-templates/combodo-wiki/elements/method.txt.twig b/.doc/phpdoc-templates/combodo-wiki/elements/method.txt.twig
new file mode 100644
index 000000000..59d0491da
--- /dev/null
+++ b/.doc/phpdoc-templates/combodo-wiki/elements/method.txt.twig
@@ -0,0 +1,95 @@
+{% block method %}
+
+
+<WRAP group box >
+<WRAP twothirds column >
+==== {{ method.name }} ====
+</WRAP>{# twothirds column#}
+<WRAP third column >
+{% include 'includes/wrap-tags.txt.twig' with {structure:method, wrap: 'safety', wrapTags: ['api', 'api-advanced', 'overwritable-hook', 'extension-hook']} %}
+{% if method.deprecated %}<wrap danger>deprecated</wrap> {% endif %}
+{% if (node.parent is not null and method.parent.fullyQualifiedStructuralElementName != node.fullyQualifiedStructuralElementName) %}<wrap notice>inherited</wrap> {% endif %}
+{% if method.abstract %}<wrap warning>abstract</wrap> {% endif %}
+{% if method.final %}<wrap notice>final</wrap> {% endif %}
+<wrap notice>{{ method.visibility }}</wrap>
+{% if method.static %}<wrap warning>static</wrap> {% endif %}
+</WRAP>{# third column#}
+
+
+== {{  method.summary|replace({"\n":""})|raw }} ==
+<html>{{ method.description|markdown|raw }}</html>
+
+<code php>{% if method.abstract %}abstract {% endif %}{% if method.final %}final {% endif %}{{ method.visibility }} {% if method.static %}static {% endif %}{{ method.name }}({% for argument in method.arguments %}{{ argument.isVariadic ? '...' }}{{ argument.name }}{{ argument.default ? (' = '~argument.default)|raw }}{% if not loop.last %}, {% endif %}{% endfor %})</code>
+
+<WRAP twothirds column >
+
+
+=== Parameters ===
+{% if method.arguments|length > 0 -%}
+^ types ^ name ^ default ^ description ^
+{% for argument in method.arguments -%}
+| **<nowiki>{{ argument.types|join('|')|raw }}</nowiki>** | {{ argument.name }} {{ argument.isVariadic ? '<small style="color: gray">variadic</small>' }}  |   <nowiki>{{ argument.default|raw }}</nowiki>   | {{ argument.description|trim|replace("\n", ' ')|raw }} |{{ "\r\n" }}
+{%- endfor %}
+{% else %}
+//none//
+{% endif %}
+
+
+{#=== Parameters ===#}
+{#{% if method.arguments|length > 0 -%}#}
+{#{% for argument in method.arguments -%}#}
+{#== {{ argument.name }} ==#}
+
+
+{#{% set varDesc %}#}
+    {#<span style="margin:0 10px; 0 20px; font-weight: bold;">{{ argument.types|join('|') }}</span>#}
+    {#{{ argument.isVariadic ? '<small style="color: gray">variadic</small>' }}#}
+    {#{{ argument.description|raw }}#}
+{#{% endset %}#}
+{#<html>{{ varDesc|markdown|raw }}</html>#}
+{#{%- endfor %}#}
+{#{% else %}#}
+{#<wrap tip>This method has no parameter</wrap>#}
+{#{% endif %}#}
+
+
+{% if method.response and method.response.types|join() != 'void' %}
+=== Returns ===
+<html>{{ ('**' ~ method.response.types|join('|')|trim ~ '** ' ~ method.response.description)|markdown|raw }}</html>
+{% endif %}
+
+</WRAP>{# twothirds column#}
+
+<WRAP third column >
+
+{% if method.tags.throws|length > 0 or method.tags.throw|length > 0 %}
+=== Throws ===
+{% for exception in method.tags.throws -%}
+{% if loop.length > 1 %}  * {% endif %}''{{ exception.types|join('|')|raw }}'' <nowiki>{{ exception.description|raw }}</nowiki>
+{% endfor %}
+{% endif %}
+
+{% include 'includes/inherited-from.txt.twig' with {structure:method} %}
+
+{% include 'includes/see-also.txt.twig' with {structure:method, title_level: '==='} %}
+
+{% include 'includes/uses.txt.twig' with {structure:method, title_level: '==='} %}
+
+{% include 'includes/used-by.txt.twig' with {structure:method, title_level: '==='} %}
+
+{% include 'includes/tags-with-description.txt.twig' with {structure:method, title_level: '===', WRAP: 'info', tagsWithDescription: ['api', 'api-advanced', 'overwritable-hook', 'extension-hook']} %}
+
+{% include 'includes/tags.txt.twig' with {structure:method, title_level: '===', blacklist:  ['todo', 'link', 'see', 'abstract', 'example', 'param', 'return', 'access', 'deprecated', 'throws', 'throw', 'uses', 'api', 'api-advanced', 'overwritable-hook', 'extension-hook', 'used-by', 'inheritdoc', 'code-example']} %}
+
+</WRAP>{# third column#}
+
+
+
+{% include 'includes/code-examples.txt.twig' with {structure:method, title_level: '==='} %}
+
+</WRAP>{# group #}
+
+
+
+
+{% endblock %}
diff --git a/.doc/phpdoc-templates/combodo-wiki/elements/property.txt.twig b/.doc/phpdoc-templates/combodo-wiki/elements/property.txt.twig
new file mode 100644
index 000000000..58083b916
--- /dev/null
+++ b/.doc/phpdoc-templates/combodo-wiki/elements/property.txt.twig
@@ -0,0 +1,49 @@
+{% block property %}
+
+<WRAP group box>
+<WRAP twothirds column >
+==== ${{ property.name }} ====
+</WRAP>{# twothirds column#}
+
+<WRAP third column>
+{% if property.deprecated %}<wrap danger>deprecated</wrap> {% endif %}
+{% if (node.parent is not null and property.parent.fullyQualifiedStructuralElementName != node.fullyQualifiedStructuralElementName) %}<wrap notice>inherited</wrap> {% endif %}
+</WRAP>{# third column#}
+
+
+
+
+== {{ property.summary|replace({"\n":""})|raw }} ==
+<html>{{ property.description|markdown|raw }}</html>
+{% if property.var.0.description %}<html>{{ property.var.0.description|markdown|raw }}</html>{% endif %}
+
+
+
+{#{% if property.types %}#}
+{#== Type ==#}
+{#{% for type in property.types  %}#}
+{#{% if loop.length > 1 %}  * {% endif %}{{ type|raw }} : {{ type.description|raw }}#}
+{#{% endfor %}#}
+{#{{ property.types|join('|')|raw }}#}
+{#{% endif %}#}
+
+
+{% if property.deprecated %}
+== Deprecated ==
+  {{ property.tags.deprecated[0].description }}
+{% endif %}
+
+{% include 'includes/inherited-from.txt.twig' with {structure:property} %}
+
+{% include 'includes/see-also.txt.twig' with {structure:property, title_level: '=='} %}
+
+{% include 'includes/uses.txt.twig' with {structure:property, title_level: ''} %}
+
+{% include 'includes/tags.txt.twig' with {structure:property, title_level: '==', blacklist:  ['link', 'see', 'access', 'var', 'deprecated', 'uses', 'todo', 'code-example']} %}
+
+
+<code php>{{ property.visibility }}  ${{ property.name }}{% if property.types %} : {{ property.types|join('|')|raw }}{% endif %}</code>
+
+</WRAP>{# group #}
+
+{% endblock %}
diff --git a/.doc/phpdoc-templates/combodo-wiki/file.source.txt.twig b/.doc/phpdoc-templates/combodo-wiki/file.source.txt.twig
new file mode 100644
index 000000000..c6f211c21
--- /dev/null
+++ b/.doc/phpdoc-templates/combodo-wiki/file.source.txt.twig
@@ -0,0 +1 @@
+{{ node.source|raw }}
diff --git a/.doc/phpdoc-templates/combodo-wiki/file.txt.twig b/.doc/phpdoc-templates/combodo-wiki/file.txt.twig
new file mode 100644
index 000000000..1a445283e
--- /dev/null
+++ b/.doc/phpdoc-templates/combodo-wiki/file.txt.twig
@@ -0,0 +1,122 @@
+{% extends 'layout.txt.twig' %}
+
+{% block javascripts %}
+
+{% endblock %}
+
+{% block content %}
+    {#<section class="row-fluid">#}
+        {#<div class="span2 sidebar">#}
+            {#{% set namespace = project.namespace %}#}
+            {#{{ block('sidebarNamespaces') }}#}
+        {#</div>#}
+    {#</section>#}
+    {#<section class="row-fluid">#}
+====== {{ node.path|split('/')|slice(0,-1)|join('/') }}{{ node.name }} ======
+{{ node.summary }}
+<html>{{ node.description|markdown|raw }}</html>
+
+{% if node.traits|length > 0 %}
+
+===== Traits =====
+{% for trait in node.traits %}
+    <tr>
+        <td>{{ trait|raw }}</td>
+        <td><em>{{ trait.summary }}</em></td>
+    </tr>
+{% endfor %}
+{% endif %}
+
+
+{% if node.interfaces|length > 0 %}
+===== Interfaces =====
+    {% for interface in node.interfaces %}
+        <tr>
+            <td>{{ interface|raw }}</td>
+            <td><em>{{ interface.summary }}</em></td>
+        </tr>
+    {% endfor %}
+{% endif %}
+
+{% if node.classes|length > 0 %}
+===== Classes =====
+{% for class in node.classes %}
+{{ class|raw }}
+<em>{{ class.summary }}</em>
+{% endfor %}
+{% endif %}
+
+{% if node.package is not empty and node.package != '\\' %}
+    ===== Package =====
+    {{ node.subpackage ? (node.package ~ '\\' ~ node.subpackage) : node.package }}
+{% endif %}
+
+{% for tagName,tags in node.tags if tagName in ['link', 'see'] %}
+    {% if loop.first %}
+        ===== See also =====
+    {% endif %}
+    {% for tag in tags %}
+        <dd><a href="{{ tag.reference ?: tag.link }}"><div class="namespace-wrapper">{{ tag.description ?: tag.reference }}</div></a></dd>
+    {% endfor %}
+{% endfor %}
+
+                    <h2>Tags</h2>
+                    <table class="table table-condensed">
+                        {% for tagName,tags in node.tags if tagName not in ['link', 'see', 'package', 'subpackage'] %}
+                            <tr>
+                                <th>
+                                    {{ tagName }}
+                                </th>
+                                <td>
+                                    {% for tag in tags %}
+                                        {{ tag.description|markdown|raw }}
+                                    {% endfor %}
+                                </td>
+                            </tr>
+                        {% else %}
+                            <tr><td colspan="2"><em>None found</em></td></tr>
+                        {% endfor %}
+                    </table>
+
+                </aside>
+            </div>
+
+            {% if node.constants|length > 0 %}
+            <div class="row-fluid">
+                <section class="span8 content file">
+                    <h2>Constants</h2>
+                </section>
+                <aside class="span4 detailsbar"></aside>
+            </div>
+
+                {% for constant in node.constants %}
+                    {{ block('constant') }}
+                {% endfor %}
+            {% endif %}
+
+            {% if node.functions|length > 0 %}
+            <div class="row-fluid">
+                <section class="span8 content file">
+                    <h2>Functions</h2>
+                </section>
+                <aside class="span4 detailsbar"></aside>
+            </div>
+
+                {% for method in node.functions %}
+                    {{ block('method') }}
+                {% endfor %}
+            {% endif %}
+
+        </div>
+    </section>
+
+    <div id="source-view" class="modal hide fade" tabindex="-1" role="dialog" aria-labelledby="source-view-label" aria-hidden="true">
+        <div class="modal-header">
+            <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
+            <h3 id="source-view-label">{{ node.file.name }}</h3>
+        </div>
+        <div class="modal-body">
+            <pre data-src="{{ path('files/' ~ node.path ~ '.txt')|raw }}" class="language-php line-numbers"></pre>
+        </div>
+    </div>
+{% endblock %}
diff --git a/.doc/phpdoc-templates/combodo-wiki/graphs/class.html.twig b/.doc/phpdoc-templates/combodo-wiki/graphs/class.html.twig
new file mode 100644
index 000000000..69b92fdca
--- /dev/null
+++ b/.doc/phpdoc-templates/combodo-wiki/graphs/class.html.twig
@@ -0,0 +1,42 @@
+{% extends 'layout.html.twig' %}
+
+{% block stylesheets %}
+    <link href="{{ path('css/jquery.iviewer.css') }}" rel="stylesheet" media="all"/>
+    <style>
+        #viewer {
+            position: relative;
+            width: 100%;
+        }
+        .wrapper {
+            overflow: hidden;
+        }
+    </style>
+{% endblock %}
+
+{% block javascripts %}
+    <script src="{{ path('js/jquery.mousewheel.js') }}" type="text/javascript"></script>
+    <script src="{{ path('js/jquery.iviewer.js') }}" type="text/javascript"></script>
+    <script type="text/javascript">
+        $(window).resize(function(){
+            $("#viewer").height($(window).height() - 100);
+        });
+
+        $(document).ready(function() {
+            $("#viewer").iviewer({src: '{{ path('graphs/classes.svg') }}', zoom_animation: false});
+            $('#viewer img').bind('dragstart', function(event){
+                event.preventDefault();
+            });
+            $(window).resize();
+        });
+    </script>
+{% endblock %}
+
+{% block content %}
+    <div class="row-fluid">
+        <div class="span12">
+            <div class="wrapper">
+                <div id="viewer" class="viewer"></div>
+            </div>
+        </div>
+    </div>
+{% endblock %}
diff --git a/.doc/phpdoc-templates/combodo-wiki/htaccess.dist b/.doc/phpdoc-templates/combodo-wiki/htaccess.dist
new file mode 100644
index 000000000..7b01f9bfd
--- /dev/null
+++ b/.doc/phpdoc-templates/combodo-wiki/htaccess.dist
@@ -0,0 +1,5 @@
+# Fixes a vulnerability in CentOS: http://stackoverflow.com/questions/20533279/prevent-php-from-parsing-non-php-files-such-as-somefile-php-txt
+<FilesMatch \.php\.txt$>
+    RemoveHandler .php
+    ForceType text/plain
+</FilesMatch>
\ No newline at end of file
diff --git a/.doc/phpdoc-templates/combodo-wiki/includes/code-examples.txt.twig b/.doc/phpdoc-templates/combodo-wiki/includes/code-examples.txt.twig
new file mode 100644
index 000000000..314840aa9
--- /dev/null
+++ b/.doc/phpdoc-templates/combodo-wiki/includes/code-examples.txt.twig
@@ -0,0 +1,34 @@
+{% if title_level is not defined %}
+    {%- set title_level = '==' -%}
+{% endif %}
+
+{% if sub_title_level is not defined %}
+    {%- set sub_title_level = title_level|slice(1) -%}
+{% endif %}
+{% if sub_title_level == '=' %}
+    {%- set sub_title_level = '' -%}
+{% endif %}
+
+{#{% for tagName,tags in structure.tags if tagName in ['code-example'] %}#}
+{#{% if loop.first %}#}
+{#{{title_level}} Examples {{title_level}}#}
+{#{% endif %}#}
+{#{% for tag in tags %}#}
+{#{%- set descToken = tag.description|split("\n", 2) -%}#}
+{#{%- set title = descToken[0] -%}#}
+{#{%- set code = descToken[1] -%}#}
+{#{{sub_title_level}} {{ title }} {{sub_title_level}}#}
+{#<code php>{{ code|raw }}</code>#}
+{#{% endfor %}#}
+{#{% endfor %}#}
+
+
+{% for tagName,tags in structure.tags if tagName in ['example'] %}
+{% if loop.first %}
+{{title_level}} Examples {{title_level}}
+{% endif %}
+{% for tag in tags %}
+{{ sub_title_level }} {{ tag.filePath|escape }}{{ sub_title_level }}
+<code php>{{ tag.description|raw }}</code>
+{% endfor %}
+{% endfor %}
\ No newline at end of file
diff --git a/.doc/phpdoc-templates/combodo-wiki/includes/inherited-from.txt.twig b/.doc/phpdoc-templates/combodo-wiki/includes/inherited-from.txt.twig
new file mode 100644
index 000000000..e56611be8
--- /dev/null
+++ b/.doc/phpdoc-templates/combodo-wiki/includes/inherited-from.txt.twig
@@ -0,0 +1,12 @@
+{% if title_level is not defined %}
+    {% set title_level='' %}
+{% endif %}
+
+{% if (node.parent is null) %}
+{{title_level}} File {{ structure.path }} {{title_level}}
+{% endif %}
+
+{% if (node.parent is not null and structure.parent.fullyQualifiedStructuralElementName != node.fullyQualifiedStructuralElementName) %}
+{{title_level}} Inherited from {{title_level}}
+[[{{structure.parent}}|{{structure.parent}}]]
+{% endif %}
diff --git a/.doc/phpdoc-templates/combodo-wiki/includes/namespace-structure-toc.html.twig b/.doc/phpdoc-templates/combodo-wiki/includes/namespace-structure-toc.html.twig
new file mode 100644
index 000000000..0d79ae9d5
--- /dev/null
+++ b/.doc/phpdoc-templates/combodo-wiki/includes/namespace-structure-toc.html.twig
@@ -0,0 +1,26 @@
+{% for structure in structures|sort_asc if structure.tags['internal'] is not defined and (structure.tags['api'] is defined or structure.tags['api-advanced'] is  defined or structure.tags['overwritable-hook'] is  defined or structure.tags['extension-hook'] is  defined ) %}
+{#{{ structure|raw }}#}
+
+{% set structureName = structure|trim('\\', 'left') %}
+
+<WRAP group box>
+<WRAP twothirds column >
+==== {{ structureName }} ====
+</WRAP>{# twothirds column#}
+
+<WRAP third column>
+{% if structure.deprecated %}<wrap danger>deprecated</wrap>{% endif %}
+{% if structure.abstract %}<wrap warning>abstract</wrap>{% endif %}
+{% if structure.final %}<wrap notice>final</wrap>{% endif %}
+{% if (node.parent is not null and structure.parent.fullyQualifiedStructuralElementName != node.fullyQualifiedStructuralElementName) %}<wrap notice>inherited</wrap> {% endif %}
+{% include 'includes/wrap-tags.txt.twig' with {structure:structure, wrap: 'safety', wrapTags: ['api', 'api-advanced', 'overwritable-hook', 'extension-hook']} %}
+</WRAP>{# third column#}
+
+
+{{ structure.summary|raw }}
+[[{{structureName}}|More informations]]
+
+</WRAP>{# group #}
+
+{% endfor %}
+
diff --git a/.doc/phpdoc-templates/combodo-wiki/includes/see-also.txt.twig b/.doc/phpdoc-templates/combodo-wiki/includes/see-also.txt.twig
new file mode 100644
index 000000000..2d41c0d3b
--- /dev/null
+++ b/.doc/phpdoc-templates/combodo-wiki/includes/see-also.txt.twig
@@ -0,0 +1,26 @@
+{% if title_level is not defined %}
+    {%- set title_level='==' -%}
+{% endif %}
+{% for tagName,tags in structure.tags if tagName in ['link', 'see'] %}
+{% if loop.first %}
+{{title_level}} See also {{title_level}}
+{% endif %}
+{% for tag in tags %}
+{%- set linkTag = tag.reference|trim('\\', 'left') -%}
+{% if not('()' in linkTag or '$' in linkTag or node.name in linkTag or  '::' in linkTag ) %}
+    {%- set linkTag = linkTag|lower -%}
+{% elseif node.name~'::' in linkTag %}
+    {%- set linkTag = linkTag|replace({(node.name~'::'): '#'})|lower -%}
+{% elseif '::' in linkTag -%}
+    {%- set linkTag = linkTag|replace({'::': '#'})|lower -%}
+{% else %}
+    {%- set linkTag = '#' ~ linkTag|lower -%}
+{%- endif %}
+
+{% if loop.length > 1 %}  * {% endif %}{% if tag.reference is not empty -%}
+    [[{{linkTag}}|{{ (tag.reference)|trim('\\', 'left') }}]] {% if tag.description|trim is not empty %}: {{ tag.description|trim('\\', 'left') }} {% endif %}
+{%- else -%}
+    {#{{ tag.description|trim('\\', 'left') }}#}
+{% endif %}
+{% endfor %}
+{% endfor %}
diff --git a/.doc/phpdoc-templates/combodo-wiki/includes/tag-synthesys.txt.twig b/.doc/phpdoc-templates/combodo-wiki/includes/tag-synthesys.txt.twig
new file mode 100644
index 000000000..05b26087a
--- /dev/null
+++ b/.doc/phpdoc-templates/combodo-wiki/includes/tag-synthesys.txt.twig
@@ -0,0 +1,56 @@
+{% if tag is not defined -%}
+    {# Do not display @api if @api-advanced is also present #}
+    {%- set tag = "api" -%}
+{%- endif %}
+
+{% if hidden_by is not defined -%}
+    {# Do not display @api if @api-advanced is also present #}
+    {%- set hidden_by = {"api" : "api-advanced"} -%}
+{%- endif %}
+
+
+
+{% for method in methods|sort_asc
+    if (method.visibility == 'public')
+    and (
+        method.tags[tag] is defined
+        and (
+            hidden_by[tag] is not defined or method.tags[hidden_by[tag]] is not defined
+        )
+    )
+%}
+{%- if loop.first %}
+{% if tag == 'api' %}
+===== API synthesis =====
+<WRAP>
+List of the public API methods.
+When manipulating {{ node.name }}, You can call those methods:
+</WRAP>
+{% elseif tag == 'api-advanced' %}
+===== Advanced API synthesis =====
+<WRAP>
+List of advanced API methods
+Beware they usage is recommended to advanced users only.
+</WRAP>
+{% elseif tag == 'overwritable-hook' %}
+===== overwritable-hook synthesis =====
+<WRAP >When inheriting from {{ node.name }},
+you can overwrite those methods in order to add custom logic:
+</WRAP>
+{% elseif tag == 'extension-hook' %}
+===== extension-hook synthesis =====
+<WRAP >
+When inheriting from {{ node.name }},
+you can extend the behaviour of iTop by implementing:
+</WRAP>
+{% endif %}
+{% endif %}
+{% set sanitizedMethod = method|trim('\\', 'left')|replace({(node.name~'::'): ''}) %}
+{% if '::' in sanitizedMethod -%}
+{%- if node.tags['phpdoc-tunning-exclude-inherited'] is not defined %}
+  * [[{{sanitizedMethod|replace({'::': '#'})|lower}}|↪{{sanitizedMethod}}]] — {{  method.summary|replace({"\n":""})|raw }}
+{% endif %}
+{%- else %}
+  * [[#{{sanitizedMethod}}|{{sanitizedMethod}}]] — {{  method.summary|replace({"\n":""})|raw }}
+{% endif %}
+{% endfor %}
\ No newline at end of file
diff --git a/.doc/phpdoc-templates/combodo-wiki/includes/tags-with-description.txt.twig b/.doc/phpdoc-templates/combodo-wiki/includes/tags-with-description.txt.twig
new file mode 100644
index 000000000..bd8e3b5d0
--- /dev/null
+++ b/.doc/phpdoc-templates/combodo-wiki/includes/tags-with-description.txt.twig
@@ -0,0 +1,20 @@
+{% if title_level is not defined %}
+    {% set title_level = '==' %}
+{% endif %}
+
+
+{%- for tagName,tags in structure.tags if tagName in tagsWithDescription -%}
+    {%- for tag in tags -%}
+        {%- if tag.description is not empty -%}
+{%- if WRAP is defined -%}
+    <WRAP {{WRAP}}>
+{%- endif -%}
+{{title_level}} {{ tagName }} {{title_level}}
+{{ tag.description|escape }}
+{%- if WRAP is defined -%}
+    </WRAP>
+{%- endif -%}
+        {%- endif -%}
+    {%- endfor -%}
+{%- endfor -%}
+
diff --git a/.doc/phpdoc-templates/combodo-wiki/includes/tags.txt.twig b/.doc/phpdoc-templates/combodo-wiki/includes/tags.txt.twig
new file mode 100644
index 000000000..008ffab56
--- /dev/null
+++ b/.doc/phpdoc-templates/combodo-wiki/includes/tags.txt.twig
@@ -0,0 +1,22 @@
+{% if title_level is not defined %}
+    {% set title_level='=====' %}
+{% endif %}
+
+{% if blacklist is not defined %}
+    {% set blacklist =['link', 'see', 'abstract', 'example', 'method', 'property', 'property-read', 'property-write', 'package', 'subpackage', 'api', 'api-advanced', 'todo', 'code-example'] %}
+{% endif %}
+{% if hidden_by is not defined -%}
+    {# Do not display @api if @api-advanced is also present #}
+    {%- set hidden_by = {"api" : "api-advanced"} -%}
+{%- endif %}
+
+{#^ {% for tagName,tags in structure.tags if tagName not in blacklist -%}#}
+{#{{ tagName }} ^#}
+{#{%- endfor %}#}
+
+{% for tagName,tags in structure.tags if tagName not in blacklist and (hidden_by[tagName] is not defined or structure.tags[hidden_by[tagName]] is not defined) %}
+{%- if loop.first %}
+{{title_level}} Tags {{title_level}}
+{% endif %}
+^ {{ tagName }} | {% for tag in tags %}{{ tag.version ? tag.version ~ ' '  : '' }}{{ tag.description}}{% endfor %}   |
+{% endfor %}
\ No newline at end of file
diff --git a/.doc/phpdoc-templates/combodo-wiki/includes/used-by.txt.twig b/.doc/phpdoc-templates/combodo-wiki/includes/used-by.txt.twig
new file mode 100644
index 000000000..e7d8d8c34
--- /dev/null
+++ b/.doc/phpdoc-templates/combodo-wiki/includes/used-by.txt.twig
@@ -0,0 +1,24 @@
+{% if title_level is not defined %}
+    {% set title_level='' %}
+{% endif %}
+{% for tagName,tags in structure.tags if tagName in ['used-by'] %}
+{% if loop.first %}
+{{title_level}} Used by {{title_level}}
+{% endif %}
+{% for tag in tags %}
+{% if loop.length > 1 %}  * {% endif %}{{ tag.reference ?: tag.link }} : {{ tag.description ?: tag.reference }}
+{% endfor %}
+{% endfor %}
+
+
+
+
+
+{#{% for tagName,tags in method.tags if tagName in ['uses'] %}#}
+    {#{% if loop.first %}#}
+        {#<dt>Uses</dt>#}
+    {#{% endif %}#}
+    {#{% for tag in tags %}#}
+        {#<dd>{{ tag.reference|raw }}</dd>#}
+    {#{% endfor %}#}
+{#{% endfor %}#}
\ No newline at end of file
diff --git a/.doc/phpdoc-templates/combodo-wiki/includes/uses.txt.twig b/.doc/phpdoc-templates/combodo-wiki/includes/uses.txt.twig
new file mode 100644
index 000000000..58e5b30b8
--- /dev/null
+++ b/.doc/phpdoc-templates/combodo-wiki/includes/uses.txt.twig
@@ -0,0 +1,24 @@
+{% if title_level is not defined %}
+    {% set title_level='' %}
+{% endif %}
+{% for tagName,tags in structure.tags if tagName in ['uses'] %}
+{% if loop.first %}
+{{title_level}} Uses {{title_level}}
+{% endif %}
+{% for tag in tags %}
+{% if loop.length > 1 %}  * {% endif %}{{ tag.reference ?: tag.link }} : {{ tag.description ?: tag.reference }}
+{% endfor %}
+{% endfor %}
+
+
+
+
+
+{#{% for tagName,tags in method.tags if tagName in ['uses'] %}#}
+    {#{% if loop.first %}#}
+        {#<dt>Uses</dt>#}
+    {#{% endif %}#}
+    {#{% for tag in tags %}#}
+        {#<dd>{{ tag.reference|raw }}</dd>#}
+    {#{% endfor %}#}
+{#{% endfor %}#}
\ No newline at end of file
diff --git a/.doc/phpdoc-templates/combodo-wiki/includes/wrap-tags.txt.twig b/.doc/phpdoc-templates/combodo-wiki/includes/wrap-tags.txt.twig
new file mode 100644
index 000000000..7419abf5b
--- /dev/null
+++ b/.doc/phpdoc-templates/combodo-wiki/includes/wrap-tags.txt.twig
@@ -0,0 +1,11 @@
+{% if wrap is not defined -%}
+    {% set wrap = 'notice' %}
+{%- endif -%}
+{% if hidden_by is not defined -%}
+    {# Do not display @api if @api-advanced is also present #}
+    {%- set hidden_by = {"api" : "api-advanced"} -%}
+{%- endif %}
+
+{%- for tagName,tags in structure.tags if tagName in wrapTags and (hidden_by[tagName] is not defined or structure.tags[hidden_by[tagName]] is not defined) %}
+ <wrap {{wrap}}>{{tagName}}</wrap>
+{% endfor %}
diff --git a/.doc/phpdoc-templates/combodo-wiki/interface.txt.twig b/.doc/phpdoc-templates/combodo-wiki/interface.txt.twig
new file mode 100644
index 000000000..5bf639994
--- /dev/null
+++ b/.doc/phpdoc-templates/combodo-wiki/interface.txt.twig
@@ -0,0 +1,121 @@
+{% extends 'layout.txt.twig' %}
+
+{% block content %}
+<wrap button>[[start|🔙 Back]]</wrap>
+
+{% if node.tags['internal'] is defined %}
+====== {{ node.name }} ======
+<WRAP alert>This interface is "internal", and thus is not documented!</WRAP>
+{% elseif node.tags['api'] is not defined and node.tags['api-advanced'] is not defined and node.tags['overwritable-hook'] is not defined and node.tags['extension-hook'] is not defined %}
+====== {{ node.name }} ======
+<WRAP alert>This interface is neither "api", "overwritable-hook" or "extension-hook", and thus is not documented!</WRAP>
+{% else %}
+
+====== {{ node.name }} ======
+
+{% if node.deprecated %}<wrap danger>deprecated</wrap>{% endif %}
+{% if node.abstract %}<wrap warning>abstract</wrap>{% endif %}
+{% if node.final %}<wrap notice>final</wrap>{% endif %}
+{% include 'includes/wrap-tags.txt.twig' with {structure:node, wrap: 'safety', wrapTags: ['api', 'api-advanced', 'overwritable-hook', 'extension-hook']} %}
+
+
+
+{% if node.deprecated %}
+=== **<del>Deprecated</del>**===
+//{{ node.tags.deprecated[0].description }}//
+{% endif %}
+
+
+== {{  node.summary|replace({"\n":""})|raw }} ==
+<html>{{ node.description|markdown|raw }}</html>
+
+
+{% include 'includes/code-examples.txt.twig' with {structure:node, title_level: '====='} %}
+
+
+{% set class = node.parent %}
+{% block hierarchy_element %}
+
+{% if class and class.name is defined and class.name|trim != '' %}
+==== parent ====
+{% set child = class %}
+{% set class = class.parent %}
+{{ block('hierarchy_element') }}
+[[{{ child.name }}|{{ child.name }}]]
+{% endif %}
+{% endblock %}
+
+
+{% for interface in node.interfaces|sort_asc %}
+{% if loop.first %}
+==== Implements ====
+{% endif %}
+{% if loop.length > 1 %}  * {% endif %}{{ interface.fullyQualifiedStructuralElementName ?: interface }}
+{% endfor %}
+
+
+{% for trait in node.usedTraits|sort_asc %}
+{% if loop.first %}
+==== Uses traits ====
+{% endif %}
+{% if loop.length > 1 %}  * {% endif %}{{ trait.fullyQualifiedStructuralElementName ?: trait }}
+{% endfor %}
+
+
+{% include 'includes/see-also.txt.twig' with {structure:node, title_level: '==='} %}
+
+{% include 'includes/tags.txt.twig' with {structure:node, title_level: '=====', blacklist:  ['link', 'see', 'abstract', 'example', 'method', 'property', 'property-read', 'property-write', 'package', 'subpackage', 'phpdoc-tunning-exclude-inherited', 'api', 'api-advanced', 'overwritable-hook', 'extension-hook', 'copyright', 'license', 'code-example']} %}
+
+
+{% set methods = node.inheritedMethods.merge(node.methods) %}
+{% include 'includes/tag-synthesys.txt.twig' with {methods:methods, tag:'api'} %}
+{% include 'includes/tag-synthesys.txt.twig' with {methods:methods, tag:'api-advanced'} %}
+{% include 'includes/tag-synthesys.txt.twig' with {methods:methods, tag:'overwritable-hook'} %}
+{% include 'includes/tag-synthesys.txt.twig' with {methods:methods, tag:'extension-hook'} %}
+
+<WRAP clear />
+
+
+{% for method in methods|sort_asc if method.visibility == 'public' %}
+{%- if loop.first %}
+===== Public methods =====
+{% endif %}
+{{ block('method') }}
+{% endfor %}
+{% for method in methods|sort_asc if method.visibility == 'protected' %}
+{%- if loop.first %}
+===== Protected methods =====
+{% endif %}
+{{ block('method') }}
+{% endfor %}
+
+
+
+{% set constants = node.inheritedConstants.merge(node.constants) %}
+{% if constants|length > 0 %}
+===== Constants =====
+{% for constant in constants|sort_asc %}
+{{ block('constant') }}
+{% endfor %}
+{% endif %}
+
+
+{#{% set properties = node.inheritedProperties.merge(node.properties) %}#}
+{#{% for property in properties|sort_asc if property.visibility == 'public' %}#}
+{#{%- if loop.first %}#}
+{#===== Public properties =====#}
+{#{% endif %}#}
+{#{{ block('property') }}#}
+{#{% endfor %}#}
+{#{% for property in properties|sort_asc if property.visibility == 'protected' %}#}
+{#{%- if loop.first %}#}
+{#===== Protected properties =====#}
+{#{% endif %}#}
+{#{{ block('property') }}#}
+{#{% endfor %}#}
+
+
+{%- endif %} {#{% elseif node.tags['xxx'] is not defined and ... #}
+
+<wrap button>[[start|🔙 Back]]</wrap>
+{% endblock %}
\ No newline at end of file
diff --git a/.doc/phpdoc-templates/combodo-wiki/layout.txt.twig b/.doc/phpdoc-templates/combodo-wiki/layout.txt.twig
new file mode 100644
index 000000000..7a2629d1d
--- /dev/null
+++ b/.doc/phpdoc-templates/combodo-wiki/layout.txt.twig
@@ -0,0 +1,5 @@
+{% use 'elements/constant.txt.twig' %}
+{% use 'elements/property.txt.twig' %}
+{% use 'elements/method.txt.twig' %}
+
+{% block content %}{% endblock %}
\ No newline at end of file
diff --git a/.doc/phpdoc-templates/combodo-wiki/namespace.txt.twig b/.doc/phpdoc-templates/combodo-wiki/namespace.txt.twig
new file mode 100644
index 000000000..3039693f8
--- /dev/null
+++ b/.doc/phpdoc-templates/combodo-wiki/namespace.txt.twig
@@ -0,0 +1,51 @@
+{% extends 'layout.txt.twig' %}
+
+{% block content %}
+{% set namespace = project.namespace %}
+{{ block('sidebarNamespaces') }}
+     
+{#{{ node.parent|raw }}#}
+{#====== {{ node.parent.fullyQualifiedStructuralElementName }}{{ node.name }} ======#}
+
+{% if node.children|length > 0 %}
+=====Namespaces=====
+{% include 'includes/namespace-structure-toc.html.twig' with {structures: node.children} %}
+----
+{% endif %}
+
+{% if node.traits|length > 0 %}
+===== Traits =====
+{% include 'includes/namespace-structure-toc.html.twig' with {structures: node.traits} %}
+----
+{%- endif %}
+
+{% if node.interfaces|length > 0 %}
+===== Interfaces =====
+{% include 'includes/namespace-structure-toc.html.twig' with {structures: node.interfaces} %}
+----
+{% endif %}
+
+{% if node.classes|length > 0 %}
+===== Classes =====
+{% include 'includes/namespace-structure-toc.html.twig' with {structures: node.classes} %}
+----
+{% endif %}
+
+
+
+{#{% if node.constants|length > 0 %}#}
+{#===== Constants =====#}
+{#{% for constant in node.constants|sort_asc %}#}
+{#    {{ block('constant') }}#}
+{#{% endfor %}#}
+{#{% endif %}#}
+
+{#{% if node.functions|length > 0 %}#}
+{#===== Functions =====#}
+
+{#{% for method in node.functions|sort_asc %}#}
+{#    {{ block('method') }}#}
+{#{% endfor %}#}
+{#{% endif %}#}
+
+{% endblock %}
diff --git a/.doc/phpdoc-templates/combodo-wiki/reports/deprecated.html.twig b/.doc/phpdoc-templates/combodo-wiki/reports/deprecated.html.twig
new file mode 100644
index 000000000..d4f372389
--- /dev/null
+++ b/.doc/phpdoc-templates/combodo-wiki/reports/deprecated.html.twig
@@ -0,0 +1,49 @@
+
+====== Deprecated elements ======
+
+{#{% for element in project.indexes.elements if element.deprecated %}#}
+    {#{% if element.file.path != previousPath %}#}
+        {#<li><a href="#{{ element.file.path }}"><i class="icon-file"></i> {{ element.file.path }}</a></li>#}
+    {#{% endif %}#}
+    {#{% set previousPath = element.file.path %}#}
+{#{% endfor %}#}
+
+{% for element in project.indexes.elements if element.deprecated %}
+    {% if element.file.path != previousPath %}
+    {% if previousPath %}
+</WRAP>{# group #}
+    {% endif %}
+    {#<a name="{{ element.file.path }}" id="{{ element.file.path }}"></a>#}
+===== {{ element.file.path }} ({{ element.tags.deprecated.count }} found)=====
+
+<WRAP group >
+<WRAP third column >
+Element
+</WRAP>{# third column#}
+<WRAP third column >
+Line
+</WRAP>{# third column#}
+<WRAP third column >
+Description
+</WRAP>{# third column#}
+
+{% endif %}
+{% for tag in element.tags.deprecated %}
+<WRAP group >
+<WRAP third column >
+    {{ element.fullyQualifiedStructuralElementName }}
+</WRAP>{# third column#}
+<WRAP third column >
+    {{ element.line }}
+</WRAP>{# third column#}
+<WRAP third column >
+    {{ tag.description }}
+</WRAP>{# third column#}
+
+{% endfor %}
+</WRAP>{# group #}
+{% set previousPath = element.file.path %}
+{% else %}
+<WRAP info>No deprecated elements have been found in this project.</WRAP>
+{% endfor %}
+
diff --git a/.doc/phpdoc-templates/combodo-wiki/template.xml b/.doc/phpdoc-templates/combodo-wiki/template.xml
new file mode 100644
index 000000000..78d52b5e7
--- /dev/null
+++ b/.doc/phpdoc-templates/combodo-wiki/template.xml
@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="utf-8"?>
+<template>
+  <author>Bruno DA SILVA</author>
+  <email>contact [at] combodo.com</email>
+  <version>1.0.0</version>
+  <copyright>Combodo 2018</copyright>
+  <description><![CDATA[
+
+      Forked from the clean theme of https://github.com/phpDocumentor/phpDocumentor2 provided under the MIT licence.
+      The original work is copyright "Mike van Riel".
+
+      ------------------------------------------------------------------------------------------------------------------
+
+      To improve performance you can add the following to your .htaccess:
+
+      <ifModule mod_deflate.c>
+          <filesMatch "\.(js|css|html)$">
+              SetOutputFilter DEFLATE
+          </filesMatch>
+      </ifModule>
+  ]]></description>
+  <transformations>
+    <transformation writer="twig" query="namespace" source="templates/combodo-wiki/namespace.txt.twig" artifact="start.txt"/>
+    <transformation writer="twig" query="indexes.classes" source="templates/combodo-wiki/class.txt.twig" artifact="{{name}}.txt"/>
+    <transformation writer="twig" query="indexes.interfaces" source="templates/combodo-wiki/interface.txt.twig" artifact="{{name}}.txt" />
+  </transformations>
+</template>
diff --git a/.gitignore b/.gitignore
index 70f08e79f..845a1a0d6 100644
--- a/.gitignore
+++ b/.gitignore
@@ -33,7 +33,8 @@ test/vendor/*
 !/.idea/inspectionProfiles
 !/.idea/inspectionProfiles/*
 
-
+#phpdocumentor temp file
+ast.dump
 
 # CMake
 cmake-build-*/
diff --git a/application/applicationextension.inc.php b/application/applicationextension.inc.php
index 392245eb1..fb2c3f8f5 100644
--- a/application/applicationextension.inc.php
+++ b/application/applicationextension.inc.php
@@ -365,7 +365,7 @@ interface iPopupMenuExtension
  * Base class for the various types of custom menus
  * 
  * @package     Extensibility
- * @internal
+ * @api
  * @since 2.0
  */
 abstract class ApplicationPopupMenuItem
@@ -378,8 +378,10 @@ abstract class ApplicationPopupMenuItem
 	protected $aCssClasses;
 	
 	/**
-	 *	Constructor
-	 *	
+	 * Constructor
+	 *
+     * @api
+     *
 	 * @param string $sUID The unique identifier of this menu in iTop... make sure you pass something unique enough
      * @param string $sLabel The display label of the menu (must be localized)
      * @param array $aCssClasses The CSS classes to add to the menu
@@ -509,6 +511,9 @@ class JSPopupMenuItem extends ApplicationPopupMenuItem
 	
 	/**
 	 * Class for adding an item that triggers some Javascript code
+     *
+     * @api
+     *
 	 * @param string $sUID The unique identifier of this menu in iTop... make sure you pass something unique enough
 	 * @param string $sLabel The display label of the menu (must be localized)
 	 * @param string $sJSCode In case the menu consists in executing some havascript code inside the page, pass it here. If supplied $sURL ans $sTarget will be ignored
diff --git a/composer.lock b/composer.lock
new file mode 100644
index 000000000..d48f8a184
--- /dev/null
+++ b/composer.lock
@@ -0,0 +1,3054 @@
+{
+    "_readme": [
+        "This file locks the dependencies of your project to a known state",
+        "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
+        "This file is @generated automatically"
+    ],
+    "content-hash": "45ec0e252f0ceab3e358672eb0944823",
+    "packages": [],
+    "packages-dev": [
+        {
+            "name": "cilex/cilex",
+            "version": "1.1.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/Cilex/Cilex.git",
+                "reference": "7acd965a609a56d0345e8b6071c261fbdb926cb5"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/Cilex/Cilex/zipball/7acd965a609a56d0345e8b6071c261fbdb926cb5",
+                "reference": "7acd965a609a56d0345e8b6071c261fbdb926cb5",
+                "shasum": ""
+            },
+            "require": {
+                "cilex/console-service-provider": "1.*",
+                "php": ">=5.3.3",
+                "pimple/pimple": "~1.0",
+                "symfony/finder": "~2.1",
+                "symfony/process": "~2.1"
+            },
+            "require-dev": {
+                "phpunit/phpunit": "3.7.*",
+                "symfony/validator": "~2.1"
+            },
+            "suggest": {
+                "monolog/monolog": ">=1.0.0",
+                "symfony/validator": ">=1.0.0",
+                "symfony/yaml": ">=1.0.0"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "1.0-dev"
+                }
+            },
+            "autoload": {
+                "psr-0": {
+                    "Cilex": "src/"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Mike van Riel",
+                    "email": "mike.vanriel@naenius.com"
+                }
+            ],
+            "description": "The PHP micro-framework for Command line tools based on the Symfony2 Components",
+            "homepage": "http://cilex.github.com",
+            "keywords": [
+                "cli",
+                "microframework"
+            ],
+            "time": "2014-03-29T14:03:13+00:00"
+        },
+        {
+            "name": "cilex/console-service-provider",
+            "version": "1.0.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/Cilex/console-service-provider.git",
+                "reference": "25ee3d1875243d38e1a3448ff94bdf944f70d24e"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/Cilex/console-service-provider/zipball/25ee3d1875243d38e1a3448ff94bdf944f70d24e",
+                "reference": "25ee3d1875243d38e1a3448ff94bdf944f70d24e",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=5.3.3",
+                "pimple/pimple": "1.*@dev",
+                "symfony/console": "~2.1"
+            },
+            "require-dev": {
+                "cilex/cilex": "1.*@dev",
+                "silex/silex": "1.*@dev"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "1.0-dev"
+                }
+            },
+            "autoload": {
+                "psr-0": {
+                    "Cilex\\Provider\\Console": "src"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Beau Simensen",
+                    "email": "beau@dflydev.com",
+                    "homepage": "http://beausimensen.com"
+                },
+                {
+                    "name": "Mike van Riel",
+                    "email": "mike.vanriel@naenius.com"
+                }
+            ],
+            "description": "Console Service Provider",
+            "keywords": [
+                "cilex",
+                "console",
+                "pimple",
+                "service-provider",
+                "silex"
+            ],
+            "time": "2012-12-19T10:50:58+00:00"
+        },
+        {
+            "name": "container-interop/container-interop",
+            "version": "1.2.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/container-interop/container-interop.git",
+                "reference": "79cbf1341c22ec75643d841642dd5d6acd83bdb8"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/container-interop/container-interop/zipball/79cbf1341c22ec75643d841642dd5d6acd83bdb8",
+                "reference": "79cbf1341c22ec75643d841642dd5d6acd83bdb8",
+                "shasum": ""
+            },
+            "require": {
+                "psr/container": "^1.0"
+            },
+            "type": "library",
+            "autoload": {
+                "psr-4": {
+                    "Interop\\Container\\": "src/Interop/Container/"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "description": "Promoting the interoperability of container objects (DIC, SL, etc.)",
+            "homepage": "https://github.com/container-interop/container-interop",
+            "time": "2017-02-14T19:40:03+00:00"
+        },
+        {
+            "name": "doctrine/annotations",
+            "version": "v1.4.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/doctrine/annotations.git",
+                "reference": "54cacc9b81758b14e3ce750f205a393d52339e97"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/doctrine/annotations/zipball/54cacc9b81758b14e3ce750f205a393d52339e97",
+                "reference": "54cacc9b81758b14e3ce750f205a393d52339e97",
+                "shasum": ""
+            },
+            "require": {
+                "doctrine/lexer": "1.*",
+                "php": "^5.6 || ^7.0"
+            },
+            "require-dev": {
+                "doctrine/cache": "1.*",
+                "phpunit/phpunit": "^5.7"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "1.4.x-dev"
+                }
+            },
+            "autoload": {
+                "psr-4": {
+                    "Doctrine\\Common\\Annotations\\": "lib/Doctrine/Common/Annotations"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Roman Borschel",
+                    "email": "roman@code-factory.org"
+                },
+                {
+                    "name": "Benjamin Eberlei",
+                    "email": "kontakt@beberlei.de"
+                },
+                {
+                    "name": "Guilherme Blanco",
+                    "email": "guilhermeblanco@gmail.com"
+                },
+                {
+                    "name": "Jonathan Wage",
+                    "email": "jonwage@gmail.com"
+                },
+                {
+                    "name": "Johannes Schmitt",
+                    "email": "schmittjoh@gmail.com"
+                }
+            ],
+            "description": "Docblock Annotations Parser",
+            "homepage": "http://www.doctrine-project.org",
+            "keywords": [
+                "annotations",
+                "docblock",
+                "parser"
+            ],
+            "time": "2017-02-24T16:22:25+00:00"
+        },
+        {
+            "name": "doctrine/instantiator",
+            "version": "1.0.5",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/doctrine/instantiator.git",
+                "reference": "8e884e78f9f0eb1329e445619e04456e64d8051d"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/doctrine/instantiator/zipball/8e884e78f9f0eb1329e445619e04456e64d8051d",
+                "reference": "8e884e78f9f0eb1329e445619e04456e64d8051d",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=5.3,<8.0-DEV"
+            },
+            "require-dev": {
+                "athletic/athletic": "~0.1.8",
+                "ext-pdo": "*",
+                "ext-phar": "*",
+                "phpunit/phpunit": "~4.0",
+                "squizlabs/php_codesniffer": "~2.0"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "1.0.x-dev"
+                }
+            },
+            "autoload": {
+                "psr-4": {
+                    "Doctrine\\Instantiator\\": "src/Doctrine/Instantiator/"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Marco Pivetta",
+                    "email": "ocramius@gmail.com",
+                    "homepage": "http://ocramius.github.com/"
+                }
+            ],
+            "description": "A small, lightweight utility to instantiate objects in PHP without invoking their constructors",
+            "homepage": "https://github.com/doctrine/instantiator",
+            "keywords": [
+                "constructor",
+                "instantiate"
+            ],
+            "time": "2015-06-14T21:17:01+00:00"
+        },
+        {
+            "name": "doctrine/lexer",
+            "version": "v1.0.1",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/doctrine/lexer.git",
+                "reference": "83893c552fd2045dd78aef794c31e694c37c0b8c"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/doctrine/lexer/zipball/83893c552fd2045dd78aef794c31e694c37c0b8c",
+                "reference": "83893c552fd2045dd78aef794c31e694c37c0b8c",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=5.3.2"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "1.0.x-dev"
+                }
+            },
+            "autoload": {
+                "psr-0": {
+                    "Doctrine\\Common\\Lexer\\": "lib/"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Roman Borschel",
+                    "email": "roman@code-factory.org"
+                },
+                {
+                    "name": "Guilherme Blanco",
+                    "email": "guilhermeblanco@gmail.com"
+                },
+                {
+                    "name": "Johannes Schmitt",
+                    "email": "schmittjoh@gmail.com"
+                }
+            ],
+            "description": "Base library for a lexer that can be used in Top-Down, Recursive Descent Parsers.",
+            "homepage": "http://www.doctrine-project.org",
+            "keywords": [
+                "lexer",
+                "parser"
+            ],
+            "time": "2014-09-09T13:34:57+00:00"
+        },
+        {
+            "name": "erusev/parsedown",
+            "version": "1.7.1",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/erusev/parsedown.git",
+                "reference": "92e9c27ba0e74b8b028b111d1b6f956a15c01fc1"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/erusev/parsedown/zipball/92e9c27ba0e74b8b028b111d1b6f956a15c01fc1",
+                "reference": "92e9c27ba0e74b8b028b111d1b6f956a15c01fc1",
+                "shasum": ""
+            },
+            "require": {
+                "ext-mbstring": "*",
+                "php": ">=5.3.0"
+            },
+            "require-dev": {
+                "phpunit/phpunit": "^4.8.35"
+            },
+            "type": "library",
+            "autoload": {
+                "psr-0": {
+                    "Parsedown": ""
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Emanuil Rusev",
+                    "email": "hello@erusev.com",
+                    "homepage": "http://erusev.com"
+                }
+            ],
+            "description": "Parser for Markdown.",
+            "homepage": "http://parsedown.org",
+            "keywords": [
+                "markdown",
+                "parser"
+            ],
+            "time": "2018-03-08T01:11:30+00:00"
+        },
+        {
+            "name": "herrera-io/json",
+            "version": "1.0.3",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/kherge-php/json.git",
+                "reference": "60c696c9370a1e5136816ca557c17f82a6fa83f1"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/kherge-php/json/zipball/60c696c9370a1e5136816ca557c17f82a6fa83f1",
+                "reference": "60c696c9370a1e5136816ca557c17f82a6fa83f1",
+                "shasum": ""
+            },
+            "require": {
+                "ext-json": "*",
+                "justinrainbow/json-schema": ">=1.0,<2.0-dev",
+                "php": ">=5.3.3",
+                "seld/jsonlint": ">=1.0,<2.0-dev"
+            },
+            "require-dev": {
+                "herrera-io/phpunit-test-case": "1.*",
+                "mikey179/vfsstream": "1.1.0",
+                "phpunit/phpunit": "3.7.*"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "1.0-dev"
+                }
+            },
+            "autoload": {
+                "files": [
+                    "src/lib/json_version.php"
+                ],
+                "psr-0": {
+                    "Herrera\\Json": "src/lib"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Kevin Herrera",
+                    "email": "kevin@herrera.io",
+                    "homepage": "http://kevin.herrera.io"
+                }
+            ],
+            "description": "A library for simplifying JSON linting and validation.",
+            "homepage": "http://herrera-io.github.com/php-json",
+            "keywords": [
+                "json",
+                "lint",
+                "schema",
+                "validate"
+            ],
+            "abandoned": "kherge/json",
+            "time": "2013-10-30T16:51:34+00:00"
+        },
+        {
+            "name": "herrera-io/phar-update",
+            "version": "1.0.3",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/kherge-abandoned/php-phar-update.git",
+                "reference": "00a79e1d5b8cf3c080a2e3becf1ddf7a7fea025b"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/kherge-abandoned/php-phar-update/zipball/00a79e1d5b8cf3c080a2e3becf1ddf7a7fea025b",
+                "reference": "00a79e1d5b8cf3c080a2e3becf1ddf7a7fea025b",
+                "shasum": ""
+            },
+            "require": {
+                "herrera-io/json": "1.*",
+                "kherge/version": "1.*",
+                "php": ">=5.3.3"
+            },
+            "require-dev": {
+                "herrera-io/phpunit-test-case": "1.*",
+                "mikey179/vfsstream": "1.1.0",
+                "phpunit/phpunit": "3.7.*"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "1.0-dev"
+                }
+            },
+            "autoload": {
+                "files": [
+                    "src/lib/constants.php"
+                ],
+                "psr-0": {
+                    "Herrera\\Phar\\Update": "src/lib"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Kevin Herrera",
+                    "email": "kevin@herrera.io",
+                    "homepage": "http://kevin.herrera.io"
+                }
+            ],
+            "description": "A library for self-updating Phars.",
+            "homepage": "http://herrera-io.github.com/php-phar-update",
+            "keywords": [
+                "phar",
+                "update"
+            ],
+            "abandoned": true,
+            "time": "2013-10-30T17:23:01+00:00"
+        },
+        {
+            "name": "jms/metadata",
+            "version": "1.7.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/schmittjoh/metadata.git",
+                "reference": "e5854ab1aa643623dc64adde718a8eec32b957a8"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/schmittjoh/metadata/zipball/e5854ab1aa643623dc64adde718a8eec32b957a8",
+                "reference": "e5854ab1aa643623dc64adde718a8eec32b957a8",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=5.3.0"
+            },
+            "require-dev": {
+                "doctrine/cache": "~1.0",
+                "symfony/cache": "~3.1"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "1.5.x-dev"
+                }
+            },
+            "autoload": {
+                "psr-0": {
+                    "Metadata\\": "src/"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Asmir Mustafic",
+                    "email": "goetas@gmail.com"
+                },
+                {
+                    "name": "Johannes M. Schmitt",
+                    "email": "schmittjoh@gmail.com"
+                }
+            ],
+            "description": "Class/method/property metadata management in PHP",
+            "keywords": [
+                "annotations",
+                "metadata",
+                "xml",
+                "yaml"
+            ],
+            "time": "2018-10-26T12:40:10+00:00"
+        },
+        {
+            "name": "jms/parser-lib",
+            "version": "1.0.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/schmittjoh/parser-lib.git",
+                "reference": "c509473bc1b4866415627af0e1c6cc8ac97fa51d"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/schmittjoh/parser-lib/zipball/c509473bc1b4866415627af0e1c6cc8ac97fa51d",
+                "reference": "c509473bc1b4866415627af0e1c6cc8ac97fa51d",
+                "shasum": ""
+            },
+            "require": {
+                "phpoption/phpoption": ">=0.9,<2.0-dev"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "1.0-dev"
+                }
+            },
+            "autoload": {
+                "psr-0": {
+                    "JMS\\": "src/"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "Apache2"
+            ],
+            "description": "A library for easily creating recursive-descent parsers.",
+            "time": "2012-11-18T18:08:43+00:00"
+        },
+        {
+            "name": "jms/serializer",
+            "version": "1.13.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/schmittjoh/serializer.git",
+                "reference": "00863e1d55b411cc33ad3e1de09a4c8d3aae793c"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/schmittjoh/serializer/zipball/00863e1d55b411cc33ad3e1de09a4c8d3aae793c",
+                "reference": "00863e1d55b411cc33ad3e1de09a4c8d3aae793c",
+                "shasum": ""
+            },
+            "require": {
+                "doctrine/annotations": "^1.0",
+                "doctrine/instantiator": "^1.0.3",
+                "jms/metadata": "^1.3",
+                "jms/parser-lib": "1.*",
+                "php": "^5.5|^7.0",
+                "phpcollection/phpcollection": "~0.1",
+                "phpoption/phpoption": "^1.1"
+            },
+            "conflict": {
+                "twig/twig": "<1.12"
+            },
+            "require-dev": {
+                "doctrine/orm": "~2.1",
+                "doctrine/phpcr-odm": "^1.3|^2.0",
+                "ext-pdo_sqlite": "*",
+                "jackalope/jackalope-doctrine-dbal": "^1.1.5",
+                "phpunit/phpunit": "^4.8|^5.0",
+                "propel/propel1": "~1.7",
+                "psr/container": "^1.0",
+                "symfony/dependency-injection": "^2.7|^3.3|^4.0",
+                "symfony/expression-language": "^2.6|^3.0",
+                "symfony/filesystem": "^2.1",
+                "symfony/form": "~2.1|^3.0",
+                "symfony/translation": "^2.1|^3.0",
+                "symfony/validator": "^2.2|^3.0",
+                "symfony/yaml": "^2.1|^3.0",
+                "twig/twig": "~1.12|~2.0"
+            },
+            "suggest": {
+                "doctrine/cache": "Required if you like to use cache functionality.",
+                "doctrine/collections": "Required if you like to use doctrine collection types as ArrayCollection.",
+                "symfony/yaml": "Required if you'd like to serialize data to YAML format."
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-1.x": "1.13-dev"
+                }
+            },
+            "autoload": {
+                "psr-0": {
+                    "JMS\\Serializer": "src/"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Asmir Mustafic",
+                    "email": "goetas@gmail.com"
+                },
+                {
+                    "name": "Johannes M. Schmitt",
+                    "email": "schmittjoh@gmail.com"
+                }
+            ],
+            "description": "Library for (de-)serializing data of any complexity; supports XML, JSON, and YAML.",
+            "homepage": "http://jmsyst.com/libs/serializer",
+            "keywords": [
+                "deserialization",
+                "jaxb",
+                "json",
+                "serialization",
+                "xml"
+            ],
+            "time": "2018-07-25T13:58:54+00:00"
+        },
+        {
+            "name": "justinrainbow/json-schema",
+            "version": "1.6.1",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/justinrainbow/json-schema.git",
+                "reference": "cc84765fb7317f6b07bd8ac78364747f95b86341"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/justinrainbow/json-schema/zipball/cc84765fb7317f6b07bd8ac78364747f95b86341",
+                "reference": "cc84765fb7317f6b07bd8ac78364747f95b86341",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=5.3.29"
+            },
+            "require-dev": {
+                "json-schema/json-schema-test-suite": "1.1.0",
+                "phpdocumentor/phpdocumentor": "~2",
+                "phpunit/phpunit": "~3.7"
+            },
+            "bin": [
+                "bin/validate-json"
+            ],
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "1.6.x-dev"
+                }
+            },
+            "autoload": {
+                "psr-4": {
+                    "JsonSchema\\": "src/JsonSchema/"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "BSD-3-Clause"
+            ],
+            "authors": [
+                {
+                    "name": "Bruno Prieto Reis",
+                    "email": "bruno.p.reis@gmail.com"
+                },
+                {
+                    "name": "Justin Rainbow",
+                    "email": "justin.rainbow@gmail.com"
+                },
+                {
+                    "name": "Igor Wiedler",
+                    "email": "igor@wiedler.ch"
+                },
+                {
+                    "name": "Robert Schönthal",
+                    "email": "seroscho@googlemail.com"
+                }
+            ],
+            "description": "A library to validate a json schema.",
+            "homepage": "https://github.com/justinrainbow/json-schema",
+            "keywords": [
+                "json",
+                "schema"
+            ],
+            "time": "2016-01-25T15:43:01+00:00"
+        },
+        {
+            "name": "kherge/version",
+            "version": "1.0.1",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/kherge-abandoned/Version.git",
+                "reference": "f07cf83f8ce533be8f93d2893d96d674bbeb7e30"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/kherge-abandoned/Version/zipball/f07cf83f8ce533be8f93d2893d96d674bbeb7e30",
+                "reference": "f07cf83f8ce533be8f93d2893d96d674bbeb7e30",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=5.3.3"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "1.0-dev"
+                }
+            },
+            "autoload": {
+                "psr-0": {
+                    "KevinGH\\Version": "src/lib/"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Kevin Herrera",
+                    "email": "me@kevingh.com"
+                }
+            ],
+            "description": "A parsing and comparison library for semantic versioning.",
+            "homepage": "http://github.com/kherge/Version",
+            "abandoned": true,
+            "time": "2012-08-16T17:13:03+00:00"
+        },
+        {
+            "name": "monolog/monolog",
+            "version": "1.24.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/Seldaek/monolog.git",
+                "reference": "bfc9ebb28f97e7a24c45bdc3f0ff482e47bb0266"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/Seldaek/monolog/zipball/bfc9ebb28f97e7a24c45bdc3f0ff482e47bb0266",
+                "reference": "bfc9ebb28f97e7a24c45bdc3f0ff482e47bb0266",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=5.3.0",
+                "psr/log": "~1.0"
+            },
+            "provide": {
+                "psr/log-implementation": "1.0.0"
+            },
+            "require-dev": {
+                "aws/aws-sdk-php": "^2.4.9 || ^3.0",
+                "doctrine/couchdb": "~1.0@dev",
+                "graylog2/gelf-php": "~1.0",
+                "jakub-onderka/php-parallel-lint": "0.9",
+                "php-amqplib/php-amqplib": "~2.4",
+                "php-console/php-console": "^3.1.3",
+                "phpunit/phpunit": "~4.5",
+                "phpunit/phpunit-mock-objects": "2.3.0",
+                "ruflin/elastica": ">=0.90 <3.0",
+                "sentry/sentry": "^0.13",
+                "swiftmailer/swiftmailer": "^5.3|^6.0"
+            },
+            "suggest": {
+                "aws/aws-sdk-php": "Allow sending log messages to AWS services like DynamoDB",
+                "doctrine/couchdb": "Allow sending log messages to a CouchDB server",
+                "ext-amqp": "Allow sending log messages to an AMQP server (1.0+ required)",
+                "ext-mongo": "Allow sending log messages to a MongoDB server",
+                "graylog2/gelf-php": "Allow sending log messages to a GrayLog2 server",
+                "mongodb/mongodb": "Allow sending log messages to a MongoDB server via PHP Driver",
+                "php-amqplib/php-amqplib": "Allow sending log messages to an AMQP server using php-amqplib",
+                "php-console/php-console": "Allow sending log messages to Google Chrome",
+                "rollbar/rollbar": "Allow sending log messages to Rollbar",
+                "ruflin/elastica": "Allow sending log messages to an Elastic Search server",
+                "sentry/sentry": "Allow sending log messages to a Sentry server"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "2.0.x-dev"
+                }
+            },
+            "autoload": {
+                "psr-4": {
+                    "Monolog\\": "src/Monolog"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Jordi Boggiano",
+                    "email": "j.boggiano@seld.be",
+                    "homepage": "http://seld.be"
+                }
+            ],
+            "description": "Sends your logs to files, sockets, inboxes, databases and various web services",
+            "homepage": "http://github.com/Seldaek/monolog",
+            "keywords": [
+                "log",
+                "logging",
+                "psr-3"
+            ],
+            "time": "2018-11-05T09:00:11+00:00"
+        },
+        {
+            "name": "nikic/php-parser",
+            "version": "v1.4.1",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/nikic/PHP-Parser.git",
+                "reference": "f78af2c9c86107aa1a34cd1dbb5bbe9eeb0d9f51"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/nikic/PHP-Parser/zipball/f78af2c9c86107aa1a34cd1dbb5bbe9eeb0d9f51",
+                "reference": "f78af2c9c86107aa1a34cd1dbb5bbe9eeb0d9f51",
+                "shasum": ""
+            },
+            "require": {
+                "ext-tokenizer": "*",
+                "php": ">=5.3"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "1.4-dev"
+                }
+            },
+            "autoload": {
+                "files": [
+                    "lib/bootstrap.php"
+                ]
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "BSD-3-Clause"
+            ],
+            "authors": [
+                {
+                    "name": "Nikita Popov"
+                }
+            ],
+            "description": "A PHP parser written in PHP",
+            "keywords": [
+                "parser",
+                "php"
+            ],
+            "time": "2015-09-19T14:15:08+00:00"
+        },
+        {
+            "name": "phpcollection/phpcollection",
+            "version": "0.5.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/schmittjoh/php-collection.git",
+                "reference": "f2bcff45c0da7c27991bbc1f90f47c4b7fb434a6"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/schmittjoh/php-collection/zipball/f2bcff45c0da7c27991bbc1f90f47c4b7fb434a6",
+                "reference": "f2bcff45c0da7c27991bbc1f90f47c4b7fb434a6",
+                "shasum": ""
+            },
+            "require": {
+                "phpoption/phpoption": "1.*"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "0.4-dev"
+                }
+            },
+            "autoload": {
+                "psr-0": {
+                    "PhpCollection": "src/"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "Apache2"
+            ],
+            "authors": [
+                {
+                    "name": "Johannes M. Schmitt",
+                    "email": "schmittjoh@gmail.com"
+                }
+            ],
+            "description": "General-Purpose Collection Library for PHP",
+            "keywords": [
+                "collection",
+                "list",
+                "map",
+                "sequence",
+                "set"
+            ],
+            "time": "2015-05-17T12:39:23+00:00"
+        },
+        {
+            "name": "phpdocumentor/fileset",
+            "version": "1.0.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/phpDocumentor/Fileset.git",
+                "reference": "bfa78d8fa9763dfce6d0e5d3730c1d8ab25d34b0"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/phpDocumentor/Fileset/zipball/bfa78d8fa9763dfce6d0e5d3730c1d8ab25d34b0",
+                "reference": "bfa78d8fa9763dfce6d0e5d3730c1d8ab25d34b0",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=5.3.3",
+                "symfony/finder": "~2.1"
+            },
+            "require-dev": {
+                "phpunit/phpunit": "~3.7"
+            },
+            "type": "library",
+            "autoload": {
+                "psr-0": {
+                    "phpDocumentor": [
+                        "src/",
+                        "tests/unit/"
+                    ]
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "description": "Fileset component for collecting a set of files given directories and file paths",
+            "homepage": "http://www.phpdoc.org",
+            "keywords": [
+                "files",
+                "fileset",
+                "phpdoc"
+            ],
+            "time": "2013-08-06T21:07:42+00:00"
+        },
+        {
+            "name": "phpdocumentor/graphviz",
+            "version": "1.0.4",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/phpDocumentor/GraphViz.git",
+                "reference": "a906a90a9f230535f25ea31caf81b2323956283f"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/phpDocumentor/GraphViz/zipball/a906a90a9f230535f25ea31caf81b2323956283f",
+                "reference": "a906a90a9f230535f25ea31caf81b2323956283f",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=5.3.3"
+            },
+            "require-dev": {
+                "phpunit/phpunit": "~4.0"
+            },
+            "type": "library",
+            "autoload": {
+                "psr-0": {
+                    "phpDocumentor": [
+                        "src/",
+                        "tests/unit"
+                    ]
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Mike van Riel",
+                    "email": "mike.vanriel@naenius.com"
+                }
+            ],
+            "time": "2016-02-02T13:00:08+00:00"
+        },
+        {
+            "name": "phpdocumentor/phpdocumentor",
+            "version": "v2.9.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/phpDocumentor/phpDocumentor2.git",
+                "reference": "be607da0eef9b9249c43c5b4820d25d631c73667"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/phpDocumentor/phpDocumentor2/zipball/be607da0eef9b9249c43c5b4820d25d631c73667",
+                "reference": "be607da0eef9b9249c43c5b4820d25d631c73667",
+                "shasum": ""
+            },
+            "require": {
+                "cilex/cilex": "~1.0",
+                "erusev/parsedown": "~1.0",
+                "herrera-io/phar-update": "1.0.3",
+                "jms/serializer": ">=0.12",
+                "monolog/monolog": "~1.6",
+                "php": ">=5.3.3",
+                "phpdocumentor/fileset": "~1.0",
+                "phpdocumentor/graphviz": "~1.0",
+                "phpdocumentor/reflection": "^3.0",
+                "phpdocumentor/reflection-docblock": "~2.0",
+                "symfony/config": "~2.3",
+                "symfony/console": "~2.3",
+                "symfony/event-dispatcher": "~2.1",
+                "symfony/process": "~2.0",
+                "symfony/stopwatch": "~2.3",
+                "symfony/validator": "~2.2",
+                "twig/twig": "~1.3",
+                "zendframework/zend-cache": "~2.1",
+                "zendframework/zend-config": "~2.1",
+                "zendframework/zend-filter": "~2.1",
+                "zendframework/zend-i18n": "~2.1",
+                "zendframework/zend-serializer": "~2.1",
+                "zendframework/zend-servicemanager": "~2.1",
+                "zendframework/zend-stdlib": "~2.1",
+                "zetacomponents/document": ">=1.3.1"
+            },
+            "require-dev": {
+                "behat/behat": "~3.0",
+                "mikey179/vfsstream": "~1.2",
+                "mockery/mockery": "~0.9@dev",
+                "phpunit/phpunit": "~4.0",
+                "squizlabs/php_codesniffer": "~1.4",
+                "symfony/expression-language": "~2.4"
+            },
+            "suggest": {
+                "ext-twig": "Enabling the twig extension improves the generation of twig based templates.",
+                "ext-xslcache": "Enabling the XSLCache extension improves the generation of xml based templates."
+            },
+            "bin": [
+                "bin/phpdoc.php",
+                "bin/phpdoc"
+            ],
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-develop": "2.9-dev"
+                }
+            },
+            "autoload": {
+                "psr-0": {
+                    "phpDocumentor": [
+                        "src/",
+                        "tests/unit/"
+                    ],
+                    "Cilex\\Provider": [
+                        "src/"
+                    ]
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "description": "Documentation Generator for PHP",
+            "homepage": "http://www.phpdoc.org",
+            "keywords": [
+                "api",
+                "application",
+                "dga",
+                "documentation",
+                "phpdoc"
+            ],
+            "time": "2016-05-22T09:50:56+00:00"
+        },
+        {
+            "name": "phpdocumentor/reflection",
+            "version": "3.0.1",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/phpDocumentor/Reflection.git",
+                "reference": "793bfd92d9a0fc96ae9608fb3e947c3f59fb3a0d"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/phpDocumentor/Reflection/zipball/793bfd92d9a0fc96ae9608fb3e947c3f59fb3a0d",
+                "reference": "793bfd92d9a0fc96ae9608fb3e947c3f59fb3a0d",
+                "shasum": ""
+            },
+            "require": {
+                "nikic/php-parser": "^1.0",
+                "php": ">=5.3.3",
+                "phpdocumentor/reflection-docblock": "~2.0",
+                "psr/log": "~1.0"
+            },
+            "require-dev": {
+                "behat/behat": "~2.4",
+                "mockery/mockery": "~0.8",
+                "phpunit/phpunit": "~4.0"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "1.0.x-dev"
+                }
+            },
+            "autoload": {
+                "psr-0": {
+                    "phpDocumentor": [
+                        "src/",
+                        "tests/unit/",
+                        "tests/mocks/"
+                    ]
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "description": "Reflection library to do Static Analysis for PHP Projects",
+            "homepage": "http://www.phpdoc.org",
+            "keywords": [
+                "phpDocumentor",
+                "phpdoc",
+                "reflection",
+                "static analysis"
+            ],
+            "time": "2016-05-21T08:42:32+00:00"
+        },
+        {
+            "name": "phpdocumentor/reflection-docblock",
+            "version": "2.0.5",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/phpDocumentor/ReflectionDocBlock.git",
+                "reference": "e6a969a640b00d8daa3c66518b0405fb41ae0c4b"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/phpDocumentor/ReflectionDocBlock/zipball/e6a969a640b00d8daa3c66518b0405fb41ae0c4b",
+                "reference": "e6a969a640b00d8daa3c66518b0405fb41ae0c4b",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=5.3.3"
+            },
+            "require-dev": {
+                "phpunit/phpunit": "~4.0"
+            },
+            "suggest": {
+                "dflydev/markdown": "~1.0",
+                "erusev/parsedown": "~1.0"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "2.0.x-dev"
+                }
+            },
+            "autoload": {
+                "psr-0": {
+                    "phpDocumentor": [
+                        "src/"
+                    ]
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Mike van Riel",
+                    "email": "mike.vanriel@naenius.com"
+                }
+            ],
+            "time": "2016-01-25T08:17:30+00:00"
+        },
+        {
+            "name": "phpoption/phpoption",
+            "version": "1.5.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/schmittjoh/php-option.git",
+                "reference": "94e644f7d2051a5f0fcf77d81605f152eecff0ed"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/schmittjoh/php-option/zipball/94e644f7d2051a5f0fcf77d81605f152eecff0ed",
+                "reference": "94e644f7d2051a5f0fcf77d81605f152eecff0ed",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=5.3.0"
+            },
+            "require-dev": {
+                "phpunit/phpunit": "4.7.*"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "1.3-dev"
+                }
+            },
+            "autoload": {
+                "psr-0": {
+                    "PhpOption\\": "src/"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "Apache2"
+            ],
+            "authors": [
+                {
+                    "name": "Johannes M. Schmitt",
+                    "email": "schmittjoh@gmail.com"
+                }
+            ],
+            "description": "Option Type for PHP",
+            "keywords": [
+                "language",
+                "option",
+                "php",
+                "type"
+            ],
+            "time": "2015-07-25T16:39:46+00:00"
+        },
+        {
+            "name": "pimple/pimple",
+            "version": "v1.1.1",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/silexphp/Pimple.git",
+                "reference": "2019c145fe393923f3441b23f29bbdfaa5c58c4d"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/silexphp/Pimple/zipball/2019c145fe393923f3441b23f29bbdfaa5c58c4d",
+                "reference": "2019c145fe393923f3441b23f29bbdfaa5c58c4d",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=5.3.0"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "1.1.x-dev"
+                }
+            },
+            "autoload": {
+                "psr-0": {
+                    "Pimple": "lib/"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Fabien Potencier",
+                    "email": "fabien@symfony.com"
+                }
+            ],
+            "description": "Pimple is a simple Dependency Injection Container for PHP 5.3",
+            "homepage": "http://pimple.sensiolabs.org",
+            "keywords": [
+                "container",
+                "dependency injection"
+            ],
+            "time": "2013-11-22T08:30:29+00:00"
+        },
+        {
+            "name": "psr/cache",
+            "version": "1.0.1",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/php-fig/cache.git",
+                "reference": "d11b50ad223250cf17b86e38383413f5a6764bf8"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/php-fig/cache/zipball/d11b50ad223250cf17b86e38383413f5a6764bf8",
+                "reference": "d11b50ad223250cf17b86e38383413f5a6764bf8",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=5.3.0"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "1.0.x-dev"
+                }
+            },
+            "autoload": {
+                "psr-4": {
+                    "Psr\\Cache\\": "src/"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "PHP-FIG",
+                    "homepage": "http://www.php-fig.org/"
+                }
+            ],
+            "description": "Common interface for caching libraries",
+            "keywords": [
+                "cache",
+                "psr",
+                "psr-6"
+            ],
+            "time": "2016-08-06T20:24:11+00:00"
+        },
+        {
+            "name": "psr/container",
+            "version": "1.0.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/php-fig/container.git",
+                "reference": "b7ce3b176482dbbc1245ebf52b181af44c2cf55f"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/php-fig/container/zipball/b7ce3b176482dbbc1245ebf52b181af44c2cf55f",
+                "reference": "b7ce3b176482dbbc1245ebf52b181af44c2cf55f",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=5.3.0"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "1.0.x-dev"
+                }
+            },
+            "autoload": {
+                "psr-4": {
+                    "Psr\\Container\\": "src/"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "PHP-FIG",
+                    "homepage": "http://www.php-fig.org/"
+                }
+            ],
+            "description": "Common Container Interface (PHP FIG PSR-11)",
+            "homepage": "https://github.com/php-fig/container",
+            "keywords": [
+                "PSR-11",
+                "container",
+                "container-interface",
+                "container-interop",
+                "psr"
+            ],
+            "time": "2017-02-14T16:28:37+00:00"
+        },
+        {
+            "name": "psr/log",
+            "version": "1.1.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/php-fig/log.git",
+                "reference": "6c001f1daafa3a3ac1d8ff69ee4db8e799a654dd"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/php-fig/log/zipball/6c001f1daafa3a3ac1d8ff69ee4db8e799a654dd",
+                "reference": "6c001f1daafa3a3ac1d8ff69ee4db8e799a654dd",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=5.3.0"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "1.0.x-dev"
+                }
+            },
+            "autoload": {
+                "psr-4": {
+                    "Psr\\Log\\": "Psr/Log/"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "PHP-FIG",
+                    "homepage": "http://www.php-fig.org/"
+                }
+            ],
+            "description": "Common interface for logging libraries",
+            "homepage": "https://github.com/php-fig/log",
+            "keywords": [
+                "log",
+                "psr",
+                "psr-3"
+            ],
+            "time": "2018-11-20T15:27:04+00:00"
+        },
+        {
+            "name": "psr/simple-cache",
+            "version": "1.0.1",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/php-fig/simple-cache.git",
+                "reference": "408d5eafb83c57f6365a3ca330ff23aa4a5fa39b"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/php-fig/simple-cache/zipball/408d5eafb83c57f6365a3ca330ff23aa4a5fa39b",
+                "reference": "408d5eafb83c57f6365a3ca330ff23aa4a5fa39b",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=5.3.0"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "1.0.x-dev"
+                }
+            },
+            "autoload": {
+                "psr-4": {
+                    "Psr\\SimpleCache\\": "src/"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "PHP-FIG",
+                    "homepage": "http://www.php-fig.org/"
+                }
+            ],
+            "description": "Common interfaces for simple caching",
+            "keywords": [
+                "cache",
+                "caching",
+                "psr",
+                "psr-16",
+                "simple-cache"
+            ],
+            "time": "2017-10-23T01:57:42+00:00"
+        },
+        {
+            "name": "seld/jsonlint",
+            "version": "1.7.1",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/Seldaek/jsonlint.git",
+                "reference": "d15f59a67ff805a44c50ea0516d2341740f81a38"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/Seldaek/jsonlint/zipball/d15f59a67ff805a44c50ea0516d2341740f81a38",
+                "reference": "d15f59a67ff805a44c50ea0516d2341740f81a38",
+                "shasum": ""
+            },
+            "require": {
+                "php": "^5.3 || ^7.0"
+            },
+            "require-dev": {
+                "phpunit/phpunit": "^4.8.35 || ^5.7 || ^6.0"
+            },
+            "bin": [
+                "bin/jsonlint"
+            ],
+            "type": "library",
+            "autoload": {
+                "psr-4": {
+                    "Seld\\JsonLint\\": "src/Seld/JsonLint/"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Jordi Boggiano",
+                    "email": "j.boggiano@seld.be",
+                    "homepage": "http://seld.be"
+                }
+            ],
+            "description": "JSON Linter",
+            "keywords": [
+                "json",
+                "linter",
+                "parser",
+                "validator"
+            ],
+            "time": "2018-01-24T12:46:19+00:00"
+        },
+        {
+            "name": "symfony/config",
+            "version": "v2.8.49",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/symfony/config.git",
+                "reference": "7dd5f5040dc04c118d057fb5886563963eb70011"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/symfony/config/zipball/7dd5f5040dc04c118d057fb5886563963eb70011",
+                "reference": "7dd5f5040dc04c118d057fb5886563963eb70011",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=5.3.9",
+                "symfony/filesystem": "~2.3|~3.0.0",
+                "symfony/polyfill-ctype": "~1.8"
+            },
+            "require-dev": {
+                "symfony/yaml": "~2.7|~3.0.0"
+            },
+            "suggest": {
+                "symfony/yaml": "To use the yaml reference dumper"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "2.8-dev"
+                }
+            },
+            "autoload": {
+                "psr-4": {
+                    "Symfony\\Component\\Config\\": ""
+                },
+                "exclude-from-classmap": [
+                    "/Tests/"
+                ]
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Fabien Potencier",
+                    "email": "fabien@symfony.com"
+                },
+                {
+                    "name": "Symfony Community",
+                    "homepage": "https://symfony.com/contributors"
+                }
+            ],
+            "description": "Symfony Config Component",
+            "homepage": "https://symfony.com",
+            "time": "2018-11-26T09:38:12+00:00"
+        },
+        {
+            "name": "symfony/console",
+            "version": "v2.8.49",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/symfony/console.git",
+                "reference": "cbcf4b5e233af15cd2bbd50dee1ccc9b7927dc12"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/symfony/console/zipball/cbcf4b5e233af15cd2bbd50dee1ccc9b7927dc12",
+                "reference": "cbcf4b5e233af15cd2bbd50dee1ccc9b7927dc12",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=5.3.9",
+                "symfony/debug": "^2.7.2|~3.0.0",
+                "symfony/polyfill-mbstring": "~1.0"
+            },
+            "require-dev": {
+                "psr/log": "~1.0",
+                "symfony/event-dispatcher": "~2.1|~3.0.0",
+                "symfony/process": "~2.1|~3.0.0"
+            },
+            "suggest": {
+                "psr/log-implementation": "For using the console logger",
+                "symfony/event-dispatcher": "",
+                "symfony/process": ""
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "2.8-dev"
+                }
+            },
+            "autoload": {
+                "psr-4": {
+                    "Symfony\\Component\\Console\\": ""
+                },
+                "exclude-from-classmap": [
+                    "/Tests/"
+                ]
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Fabien Potencier",
+                    "email": "fabien@symfony.com"
+                },
+                {
+                    "name": "Symfony Community",
+                    "homepage": "https://symfony.com/contributors"
+                }
+            ],
+            "description": "Symfony Console Component",
+            "homepage": "https://symfony.com",
+            "time": "2018-11-20T15:55:20+00:00"
+        },
+        {
+            "name": "symfony/debug",
+            "version": "v3.0.9",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/symfony/debug.git",
+                "reference": "697c527acd9ea1b2d3efac34d9806bf255278b0a"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/symfony/debug/zipball/697c527acd9ea1b2d3efac34d9806bf255278b0a",
+                "reference": "697c527acd9ea1b2d3efac34d9806bf255278b0a",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=5.5.9",
+                "psr/log": "~1.0"
+            },
+            "conflict": {
+                "symfony/http-kernel": ">=2.3,<2.3.24|~2.4.0|>=2.5,<2.5.9|>=2.6,<2.6.2"
+            },
+            "require-dev": {
+                "symfony/class-loader": "~2.8|~3.0",
+                "symfony/http-kernel": "~2.8|~3.0"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "3.0-dev"
+                }
+            },
+            "autoload": {
+                "psr-4": {
+                    "Symfony\\Component\\Debug\\": ""
+                },
+                "exclude-from-classmap": [
+                    "/Tests/"
+                ]
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Fabien Potencier",
+                    "email": "fabien@symfony.com"
+                },
+                {
+                    "name": "Symfony Community",
+                    "homepage": "https://symfony.com/contributors"
+                }
+            ],
+            "description": "Symfony Debug Component",
+            "homepage": "https://symfony.com",
+            "time": "2016-07-30T07:22:48+00:00"
+        },
+        {
+            "name": "symfony/event-dispatcher",
+            "version": "v2.8.49",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/symfony/event-dispatcher.git",
+                "reference": "a77e974a5fecb4398833b0709210e3d5e334ffb0"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/symfony/event-dispatcher/zipball/a77e974a5fecb4398833b0709210e3d5e334ffb0",
+                "reference": "a77e974a5fecb4398833b0709210e3d5e334ffb0",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=5.3.9"
+            },
+            "require-dev": {
+                "psr/log": "~1.0",
+                "symfony/config": "^2.0.5|~3.0.0",
+                "symfony/dependency-injection": "~2.6|~3.0.0",
+                "symfony/expression-language": "~2.6|~3.0.0",
+                "symfony/stopwatch": "~2.3|~3.0.0"
+            },
+            "suggest": {
+                "symfony/dependency-injection": "",
+                "symfony/http-kernel": ""
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "2.8-dev"
+                }
+            },
+            "autoload": {
+                "psr-4": {
+                    "Symfony\\Component\\EventDispatcher\\": ""
+                },
+                "exclude-from-classmap": [
+                    "/Tests/"
+                ]
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Fabien Potencier",
+                    "email": "fabien@symfony.com"
+                },
+                {
+                    "name": "Symfony Community",
+                    "homepage": "https://symfony.com/contributors"
+                }
+            ],
+            "description": "Symfony EventDispatcher Component",
+            "homepage": "https://symfony.com",
+            "time": "2018-11-21T14:20:20+00:00"
+        },
+        {
+            "name": "symfony/filesystem",
+            "version": "v3.0.9",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/symfony/filesystem.git",
+                "reference": "b2da5009d9bacbd91d83486aa1f44c793a8c380d"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/symfony/filesystem/zipball/b2da5009d9bacbd91d83486aa1f44c793a8c380d",
+                "reference": "b2da5009d9bacbd91d83486aa1f44c793a8c380d",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=5.5.9"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "3.0-dev"
+                }
+            },
+            "autoload": {
+                "psr-4": {
+                    "Symfony\\Component\\Filesystem\\": ""
+                },
+                "exclude-from-classmap": [
+                    "/Tests/"
+                ]
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Fabien Potencier",
+                    "email": "fabien@symfony.com"
+                },
+                {
+                    "name": "Symfony Community",
+                    "homepage": "https://symfony.com/contributors"
+                }
+            ],
+            "description": "Symfony Filesystem Component",
+            "homepage": "https://symfony.com",
+            "time": "2016-07-20T05:43:46+00:00"
+        },
+        {
+            "name": "symfony/finder",
+            "version": "v2.8.49",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/symfony/finder.git",
+                "reference": "1444eac52273e345d9b95129bf914639305a9ba4"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/symfony/finder/zipball/1444eac52273e345d9b95129bf914639305a9ba4",
+                "reference": "1444eac52273e345d9b95129bf914639305a9ba4",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=5.3.9"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "2.8-dev"
+                }
+            },
+            "autoload": {
+                "psr-4": {
+                    "Symfony\\Component\\Finder\\": ""
+                },
+                "exclude-from-classmap": [
+                    "/Tests/"
+                ]
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Fabien Potencier",
+                    "email": "fabien@symfony.com"
+                },
+                {
+                    "name": "Symfony Community",
+                    "homepage": "https://symfony.com/contributors"
+                }
+            ],
+            "description": "Symfony Finder Component",
+            "homepage": "https://symfony.com",
+            "time": "2018-11-11T11:18:13+00:00"
+        },
+        {
+            "name": "symfony/polyfill-ctype",
+            "version": "v1.10.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/symfony/polyfill-ctype.git",
+                "reference": "e3d826245268269cd66f8326bd8bc066687b4a19"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/symfony/polyfill-ctype/zipball/e3d826245268269cd66f8326bd8bc066687b4a19",
+                "reference": "e3d826245268269cd66f8326bd8bc066687b4a19",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=5.3.3"
+            },
+            "suggest": {
+                "ext-ctype": "For best performance"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "1.9-dev"
+                }
+            },
+            "autoload": {
+                "psr-4": {
+                    "Symfony\\Polyfill\\Ctype\\": ""
+                },
+                "files": [
+                    "bootstrap.php"
+                ]
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Symfony Community",
+                    "homepage": "https://symfony.com/contributors"
+                },
+                {
+                    "name": "Gert de Pagter",
+                    "email": "backendtea@gmail.com"
+                }
+            ],
+            "description": "Symfony polyfill for ctype functions",
+            "homepage": "https://symfony.com",
+            "keywords": [
+                "compatibility",
+                "ctype",
+                "polyfill",
+                "portable"
+            ],
+            "time": "2018-08-06T14:22:27+00:00"
+        },
+        {
+            "name": "symfony/polyfill-mbstring",
+            "version": "v1.10.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/symfony/polyfill-mbstring.git",
+                "reference": "c79c051f5b3a46be09205c73b80b346e4153e494"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/symfony/polyfill-mbstring/zipball/c79c051f5b3a46be09205c73b80b346e4153e494",
+                "reference": "c79c051f5b3a46be09205c73b80b346e4153e494",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=5.3.3"
+            },
+            "suggest": {
+                "ext-mbstring": "For best performance"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "1.9-dev"
+                }
+            },
+            "autoload": {
+                "psr-4": {
+                    "Symfony\\Polyfill\\Mbstring\\": ""
+                },
+                "files": [
+                    "bootstrap.php"
+                ]
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Nicolas Grekas",
+                    "email": "p@tchwork.com"
+                },
+                {
+                    "name": "Symfony Community",
+                    "homepage": "https://symfony.com/contributors"
+                }
+            ],
+            "description": "Symfony polyfill for the Mbstring extension",
+            "homepage": "https://symfony.com",
+            "keywords": [
+                "compatibility",
+                "mbstring",
+                "polyfill",
+                "portable",
+                "shim"
+            ],
+            "time": "2018-09-21T13:07:52+00:00"
+        },
+        {
+            "name": "symfony/process",
+            "version": "v2.8.49",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/symfony/process.git",
+                "reference": "c3591a09c78639822b0b290d44edb69bf9f05dc8"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/symfony/process/zipball/c3591a09c78639822b0b290d44edb69bf9f05dc8",
+                "reference": "c3591a09c78639822b0b290d44edb69bf9f05dc8",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=5.3.9"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "2.8-dev"
+                }
+            },
+            "autoload": {
+                "psr-4": {
+                    "Symfony\\Component\\Process\\": ""
+                },
+                "exclude-from-classmap": [
+                    "/Tests/"
+                ]
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Fabien Potencier",
+                    "email": "fabien@symfony.com"
+                },
+                {
+                    "name": "Symfony Community",
+                    "homepage": "https://symfony.com/contributors"
+                }
+            ],
+            "description": "Symfony Process Component",
+            "homepage": "https://symfony.com",
+            "time": "2018-11-11T11:18:13+00:00"
+        },
+        {
+            "name": "symfony/stopwatch",
+            "version": "v2.8.49",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/symfony/stopwatch.git",
+                "reference": "752586c80af8a85aeb74d1ae8202411c68836663"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/symfony/stopwatch/zipball/752586c80af8a85aeb74d1ae8202411c68836663",
+                "reference": "752586c80af8a85aeb74d1ae8202411c68836663",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=5.3.9"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "2.8-dev"
+                }
+            },
+            "autoload": {
+                "psr-4": {
+                    "Symfony\\Component\\Stopwatch\\": ""
+                },
+                "exclude-from-classmap": [
+                    "/Tests/"
+                ]
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Fabien Potencier",
+                    "email": "fabien@symfony.com"
+                },
+                {
+                    "name": "Symfony Community",
+                    "homepage": "https://symfony.com/contributors"
+                }
+            ],
+            "description": "Symfony Stopwatch Component",
+            "homepage": "https://symfony.com",
+            "time": "2018-11-11T11:18:13+00:00"
+        },
+        {
+            "name": "symfony/translation",
+            "version": "v3.0.9",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/symfony/translation.git",
+                "reference": "eee6c664853fd0576f21ae25725cfffeafe83f26"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/symfony/translation/zipball/eee6c664853fd0576f21ae25725cfffeafe83f26",
+                "reference": "eee6c664853fd0576f21ae25725cfffeafe83f26",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=5.5.9",
+                "symfony/polyfill-mbstring": "~1.0"
+            },
+            "conflict": {
+                "symfony/config": "<2.8"
+            },
+            "require-dev": {
+                "psr/log": "~1.0",
+                "symfony/config": "~2.8|~3.0",
+                "symfony/intl": "~2.8|~3.0",
+                "symfony/yaml": "~2.8|~3.0"
+            },
+            "suggest": {
+                "psr/log": "To use logging capability in translator",
+                "symfony/config": "",
+                "symfony/yaml": ""
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "3.0-dev"
+                }
+            },
+            "autoload": {
+                "psr-4": {
+                    "Symfony\\Component\\Translation\\": ""
+                },
+                "exclude-from-classmap": [
+                    "/Tests/"
+                ]
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Fabien Potencier",
+                    "email": "fabien@symfony.com"
+                },
+                {
+                    "name": "Symfony Community",
+                    "homepage": "https://symfony.com/contributors"
+                }
+            ],
+            "description": "Symfony Translation Component",
+            "homepage": "https://symfony.com",
+            "time": "2016-07-30T07:22:48+00:00"
+        },
+        {
+            "name": "symfony/validator",
+            "version": "v2.8.49",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/symfony/validator.git",
+                "reference": "d5d2090bba3139d8ddb79959fbf516e87238fe3a"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/symfony/validator/zipball/d5d2090bba3139d8ddb79959fbf516e87238fe3a",
+                "reference": "d5d2090bba3139d8ddb79959fbf516e87238fe3a",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=5.3.9",
+                "symfony/polyfill-ctype": "~1.8",
+                "symfony/polyfill-mbstring": "~1.0",
+                "symfony/translation": "~2.4|~3.0.0"
+            },
+            "require-dev": {
+                "doctrine/annotations": "~1.0",
+                "doctrine/cache": "~1.0",
+                "egulias/email-validator": "^1.2.1",
+                "symfony/config": "~2.2|~3.0.0",
+                "symfony/expression-language": "~2.4|~3.0.0",
+                "symfony/http-foundation": "~2.3|~3.0.0",
+                "symfony/intl": "~2.7.25|^2.8.18|~3.2.5",
+                "symfony/property-access": "~2.3|~3.0.0",
+                "symfony/yaml": "^2.0.5|~3.0.0"
+            },
+            "suggest": {
+                "doctrine/annotations": "For using the annotation mapping. You will also need doctrine/cache.",
+                "doctrine/cache": "For using the default cached annotation reader and metadata cache.",
+                "egulias/email-validator": "Strict (RFC compliant) email validation",
+                "symfony/config": "",
+                "symfony/expression-language": "For using the 2.4 Expression validator",
+                "symfony/http-foundation": "",
+                "symfony/intl": "",
+                "symfony/property-access": "For using the 2.4 Validator API",
+                "symfony/yaml": ""
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "2.8-dev"
+                }
+            },
+            "autoload": {
+                "psr-4": {
+                    "Symfony\\Component\\Validator\\": ""
+                },
+                "exclude-from-classmap": [
+                    "/Tests/"
+                ]
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Fabien Potencier",
+                    "email": "fabien@symfony.com"
+                },
+                {
+                    "name": "Symfony Community",
+                    "homepage": "https://symfony.com/contributors"
+                }
+            ],
+            "description": "Symfony Validator Component",
+            "homepage": "https://symfony.com",
+            "time": "2018-11-14T14:06:48+00:00"
+        },
+        {
+            "name": "twig/twig",
+            "version": "v1.37.1",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/twigphp/Twig.git",
+                "reference": "66be9366c76cbf23e82e7171d47cbfa54a057a62"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/twigphp/Twig/zipball/66be9366c76cbf23e82e7171d47cbfa54a057a62",
+                "reference": "66be9366c76cbf23e82e7171d47cbfa54a057a62",
+                "shasum": ""
+            },
+            "require": {
+                "php": ">=5.4.0",
+                "symfony/polyfill-ctype": "^1.8"
+            },
+            "require-dev": {
+                "psr/container": "^1.0",
+                "symfony/debug": "^2.7",
+                "symfony/phpunit-bridge": "^3.4.19|^4.1.8"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "1.37-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": "https://twig.symfony.com/contributors",
+                    "role": "Contributors"
+                }
+            ],
+            "description": "Twig, the flexible, fast, and secure template language for PHP",
+            "homepage": "https://twig.symfony.com",
+            "keywords": [
+                "templating"
+            ],
+            "time": "2019-01-14T14:59:29+00:00"
+        },
+        {
+            "name": "zendframework/zend-cache",
+            "version": "2.8.2",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/zendframework/zend-cache.git",
+                "reference": "4983dff629956490c78b88adcc8ece4711d7d8a3"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/zendframework/zend-cache/zipball/4983dff629956490c78b88adcc8ece4711d7d8a3",
+                "reference": "4983dff629956490c78b88adcc8ece4711d7d8a3",
+                "shasum": ""
+            },
+            "require": {
+                "php": "^5.6 || ^7.0",
+                "psr/cache": "^1.0",
+                "psr/simple-cache": "^1.0",
+                "zendframework/zend-eventmanager": "^2.6.3 || ^3.2",
+                "zendframework/zend-servicemanager": "^2.7.8 || ^3.3",
+                "zendframework/zend-stdlib": "^2.7.7 || ^3.1"
+            },
+            "provide": {
+                "psr/cache-implementation": "1.0",
+                "psr/simple-cache-implementation": "1.0"
+            },
+            "require-dev": {
+                "cache/integration-tests": "^0.16",
+                "phpbench/phpbench": "^0.13",
+                "phpunit/phpunit": "^5.7.27 || ^6.5.8 || ^7.1.2",
+                "zendframework/zend-coding-standard": "~1.0.0",
+                "zendframework/zend-serializer": "^2.6",
+                "zendframework/zend-session": "^2.7.4"
+            },
+            "suggest": {
+                "ext-apc": "APC or compatible extension, to use the APC storage adapter",
+                "ext-apcu": "APCU >= 5.1.0, to use the APCu storage adapter",
+                "ext-dba": "DBA, to use the DBA storage adapter",
+                "ext-memcache": "Memcache >= 2.0.0 to use the Memcache storage adapter",
+                "ext-memcached": "Memcached >= 1.0.0 to use the Memcached storage adapter",
+                "ext-mongo": "Mongo, to use MongoDb storage adapter",
+                "ext-mongodb": "MongoDB, to use the ExtMongoDb storage adapter",
+                "ext-redis": "Redis, to use Redis storage adapter",
+                "ext-wincache": "WinCache, to use the WinCache storage adapter",
+                "ext-xcache": "XCache, to use the XCache storage adapter",
+                "mongodb/mongodb": "Required for use with the ext-mongodb adapter",
+                "mongofill/mongofill": "Alternative to ext-mongo - a pure PHP implementation designed as a drop in replacement",
+                "zendframework/zend-serializer": "Zend\\Serializer component",
+                "zendframework/zend-session": "Zend\\Session component"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "2.8.x-dev",
+                    "dev-develop": "2.9.x-dev"
+                },
+                "zf": {
+                    "component": "Zend\\Cache",
+                    "config-provider": "Zend\\Cache\\ConfigProvider"
+                }
+            },
+            "autoload": {
+                "files": [
+                    "autoload/patternPluginManagerPolyfill.php"
+                ],
+                "psr-4": {
+                    "Zend\\Cache\\": "src/"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "BSD-3-Clause"
+            ],
+            "description": "Caching implementation with a variety of storage options, as well as codified caching strategies for callbacks, classes, and output",
+            "keywords": [
+                "ZendFramework",
+                "cache",
+                "psr-16",
+                "psr-6",
+                "zf"
+            ],
+            "time": "2018-05-01T21:58:00+00:00"
+        },
+        {
+            "name": "zendframework/zend-config",
+            "version": "2.6.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/zendframework/zend-config.git",
+                "reference": "2920e877a9f6dca9fa8f6bd3b1ffc2e19bb1e30d"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/zendframework/zend-config/zipball/2920e877a9f6dca9fa8f6bd3b1ffc2e19bb1e30d",
+                "reference": "2920e877a9f6dca9fa8f6bd3b1ffc2e19bb1e30d",
+                "shasum": ""
+            },
+            "require": {
+                "php": "^5.5 || ^7.0",
+                "zendframework/zend-stdlib": "^2.7 || ^3.0"
+            },
+            "require-dev": {
+                "fabpot/php-cs-fixer": "1.7.*",
+                "phpunit/phpunit": "~4.0",
+                "zendframework/zend-filter": "^2.6",
+                "zendframework/zend-i18n": "^2.5",
+                "zendframework/zend-json": "^2.6.1",
+                "zendframework/zend-servicemanager": "^2.7.5 || ^3.0.3"
+            },
+            "suggest": {
+                "zendframework/zend-filter": "Zend\\Filter component",
+                "zendframework/zend-i18n": "Zend\\I18n component",
+                "zendframework/zend-json": "Zend\\Json to use the Json reader or writer classes",
+                "zendframework/zend-servicemanager": "Zend\\ServiceManager for use with the Config Factory to retrieve reader and writer instances"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "2.6-dev",
+                    "dev-develop": "2.7-dev"
+                }
+            },
+            "autoload": {
+                "psr-4": {
+                    "Zend\\Config\\": "src/"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "BSD-3-Clause"
+            ],
+            "description": "provides a nested object property based user interface for accessing this configuration data within application code",
+            "homepage": "https://github.com/zendframework/zend-config",
+            "keywords": [
+                "config",
+                "zf2"
+            ],
+            "time": "2016-02-04T23:01:10+00:00"
+        },
+        {
+            "name": "zendframework/zend-eventmanager",
+            "version": "3.2.1",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/zendframework/zend-eventmanager.git",
+                "reference": "a5e2583a211f73604691586b8406ff7296a946dd"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/zendframework/zend-eventmanager/zipball/a5e2583a211f73604691586b8406ff7296a946dd",
+                "reference": "a5e2583a211f73604691586b8406ff7296a946dd",
+                "shasum": ""
+            },
+            "require": {
+                "php": "^5.6 || ^7.0"
+            },
+            "require-dev": {
+                "athletic/athletic": "^0.1",
+                "container-interop/container-interop": "^1.1.0",
+                "phpunit/phpunit": "^5.7.27 || ^6.5.8 || ^7.1.2",
+                "zendframework/zend-coding-standard": "~1.0.0",
+                "zendframework/zend-stdlib": "^2.7.3 || ^3.0"
+            },
+            "suggest": {
+                "container-interop/container-interop": "^1.1.0, to use the lazy listeners feature",
+                "zendframework/zend-stdlib": "^2.7.3 || ^3.0, to use the FilterChain feature"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "3.2-dev",
+                    "dev-develop": "3.3-dev"
+                }
+            },
+            "autoload": {
+                "psr-4": {
+                    "Zend\\EventManager\\": "src/"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "BSD-3-Clause"
+            ],
+            "description": "Trigger and listen to events within a PHP application",
+            "homepage": "https://github.com/zendframework/zend-eventmanager",
+            "keywords": [
+                "event",
+                "eventmanager",
+                "events",
+                "zf2"
+            ],
+            "time": "2018-04-25T15:33:34+00:00"
+        },
+        {
+            "name": "zendframework/zend-filter",
+            "version": "2.9.1",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/zendframework/zend-filter.git",
+                "reference": "1c3e6d02f9cd5f6c929c9859498f5efbe216e86f"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/zendframework/zend-filter/zipball/1c3e6d02f9cd5f6c929c9859498f5efbe216e86f",
+                "reference": "1c3e6d02f9cd5f6c929c9859498f5efbe216e86f",
+                "shasum": ""
+            },
+            "require": {
+                "php": "^5.6 || ^7.0",
+                "zendframework/zend-stdlib": "^2.7.7 || ^3.1"
+            },
+            "conflict": {
+                "zendframework/zend-validator": "<2.10.1"
+            },
+            "require-dev": {
+                "pear/archive_tar": "^1.4.3",
+                "phpunit/phpunit": "^5.7.23 || ^6.4.3",
+                "psr/http-factory": "^1.0",
+                "zendframework/zend-coding-standard": "~1.0.0",
+                "zendframework/zend-crypt": "^3.2.1",
+                "zendframework/zend-servicemanager": "^2.7.8 || ^3.3",
+                "zendframework/zend-uri": "^2.6"
+            },
+            "suggest": {
+                "psr/http-factory-implementation": "psr/http-factory-implementation, for creating file upload instances when consuming PSR-7 in file upload filters",
+                "zendframework/zend-crypt": "Zend\\Crypt component, for encryption filters",
+                "zendframework/zend-i18n": "Zend\\I18n component for filters depending on i18n functionality",
+                "zendframework/zend-servicemanager": "Zend\\ServiceManager component, for using the filter chain functionality",
+                "zendframework/zend-uri": "Zend\\Uri component, for the UriNormalize filter"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "2.9.x-dev",
+                    "dev-develop": "2.10.x-dev"
+                },
+                "zf": {
+                    "component": "Zend\\Filter",
+                    "config-provider": "Zend\\Filter\\ConfigProvider"
+                }
+            },
+            "autoload": {
+                "psr-4": {
+                    "Zend\\Filter\\": "src/"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "BSD-3-Clause"
+            ],
+            "description": "provides a set of commonly needed data filters",
+            "keywords": [
+                "ZendFramework",
+                "filter",
+                "zf"
+            ],
+            "time": "2018-12-17T16:00:04+00:00"
+        },
+        {
+            "name": "zendframework/zend-hydrator",
+            "version": "1.1.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/zendframework/zend-hydrator.git",
+                "reference": "22652e1661a5a10b3f564cf7824a2206cf5a4a65"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/zendframework/zend-hydrator/zipball/22652e1661a5a10b3f564cf7824a2206cf5a4a65",
+                "reference": "22652e1661a5a10b3f564cf7824a2206cf5a4a65",
+                "shasum": ""
+            },
+            "require": {
+                "php": "^5.5 || ^7.0",
+                "zendframework/zend-stdlib": "^2.7 || ^3.0"
+            },
+            "require-dev": {
+                "phpunit/phpunit": "~4.0",
+                "squizlabs/php_codesniffer": "^2.0@dev",
+                "zendframework/zend-eventmanager": "^2.6.2 || ^3.0",
+                "zendframework/zend-filter": "^2.6",
+                "zendframework/zend-inputfilter": "^2.6",
+                "zendframework/zend-serializer": "^2.6.1",
+                "zendframework/zend-servicemanager": "^2.7.5 || ^3.0.3"
+            },
+            "suggest": {
+                "zendframework/zend-eventmanager": "^2.6.2 || ^3.0, to support aggregate hydrator usage",
+                "zendframework/zend-filter": "^2.6, to support naming strategy hydrator usage",
+                "zendframework/zend-serializer": "^2.6.1, to use the SerializableStrategy",
+                "zendframework/zend-servicemanager": "^2.7.5 || ^3.0.3, to support hydrator plugin manager usage"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-release-1.0": "1.0-dev",
+                    "dev-release-1.1": "1.1-dev",
+                    "dev-master": "2.0-dev",
+                    "dev-develop": "2.1-dev"
+                }
+            },
+            "autoload": {
+                "psr-4": {
+                    "Zend\\Hydrator\\": "src/"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "BSD-3-Clause"
+            ],
+            "homepage": "https://github.com/zendframework/zend-hydrator",
+            "keywords": [
+                "hydrator",
+                "zf2"
+            ],
+            "time": "2016-02-18T22:38:26+00:00"
+        },
+        {
+            "name": "zendframework/zend-i18n",
+            "version": "2.9.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/zendframework/zend-i18n.git",
+                "reference": "6d69af5a04e1a4de7250043cb1322f077a0cdb7f"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/zendframework/zend-i18n/zipball/6d69af5a04e1a4de7250043cb1322f077a0cdb7f",
+                "reference": "6d69af5a04e1a4de7250043cb1322f077a0cdb7f",
+                "shasum": ""
+            },
+            "require": {
+                "php": "^5.6 || ^7.0",
+                "zendframework/zend-stdlib": "^2.7 || ^3.0"
+            },
+            "require-dev": {
+                "phpunit/phpunit": "^5.7.27 || ^6.5.8 || ^7.1.2",
+                "zendframework/zend-cache": "^2.6.1",
+                "zendframework/zend-coding-standard": "~1.0.0",
+                "zendframework/zend-config": "^2.6",
+                "zendframework/zend-eventmanager": "^2.6.2 || ^3.0",
+                "zendframework/zend-filter": "^2.6.1",
+                "zendframework/zend-servicemanager": "^2.7.5 || ^3.0.3",
+                "zendframework/zend-validator": "^2.6",
+                "zendframework/zend-view": "^2.6.3"
+            },
+            "suggest": {
+                "ext-intl": "Required for most features of Zend\\I18n; included in default builds of PHP",
+                "zendframework/zend-cache": "Zend\\Cache component",
+                "zendframework/zend-config": "Zend\\Config component",
+                "zendframework/zend-eventmanager": "You should install this package to use the events in the translator",
+                "zendframework/zend-filter": "You should install this package to use the provided filters",
+                "zendframework/zend-i18n-resources": "Translation resources",
+                "zendframework/zend-servicemanager": "Zend\\ServiceManager component",
+                "zendframework/zend-validator": "You should install this package to use the provided validators",
+                "zendframework/zend-view": "You should install this package to use the provided view helpers"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "2.9.x-dev",
+                    "dev-develop": "2.10.x-dev"
+                },
+                "zf": {
+                    "component": "Zend\\I18n",
+                    "config-provider": "Zend\\I18n\\ConfigProvider"
+                }
+            },
+            "autoload": {
+                "psr-4": {
+                    "Zend\\I18n\\": "src/"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "BSD-3-Clause"
+            ],
+            "description": "Provide translations for your application, and filter and validate internationalized values",
+            "keywords": [
+                "ZendFramework",
+                "i18n",
+                "zf"
+            ],
+            "time": "2018-05-16T16:39:13+00:00"
+        },
+        {
+            "name": "zendframework/zend-json",
+            "version": "3.1.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/zendframework/zend-json.git",
+                "reference": "4dd940e8e6f32f1d36ea6b0677ea57c540c7c19c"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/zendframework/zend-json/zipball/4dd940e8e6f32f1d36ea6b0677ea57c540c7c19c",
+                "reference": "4dd940e8e6f32f1d36ea6b0677ea57c540c7c19c",
+                "shasum": ""
+            },
+            "require": {
+                "php": "^5.6 || ^7.0"
+            },
+            "require-dev": {
+                "phpunit/phpunit": "^5.7.23 || ^6.4.3",
+                "zendframework/zend-coding-standard": "~1.0.0",
+                "zendframework/zend-stdlib": "^2.7.7 || ^3.1"
+            },
+            "suggest": {
+                "zendframework/zend-json-server": "For implementing JSON-RPC servers",
+                "zendframework/zend-xml2json": "For converting XML documents to JSON"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "3.1.x-dev",
+                    "dev-develop": "3.2.x-dev"
+                }
+            },
+            "autoload": {
+                "psr-4": {
+                    "Zend\\Json\\": "src/"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "BSD-3-Clause"
+            ],
+            "description": "provides convenience methods for serializing native PHP to JSON and decoding JSON to native PHP",
+            "keywords": [
+                "ZendFramework",
+                "json",
+                "zf"
+            ],
+            "time": "2018-01-04T17:51:34+00:00"
+        },
+        {
+            "name": "zendframework/zend-serializer",
+            "version": "2.9.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/zendframework/zend-serializer.git",
+                "reference": "0172690db48d8935edaf625c4cba38b79719892c"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/zendframework/zend-serializer/zipball/0172690db48d8935edaf625c4cba38b79719892c",
+                "reference": "0172690db48d8935edaf625c4cba38b79719892c",
+                "shasum": ""
+            },
+            "require": {
+                "php": "^5.6 || ^7.0",
+                "zendframework/zend-json": "^2.5 || ^3.0",
+                "zendframework/zend-stdlib": "^2.7 || ^3.0"
+            },
+            "require-dev": {
+                "phpunit/phpunit": "^5.7.25 || ^6.4.4",
+                "zendframework/zend-coding-standard": "~1.0.0",
+                "zendframework/zend-math": "^2.6 || ^3.0",
+                "zendframework/zend-servicemanager": "^2.7.5 || ^3.0.3"
+            },
+            "suggest": {
+                "zendframework/zend-math": "(^2.6 || ^3.0) To support Python Pickle serialization",
+                "zendframework/zend-servicemanager": "(^2.7.5 || ^3.0.3) To support plugin manager support"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "2.9.x-dev",
+                    "dev-develop": "2.10.x-dev"
+                },
+                "zf": {
+                    "component": "Zend\\Serializer",
+                    "config-provider": "Zend\\Serializer\\ConfigProvider"
+                }
+            },
+            "autoload": {
+                "psr-4": {
+                    "Zend\\Serializer\\": "src/"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "BSD-3-Clause"
+            ],
+            "description": "provides an adapter based interface to simply generate storable representation of PHP types by different facilities, and recover",
+            "keywords": [
+                "ZendFramework",
+                "serializer",
+                "zf"
+            ],
+            "time": "2018-05-14T18:45:18+00:00"
+        },
+        {
+            "name": "zendframework/zend-servicemanager",
+            "version": "2.7.11",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/zendframework/zend-servicemanager.git",
+                "reference": "99ec9ed5d0f15aed9876433c74c2709eb933d4c7"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/zendframework/zend-servicemanager/zipball/99ec9ed5d0f15aed9876433c74c2709eb933d4c7",
+                "reference": "99ec9ed5d0f15aed9876433c74c2709eb933d4c7",
+                "shasum": ""
+            },
+            "require": {
+                "container-interop/container-interop": "~1.0",
+                "php": "^5.5 || ^7.0"
+            },
+            "require-dev": {
+                "athletic/athletic": "dev-master",
+                "fabpot/php-cs-fixer": "1.7.*",
+                "phpunit/phpunit": "~4.0",
+                "zendframework/zend-di": "~2.5",
+                "zendframework/zend-mvc": "~2.5"
+            },
+            "suggest": {
+                "ocramius/proxy-manager": "ProxyManager 0.5.* to handle lazy initialization of services",
+                "zendframework/zend-di": "Zend\\Di component"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-master": "2.7-dev",
+                    "dev-develop": "3.0-dev"
+                }
+            },
+            "autoload": {
+                "psr-4": {
+                    "Zend\\ServiceManager\\": "src/"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "BSD-3-Clause"
+            ],
+            "homepage": "https://github.com/zendframework/zend-servicemanager",
+            "keywords": [
+                "servicemanager",
+                "zf2"
+            ],
+            "time": "2018-06-22T14:49:54+00:00"
+        },
+        {
+            "name": "zendframework/zend-stdlib",
+            "version": "2.7.7",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/zendframework/zend-stdlib.git",
+                "reference": "0e44eb46788f65e09e077eb7f44d2659143bcc1f"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/zendframework/zend-stdlib/zipball/0e44eb46788f65e09e077eb7f44d2659143bcc1f",
+                "reference": "0e44eb46788f65e09e077eb7f44d2659143bcc1f",
+                "shasum": ""
+            },
+            "require": {
+                "php": "^5.5 || ^7.0",
+                "zendframework/zend-hydrator": "~1.1"
+            },
+            "require-dev": {
+                "athletic/athletic": "~0.1",
+                "fabpot/php-cs-fixer": "1.7.*",
+                "phpunit/phpunit": "~4.0",
+                "zendframework/zend-config": "~2.5",
+                "zendframework/zend-eventmanager": "~2.5",
+                "zendframework/zend-filter": "~2.5",
+                "zendframework/zend-inputfilter": "~2.5",
+                "zendframework/zend-serializer": "~2.5",
+                "zendframework/zend-servicemanager": "~2.5"
+            },
+            "suggest": {
+                "zendframework/zend-eventmanager": "To support aggregate hydrator usage",
+                "zendframework/zend-filter": "To support naming strategy hydrator usage",
+                "zendframework/zend-serializer": "Zend\\Serializer component",
+                "zendframework/zend-servicemanager": "To support hydrator plugin manager usage"
+            },
+            "type": "library",
+            "extra": {
+                "branch-alias": {
+                    "dev-release-2.7": "2.7-dev",
+                    "dev-master": "3.0-dev",
+                    "dev-develop": "3.1-dev"
+                }
+            },
+            "autoload": {
+                "psr-4": {
+                    "Zend\\Stdlib\\": "src/"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "BSD-3-Clause"
+            ],
+            "homepage": "https://github.com/zendframework/zend-stdlib",
+            "keywords": [
+                "stdlib",
+                "zf2"
+            ],
+            "time": "2016-04-12T21:17:31+00:00"
+        },
+        {
+            "name": "zetacomponents/base",
+            "version": "1.9.1",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/zetacomponents/Base.git",
+                "reference": "489e20235989ddc97fdd793af31ac803972454f1"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/zetacomponents/Base/zipball/489e20235989ddc97fdd793af31ac803972454f1",
+                "reference": "489e20235989ddc97fdd793af31ac803972454f1",
+                "shasum": ""
+            },
+            "require-dev": {
+                "phpunit/phpunit": "~5.7",
+                "zetacomponents/unit-test": "*"
+            },
+            "type": "library",
+            "autoload": {
+                "classmap": [
+                    "src"
+                ]
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "Apache-2.0"
+            ],
+            "authors": [
+                {
+                    "name": "Sergey Alexeev"
+                },
+                {
+                    "name": "Sebastian Bergmann"
+                },
+                {
+                    "name": "Jan Borsodi"
+                },
+                {
+                    "name": "Raymond Bosman"
+                },
+                {
+                    "name": "Frederik Holljen"
+                },
+                {
+                    "name": "Kore Nordmann"
+                },
+                {
+                    "name": "Derick Rethans"
+                },
+                {
+                    "name": "Vadym Savchuk"
+                },
+                {
+                    "name": "Tobias Schlitt"
+                },
+                {
+                    "name": "Alexandru Stanoi"
+                }
+            ],
+            "description": "The Base package provides the basic infrastructure that all packages rely on. Therefore every component relies on this package.",
+            "homepage": "https://github.com/zetacomponents",
+            "time": "2017-11-28T11:30:00+00:00"
+        },
+        {
+            "name": "zetacomponents/document",
+            "version": "1.3.1",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/zetacomponents/Document.git",
+                "reference": "688abfde573cf3fe0730f82538fbd7aa9fc95bc8"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/zetacomponents/Document/zipball/688abfde573cf3fe0730f82538fbd7aa9fc95bc8",
+                "reference": "688abfde573cf3fe0730f82538fbd7aa9fc95bc8",
+                "shasum": ""
+            },
+            "require": {
+                "zetacomponents/base": "*"
+            },
+            "require-dev": {
+                "zetacomponents/unit-test": "dev-master"
+            },
+            "type": "library",
+            "autoload": {
+                "classmap": [
+                    "src"
+                ]
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "Apache-2.0"
+            ],
+            "authors": [
+                {
+                    "name": "Sebastian Bergmann"
+                },
+                {
+                    "name": "Kore Nordmann"
+                },
+                {
+                    "name": "Derick Rethans"
+                },
+                {
+                    "name": "Tobias Schlitt"
+                },
+                {
+                    "name": "Alexandru Stanoi"
+                }
+            ],
+            "description": "The Document components provides a general conversion framework for different semantic document markup languages like XHTML, Docbook, RST and similar.",
+            "homepage": "https://github.com/zetacomponents",
+            "time": "2013-12-19T11:40:00+00:00"
+        }
+    ],
+    "aliases": [],
+    "minimum-stability": "stable",
+    "stability-flags": [],
+    "prefer-stable": false,
+    "prefer-lowest": false,
+    "platform": {
+        "php": ">=5.6.0",
+        "ext-soap": "*",
+        "ext-json": "*",
+        "ext-zip": "*",
+        "ext-mysqli": "*",
+        "ext-dom": "*",
+        "ext-iconv": "*",
+        "ext-gd": "*"
+    },
+    "platform-dev": [],
+    "platform-overrides": {
+        "php": "5.6.0"
+    }
+}
diff --git a/CONTRIBUTING.md b/contributing.md
similarity index 100%
rename from CONTRIBUTING.md
rename to contributing.md
diff --git a/core/cmdbobject.class.inc.php b/core/cmdbobject.class.inc.php
index 0f5db54f7..2b23913e7 100644
--- a/core/cmdbobject.class.inc.php
+++ b/core/cmdbobject.class.inc.php
@@ -696,6 +696,8 @@ abstract class CMDBObject extends DBObject
  * TODO: investigate how to get rid of this class that was made to workaround some language limitation... or a poor design!
  *
  * @package     iTopORM
+ *
+ * @internal
  */
 class CMDBObjectSet extends DBObjectSet
 {
diff --git a/core/dbobject.class.php b/core/dbobject.class.php
index 4ceb6a8ec..547acd2bf 100644
--- a/core/dbobject.class.php
+++ b/core/dbobject.class.php
@@ -1,5 +1,5 @@
 <?php
-// Copyright (C) 2010-2018 Combodo SARL
+// Copyright (C) 2010-2019 Combodo SARL
 //
 //   This file is part of iTop.
 //
@@ -19,6 +19,8 @@
 /**
  * All objects to be displayed in the application (either as a list or as details)
  * must implement this interface.
+ *
+ * @internal this interface is implemented by DBObject, you should extends DBObject instead of implementing iDisplay
  */
 interface iDisplay
 {
@@ -65,6 +67,8 @@ require_once('mutex.class.inc.php');
  * A persistent object, as defined by the metamodel 
  *
  * @package     iTopORM
+ * @api
+ * @overwritable-hook
  */
 abstract class DBObject implements iDisplay
 {
@@ -76,19 +80,24 @@ abstract class DBObject implements iDisplay
 	private static $m_aBulkInsertCols = array();
   	private static $m_bBulkInsert = false;
 
-	/** @var bool true IIF the object is mapped to a DB record */
+	/** @var bool true IF the object is mapped to a DB record */
 	protected $m_bIsInDB = false;
 	protected $m_iKey = null;
+	/** @var array key: attcode, value: corresponding current value (in memory, before persisting object) */
 	private $m_aCurrValues = array();
 	protected $m_aOrigValues = array();
 
 	protected $m_aExtendedData = null;
 
-	private $m_bDirty = false; // Means: "a modification is ongoing"
-										// The object may have incorrect external keys, then any attempt of reload must be avoided
+    /**
+     * @var bool Is dirty (true) if a modification is ongoing.
+     *
+     * @internal The object may have incorrect external keys, then any attempt of reload must be avoided
+     */
+	private $m_bDirty = false;
+
 	/**
-	 * @var boolean|null true if the object has been verified and is consistent with integrity rules
-	 *                   if null, then the check has to be performed again to know the status
+	 * @var boolean|null true if the object has been verified and is consistent with integrity rules. If null, then the check has to be performed again to know the status
 	 * @see CheckToWrite()
 	 */
 	private $m_bCheckStatus = null;
@@ -98,27 +107,62 @@ abstract class DBObject implements iDisplay
 	 */
 	protected $m_bSecurityIssue = null;
 	/**
-	 * @var null|string[] list of issues preventing object save
+	 * @var null|string[] list of issues preventing DB write
 	 * @see CheckToWrite()
 	 */
 	protected $m_aCheckIssues = null;
 	/**
-	 * @var null|string[] list of warnings throws during object save
+	 * @var null|string[] list of warnings thrown during DB write
 	 * @see CheckToWrite()
 	 * @since 2.6 N°659 uniqueness constraints
 	 */
 	protected $m_aCheckWarnings = null;
 	protected $m_aDeleteIssues = null;
 
-	private $m_bFullyLoaded = false; // Compound objects can be partially loaded
-	private $m_aLoadedAtt = array(); // Compound objects can be partially loaded, array of sAttCode
-	protected $m_aTouchedAtt = array(); // list of (potentially) modified sAttCodes
-	protected $m_aModifiedAtt = array(); // real modification status: for each attCode can be: unset => don't know, true => modified, false => not modified (the same value as the original value was set)
-	protected $m_aSynchroData = null; // Set of Synch data related to this object
+	/** @var bool Compound objects can be partially loaded */
+	private $m_bFullyLoaded = false;
+	/** @var array Compound objects can be partially loaded, array of sAttCode */
+	private $m_aLoadedAtt = array();
+	/** @var array list of (potentially) modified sAttCodes */
+	protected $m_aTouchedAtt = array();
+	/**
+	 * @var array real modification status
+	 * for each attCode can be:
+	 *   * unset => don't know,
+	 *   * true => modified,
+	 *   * false => not modified (the same value as the original value was set)
+	 */
+	protected $m_aModifiedAtt = array();
+	/**
+	 * @var array Set of Synch data related to this object
+	 * <ul>
+	 * <li>key: sourceId
+	 * <li>value : array of source, attributes, replica
+	 * </ul>
+	 *
+	 * @see #GetSynchroData
+	 */
+	protected $m_aSynchroData = null;
 	protected $m_sHighlightCode = null;
 	protected $m_aCallbacks = array();
 
-	// Use the MetaModel::NewObject to build an object (do we have to force it?)
+
+    /**
+     * DBObject constructor.
+     *
+     * You should preferably use MetaModel::NewObject() instead of this constructor.
+     * The whole collection of parameters is [*optional*] please refer to DBObjectSet::FromRow()
+     *
+     * @internal The availability of this method is not guaranteed in the long term, you should preferably use MetaModel::NewObject().
+     * @see MetaModel::NewObject()
+     *
+     * @param null|array   $aRow                If given : DBObjectSet::FromRow() will be used to fetch the object
+     * @param string       $sClassAlias
+     * @param null|array   $aAttToLoad
+     * @param null|array   $aExtendedDataSpec
+     *
+     * @throws CoreException
+     */
 	public function __construct($aRow = null, $sClassAlias = '', $aAttToLoad = null, $aExtendedDataSpec = null)
 	{
 		if (!empty($aRow))
@@ -158,8 +202,10 @@ abstract class DBObject implements iDisplay
 	/**
 	 * Update meta-attributes depending on the given attribute list
 	 *
-	 * @param array|null $aAttCodes List of att codes
-	 *
+     * @internal
+     *
+     * @param array|null $aAttCodes List of att codes
+     *
 	 * @throws \CoreException
 	 */
 	protected function UpdateMetaAttributes($aAttCodes = null)
@@ -178,20 +224,41 @@ abstract class DBObject implements iDisplay
 		}
 	}
 
-	// Read-only <=> Written once (archive)
+    /**
+     * Mark the object as dirty
+     *
+     * Once dirty the object may be written to the DB, it is NOT possible to reload it
+     * or at least not possible to reload it the same way
+     *
+     * @internal
+     */
 	public function RegisterAsDirty()
 	{
-		// While the object may be written to the DB, it is NOT possible to reload it
-		// or at least not possible to reload it the same way
-		$this->m_bDirty = true;	
+		$this->m_bDirty = true;
 	}
 
+    /**
+     * Whether the object is already persisted in DB or not.
+     * 
+     * @api
+     * 
+     * @return bool
+     */
 	public function IsNew()
 	{
 		return (!$this->m_bIsInDB);
 	}
 
-	// Returns an Id for memory objects
+    /**
+     * Returns an Id for memory objects
+     * 
+     * @internal
+     * 
+     * @param string $sClass
+     *
+     * @return int
+     * @throws CoreException
+     */
 	static protected function GetNextTempId($sClass)
 	{
 		$sRootClass = MetaModel::GetRootClass($sClass);
@@ -203,23 +270,53 @@ abstract class DBObject implements iDisplay
 		return (- self::$m_aMemoryObjectsByClass[$sRootClass]);
 	}
 
+    /**
+     * HTML String representation of the object
+     *
+     * Only a few meaningful information will be returned.
+     * This representation is for debugging purposes, and is subject to change.
+     * The returned string is raw HTML
+     *
+     * @return string
+     * @throws CoreException
+     */
 	public function __toString()
 	{
         $sRet = '';
         $sClass = get_class($this);
         $sRootClass = MetaModel::GetRootClass($sClass);
         $iPKey = $this->GetKey();
-        $sFriendlyname = $this->Get('friendlyname');
+        $sFriendlyname = $this->GetAsHTML('friendlyname');
         $sRet .= "<b title=\"$sRootClass\">$sClass</b>::$iPKey ($sFriendlyname)<br/>\n";
         return $sRet;
 	}
 	
-	// Restore initial values... mmmm, to be discussed
+    /**
+     * Alias of DBObject::Reload()
+     *
+     * Restore initial values
+     *
+     * @see Reload()
+     *
+     * @throws CoreException
+     */
 	public function DBRevert()
 	{
 		$this->Reload();
 	}
 
+    /**
+     * Is the current instance fully or partially loaded.
+     *
+     * This method compute the state in realtime.
+     * In almost every case it is preferable to use DBObject::m_bFullyLoaded.
+     *
+     * @internal
+     * @see m_bFullyLoaded
+     * 
+     * @return bool
+     * @throws CoreException
+     */
 	protected function IsFullyLoaded()
 	{
 		foreach(MetaModel::ListAttributeDefs(get_class($this)) as $sAttCode=>$oAttDef)
@@ -234,10 +331,14 @@ abstract class DBObject implements iDisplay
 	}
 
 	/**
-	 * @param bool $bAllowAllData DEPRECATED: the reload must never fail!
+     * Reload the object from the DB.
+     *
+     * This is mostly used after a lazy load (automatically performed by the framework)
+     * This will erase any pending changes.
+     *
+	 * @param bool $bAllowAllData @deprecated This parameter is ignored!!
 	 *
 	 * @throws CoreException
-	 * @internal 
 	 */
 	public function Reload($bAllowAllData = false)
 	{
@@ -265,6 +366,20 @@ abstract class DBObject implements iDisplay
 		$this->m_aModifiedAtt = array();
 	}
 
+    /**
+     * Initialize the instance against a given structured array
+     *
+     * @internal
+     * @see GetExtendedData() extended data
+     *
+     * @param array        $aRow                an array under the form: `<AttributeCode> => <value>`
+     * @param string       $sClassAlias         if not null, it is preprended to the `<AttributeCode>` part of $aRow
+     * @param null|array   $aAttToLoad          List of attribute that will be fetched against the database anyway
+     * @param null|array   $aExtendedDataSpec   List of attribute that will be marked as DBObject::GetExtendedData()
+     *
+     * @return bool
+     * @throws CoreException
+     */
 	protected function FromRow($aRow, $sClassAlias = '', $aAttToLoad = null, $aExtendedDataSpec = null)
 	{
 		if (strlen($sClassAlias) == 0)
@@ -381,6 +496,18 @@ abstract class DBObject implements iDisplay
 		return $bFullyLoaded;
 	}
 
+    /**
+     * Protected raw Setter
+     *
+     * This method is an internal plumbing : it sets the value without doing any of the required processes.
+     * The exposed API Setter is DBObject::Set()
+     *
+     * @internal
+     * @see Set()
+     * 
+     * @param string $sAttCode
+     * @param mixed $value
+     */
 	protected function _Set($sAttCode, $value)
 	{
 		$this->m_aCurrValues[$sAttCode] = $value;
@@ -388,6 +515,24 @@ abstract class DBObject implements iDisplay
 		unset($this->m_aModifiedAtt[$sAttCode]);
 	}
 
+
+    /**
+     * Attributes setter
+     *
+     * Set $sAttCode to $value.
+     * The value must be valid according to the type of attribute.
+     * The value will not be recorded into the DB until DBObject::DBWrite() is called.
+     *
+     * @api
+     * @see DBWrite()
+     *
+     * @param string $sAttCode
+     * @param mixed $value
+     *
+     * @return bool
+     * @throws CoreException
+     * @throws CoreUnexpectedValue
+     */
 	public function Set($sAttCode, $value)
 	{
 		if ($sAttCode == 'finalclass')
@@ -475,6 +620,13 @@ abstract class DBObject implements iDisplay
 	}
 
 	/**
+     * Helper to set a value only if it is currently undefined
+     *
+     * Call Set() only of the internal representation of the attribute is null.
+     *
+     * @api
+     * @see Set()
+     *
 	 * @param string $sAttCode
 	 * @param mixed $value
 	 *
@@ -493,6 +645,20 @@ abstract class DBObject implements iDisplay
 		}
 	}
 
+    /**
+     * Helper to set a value that fits the attribute max size
+     *
+     * compare $sValue against the field's max size in the database, and truncate it's ending in order to make it fit.
+     * If $sValue is short enough, nothing is done.
+     *
+     * @api
+     *
+     * @param string $sAttCode
+     * @param string $sValue
+     *
+     * @throws CoreException
+     * @throws CoreUnexpectedValue
+     */
 	public function SetTrim($sAttCode, $sValue)
 	{
 		$oAttDef = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
@@ -504,12 +670,40 @@ abstract class DBObject implements iDisplay
 		$this->Set($sAttCode, $sValue);
 	}
 
+    /**
+     * Get the label of an attribute.
+     * 
+     * Shortcut to the field's AttributeDefinition->GetLabel()
+     *
+     * @api
+     * 
+     * @param string $sAttCode
+     *
+     * @return string
+     *
+     * @throws Exception
+     */
 	public function GetLabel($sAttCode)
 	{
 		$oAttDef = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
 		return $oAttDef->GetLabel();
 	}
 
+    /**
+     * Getter : get a value from the current object of from a related object
+     * 
+     * Get the value of the attribute $sAttCode
+     * This call may involve an object reload if the object was not completely loaded (lazy loading)
+     * 
+     * @api
+     * 
+     * @param string $sAttCode Could be an extended attribute code in the form extkey_id->anotherkey_id->remote_attr
+     *
+     * @return mixed|string
+     *
+     * @throws ArchivedObjectException
+     * @throws CoreException
+     */
 	public function Get($sAttCode)
 	{
 		if (($iPos = strpos($sAttCode, '->')) === false)
@@ -549,6 +743,18 @@ abstract class DBObject implements iDisplay
 		}
 	}
 
+    /**
+     * Getter : get values from the current object
+     *
+     * @internal
+     * @see Get
+     * 
+     * @param string $sAttCode
+     *
+     * @return int|mixed|null
+     * @throws ArchivedObjectException
+     * @throws CoreException
+     */
 	public function GetStrict($sAttCode)
 	{
 		if ($sAttCode == 'id')
@@ -636,6 +842,19 @@ abstract class DBObject implements iDisplay
 		return $value; 
 	}
 
+    /**
+     * Get the value as it was before change with Set
+     * 
+     * The original value vary according to the persisted state 
+     *   - not persisted: NULL
+     *   - persisted: the "in DB" value
+     * 
+     * @param string $sAttCode
+     *
+     * @return mixed|null the original value
+     *
+     * @throws CoreException
+     */
 	public function GetOriginal($sAttCode)
 	{
 		if (!array_key_exists($sAttCode, MetaModel::ListAttributeDefs(get_class($this))))
@@ -647,11 +866,17 @@ abstract class DBObject implements iDisplay
 	}
 
     /**
-     * Returns the default value of the $sAttCode. By default, returns the default value of the AttributeDefinition.
-     * Overridable.
+     * Returns the default value of the $sAttCode.
+     *
+     * Returns the default value of the given attribute.
+     * 
+     * @internal
+     *
+     * @param string $sAttCode
      *
-     * @param $sAttCode
      * @return mixed
+     *
+     * @throws Exception
      */
 	public function GetDefaultValue($sAttCode)
     {
@@ -661,6 +886,10 @@ abstract class DBObject implements iDisplay
 
 	/**
 	 * Returns data loaded by the mean of a dynamic and explicit JOIN
+     *
+     * @internal
+     *
+     * @return array|null
 	 */	 
 	public function GetExtendedData()
 	{
@@ -668,8 +897,16 @@ abstract class DBObject implements iDisplay
 	}
 	
 	/**
-	 * Set the HighlightCode if the given code has a greater rank than the current HilightCode
+     * Set the HighlightCode
+     *
+     * Switch to $sCode if it has a greater rank than the current code
+     *
+     * @internal
+     * @used-by DBObject::ComputeHighlightCode()
+     * @see m_sHighlightCode
+     *
 	 * @param string $sCode
+	 *
 	 * @return void
 	 */
 	protected function SetHighlightCode($sCode)
@@ -693,13 +930,29 @@ abstract class DBObject implements iDisplay
 	
 	/**
 	 * Get the current HighlightCode
-	 * @return string The Hightlight code (null if none set, meaning rank = 0)
+     * 
+     * @internal
+     * @used-by DBObject::ComputeHighlightCode()
+     * 
+	 * @return string|null The Hightlight code (null if none set, meaning rank = 0)
 	 */
 	protected function GetHighlightCode()
 	{
 		return $this->m_sHighlightCode;
 	}
-	
+
+    /**
+     * Compute the highlightCode
+     * 
+     * @example When TTR, then TTR of a UserRequest is greater thant a defined scale, the item is highlighted in the listings
+     *
+     * @interal
+     *
+     * @return string|null The Hightlight code (null if none set, meaning rank = 0)
+     *
+     * @throws ArchivedObjectException
+     * @throws CoreException
+     */
 	protected function ComputeHighlightCode()
 	{
 		// First if the state defines a HiglightCode, apply it
@@ -725,15 +978,23 @@ abstract class DBObject implements iDisplay
 		return $this->GetHighlightCode();
 	}
 
-	/**
-	 * Updates the value of an external field by (re)loading the object
-	 * corresponding to the external key and getting the value from it
-	 * 	 
-	 * UNUSED ?
-	 * 	 
-	 * @param string $sAttCode Attribute code of the external field to update
-	 * @return void
-	 */
+    /**
+     * Updates the value of an external field by (re)loading the object
+     * corresponding to the external key and getting the value from it
+     *
+     * UNUSED ?
+     * 
+     * @internal
+     * @todo: check if this is dead code.
+     *
+     * @param string $sAttCode Attribute code of the external field to update
+     *
+     * @return void
+     *
+     * @throws ArchivedObjectException
+     * @throws CoreException
+     * @throws CoreUnexpectedValue
+     */
 	protected function UpdateExternalField($sAttCode)
 	{
 		$oAttDef = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
@@ -755,9 +1016,10 @@ abstract class DBObject implements iDisplay
 	}
 
 	/**
-	 * Overridable callback, called by \DBObject::DoComputeValues
-	 *
-	 * @api
+	 * Overridable callback
+     *
+	 * @internal this method is elligible to the "overwritable-hook" tag. But it is willingly excluded.
+     * @used-by DoComputeValues()
 	 */
 	public function ComputeValues()
 	{
@@ -765,6 +1027,8 @@ abstract class DBObject implements iDisplay
 
 	/**
 	 * Compute scalar attributes that depend on any other type of attribute
+     * 
+     * if you want to customize this behaviour, overwrite @see ComputeValues()
 	 *
 	 * @throws \CoreException
 	 * @throws \CoreUnexpectedValue
@@ -798,6 +1062,23 @@ abstract class DBObject implements iDisplay
 		$this->ComputeValues();
 	}
 
+    /**
+     * Get $sAttCode formatted as HTML
+     * 
+     * The returned string is already escaped, and as such is protected against XSS
+     * The markup relies on a few assumptions (CSS) that could change without notice
+     * 
+     * @api
+     * 
+     * @param string $sAttCode
+     * @param bool   $bLocalize
+     *
+     * @return string
+     *
+     * @throws ArchivedObjectException
+     * @throws CoreException
+     * @throws DictExceptionMissingString
+     */
 	public function GetAsHTML($sAttCode, $bLocalize = true)
 	{
 		$sClass = get_class($this);
@@ -827,6 +1108,20 @@ abstract class DBObject implements iDisplay
 		return $oAtt->GetAsHTML($this->Get($sAttCode), $this, $bLocalize);
 	}
 
+    /**
+     * Get the value as it must be in the edit areas (forms)
+     * 
+     * Makes a raw text representation of the value.
+     *
+     * @internal
+     * 
+     * @param string $sAttCode
+     *
+     * @return int|mixed|string
+     *
+     * @throws ArchivedObjectException
+     * @throws CoreException
+     */
 	public function GetEditValue($sAttCode)
 	{
 		$sClass = get_class($this);
@@ -863,30 +1158,100 @@ abstract class DBObject implements iDisplay
 		return $sEditValue;
 	}
 
+    /**
+     * Get $sAttCode formatted as XML
+     * 
+     * The returned value is a text that is suitable for insertion into an XML node.
+     * Depending on the type of attribute, the returned text is either:
+     *   * A literal, with XML entities already escaped,
+     *   * XML
+     *
+     * @api
+     * 
+     * @param string $sAttCode
+     * @param bool   $bLocalize
+     *
+     * @return mixed
+     *
+     * @throws ArchivedObjectException
+     * @throws CoreException
+     */
 	public function GetAsXML($sAttCode, $bLocalize = true)
 	{
 		$oAtt = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
 		return $oAtt->GetAsXML($this->Get($sAttCode), $this, $bLocalize);
 	}
 
+    /**
+     * Get $sAttCode formatted as CSV
+     *
+     * @api
+     *
+     * @param string $sAttCode
+     * @param string $sSeparator
+     * @param string $sTextQualifier
+     * @param bool   $bLocalize
+     * @param bool   $bConvertToPlainText
+     *
+     * @return string
+     *
+     * @throws ArchivedObjectException
+     * @throws CoreException
+     */
 	public function GetAsCSV($sAttCode, $sSeparator = ',', $sTextQualifier = '"', $bLocalize = true, $bConvertToPlainText = false)
 	{
 		$oAtt = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
 		return $oAtt->GetAsCSV($this->Get($sAttCode), $sSeparator, $sTextQualifier, $this, $bLocalize, $bConvertToPlainText);
 	}
 
+    /**
+     * 
+     * @see GetAsHTML()
+     * @see GetOriginal()
+     * 
+     * @param string $sAttCode
+     * @param bool   $bLocalize
+     *
+     * @return string
+     * @throws CoreException
+     */
 	public function GetOriginalAsHTML($sAttCode, $bLocalize = true)
 	{
 		$oAtt = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
 		return $oAtt->GetAsHTML($this->GetOriginal($sAttCode), $this, $bLocalize);
 	}
 
+    /**
+     *
+     * @see GetAsXML()
+     * @see GetOriginal()
+     *
+     * @param string $sAttCode
+     * @param bool   $bLocalize
+     *
+     * @return mixed
+     * @throws CoreException
+     */
 	public function GetOriginalAsXML($sAttCode, $bLocalize = true)
 	{
 		$oAtt = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
 		return $oAtt->GetAsXML($this->GetOriginal($sAttCode), $this, $bLocalize);
 	}
 
+    /**
+     *
+     * @see GetAsCSV()
+     * @see GetOriginal()
+     *
+     * @param string $sAttCode
+     * @param string $sSeparator
+     * @param string $sTextQualifier
+     * @param bool   $bLocalize
+     * @param bool   $bConvertToPlainText
+     *
+     * @return string
+     * @throws CoreException
+     */
 	public function GetOriginalAsCSV($sAttCode, $sSeparator = ',', $sTextQualifier = '"', $bLocalize = true, $bConvertToPlainText = false)
 	{
 		$oAtt = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
@@ -894,15 +1259,20 @@ abstract class DBObject implements iDisplay
 	}
 
     /**
-     * @param string $sObjClass
-     * @param string $sObjKey
-     * @param string $sHtmlLabel Label with HTML entities escaped (< escaped as &lt;)
-     * @param null $sUrlMakerClass
-     * @param bool|true $bWithNavigationContext
-     * @param bool|false $bArchived
-     * @param bool|false $bObsolete
+     * Return an hyperlink pointing to  <$sObjClass, $sObjKey>
+     *
+     * @internal
+     *
+     * @param string      $sObjClass
+     * @param string      $sObjKey
+     * @param string      $sHtmlLabel Label with HTML entities escaped (< escaped as &lt;)
+     * @param null|string $sUrlMakerClass if not null, the class must expose a public method ''MakeObjectUrl(string $sObjClass, string $sObjKey)''
+     * @param bool        $bWithNavigationContext
+     * @param bool        $bArchived
+     * @param bool        $bObsolete
+     *
+     * @return string the HTML markup pointing to  <$sObjClass, $sObjKey>
      *
-     * @return string
      * @throws \ArchivedObjectException
      * @throws \CoreException
      * @throws \DictExceptionMissingString
@@ -978,12 +1348,19 @@ abstract class DBObject implements iDisplay
 	}
 
     /**
+     * Return an hyperlink pointing to the current DBObject
+     *
+     * @api
+     *
      * @param string $sUrlMakerClass
-     * @param bool $bWithNavigationContext
+     * @param bool   $bWithNavigationContext
      * @param string $sLabel
      *
      * @return string
-     * @throws \DictExceptionMissingString
+     *
+     * @throws ArchivedObjectException
+     * @throws CoreException
+     * @throws DictExceptionMissingString
      */
 	public function GetHyperlink($sUrlMakerClass = null, $bWithNavigationContext = true, $sLabel = null)
 	{
@@ -995,7 +1372,14 @@ abstract class DBObject implements iDisplay
 		$bObsolete = $this->IsObsolete();
 		return self::MakeHyperLink(get_class($this), $this->GetKey(), $sLabel, $sUrlMakerClass, $bWithNavigationContext, $bArchived, $bObsolete);
 	}
-	
+
+    /**
+     * @internal
+     * 
+     * @param string $sClass
+     *
+     * @return mixed
+     */
 	public static function ComputeStandardUIPage($sClass)
 	{
 		static $aUIPagesCache = array(); // Cache to store the php page used to display each class of object
@@ -1012,22 +1396,58 @@ abstract class DBObject implements iDisplay
 		return $sPage;
 	}
 
+    /**
+     * @internal
+     *
+     * @return string
+     */
 	public static function GetUIPage()
 	{
 		return 'UI.php';
 	}
 
 
-	// could be in the metamodel ?
+
+
+    /**
+     * Whether $value is valid as a primary key
+     *
+     * @internal
+     *
+     * @param string $value
+     *
+     * @return bool
+     */
 	public static function IsValidPKey($value)
 	{
+	    // this function could be in the metamodel ?
 		return ((string)$value === (string)(int)$value);
 	}
 
+    /**
+     * Primary key Getter
+     *
+     * Get the id
+     *
+     * @api
+     * 
+     * @return int|null
+     */
 	public function GetKey()
 	{
 		return $this->m_iKey;
 	}
+
+    /**
+     * Primary key Setter
+     * Usable only for not yet persisted DBObjects
+     * 
+     * @internal
+     *
+     * @param int $iNewKey the desired identifier
+     *
+     * @throws CoreException
+     */
 	public function SetKey($iNewKey)
 	{
 		if (!self::IsValidPKey($iNewKey))
@@ -1041,11 +1461,18 @@ abstract class DBObject implements iDisplay
 		}
 		$this->m_iKey = $iNewKey;
 	}
-	/**
-	 * Get the icon representing this object
-	 * @param boolean $bImgTag If true the result is a full IMG tag (or an emtpy string if no icon is defined)
-	 * @return string Either the full IMG tag ($bImgTag == true) or just the URL to the icon file
-	 */
+
+    /**
+     * Get the icon representing this object
+     * 
+     * @api
+     *
+     * @param boolean $bImgTag If true the result is a full IMG tag (or an empty string if no icon is defined)
+     *
+     * @return string Either the full IMG tag ($bImgTag == true) or just the URL to the icon file
+     * @throws ArchivedObjectException
+     * @throws CoreException
+     */
 	public function GetIcon($bImgTag = true)
 	{
 		$sCode = $this->ComputeHighlightCode();
@@ -1069,7 +1496,12 @@ abstract class DBObject implements iDisplay
 	}
 
 	/**
-	 * Get the name as defined in the dictionary
+	 * Get the label of a class
+	 *
+	 * Returns the label as defined in the dictionary for the language of the current user
+     *
+     * @api 
+     *
 	 * @return string (empty for default name scheme)
 	 */
 	public static function GetClassName($sClass)
@@ -1079,7 +1511,12 @@ abstract class DBObject implements iDisplay
 	}
 
 	/**
-	 * Get the description as defined in the dictionary
+	 * Get the description of a class
+	 *
+	 * Returns the label as defined in the dictionary for the language of the current user
+     *
+     * @internal
+     *
 	 * @param string $sClass
 	 *
 	 * @return string
@@ -1091,7 +1528,9 @@ abstract class DBObject implements iDisplay
 	}
 
 	/**
-	 * Gets the name of an object in a safe manner for displaying inside a web page
+	 * Helper to get the friendly name in a safe manner for displaying inside a web page
+	 *
+     * @api
 	 *
 	 * @return string
 	 * @throws \CoreException
@@ -1102,11 +1541,14 @@ abstract class DBObject implements iDisplay
 	}
 
 	/**
-	 * Gets the raw name of an object, this is not safe for displaying inside a web page
-	 * since the " < > characters are not escaped and the name may contain some XSS script
-	 * instructions.
+     * Helper to get the friendly name
+     *
+     * This is not safe for displaying inside a web page since the " < > characters are not escaped.
+     * In example, the name may contain some XSS script instructions.
 	 * Use this function only for internal computations or for an output to a non-HTML destination
 	 *
+     * @api
+     *
 	 * @return string
 	 * @throws \CoreException
 	 */
@@ -1116,9 +1558,12 @@ abstract class DBObject implements iDisplay
 	}
 
 	/**
+     * Helper to get the state
+     * 
+     * @api
+     *
 	 * @return mixed|string '' if no state attribute, object representing its value otherwise
 	 * @throws \CoreException
-	 * @internal
 	 */
 	public function GetState()
 	{
@@ -1133,6 +1578,16 @@ abstract class DBObject implements iDisplay
 		}
 	}
 
+    /**
+     * Get the label of the current state
+     * 
+     * @api
+     * 
+     * @return mixed|string
+     *
+     * @throws ArchivedObjectException
+     * @throws CoreException
+     */
 	public function GetStateLabel()
 	{
 		$sStateAttCode = MetaModel::GetStateAttributeCode(get_class($this));
@@ -1147,6 +1602,15 @@ abstract class DBObject implements iDisplay
 		}
 	}
 
+    /**
+     * Get the description of the state
+     *
+     * @api
+     *
+     * @return mixed|string
+     * @throws ArchivedObjectException
+     * @throws CoreException
+     */
 	public function GetStateDescription()
 	{
 		$sStateAttCode = MetaModel::GetStateAttributeCode(get_class($this));
@@ -1162,9 +1626,9 @@ abstract class DBObject implements iDisplay
 	}
 
 	/**
-	 * Overridable - Define attributes read-only from the end-user perspective
-	 * 	 
-	 * @return array List of attcodes
+	 * Define attributes read-only from the end-user perspective
+	 *
+	 * @return array|null List of attcodes
 	 */	 	  	 	
 	public static function GetReadOnlyAttributes()
 	{
@@ -1173,9 +1637,13 @@ abstract class DBObject implements iDisplay
 
 
 	/**
-	 * Overridable - Get predefined objects (could be hardcoded)
+	 * Get predefined objects
+     * 
 	 * The predefined objects will be synchronized with the DB at each install/upgrade
-	 * As soon as a class has predefined objects, then nobody can create nor delete objects	 
+     * As soon as a class has predefined objects, then nobody can create nor delete objects
+     *
+     * @internal
+     *
 	 * @return array An array of id => array of attcode => php value(so-called "real value": integer, string, ormDocument, DBObjectSet, etc.)
 	 */	 	  	 	
 	public static function GetPredefinedObjects()
@@ -1184,17 +1652,19 @@ abstract class DBObject implements iDisplay
 	}
 
 	/**
+     * Get the flags for the given state
+     *
+     * @overwritable-hook You can extend this method in order to provide your own logic. If you do so, rely on the parent as a fallback if you have uncovered $sAttCode
+     *
 	 * @param string $sAttCode $sAttCode The code of the attribute
-	 * @param array $aReasons To store the reasons why the attribute is read-only (info about the synchro replicas)
-	 * @param string $sTargetState The target state in which to evalutate the flags, if empty the current state will be
-	 *     used
+	 * @param array  $aReasons To store the reasons why the attribute is read-only (info about the synchro replicas)
+	 * @param string $sTargetState The target state in which to evalutate the flags, if empty the current state will be used
 	 *
-	 * @return integer the binary combination of flags for the given attribute in the given state of the object<br>
-	 *         Values can be one of the OPT_ATT_HIDDEN, OPT_ATT_READONLY, OPT_ATT_MANDATORY, ... (see define in metamodel.class.php)
+	 * @return integer the binary combination of flags for the given attribute in the given state of the object.
+	 * Values can be one of the OPT_ATT_HIDDEN, OPT_ATT_READONLY, OPT_ATT_MANDATORY, ... (see define in metamodel.class.php)
+     *
 	 * @throws \CoreException
 	 *
-	 * @api
-	 *
 	 * @see GetInitialStateAttributeFlags for creation
 	 */
 	public function GetAttributeFlags($sAttCode, &$aReasons = array(), $sTargetState = '')
@@ -1232,12 +1702,18 @@ abstract class DBObject implements iDisplay
 		return $iFlags | $iSynchroFlags; // Combine both sets of flags
 	}
 
-	/**
-	 * @param string $sAttCode
-	 * @param array $aReasons To store the reasons why the attribute is read-only (info about the synchro replicas)
-	 *
-	 * @throws \CoreException
-	 */
+    /**
+     * Whether the attribute is read-only
+     *
+     * @internal
+     *
+     * @param string $sAttCode
+     * @param array  $aReasons To store the reasons why the attribute is read-only (info about the synchro replicas)
+     *
+     * @return int Values can be one of the OPT_ATT_HIDDEN, OPT_ATT_READONLY, OPT_ATT_MANDATORY, ... (see define in metamodel.class.php)
+     *
+     * @throws \CoreException
+     */
 	public function IsAttributeReadOnlyForCurrentState($sAttCode, &$aReasons = array())
 	{
 		$iAttFlags = $this->GetAttributeFlags($sAttCode, $aReasons);
@@ -1248,11 +1724,17 @@ abstract class DBObject implements iDisplay
     /**
      * Returns the set of flags (OPT_ATT_HIDDEN, OPT_ATT_READONLY, OPT_ATT_MANDATORY...)
      * for the given attribute in a transition
-     * @param $sAttCode string $sAttCode The code of the attribute
-     * @param $sStimulus string The stimulus code to apply
-     * @param $aReasons array To store the reasons why the attribute is read-only (info about the synchro replicas)
-     * @param $sOriginState string The state from which to apply $sStimulus, if empty current state will be used
+     *
+     * @internal
+     *
+     * @param string $sAttCode     $sAttCode The code of the attribute
+     * @param string $sStimulus    The stimulus code to apply
+     * @param array|null $aReasons To store the reasons why the attribute is read-only (info about the synchro replicas)
+     * @param string $sOriginState The state from which to apply $sStimulus, if empty current state will be used
+     *
      * @return integer Flags: the binary combination of the flags applicable to this attribute
+     * @throws ArchivedObjectException
+     * @throws CoreException
      */
     public function GetTransitionFlags($sAttCode, $sStimulus, &$aReasons = array(), $sOriginState = '')
     {
@@ -1287,9 +1769,13 @@ abstract class DBObject implements iDisplay
      * Returns an array of attribute codes (with their flags) when $sStimulus is applied on the object in the $sOriginState state.
      * Note: Attributes (and flags) from the target state and the transition are combined.
      *
-     * @param $sStimulus string
-     * @param $sOriginState string Default is current state
+     * @internal
+     * 
+     * @param string $sStimulus
+     * @param string $sOriginState Default is current state
+     *
      * @return array
+     * @throws CoreException
      */
     public function GetTransitionAttributes($sStimulus, $sOriginState = null)
     {
@@ -1310,13 +1796,13 @@ abstract class DBObject implements iDisplay
 	 * @param string $sAttCode The code of the attribute
 	 * @param array $aReasons
 	 *
-	 * @return integer The binary combination of the flags for the given attribute for the current state of the object
-	 *         considered as an INITIAL state.<br>
-	 *         Values can be one of the OPT_ATT_HIDDEN, OPT_ATT_READONLY, OPT_ATT_MANDATORY, ... (see define in metamodel.class.php)
+     * @overwritable-hook You can extend this method in order to provide your own logic
+     *
+	 * @return integer The binary combination of the flags for the given attribute for the current state of the object considered as an INITIAL state.
+	 * Values can be one of the OPT_ATT_HIDDEN, OPT_ATT_READONLY, OPT_ATT_MANDATORY, ... (see define in metamodel.class.php)
+     *
 	 * @throws \CoreException
 	 *
-	 * @api
-	 *
 	 * @see GetAttributeFlags when modifying the object
 	 */
 	public function GetInitialStateAttributeFlags($sAttCode, &$aReasons = array())
@@ -1333,15 +1819,17 @@ abstract class DBObject implements iDisplay
 	/**
 	 * Check if the given (or current) value is suitable for the attribute
 	 *
-	 * @param $sAttCode
-	 * @param boolean|string $value true if successfull, the error desciption otherwise
+     * @api
+     * @api-advanced
+     *
+	 * @param string $sAttCode
+	 * @param boolean|string $value true if successful, the error description otherwise
 	 *
 	 * @return bool|string
 	 * @throws \ArchivedObjectException
 	 * @throws \CoreException
 	 * @throws \OQLException
 	 *
-	 * @internal
 	 */
 	public function CheckValue($sAttCode, $value = null)
 	{
@@ -1476,8 +1964,9 @@ abstract class DBObject implements iDisplay
 	/**
 	 * check attributes together
 	 *
-	 * @return bool
-	 * @api
+     * @overwritable-hook You can extend this method in order to provide your own logic.
+     * 
+	 * @return bool 
 	 */
 	public function CheckConsistency()
 	{
@@ -1485,8 +1974,11 @@ abstract class DBObject implements iDisplay
 	}
 
 	/**
+     * @internal
+     * 
 	 * @throws \CoreException
 	 * @throws \OQLException
+     *
 	 * @since 2.6 N°659 uniqueness constraint
 	 */
 	protected function DoCheckUniqueness()
@@ -1524,11 +2016,13 @@ abstract class DBObject implements iDisplay
 	}
 
 	/**
+     *
+     * @internal
+     *
 	 * @param string $sUniquenessRuleId
 	 *
-	 * @return string dict key : Class:$sClassName/UniquenessRule:$sUniquenessRuleId
-	 *          if none then will use Core:UniquenessDefaultError
-	 *         Dictionary keys can contain "$this" placeholders
+	 * @return string dict key : Class:$sClassName/UniquenessRule:$sUniquenessRuleId if none then will use Core:UniquenessDefaultError
+	 * Dictionary keys can contain "$this" placeholders
 	 *
 	 * @since 2.6 N°659 uniqueness constraint
 	 */
@@ -1551,6 +2045,9 @@ abstract class DBObject implements iDisplay
 	}
 
 	/**
+     *
+     * @internal
+     *
 	 * @param string $sUniquenessRuleId uniqueness rule ID
 	 * @param array $aUniquenessRuleProperties uniqueness rule properties
 	 *
@@ -1571,6 +2068,8 @@ abstract class DBObject implements iDisplay
 	}
 
 	/**
+     * @internal
+     *
 	 * @param string $sUniquenessRuleId uniqueness rule ID
 	 * @param array $aUniquenessRuleProperties uniqueness rule properties
 	 *
@@ -1613,13 +2112,18 @@ abstract class DBObject implements iDisplay
 	/**
 	 * Check integrity rules (before inserting or updating the object)
 	 *
-	 * Errors should be inserted in {@link $m_aCheckIssues} and {@link $m_aCheckWarnings} arrays
-	 *
+     * **This method is not meant to be called directly, use DBObject::CheckToWrite()!**
+	 * Errors should be inserted in $m_aCheckIssues and $m_aCheckWarnings arrays
+     *
+     * @overwritable-hook You can extend this method in order to provide your own logic.
+     * @see CheckToWrite()
+     * @see $m_aCheckIssues
+     * @see $m_aCheckWarnings
+     *
 	 * @throws \ArchivedObjectException
 	 * @throws \CoreException
 	 * @throws \OQLException
 	 *
-	 * @api
 	 */
 	public function DoCheckToWrite()
 	{
@@ -1674,18 +2178,23 @@ abstract class DBObject implements iDisplay
 	}
 
 	/**
+     *
+     * @api
+     * @api-advanced
+     *
 	 * @return array containing :
-	 * <ul>
-	 * <li>{@link $m_bCheckStatus}
-	 * <li>{@link $m_aCheckIssues}
-	 * <li>{@link $m_bSecurityIssue}
-	 * </ul>
+	 *   * $m_bCheckStatus
+	 *   * $m_aCheckIssues
+	 *   * $m_bSecurityIssue
 	 *
+     * @see $m_bCheckStatus
+     * @see $m_aCheckIssues
+     * @see $m_bSecurityIssue
+     *
 	 * @throws \ArchivedObjectException
 	 * @throws \CoreException
 	 * @throws \OQLException
 	 *
-	 * @internal do not overwrite ! Use {@link DoCheckToWrite} instead
 	 */
 	final public function CheckToWrite()
 	{
@@ -1712,13 +2221,13 @@ abstract class DBObject implements iDisplay
 		return array($this->m_bCheckStatus, $this->m_aCheckIssues, $this->m_bSecurityIssue);
 	}
 
-	// check if it is allowed to delete the existing object from the database
-	// a displayable error is returned
 	/**
-	 * check if it is allowed to delete the existing object from the database
+	 * Check if it is allowed to delete the existing object from the database
 	 *
-	 * a displayable error is added in {@link $m_aDeleteIssues}
+	 * an array of displayable error is added in {@link $m_aDeleteIssues}
 	 *
+     * @internal 
+     *
 	 * @param \DeletionPlan $oDeletionPlan
 	 *
 	 * @throws \CoreException
@@ -1774,18 +2283,29 @@ abstract class DBObject implements iDisplay
 		}
 	}
 
-	/**
-	 * @param \DeletionPlan $oDeletionPlan
-	 *
-	 * @return bool
-	 */
+    /**
+     * @internal
+     *
+     * @param \DeletionPlan $oDeletionPlan
+     *
+     * @return bool
+     * @throws CoreException
+     */
 	public function CheckToDelete(&$oDeletionPlan)
   	{
 		$this->MakeDeletionPlan($oDeletionPlan);
 		$oDeletionPlan->ComputeResults();
 		return (!$oDeletionPlan->FoundStopper());
-	} 
+	}
 
+    /**
+     * @internal
+     *
+     * @param array $aProposal
+     *
+     * @return array
+     * @throws Exception
+     */
 	protected function ListChangedValues(array $aProposal)
 	{
 		$aDelta = array();
@@ -1842,12 +2362,15 @@ abstract class DBObject implements iDisplay
 		return $aDelta;
 	}
 
-	/**
-	 * List the attributes that have been changed
-	 *
-	 * @return array attname => currentvalue
-	 * @internal
-	 */
+    /**
+     * List the attributes that have been changed since the object has been loaded from the DB
+     *
+     * @api
+     * @api-advanced
+     *
+     * @return array attname => currentvalue
+     * @throws Exception
+     */
 	public function ListChanges()
 	{
 		if ($this->m_bIsInDB)
@@ -1860,7 +2383,14 @@ abstract class DBObject implements iDisplay
 		}
 	}
 
-	// Tells whether or not an object was modified since last read (ie: does it differ from the DB ?)
+    /**
+     * Whether or not an object was modified since last read from the DB
+     * (ie: does it differ from the DB ?)
+     * 
+     * @api
+     *
+     * @return bool
+     */
 	public function IsModified()
 	{
 		$aChanges = $this->ListChanges();
@@ -1868,7 +2398,9 @@ abstract class DBObject implements iDisplay
 	}
 
 	/**
-	 * @param \DBObject $oSibling
+     * Whether or not $oSibling is equal to the current DBObject
+     * 
+	 * @param DBObject $oSibling
 	 *
 	 * @return bool
 	 */
@@ -1909,8 +2441,8 @@ abstract class DBObject implements iDisplay
 
 	/**
 	 * Used only by insert, Meant to be overloaded
-	 *
-	 * @api
+     * 
+     * @overwritable-hook You can extend this method in order to provide your own logic.
 	 */
 	protected function OnObjectKeyReady()
     {
@@ -1919,8 +2451,9 @@ abstract class DBObject implements iDisplay
 	/**
 	 * used both by insert/update
 	 *
+     * @internal
+     *
 	 * @throws \CoreException
-	 * @internal
 	 */
 	private function DBWriteLinks()
 	{
@@ -1939,8 +2472,9 @@ abstract class DBObject implements iDisplay
 	/**
 	 * Used both by insert/update
 	 *
+     * @internal
+     *
 	 * @throws \CoreException
-	 * @internal
 	 */
 	private function WriteExternalAttributes()
 	{
@@ -1955,15 +2489,26 @@ abstract class DBObject implements iDisplay
 		}
 	}
 
-	// Note: this is experimental - it was designed to speed up the setup of iTop
-	// Known limitations:
-	//   - does not work with multi-table classes (issue with the unique id to maintain in several tables)
-	//   - the id of the object is not updated
+
+    /**
+     * Note: this is experimental - it was designed to speed up the setup of iTop
+     * Known limitations:
+     * - does not work with multi-table classes (issue with the unique id to maintain in several tables)
+     * - the id of the object is not updated
+     *
+     * @internal
+     * @experimental
+     */
 	static public final function BulkInsertStart()
 	{
 		self::$m_bBulkInsert = true;
-	} 
+	}
 
+    /**
+     *
+     * @internal
+     * @experimental
+     */
 	static public final function BulkInsertFlush()
 	{
 		if (!self::$m_bBulkInsert) return;
@@ -1986,13 +2531,14 @@ abstract class DBObject implements iDisplay
 
 	/**
 	 * Persists new object in the DB
+     *
+     * @internal
 	 *
-	 * @param $sTableClass
+	 * @param string $sTableClass
 	 *
 	 * @return bool|int false if nothing to persist (no change), new key value otherwise
 	 * @throws \CoreException
 	 * @throws \MySQLException
-	 * @internal
 	 */
 	private function DBInsertSingleTable($sTableClass)
 	{
@@ -2077,6 +2623,8 @@ abstract class DBObject implements iDisplay
 
 	/**
 	 * Persists object to new records in the DB
+     *
+     * @internal
 	 *
 	 * @return int key of the newly created object
 	 * @throws \ArchivedObjectException
@@ -2087,7 +2635,6 @@ abstract class DBObject implements iDisplay
 	 * @throws \MySQLException
 	 * @throws \OQLException
 	 *
-	 * @internal
 	 */
 	public function DBInsertNoReload()
 	{
@@ -2204,6 +2751,16 @@ abstract class DBObject implements iDisplay
 		return $this->m_iKey;
 	}
 
+    /**
+     * @internal
+     *
+     * @param array $aAuthorizedExtKeys
+     * @param array $aStatements
+     * @param string $sTableClass
+     *
+     * @throws CoreException
+     * @throws MySQLException
+     */
 	protected function MakeInsertStatementSingleTable($aAuthorizedExtKeys, &$aStatements, $sTableClass)
 	{
 		$sTable = MetaModel::DBGetTable($sTableClass);
@@ -2270,6 +2827,15 @@ abstract class DBObject implements iDisplay
 		$aStatements[] = "INSERT INTO `$sTable` (".join(",", $aFieldsToWrite).") VALUES (".join(", ", $aValuesToWrite).");";
 	}
 
+    /**
+     * @internal
+     *
+     * @param array $aAuthorizedExtKeys
+     * @param array $aStatements
+     *
+     * @throws CoreException
+     * @throws MySQLException
+     */
 	public function MakeInsertStatements($aAuthorizedExtKeys, &$aStatements)
 	{
 		$sClass = get_class($this);
@@ -2292,8 +2858,14 @@ abstract class DBObject implements iDisplay
 		}
 	}
 
-	/**
+	/*
+	* Persist an object to the DB, for the first time
+	*
+     * @api
+     * @see DBWrite
+     *
 	 * @return int|null inserted object key
+     *
 	 * @throws \ArchivedObjectException
 	 * @throws \CoreCannotSaveObjectException
 	 * @throws \CoreException
@@ -2301,7 +2873,6 @@ abstract class DBObject implements iDisplay
 	 * @throws \CoreWarning
 	 * @throws \MySQLException
 	 * @throws \OQLException
-	 * @internal
 	 */
 	public function DBInsert()
 	{
@@ -2309,21 +2880,64 @@ abstract class DBObject implements iDisplay
 		$this->Reload();
 		return $this->m_iKey;
 	}
-	
+
+    /**
+     * @internal
+     *
+     * @param CMDBChange $oChange
+     *
+     * @return int|null
+     * @throws ArchivedObjectException
+     * @throws CoreCannotSaveObjectException
+     * @throws CoreException
+     * @throws CoreUnexpectedValue
+     * @throws CoreWarning
+     * @throws MySQLException
+     * @throws OQLException
+     */
 	public function DBInsertTracked(CMDBChange $oChange)
 	{
 		CMDBObject::SetCurrentChange($oChange);
 		return $this->DBInsert();
 	}
 
+    /**
+     * @internal
+     *
+     * @param CMDBChange $oChange
+     *
+     * @return int
+     * @throws ArchivedObjectException
+     * @throws CoreCannotSaveObjectException
+     * @throws CoreException
+     * @throws CoreUnexpectedValue
+     * @throws CoreWarning
+     * @throws MySQLException
+     * @throws OQLException
+     */
 	public function DBInsertTrackedNoReload(CMDBChange $oChange)
 	{
 		CMDBObject::SetCurrentChange($oChange);
 		return $this->DBInsertNoReload();
 	}
 
-	// Creates a copy of the current object into the database
-	// Returns the id of the newly created object
+    /**
+     * Creates a copy of the current object into the database
+     *
+     * @internal
+     *
+     * @param null $iNewKey
+     *
+     * @return int|null the id of the newly created object
+     *
+     * @throws ArchivedObjectException
+     * @throws CoreCannotSaveObjectException
+     * @throws CoreException
+     * @throws CoreUnexpectedValue
+     * @throws CoreWarning
+     * @throws MySQLException
+     * @throws OQLException
+     */
 	public function DBClone($iNewKey = null)
 	{
 		$this->m_bIsInDB = false;
@@ -2337,6 +2951,8 @@ abstract class DBObject implements iDisplay
 	 * This function is automatically called after cloning an object with the "clone" PHP language construct
 	 * The purpose of this method is to reset the appropriate attributes of the object in
 	 * order to make sure that the newly cloned object is really distinct from its clone
+     *
+     * @internal
 	 */
 	public function __clone()
 	{
@@ -2348,9 +2964,13 @@ abstract class DBObject implements iDisplay
 	/**
 	 * Update an object in DB
 	 *
+     * @api
+     * @see DBWrite
+     * 
 	 * @return int object key
+     *
 	 * @throws \CoreException
-	 * @throws \CoreCannotSaveObjectException if {@link CheckToWrite()} returns issues
+	 * @throws \CoreCannotSaveObjectException if CheckToWrite() returns issues
 	 */
 	public function DBUpdate()
 	{
@@ -2539,7 +3159,17 @@ abstract class DBObject implements iDisplay
 
 		return $this->m_iKey;
 	}
-	
+
+    /**
+     *
+     * @internal
+     *
+     * @param CMDBChange $oChange
+     *
+     * @return int
+     * @throws CoreCannotSaveObjectException
+     * @throws CoreException
+     */
 	public function DBUpdateTracked(CMDBChange $oChange)
 	{
 		CMDBObject::SetCurrentChange($oChange);
@@ -2548,8 +3178,11 @@ abstract class DBObject implements iDisplay
 
 	/**
 	 * Make the current changes persistent - clever wrapper for Insert or Update
+     *
+     * @api
 	 *
 	 * @return int
+     *
 	 * @throws \CoreCannotSaveObjectException
 	 * @throws \CoreException
 	 */
@@ -2565,6 +3198,13 @@ abstract class DBObject implements iDisplay
 		}
 	}
 
+    /**
+     * @internal
+     *
+     * @param string $sTableClass
+     *
+     * @throws CoreException
+     */
 	private function DBDeleteSingleTable($sTableClass)
 	{
 		$sTable = MetaModel::DBGetTable($sTableClass);
@@ -2578,6 +3218,16 @@ abstract class DBObject implements iDisplay
 		CMDBSource::DeleteFrom($sDeleteSQL);
 	}
 
+    /**
+     * @internal
+     *
+     * @throws ArchivedObjectException
+     * @throws CoreException
+     * @throws CoreUnexpectedValue
+     * @throws MySQLException
+     * @throws MySQLHasGoneAwayException
+     * @throws OQLException
+     */
 	protected function DBDeleteSingleObject()
 	{
 		if (!MetaModel::DBIsReadOnly())
@@ -2644,8 +3294,27 @@ abstract class DBObject implements iDisplay
 		}
 	}
 
-	// Delete an object... and guarantee data integrity
-	//
+    /**
+     * Delete an object
+     *
+     * Pior to the delete the object, it checks if this is feasible to guarantee the DB integrity.
+     * If so, it performs any required cleanup (delete other objects or reset external keys) in addition to the object deletion.
+     * 
+     * @api
+     * 
+     * @param null $oDeletionPlan Do not use: aims at dealing with recursion
+     *
+     * @return DeletionPlan The detailed description of cleanup operation that have been performed
+     *
+     * @throws ArchivedObjectException
+     * @throws CoreCannotSaveObjectException
+     * @throws CoreException
+     * @throws CoreUnexpectedValue
+     * @throws DeleteException
+     * @throws MySQLException
+     * @throws MySQLHasGoneAwayException
+     * @throws OQLException
+     */
 	public function DBDelete(&$oDeletionPlan = null)
 	{
 		static $iLoopTimeLimit = null;
@@ -2710,12 +3379,36 @@ abstract class DBObject implements iDisplay
 		return $oDeletionPlan;
 	}
 
+    /**
+     * @internal
+     *
+     * @param CMDBChange $oChange
+     * @param null       $bSkipStrongSecurity
+     * @param null       $oDeletionPlan
+     *
+     * @throws ArchivedObjectException
+     * @throws CoreCannotSaveObjectException
+     * @throws CoreException
+     * @throws CoreUnexpectedValue
+     * @throws DeleteException
+     * @throws MySQLException
+     * @throws MySQLHasGoneAwayException
+     * @throws OQLException
+     */
 	public function DBDeleteTracked(CMDBChange $oChange, $bSkipStrongSecurity = null, &$oDeletionPlan = null)
 	{
 		CMDBObject::SetCurrentChange($oChange);
 		$this->DBDelete($oDeletionPlan);
 	}
 
+    /**
+     * @internal
+     *
+     * @return array
+     *
+     * @throws ArchivedObjectException
+     * @throws CoreException
+     */
 	public function EnumTransitions()
 	{
 		$sStateAttCode = MetaModel::GetStateAttributeCode(get_class($this));
@@ -2725,9 +3418,20 @@ abstract class DBObject implements iDisplay
 		return MetaModel::EnumTransitions(get_class($this), $sState);
 	}
 
-	/**
-	* Designed as an action to be called when a stop watch threshold times out
-	*/
+    /**
+     * Helper to reset a stop-watch
+     * Suitable for use as a lifecycle action
+     *
+     * @api
+     *
+     * @param string $sAttCode
+     *
+     * @return bool
+     *
+     * @throws ArchivedObjectException
+     * @throws CoreException
+     * @throws CoreUnexpectedValue
+     */
 	public function ResetStopWatch($sAttCode)
 	{
 		$oAttDef = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
@@ -2742,11 +3446,15 @@ abstract class DBObject implements iDisplay
 	}
 
 	/**
-	 * Designed as an action to be called when a stop watch threshold times out
-	 * or from within the framework
-	 * @param $sStimulusCode
-	 * @param bool|false $bDoNotWrite
+	 * Apply a stimulus (workflow)
+     *
+     * @api
+     *
+	 * @param string  $sStimulusCode
+	 * @param bool $bDoNotWrite
+     *
 	 * @return bool
+     *
 	 * @throws CoreException
 	 * @throws CoreUnexpectedValue
 	 */
@@ -2884,7 +3592,11 @@ abstract class DBObject implements iDisplay
 	}
 
 	/**
-	 * Lifecycle action: Recover the default value (aka when an object is being created)
+	 * Helper to recover the default value (aka when an object is being created)
+     * Suitable for use as a lifecycle action
+     *
+     * @api
+     *
 	 */	 	
 	public function Reset($sAttCode)
 	{
@@ -2893,7 +3605,10 @@ abstract class DBObject implements iDisplay
 	}
 
 	/**
-	 * Lifecycle action: Copy an attribute to another
+     * Helper to copy the value of an attribute to another one
+     * Suitable for use as a lifecycle action
+     *
+     * @api
 	 */	 	
 	public function Copy($sDestAttCode, $sSourceAttCode)
 	{
@@ -2901,18 +3616,38 @@ abstract class DBObject implements iDisplay
 		return true;
 	}
 
-	/**
-	 * Lifecycle action: Set the current date/time for the given attribute
-	 */	 	
+    /**
+     * Helper to set the current date/time for the given attribute
+     * Suitable for use as a lifecycle action
+     *
+     * @api
+     *
+     * @param string $sAttCode
+     *
+     * @return bool
+     *
+     * @throws CoreException
+     * @throws CoreUnexpectedValue
+     */
 	public function SetCurrentDate($sAttCode)
 	{
 		$this->Set($sAttCode, time());
 		return true;
 	}
 
-	/**
-	 * Lifecycle action: Set the current logged in user for the given attribute
-	 */	 	
+    /**
+     * Helper to set the current logged in user for the given attribute
+     * Suitable for use as a lifecycle action
+     *
+     * @api
+     *
+     * @param string $sAttCode
+     *
+     * @return bool
+     *
+     * @throws CoreException
+     * @throws CoreUnexpectedValue
+     */
 	public function SetCurrentUser($sAttCode)
 	{
 		$oAttDef = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
@@ -2936,9 +3671,19 @@ abstract class DBObject implements iDisplay
 		return true;
 	}
 
-	/**
-	 * Lifecycle action: Set the current logged in CONTACT for the given attribute
-	 */	 	
+    /**
+     * Helper to set the current logged in CONTACT for the given attribute
+     * Suitable for use as a lifecycle action
+     *
+     * @api
+     *
+     * @param string $sAttCode
+     *
+     * @return bool
+     * @throws ArchivedObjectException
+     * @throws CoreException
+     * @throws CoreUnexpectedValue
+     */
 	public function SetCurrentPerson($sAttCode)
 	{
 		$oAttDef = MetaModel::GetAttributeDef(get_class($this), $sAttCode);
@@ -2970,9 +3715,21 @@ abstract class DBObject implements iDisplay
 		return true;
 	}
 
-	/**
-	 * Lifecycle action: Set the time elapsed since a reference point
-	 */	 	
+    /**
+     * Helper to set the time elapsed since a reference point
+     * Suitable for use as a lifecycle action
+     *
+     * @api
+     *
+     * @param string      $sAttCode
+     * @param string      $sRefAttCode
+     * @param string|null $sWorkingTimeComputer
+     *
+     * @return bool
+     * @throws ArchivedObjectException
+     * @throws CoreException
+     * @throws CoreUnexpectedValue
+     */
 	public function SetElapsedTime($sAttCode, $sRefAttCode, $sWorkingTimeComputer = null)
 	{
 		if (is_null($sWorkingTimeComputer))
@@ -3006,28 +3763,51 @@ abstract class DBObject implements iDisplay
 	}
 
 
-
-   	/**
-	 * Create query parameters (SELECT ... WHERE service = :this->service_id)
-	 * to be used with the APIs DBObjectSearch/DBObjectSet
-	 * 		
-	 * Starting 2.0.2 the parameters are computed on demand, at the lowest level,
-	 * in VariableExpression::Render()		
-	 */	
+    /**
+     * Create query parameters (SELECT ... WHERE service = :this->service_id)
+     * to be used with the APIs DBObjectSearch/DBObjectSet
+     *
+     * Starting 2.0.2 the parameters are computed on demand, at the lowest level,
+     * in VariableExpression::Render()
+     *
+     * @internal
+     *
+     * @param string $sArgName
+     *
+     * @return array
+     */
 	public function ToArgsForQuery($sArgName = 'this')
 	{
 		return array($sArgName.'->object()' => $this);
 	}
 
-	/**
- 	 * Create template placeholders: now equivalent to ToArgsForQuery since the actual
-	 * template placeholders are computed on demand.	
-	 */
+    /**
+     * Create template placeholders: now equivalent to ToArgsForQuery since the actual
+     * template placeholders are computed on demand.
+     *
+     * @internal
+     *
+     * @param string $sArgName
+     *
+     * @return array
+     */
 	public function ToArgs($sArgName = 'this')
 	{
 		return $this->ToArgsForQuery($sArgName);
 	}
 
+    /**
+     * Get various representations of the value, for insertion into a template (e.g. in Notifications)
+     *
+     * @internal
+     *
+     * @param string $sPlaceholderAttCode
+     *
+     * @return int|mixed|string|null
+     * @throws ArchivedObjectException
+     * @throws CoreException
+     * @throws DictExceptionMissingString
+     */
 	public function GetForTemplate($sPlaceholderAttCode)
 	{
 		$ret = null;
@@ -3110,6 +3890,8 @@ abstract class DBObject implements iDisplay
 	 * Associate a portal to a class that implements iDBObjectURLMaker,
 	 * and which will be invoked with placeholders like $this->org_id->hyperlink(portal)$
 	 *
+     * @internal
+     *
 	 * @param string $sPortalId Identifies the portal. Conventions: the main portal is 'console', The user requests portal is 'portal'.
 	 * @param string $sUrlMakerClass
 	 */
@@ -3119,55 +3901,56 @@ abstract class DBObject implements iDisplay
 	}
 
 	/**
-	 * Can be overloaded
-	 *
-	 * @api
+	 * this method is called before the object is inserted into DB.
+     *
+     *
+	 * @overwritable-hook You can extend this method in order to provide your own logic.
 	 */
 	protected function OnInsert()
 	{
 	}
 
-	/**
-	 * Can be overloaded
-	 *
-	 * @api
-	 */
+    /**
+     * this method is called after the object is inserted into DB.
+     *
+     * @overwritable-hook You can extend this method in order to provide your own logic.
+     */
 	protected function AfterInsert()
 	{
 	}
 
-	/**
-	 * Can be overloaded
-	 *
-	 * @api
-	 */
+    /**
+     * this method is called before the object is updated into DB.
+     *
+     * @overwritable-hook You can extend this method in order to provide your own logic.
+     */
 	protected function OnUpdate()
 	{
 	}
 
-	/**
-	 * Can be overloaded
-	 *
-	 * @api
-	 */
+    /**
+     * this method is called after the object is updated into DB.
+     *
+     * @overwritable-hook You can extend this method in order to provide your own logic.
+     */
 	protected function AfterUpdate()
 	{
 	}
 
-	/**
-	 * Can be overloaded
-	 *
-	 * @api
-	 */
+    /**
+     * this method is called before the object is deleted into DB.
+     *
+     * @overwritable-hook You can extend this method in order to provide your own logic.
+     */
 	protected function OnDelete()
 	{
 	}
 
-	/**
-	 * Can be overloaded
-	 *
-	 * @api
-	 */
+    /**
+     * this method is called after the object is deleted into DB.
+     *
+     * @overwritable-hook You can extend this method in order to provide your own logic.
+     */
 	protected function AfterDelete()
 	{
 	}
@@ -3176,6 +3959,8 @@ abstract class DBObject implements iDisplay
 	/**
 	 * Common to the recording of link set changes (add/remove/modify)
 	 *
+     * @internal
+     *
 	 * @param $iLinkSetOwnerId
 	 * @param \AttributeLinkedSet $oLinkSet
 	 * @param $sChangeOpClass
@@ -3285,11 +4070,17 @@ abstract class DBObject implements iDisplay
 		$this->RecordLinkSetListChange(true);
 	}
 
+    /**
+     * @internal
+     */
 	protected function RecordObjDeletion($objkey)
 	{
 		$this->RecordLinkSetListChange(false);
 	}
 
+    /**
+     * @internal
+     */
 	protected function RecordAttChanges(array $aValues, array $aOrigValues)
 	{
 		foreach(MetaModel::GetTrackForwardExternalKeys(get_class($this)) as $sExtKeyAttCode => $oLinkSet)
@@ -3335,23 +4126,38 @@ abstract class DBObject implements iDisplay
 		}
 	}
 
-	// Return an empty set for the parent of all
-	// May be overloaded.
-	// Anyhow, this way of implementing the relations suffers limitations (not handling the redundancy)
-	// and you should consider defining those things in XML.
+
+    /**
+     * implement relations
+     *
+     * Return an empty set for the parent of all
+     *
+     * this way of implementing the relations suffers limitations (not handling the redundancy)
+     * and you should consider defining those things in XML
+     *
+     * @internal
+     * @deprecated
+     */
 	public static function GetRelationQueries($sRelCode)
 	{
 		return array();
 	}
 	
-	// Reserved: do not overload
+    /**
+     * Reserved: do not overload
+     *
+     * @internal
+     */
 	public static function GetRelationQueriesEx($sRelCode)
 	{
 		return array();
 	}
 
 	/**
-	 * Will be deprecated soon - use GetRelatedObjectsDown/Up instead to take redundancy into account
+	 * Use GetRelatedObjectsDown/Up instead to take redundancy into account
+     *
+     * @internal
+     * @deprecated
 	 */
 	public function GetRelatedObjects($sRelCode, $iMaxDepth = 99, &$aResults = array())
 	{
@@ -3412,17 +4218,20 @@ abstract class DBObject implements iDisplay
 		}
 		return $aResults;
 	}
-	
-	/**
-	 * Compute the "RelatedObjects" (forward or "down" direction) for the object
-	 * for the specified relation
-	 *
-	 * @param string $sRelCode The code of the relation to use for the computation
-	 * @param int $iMaxDepth Maximum recursion depth
-	 * @param boolean $bEnableReduncancy Whether or not to take into account the redundancy
-	 *
-	 * @return RelationGraph The graph of all the related objects
-	 */
+
+    /**
+     * Compute the "RelatedObjects" (forward or "down" direction) for the object
+     * for the specified relation
+     *
+     * @internal
+     *
+     * @param string $sRelCode  The code of the relation to use for the computation
+     * @param int    $iMaxDepth Maximum recursion depth
+     * @param bool   $bEnableRedundancy
+     *
+     * @return RelationGraph The graph of all the related objects
+     * @throws CoreException
+     */
 	public function GetRelatedObjectsDown($sRelCode, $iMaxDepth = 99, $bEnableRedundancy = true)
 	{
 		$oGraph = new RelationGraph();
@@ -3430,17 +4239,20 @@ abstract class DBObject implements iDisplay
 		$oGraph->ComputeRelatedObjectsDown($sRelCode, $iMaxDepth, $bEnableRedundancy);
 		return $oGraph;
 	}
-	
-	/**
-	 * Compute the "RelatedObjects" (reverse or "up" direction) for the object
-	 * for the specified relation
-	 *
-	 * @param string $sRelCode The code of the relation to use for the computation
-	 * @param int $iMaxDepth Maximum recursion depth
-	 * @param boolean $bEnableReduncancy Whether or not to take into account the redundancy
-	 *
-	 * @return RelationGraph The graph of all the related objects
-	 */
+
+    /**
+     * Compute the "RelatedObjects" (reverse or "up" direction) for the object
+     * for the specified relation
+     *
+     * @internal
+     *
+     * @param string $sRelCode  The code of the relation to use for the computation
+     * @param int    $iMaxDepth Maximum recursion depth
+     * @param bool   $bEnableRedundancy
+     *
+     * @return RelationGraph The graph of all the related objects
+     * @throws CoreException
+     */
 	public function GetRelatedObjectsUp($sRelCode, $iMaxDepth = 99, $bEnableRedundancy = true)
 	{
 		$oGraph = new RelationGraph();
@@ -3481,6 +4293,8 @@ abstract class DBObject implements iDisplay
 	}
 
 	/**
+     * @internal
+     *
 	 * @param \DeletionPlan $oDeletionPlan
 	 * @param array $aVisited
 	 * @param int $iDeleteOption
@@ -3563,11 +4377,13 @@ abstract class DBObject implements iDisplay
 	}
 
 	/**
-	 * WILL DEPRECATED SOON
 	 * Caching relying on an object set is not efficient since 2.0.3
 	 * Use GetSynchroData instead
 	 *
 	 * Get all the synchro replica related to this object
+     *
+     * @internal
+     * @deprecated
 	 *
 	 * @return DBObjectSet Set with two columns: R=SynchroReplica S=SynchroDataSource
 	 * @throws \OQLException
@@ -3581,11 +4397,13 @@ abstract class DBObject implements iDisplay
 
 	/**
 	 * Get all the synchro data related to this object
+     *
+     * @internal
 	 *
 	 * @return array of data_source_id => array
-	 *    'source' => $oSource,
-	 *    'attributes' => array of $oSynchroAttribute
-	 *    'replica' => array of $oReplica (though only one should exist, misuse of the data sync can have this consequence)
+	 *   * 'source' => $oSource,
+	 *   * 'attributes' => array of $oSynchroAttribute
+	 *   * 'replica' => array of $oReplica (though only one should exist, misuse of the data sync can have this consequence)
 	 * @throws \CoreException
 	 * @throws \CoreUnexpectedValue
 	 * @throws \MySQLException
@@ -3624,6 +4442,20 @@ abstract class DBObject implements iDisplay
 		return $this->m_aSynchroData;
 	}
 
+    /**
+     *
+     * @internal
+     *
+     * @param string $sAttCode
+     * @param array $aReason
+     *
+     * @return int
+     * @throws ArchivedObjectException
+     * @throws CoreException
+     * @throws CoreUnexpectedValue
+     * @throws MySQLException
+     * @throws OQLException
+     */
 	public function GetSynchroReplicaFlags($sAttCode, &$aReason)
 	{
 		$iFlags = OPT_ATT_NORMAL;
@@ -3654,6 +4486,9 @@ abstract class DBObject implements iDisplay
 	}
 
 	/**
+     *
+     * @internal
+     *
 	 * @return bool true if this object is used in a data synchro
 	 * @throws \CoreException
 	 * @throws \CoreUnexpectedValue
@@ -3694,12 +4529,26 @@ abstract class DBObject implements iDisplay
 	// Experimental iDisplay implementation
 	//
 	/////////////////////////////////////////////////////////////////////////
-	
+
+    /**
+     * @internal
+     *
+     * @param string $sContextParam
+     *
+     * @return string|null
+     */
 	public static function MapContextParam($sContextParam)
 	{
 		return null;
 	}
-	
+
+    /**
+     * @internal
+     *
+     * @return String
+     * @throws ArchivedObjectException
+     * @throws CoreException
+     */
 	public function GetHilightClass()
 	{
 		$sCode = $this->ComputeHighlightCode();
@@ -3714,6 +4563,16 @@ abstract class DBObject implements iDisplay
 		return HILIGHT_CLASS_NONE;
 	}
 
+    /**
+     * @internal
+     *
+     * @param WebPage $oPage
+     * @param bool    $bEditMode
+     *
+     * @throws ArchivedObjectException
+     * @throws CoreException
+     * @throws DictExceptionMissingString
+     */
 	public function DisplayDetails(WebPage $oPage, $bEditMode = false)
 	{
 		$oPage->add('<h1>'.MetaModel::GetName(get_class($this)).': '.$this->GetName().'</h1>');
@@ -3730,11 +4589,13 @@ abstract class DBObject implements iDisplay
 		$oPage->details($aValues);
 	}
 
-
+    /** @internal */
 	const CALLBACK_AFTERINSERT = 0;
 
 	/**
 	 * Register a call back that will be called when some internal event happens
+     *
+     * @internal
 	 *
 	 * @param $iType string Any of the CALLBACK_x constants
 	 * @param $callback callable Call specification like a function name, or array('<class>', '<method>') or array($object, '<method>')
@@ -3755,12 +4616,18 @@ abstract class DBObject implements iDisplay
 		);
 	}
 
-	/**
-	 * Computes a text-like fingerprint identifying the content of the object
-	 * but excluding the specified columns
-	 * @param $aExcludedColumns array The list of columns to exclude
-	 * @return string
-	 */
+    /**
+     * Computes a text-like fingerprint identifying the content of the object
+     * but excluding the specified columns
+     *
+     * @internal
+     *
+     * @param $aExcludedColumns array The list of columns to exclude
+     *
+     * @return string
+     * @throws ArchivedObjectException
+     * @throws CoreException
+     */
 	public function Fingerprint($aExcludedColumns = array())
 	{
 		$sFingerprint = '';
@@ -3780,6 +4647,8 @@ abstract class DBObject implements iDisplay
 	/**
 	 * Execute a set of scripted actions onto the current object
 	 * See ExecAction for the syntax and features of the scripted actions
+     *
+     * @internal
 	 *
 	 * @param $aActions array of statements (e.g. "set(name, Made after $source->name$)")
 	 * @param $aSourceObjects array of Alias => Context objects (Convention: some statements require the 'source' element
@@ -3831,6 +4700,8 @@ abstract class DBObject implements iDisplay
 	/**
 	 * Helper to copy an attribute between two objects (in memory)
 	 * Originally designed for ExecAction()
+     *
+     * @internal
 	 *
 	 * @param \DBObject $oSourceObject
 	 * @param $sSourceAttCode
@@ -3906,6 +4777,9 @@ abstract class DBObject implements iDisplay
 	 *    - add_to_list (source_key_att, dest_att, lnk_att, lnk_att_value)
 	 *    - apply_stimulus (stimulus)
 	 *    - call_method (method_name)
+     *
+     *
+     * @internal
 	 *
 	 * @param $sVerb string Any of the verb listed above (e.g. "set")
 	 * @param $aParams array of strings (e.g. array('name', 'copied from $source->name$')
@@ -4138,6 +5012,17 @@ abstract class DBObject implements iDisplay
 		}
 	}
 
+    /**
+     * Is the object archived
+     *
+     * @api
+     *
+     * @param string|null $sKeyAttCode
+     *
+     * @return bool
+     * @throws ArchivedObjectException
+     * @throws CoreException
+     */
 	public function IsArchived($sKeyAttCode = null)
 	{
 		$bRet = false;
@@ -4149,6 +5034,15 @@ abstract class DBObject implements iDisplay
 		return $bRet;
 	}
 
+    /**
+     * Is the object obsolete
+     *
+     * @param string|null $sKeyAttCode
+     *
+     * @return bool
+     * @throws ArchivedObjectException
+     * @throws CoreException
+     */
 	public function IsObsolete($sKeyAttCode = null)
 	{
 		$bRet = false;
@@ -4161,7 +5055,10 @@ abstract class DBObject implements iDisplay
 	}
 
 	/**
-	 * @param $bArchive
+     *
+     * @internal
+     *
+	 * @param boolean $bArchive
 	 * @throws Exception
 	 */
 	protected function DBWriteArchiveFlag($bArchive)
@@ -4207,6 +5104,9 @@ abstract class DBObject implements iDisplay
 	}
 
 	/**
+     *
+     * @internal
+     *
 	 * Can be called to repair the database (tables consistency)
 	 * The archive_date will be preserved
 	 * @throws Exception
@@ -4218,6 +5118,11 @@ abstract class DBObject implements iDisplay
 		$this->m_aOrigValues['archive_flag'] = true;
 	}
 
+    /**
+     * @internal
+     *
+     * @throws Exception
+     */
 	public function DBUnarchive()
 	{
 		$this->DBWriteArchiveFlag(false);
@@ -4228,11 +5133,15 @@ abstract class DBObject implements iDisplay
 	}
 
 
-
-	/**
-	 * @param string $sClass Needs to be an instanciable class
-	 * @returns $oObj
-	 **/
+    /**
+     * @internal
+     *
+     * @param string $sClass Needs to be an instanciable class
+     *
+     * @return DBObject
+     * @throws CoreException
+     * @throws CoreUnexpectedValue
+     */
 	public static function MakeDefaultInstance($sClass)
 	{
 		$sStateAttCode = MetaModel::GetStateAttributeCode($sClass);
@@ -4247,6 +5156,9 @@ abstract class DBObject implements iDisplay
 
 	/**
 	 * Complete a new object with data from context
+     *
+     * @internal
+     *
 	 * @param array $aContextParam Context used for creation form prefilling
 	 *
 	 */
@@ -4256,6 +5168,9 @@ abstract class DBObject implements iDisplay
 
 	/**
 	 * Complete an object after a state transition with data from context
+     *
+     * @internal
+     *
 	 * @param array $aContextParam Context used for creation form prefilling
 	 *
 	 */
@@ -4266,6 +5181,9 @@ abstract class DBObject implements iDisplay
 	/**
 	 * Complete a filter ($aContextParam['filter']) data from context
 	 * (Called on source object)
+     *
+     * @internal
+     *
 	 * @param array $aContextParam Context used for creation form prefilling
 	 *
 	 */
@@ -4275,6 +5193,9 @@ abstract class DBObject implements iDisplay
 
 	/**
 	 * Prefill a creation / stimulus change / search form according to context, current state of an object, stimulus.. $sOperation
+     *
+     * @internal
+     *
 	 * @param string $sOperation Operation identifier
 	 * @param array $aContextParam Context used for creation form prefilling
 	 *
diff --git a/core/dbobjectsearch.class.php b/core/dbobjectsearch.class.php
index d6e650bdc..002c643d8 100644
--- a/core/dbobjectsearch.class.php
+++ b/core/dbobjectsearch.class.php
@@ -17,9 +17,22 @@
 //   along with iTop. If not, see <http://www.gnu.org/licenses/>
 //
 
-// Dev hack for disabling the some query build optimizations (Folding/Merging)
+/** @internal Dev hack for disabling some query build optimizations (Folding/Merging) */
 define('ENABLE_OPT', true);
 
+/**
+ * A search over a DBObject
+ *
+ * This is the most common search cases, the other class representing a search is DBUnionSearch.
+ * For clarity purpose, since only the constructor vary between DBObjectSearch and DBUnionSearch, all the API is documented on the common ancestor: DBSearch
+ * Please refer to DBSearch's documentation
+ *
+ * @package     iTopORM
+ * @phpdoc-tunning-exclude-inherited this tag prevent PHPdoc from displaying inherited methods. This is done in order to force the API doc. location into DBSearch only.
+ * @api
+ * @see DBSearch
+ * @see DBUnionSearch
+ */
 class DBObjectSearch extends DBSearch
 {
 	private $m_aClasses; // queried classes (alias => class name), the first item is the class corresponding to this filter (the rest is coming from subfilters)
@@ -29,11 +42,23 @@ class DBObjectSearch extends DBSearch
 	private $m_aPointingTo;
 	private $m_aReferencedBy;
 
-	// By default, some information may be hidden to the current user
-	// But it may happen that we need to disable that feature
+    /**
+     * @var bool whether or not some information should be hidden to the current user. Default to false == hide information.
+     * @see AllowAllData()
+     */
 	protected $m_bAllowAllData = false;
 	protected $m_bDataFiltered = false;
 
+    /**
+     * DBObjectSearch constructor.
+     *
+     * @api
+     *
+     * @param string      $sClass
+     * @param string|null $sClassAlias
+     *
+     * @throws Exception
+     */
 	public function __construct($sClass, $sClassAlias = null)
 	{
 		parent::__construct();
@@ -524,7 +549,7 @@ class DBObjectSearch extends DBSearch
 	/**
 	 * Specify a condition on external keys or link sets
 	 * @param string $sAttSpec Can be either an attribute code or extkey->[sAttSpec] or linkset->[sAttSpec] and so on, recursively
-	 *                 Example: infra_list->ci_id->location_id->country
+	 * Example: infra_list->ci_id->location_id->country
 	 * @param $value
 	 * @return void
 	 * @throws \CoreException
@@ -2344,8 +2369,8 @@ class DBObjectSearch extends DBSearch
 	}
 
 	/**
-	 *    Get the expression for the class and its subclasses (if finalclass = 'subclass' ...)
-	 *    Simplifies the final expression by grouping classes having the same expression
+	 * Get the expression for the class and its subclasses (if finalclass = 'subclass' ...)
+	 * Simplifies the final expression by grouping classes having the same expression
 	 * @param $sClass
 	 * @param $sAttCode
 	 * @return \FunctionExpression|mixed|null
diff --git a/core/dbobjectset.class.php b/core/dbobjectset.class.php
index 026789f57..564a93331 100644
--- a/core/dbobjectset.class.php
+++ b/core/dbobjectset.class.php
@@ -27,9 +27,13 @@ require_once('dbobjectiterator.php');
 
 
 /**
- * A set of persistent objects, could be heterogeneous as long as the objects in the set have a common ancestor class 
+ * A set of persistent objects
+ *
+ * Created against a DBObjectSearch with additional information not relevant for the  DBObjectSearch (ie: order, limit, ...)
+ * This set could be heterogeneous as long as the objects in the set have a common ancestor class.
  *
  * @package     iTopORM
+ * @api
  */
 class DBObjectSet implements iDBObjectSetIterator
 {
@@ -81,6 +85,8 @@ class DBObjectSet implements iDBObjectSetIterator
 
 	/**
 	 * Create a new set based on a Search definition.
+     *
+     * @api
 	 * 
 	 * @param DBSearch $oFilter The search filter defining the objects which are part of the set (multiple columns/objects per row are supported)
 	 * @param array $aOrderBy Array of '[<classalias>.]attcode' => bAscending
@@ -110,6 +116,9 @@ class DBObjectSet implements iDBObjectSetIterator
 		$this->m_oSQLResult = null;
 	}
 
+    /**
+     * @internal
+     */
 	public function __destruct()
 	{
 		if (is_object($this->m_oSQLResult))
@@ -119,6 +128,8 @@ class DBObjectSet implements iDBObjectSetIterator
 	}
 
     /**
+     * @internal
+     *
      * @return string
      *
      * @throws \Exception
@@ -145,6 +156,9 @@ class DBObjectSet implements iDBObjectSetIterator
 		return $sRet;
 	}
 
+    /**
+     * @internal
+     */
 	public function __clone()
 	{
 		$this->m_oFilter = $this->m_oFilter->DeepClone();
@@ -158,6 +172,7 @@ class DBObjectSet implements iDBObjectSetIterator
 
 	/**
 	 * Called when unserializing a DBObjectSet
+     * @internal
 	 */
 	public function __wakeup()
 	{
@@ -168,18 +183,30 @@ class DBObjectSet implements iDBObjectSetIterator
 		$this->m_oSQLResult = null;
 	}
 
+    /**
+     * @internal
+     * @param $bShow
+     */
 	public function SetShowObsoleteData($bShow)
 	{
 		$this->m_oFilter->SetShowObsoleteData($bShow);
 	}
 
+    /**
+     * @internal
+     * @return bool
+     */
 	public function GetShowObsoleteData()
 	{
 		return $this->m_oFilter->GetShowObsoleteData();
 	}
 
     /**
-     * Specify the subset of attributes to load (for each class of objects) before performing the SQL query for retrieving the rows from the DB
+     * Specify the subset of attributes to load
+     * this subset is specified for each class of objects,
+     * this has to be done before the actual fetch.
+     *
+     * @api
      *
      * @param array $aAttToLoad Format: alias => array of attribute_codes
      *
@@ -262,6 +289,8 @@ class DBObjectSet implements iDBObjectSetIterator
     /**
      * Create a set (in-memory) containing just the given object
      *
+     * @internal
+     *
      * @param \DBobject $oObject
      *
      * @return \DBObjectSet The singleton set
@@ -278,6 +307,8 @@ class DBObjectSet implements iDBObjectSetIterator
     /**
      * Create an empty set (in-memory), for the given class (and its subclasses) of objects
      *
+     * @internal
+     *
      * @param string $sClass The class (or an ancestor) for the objects to be added in this set
      *
      * @return \DBObjectSet The empty set
@@ -297,6 +328,8 @@ class DBObjectSet implements iDBObjectSetIterator
     /**
      * Create a set (in-memory) with just one column (i.e. one object per row) and filled with the given array of objects
      *
+     * @internal
+     *
      * @param string $sClass The class of the objects (must be a common ancestor to all objects in the set)
      * @param array $aObjects The list of objects to add into the set
      *
@@ -314,9 +347,11 @@ class DBObjectSet implements iDBObjectSetIterator
     /**
      * Create a set in-memory with several classes of objects per row (with one alias per "column")
      *
-     * Limitation:
+     * **Limitation:**
      * The filter/OQL query representing such a set can not be rebuilt (only the first column will be taken into account)
      *
+     * @internal
+     *
      * @param array $aClasses Format: array of (alias => class)
      * @param array $aObjects Format: array of (array of (classalias => object))
      *
@@ -345,6 +380,9 @@ class DBObjectSet implements iDBObjectSetIterator
 	}
 
     /**
+     *
+     * @internal
+     *
      * @param $oObject
      * @param string $sLinkSetAttCode
      * @param string $sExtKeyToRemote
@@ -371,11 +409,15 @@ class DBObjectSet implements iDBObjectSetIterator
 	}
 
     /**
+     * Fetch all as array of DBObject
+     *
      * Note: After calling this method, the set cursor will be at the end of the set. You might want to rewind it.
      *
+     * @api
+     *
      * @param bool $bWithId
      *
-     * @return array
+     * @return DBObject[]
      *
      * @throws \Exception
      * @throws \CoreException
@@ -401,7 +443,14 @@ class DBObjectSet implements iDBObjectSetIterator
 	}
 
     /**
-     * @return array
+     * Fetch all as a structured array
+     *
+     * Unlike ToArray, ToArrayOfValues return the objects as an array.
+     * Only the scalar values will be presents (see AttributeDefinition::IsScalar())
+     *
+     * @api
+     *
+     * @return array[]
      *
      * @throws \Exception
      * @throws \CoreException
@@ -773,6 +822,7 @@ class DBObjectSet implements iDBObjectSetIterator
      * May actually perform the SQL query SELECT COUNT... if the set was not previously loaded, or loaded with a
      * SetLimit
      *
+     * @api
      * @return int The total number of rows for this set.
      *
      * @throws \CoreException
@@ -796,11 +846,13 @@ class DBObjectSet implements iDBObjectSetIterator
 		return $this->m_iNumTotalDBRows + count($this->m_aAddedObjects); // Does it fix Trac #887 ??
 	}
 
-	/** Check if the count exceeds a given limit
+	/**
+	 * Check if the count exceeds a given limit
+	 *
 	 * @param $iLimit
 	 *
 	 * @return bool
-     *
+	 *
 	 * @throws \CoreException
 	 * @throws \MissingQueryArgument
 	 * @throws \MySQLException
@@ -831,11 +883,13 @@ class DBObjectSet implements iDBObjectSetIterator
 		return ($iCount > $iLimit);
 	}
 
-	/** Count only up to the given limit
+	/**
+	 * Count only up to the given limit
+	 *
 	 * @param $iLimit
 	 *
 	 * @return int
-     *
+	 *
 	 * @throws \CoreException
 	 * @throws \MissingQueryArgument
 	 * @throws \MySQLException
@@ -877,9 +931,11 @@ class DBObjectSet implements iDBObjectSetIterator
 	}
 
     /**
-     * Fetch the object (with the given class alias) at the current position in the set and move the cursor to the next position.
+     * Fetch an object (with the given class alias) at the current position in the set and move the cursor to the next position.
      *
-     * @param string $sRequestedClassAlias The class alias to fetch (if there are several objects/classes per row)
+     * @api
+     *
+     * @param string $sRequestedClassAlias The class alias to fetch (defaults to the first selected class)
      *
      * @return \DBObject The fetched object or null when at the end
      *
@@ -933,6 +989,8 @@ class DBObjectSet implements iDBObjectSetIterator
     /**
      * Fetch the whole row of objects (if several classes have been specified in the query) and move the cursor to the next position
      *
+     * @api
+     *
      * @return array An associative with the format 'classAlias' => $oObj representing the current row of the set. Returns null when at the end.
      *
      * @throws \CoreException
@@ -981,8 +1039,10 @@ class DBObjectSet implements iDBObjectSetIterator
 
 	/**
 	 * Position the cursor (for iterating in the set) to the first position (equivalent to Seek(0))
-     *
-     * @throws \Exception
+	 *
+	 * @api
+	 *
+	 * @throws \Exception
 	 */
 	public function Rewind()
 	{
@@ -1200,9 +1260,9 @@ class DBObjectSet implements iDBObjectSetIterator
 	 * @param \DBObjectSet $oObjectSet
 	 * 
 	 * @return \DBObjectSet The "delta" set.
-     *
-     * @throws \Exception
-     * @throws \CoreException
+	 *
+	 * @throws \Exception
+	 * @throws \CoreException
 	 */
 	public function CreateDelta(DBObjectSet $oObjectSet)
 	{
@@ -1445,6 +1505,8 @@ class DBObjectSet implements iDBObjectSetIterator
 
 /**
  * Helper function to perform a custom sort of a hash array
+ *
+ * @internal
  */
 function HashCountComparison($a, $b) // Sort descending on 'count'
 {
@@ -1464,6 +1526,11 @@ function HashCountComparison($a, $b) // Sort descending on 'count'
  * LIMITATIONS:
  *  - only DBObjectSets with one column (i.e. one class of object selected) are supported
  *  - the first set must be the one loaded from the database
+ *
+ * @internal
+ *
+ * @package iTopORM
+ *
  */
 class DBObjectSetComparator
 {
@@ -1508,6 +1575,8 @@ class DBObjectSetComparator
     /**
      * Builds the lists of fingerprints and initializes internal structures, if it was not already done
      *
+     * @internal
+     *
      * @throws \CoreException
      */
 	protected function ComputeFingerprints()
@@ -1557,6 +1626,9 @@ class DBObjectSetComparator
 
     /**
      * Tells if the sets are equivalent or not. Returns as soon as the first difference is found.
+     *
+     * @internal
+     *
      * @return boolean true if the set have an equivalent content, false otherwise
      *
      * @throws \CoreException
@@ -1603,8 +1675,10 @@ class DBObjectSetComparator
     /**
      * Get the list of differences between the two sets. In ordeer to write back into the database only the minimum changes
      * THE FIRST SET MUST BE THE ONE LOADED FROM THE DATABASE
-     * Returns a hash: 'added' => DBObject(s), 'removed' => DBObject(s), 'modified' => DBObjects(s)
-     * @return array
+     *
+     * @internal
+     *
+     * @return array 'added' => DBObject(s), 'removed' => DBObject(s), 'modified' => DBObjects(s)
      *
      * @throws \Exception
      * @throws \CoreException
@@ -1659,7 +1733,9 @@ class DBObjectSetComparator
 	}
 
     /**
-     * Helpr to clone (in memory) an object and to apply to it the values taken from a second object
+     * Helper to clone (in memory) an object and to apply to it the values taken from a second object
+     *
+     * @internal
      *
      * @param \DBObject $oObjToClone
      * @param \DBObject $oObjWithValues
@@ -1682,4 +1758,4 @@ class DBObjectSetComparator
 		}
 		return $oObj;
 	}
-}
\ No newline at end of file
+}
diff --git a/core/dbsearch.class.php b/core/dbsearch.class.php
index 9f22b796a..56f7ba8e0 100644
--- a/core/dbsearch.class.php
+++ b/core/dbsearch.class.php
@@ -22,24 +22,35 @@ require_once('dbunionsearch.class.php');
 
 /**
  * An object search
- * 
+ *
+ * DBSearch provides an API that leverage the possibility to construct a search against iTop's persisted objects.
+ * In order to do so, it let you declare the classes you want to fetch, the conditions you want to apply, ...
+ *
  * Note: in the ancient times of iTop, a search was named after DBObjectSearch.
- *  When the UNION has been introduced, it has been decided to:
- *  - declare a hierarchy of search classes, with two leafs :
- *    - one class to cope with a single query (A JOIN B... WHERE...)
- *    - and the other to cope with several queries (query1 UNION query2)
- *  - in order to preserve forward/backward compatibility of the existing modules 
- *    - keep the name of DBObjectSearch even if it a little bit confusing
- *    - do not provide a type-hint for function parameters defined in the modules
- *    - leave the statements DBObjectSearch::FromOQL in the modules, though DBSearch is more relevant 
+ * When the UNION has been introduced, it has been decided to:
+ *   * declare a hierarchy of search classes : `DBObjectSearch` & `DBUnionSearch`
+ *     * DBObjectSearch cope with single query (A JOIN B... WHERE...)
+ *     * DBUnionSearch cope with several queries (query1 UNION query2)
+ *   * in order to preserve forward/backward compatibility of the existing modules
+ *     * keep the name of DBObjectSearch even if it a little bit confusing
+ *     * do not provide a type-hint for function parameters defined in the modules
+ *     * leave the statements DBObjectSearch::FromOQL in the modules, though DBSearch is more relevant
  *
  * @copyright   Copyright (C) 2015-2017 Combodo SARL
  * @license     http://opensource.org/licenses/AGPL-3.0
+ *
+ *
+ * @package     iTopORM
+ * @api
+ * @see DBObjectSearch::__construct()
+ * @see DBUnionSearch::__construct()
  */
  
 abstract class DBSearch
 {
+    /** @internal */
 	const JOIN_POINTING_TO = 0;
+    /** @internal */
 	const JOIN_REFERENCED_BY = 1;
 
 	protected $m_bNoContextParameters = false;
@@ -47,14 +58,23 @@ abstract class DBSearch
 	protected $m_bArchiveMode = false;
 	protected $m_bShowObsoleteData = true;
 
+    /**
+     * DBSearch constructor.
+     *
+     * @api
+     * @see DBSearch::FromOQL()
+     */
 	public function __construct()
 	{
 		$this->Init();
 	}
 
+    /**
+     * called by the constructor
+     * @internal Set the obsolete and archive modes to the default ones
+     */
 	protected function Init()
 	{
-		// Set the obsolete and archive modes to the default ones
 		$this->m_bArchiveMode = utils::IsArchiveMode();
 		$this->m_bShowObsoleteData = true;
 	}
@@ -62,6 +82,8 @@ abstract class DBSearch
 	/**
 	 * Perform a deep clone (as opposed to "clone" which does copy a reference to the underlying objects)
 	 *
+     * @internal
+     *
 	 * @return \DBSearch
 	 **/	 	
 	public function DeepClone()
@@ -69,22 +91,62 @@ abstract class DBSearch
 		return unserialize(serialize($this)); // Beware this serializes/unserializes the search and its parameters as well
 	}
 
+    /**
+     * whether or not some information should be hidden to the current user.
+     *
+     * @api
+     * @see IsAllDataAllowed()
+     *
+     * @return mixed
+     */
 	abstract public function AllowAllData();
+
+    /**
+     * Current state of AllowAllData
+     *
+     * @internal
+     * @see AllowAllData()
+     *
+     * @return mixed
+     */
 	abstract public function IsAllDataAllowed();
 
+    /**
+     * Should the archives be fetched
+     *
+     * @internal
+     *
+     * @param $bEnable
+     */
 	public function SetArchiveMode($bEnable)
 	{
 		$this->m_bArchiveMode = $bEnable;
 	}
+
+    /**
+     * @internal
+     * @return bool
+     */
 	public function GetArchiveMode()
 	{
 		return $this->m_bArchiveMode;
 	}
 
+    /**
+     * Should the obsolete data be fetched
+     *
+     * @internal
+     * @param $bShow
+     */
 	public function SetShowObsoleteData($bShow)
 	{
 		$this->m_bShowObsoleteData = $bShow;
 	}
+
+    /**
+     * @internal
+     * @return bool
+     */
 	public function GetShowObsoleteData()
 	{
 		if ($this->m_bArchiveMode || $this->IsAllDataAllowed())
@@ -99,14 +161,36 @@ abstract class DBSearch
 		return $bRet;
 	}
 
+    /**
+     * @internal
+     */
 	public function NoContextParameters() {$this->m_bNoContextParameters = true;}
+
+    /**
+     * @internal
+     * @return bool
+     */
 	public function HasContextParameters() {return $this->m_bNoContextParameters;}
 
+    /**
+     * @internal
+     *
+     * @param $sPluginClass
+     * @param $sProperty
+     * @param $value
+     */
 	public function SetModifierProperty($sPluginClass, $sProperty, $value)
 	{
 		$this->m_aModifierProperties[$sPluginClass][$sProperty] = $value;
 	}
 
+    /**
+     * @internal
+     *
+     * @param $sPluginClass
+     *
+     * @return array|mixed
+     */
 	public function GetModifierProperties($sPluginClass)
 	{
 		if (array_key_exists($sPluginClass, $this->m_aModifierProperties))
@@ -119,18 +203,44 @@ abstract class DBSearch
 		}
 	}
 
+    /**
+     * @internal
+     * @param $sAlias
+     *
+     * @return mixed
+     */
 	abstract public function GetClassName($sAlias);
+
+    /**
+     * @internal
+     * @return mixed
+     */
 	abstract public function GetClass();
+
+    /**
+     * @internal
+     * @return mixed
+     */
 	abstract public function GetClassAlias();
 
 	/**
-	 * Change the class (only subclasses are supported as of now, because the conditions must fit the new class)
-	 * Defaults to the first selected class (most of the time it is also the first joined class	 
-	 */	 	
+     * Change the class
+     *
+     * Defaults to the first selected class (most of the time it is also the first joined class
+     * only subclasses are supported as of now, because the conditions must fit the new class
+     *
+     * @internal
+     */
 	abstract public function ChangeClass($sNewClass, $sAlias = null);
+
+    /**
+     * @internal
+     * @return mixed
+     */
 	abstract public function GetSelectedClasses();
 
 	/**
+     * @internal
 	 * @param array $aSelectedClasses array of aliases
 	 * @throws CoreException
 	 */
@@ -139,64 +249,207 @@ abstract class DBSearch
 	/**
 	 * Change any alias of the query tree
 	 *
+     * @internal
+     *
 	 * @param $sOldName
 	 * @param $sNewName
 	 * @return bool True if the alias has been found and changed
 	 */
 	abstract public function RenameAlias($sOldName, $sNewName);
 
+    /**
+     * @internal
+     * @return mixed
+     */
 	abstract public function IsAny();
 
+    /**
+     * @deprecated use ToOQL() instead
+     * @internal
+     * @return string
+     */
 	public function Describe(){return 'deprecated - use ToOQL() instead';}
+    /**
+     * @deprecated use ToOQL() instead
+     * @internal
+     * @return string
+     */
 	public function DescribeConditionPointTo($sExtKeyAttCode, $aPointingTo){return 'deprecated - use ToOQL() instead';}
+    /**
+     * @deprecated use ToOQL() instead
+     * @internal
+     * @return string
+     */
 	public function DescribeConditionRefBy($sForeignClass, $sForeignExtKeyAttCode){return 'deprecated - use ToOQL() instead';}
+    /**
+     * @deprecated use ToOQL() instead
+     * @internal
+     * @return string
+     */
 	public function DescribeConditionRelTo($aRelInfo){return 'deprecated - use ToOQL() instead';}
+    /**
+     * @deprecated use ToOQL() instead
+     * @internal
+     * @return string
+     */
 	public function DescribeConditions(){return 'deprecated - use ToOQL() instead';}
+    /**
+     * @deprecated use ToOQL() instead
+     * @internal
+     * @return string
+     */
 	public function __DescribeHTML(){return 'deprecated - use ToOQL() instead';}
 
+    /**
+     * @internal
+     * @return mixed
+     */
 	abstract public function ResetCondition();
+
+    /**
+     * add $oExpression as a OR
+     *
+     * @api
+     * @see DBSearch::AddConditionExpression()
+     *
+     * @param Expression $oExpression
+     *
+     * @return mixed
+     */
 	abstract public function MergeConditionExpression($oExpression);
+
+    /**
+     * add $oExpression as a AND
+     *
+     * @api
+     * @see DBSearch::MergeConditionExpression()
+     *
+     * @param Expression $oExpression
+     *
+     * @return mixed
+     */
 	abstract public function AddConditionExpression($oExpression);
+
+    /**
+     * Condition on the friendlyname
+     *
+     * Restrict the query to only the corresponding selected class' friendlyname
+     *
+     * @internal
+     *
+     * @param string $sName the desired friendlyname
+     *
+     * @return mixed
+     */
   	abstract public function AddNameCondition($sName);
+
+    /**
+     * Add a condition
+     *
+     * This is the simplest way to express a AND condition. For complex use cases, use MergeConditionExpression or AddConditionExpression instead
+     *
+     * @api
+     *
+     * @param string $sFilterCode
+     * @param mixed  $value
+     * @param string $sOpCode operator to use : '=' (default), '!=', 'IN', 'NOT IN'
+     *
+     * @throws \CoreException
+     *
+     */
 	abstract public function AddCondition($sFilterCode, $value, $sOpCode = null);
 	/**
 	 * Specify a condition on external keys or link sets
-	 * @param sAttSpec Can be either an attribute code or extkey->[sAttSpec] or linkset->[sAttSpec] and so on, recursively
+     *
+     * @internal
+     *
+	 * @param string $sAttSpec Can be either an attribute code or extkey->[sAttSpec] or linkset->[sAttSpec] and so on, recursively
 	 *                 Example: infra_list->ci_id->location_id->country	 
-	 * @param value The value to match (can be an array => IN(val1, val2...)
+	 * @param mixed $value The value to match (can be an array => IN(val1, val2...)
 	 * @return void
 	 */
 	abstract public function AddConditionAdvanced($sAttSpec, $value);
+
+    /**
+     * @internal
+     *
+     * @param string $sFullText
+     *
+     * @return mixed
+     */
 	abstract public function AddCondition_FullText($sFullText);
 
 	/**
+     * Perform a join, the remote class being matched by the mean of its primary key
+     *
+     * The join is performed
+     *   * from the searched class, based on the $sExtKeyAttCode attribute
+     *   * against the oFilter searched class, based on its primary key
+     * Note : if several classes have already being joined (SELECT a join b ON...), the first joined class (a in the example) is considered as being the searched class.
+     *
+     * @api
+     * @see AddCondition_ReferencedBy()
+     *
 	 * @param DBObjectSearch $oFilter
-	 * @param $sExtKeyAttCode
-	 * @param int $iOperatorCode
-	 * @param null $aRealiasingMap array of <old-alias> => <new-alias>, for each alias that has changed
+	 * @param string $sExtKeyAttCode
+	 * @param int $iOperatorCode the comparison operator to use. For the list of all possible values, see the constant defined in core/oql/oqlquery.class.inc.php
+	 * @param array|null $aRealiasingMap array of <old-alias> => <new-alias>, for each alias that has changed in the newly attached oFilter (in case of collisions between the two filters)
+     *
 	 * @throws CoreException
 	 * @throws CoreWarning
 	 */
 	abstract public function AddCondition_PointingTo(DBObjectSearch $oFilter, $sExtKeyAttCode, $iOperatorCode = TREE_OPERATOR_EQUALS, &$aRealiasingMap = null);
 
 	/**
+     * Inverse operation of AddCondition_PointingTo
+     *
+     * The join is performed
+     *   * from the olFilter searched class, based on the $sExtKeyAttCode attribute
+     *   * against the searched class, based on its primary key
+     * Note : if several classes have already being joined (SELECT a join b ON...), the first joined class (a in the example) is considered as being the searched class.
+     *
+     *
+     * @api
+     * @see AddCondition_PointingTo()
+     *
 	 * @param DBObjectSearch $oFilter
 	 * @param $sForeignExtKeyAttCode
 	 * @param int $iOperatorCode
-	 * @param null $aRealiasingMap array of <old-alias> => <new-alias>, for each alias that has changed
+	 * @param array|null $aRealiasingMap array of <old-alias> => <new-alias>, for each alias that has changed in the newly attached oFilter (in case of collisions between the two filters)
 	 */
 	abstract public function AddCondition_ReferencedBy(DBObjectSearch $oFilter, $sForeignExtKeyAttCode, $iOperatorCode = TREE_OPERATOR_EQUALS, &$aRealiasingMap = null);
 
+    /**
+     * Filter the result
+     *
+     * The filter is performed by returning only the values in common with the given $oFilter
+     * The impact on the resulting query performance/viability can be significant.
+     *
+     * @internal
+     *
+     * @param DBSearch $oFilter
+     *
+     * @return mixed
+     */
 	abstract public function Intersect(DBSearch $oFilter);
 
-	/**
-	 * @param DBSearch $oFilter
-	 * @param integer $iDirection
-	 * @param string $sExtKeyAttCode
-	 * @param integer $iOperatorCode
-	 * @param array &$RealisasingMap  Map of aliases from the attached query, that could have been renamed by the optimization process
-	 * @return DBSearch
-	 */
+    /**
+     * Perform a join
+     *
+     * The join is performed against $oFilter selected class using $sExtKeyAttCode of the current selected class
+     *
+     * @internal
+     *
+     * @param DBSearch   $oFilter        The join is performed against $oFilter selected class
+     * @param integer    $iDirection     can be either DBSearch::JOIN_POINTING_TO or DBSearch::JOIN_REFERENCED_BY
+     * @param string     $sExtKeyAttCode The join is performed against $sExtKeyAttCode wetheir it is compared aginst the current DBSearch or $oFilter depend of $iDirection
+     * @param integer    $iOperatorCode  See DBSearch::AddCondition_PointingTo()
+     * @param array|null $aRealiasingMap Map of aliases from the attached query, that could have been renamed by the optimization process
+     *
+     * @return DBSearch
+     * @throws CoreException
+     * @throws CoreWarning
+     */
 	public function Join(DBSearch $oFilter, $iDirection, $sExtKeyAttCode, $iOperatorCode = TREE_OPERATOR_EQUALS, &$aRealiasingMap = null)
 	{
 		$oSourceFilter = $this->DeepClone();
@@ -231,21 +484,68 @@ abstract class DBSearch
 		return $oRet;
 	}
 
+    /**
+     * Set the internal params.
+     *
+     * If any params pre-existed, they are lost.
+     *
+     * @internal
+     *
+     * @param mixed[string] $aParams array of mixed params index by string name
+     *
+     * @return mixed
+     */
 	abstract public function SetInternalParams($aParams);
+
+    /**
+     * @internal
+     * @return mixed
+     */
 	abstract public function GetInternalParams();
+
+    /**
+     * @internal
+     *
+     * @param bool $bExcludeMagicParams
+     *
+     * @return mixed
+     */
 	abstract public function GetQueryParams($bExcludeMagicParams = true);
+
+    /**
+     * @internal
+     * @return mixed
+     */
 	abstract public function ListConstantFields();
 
 	/**
-	 * Turn the parameters (:xxx) into scalar values in order to easily
-	 * serialize a search
+     * Turn the parameters (:xxx) into scalar values
+     *
+     * The goal is to easily serialize a search
 	 *
+     * @internal
+     *
 	 * @param array $aArgs
 	 *
 	 * @return string
 	 */
 	abstract public function ApplyParameters($aArgs);
 
+    /**
+     * Convert a query to a string representation
+     *
+     * This operation can be revert back to a DBSearch using DBSearch::unserialize()
+     *
+     * @api
+     * @see DBSearch::unserialize()
+     *
+     * @param bool  $bDevelopParams
+     * @param array $aContextParams
+     *
+     * @return false|string
+     * @throws ArchivedObjectException
+     * @throws CoreException
+     */
     public function serialize($bDevelopParams = false, $aContextParams = array())
 	{
 		$aQueryParams = $this->GetQueryParams();
@@ -293,6 +593,10 @@ abstract class DBSearch
 	}
 
 	/**
+     * Convert a serialized query back to an instance of DBSearch
+     *
+     * @api
+     *
 	 * @param string $sValue Serialized OQL query
 	 *
 	 * @return \DBSearch
@@ -336,11 +640,13 @@ abstract class DBSearch
     /**
      * Create a new DBObjectSearch from $oSearch with a new alias $sAlias
      *
-     * Note : This has not be tested with UNION queries.
+     * @internal Note : This has not be tested with UNION queries.
      *
      * @param DBSearch $oSearch
-     * @param string $sAlias
+     * @param string   $sAlias
+     *
      * @return DBObjectSearch
+     * @throws CoreException
      */
     static public function CloneWithAlias(DBSearch $oSearch, $sAlias)
     {
@@ -349,12 +655,37 @@ abstract class DBSearch
         return $oSearchWithAlias;
     }
 
+    /**
+     * Convert the DBSearch to an OQL representation
+     *
+     * @api
+     * @see DBSearch::FromOQL()
+     *
+     * @param bool $bDevelopParams
+     * @param null $aContextParams
+     * @param bool $bWithAllowAllFlag
+     *
+     * @return mixed
+     */
     abstract public function ToOQL($bDevelopParams = false, $aContextParams = null, $bWithAllowAllFlag = false);
 
 	static protected $m_aOQLQueries = array();
 
-	// Do not filter out depending on user rights
-	// In particular when we are currently in the process of evaluating the user rights...
+    /**
+     * FromOQL with AllowAllData enabled
+     *
+     * The goal is to  not filter out depending on user rights.
+     * In particular when we are currently in the process of evaluating the user rights...
+     *
+     * @internal
+     * @see DBSearch::FromOQL()
+     *
+     * @param string $sQuery
+     * @param null   $aParams
+     *
+     * @return DBSearch
+     * @throws OQLException
+     */
 	static public function FromOQL_AllData($sQuery, $aParams = null)
 	{
 		$oRes = self::FromOQL($sQuery, $aParams);
@@ -363,9 +694,19 @@ abstract class DBSearch
 	}
 
 	/**
-	 * @param string $sQuery
-	 * @param array $aParams
-	 * @return self
+     * Create a new DBSearch from the given OQL.
+     *
+     * This is the simplest way to create a DBSearch.
+     * For almost every cases, this is the easiest way.
+     *
+     * @api
+     * @see DBSearch::ToOQL()
+     *
+	 * @param string $sQuery The OQL to convert to a DBSearch
+	 * @param mixed[string]  $aParams array of <mixed> params index by <string> name
+     *
+	 * @return DBObjectSearch|DBUnionSearch
+     *
 	 * @throws OQLException
 	 */
 	static public function FromOQL($sQuery, $aParams = null)
@@ -442,14 +783,20 @@ abstract class DBSearch
 	}
 
 	/**
+     * Fetch the result has an array structure.
+     *
 	 * Alternative to object mapping: the data are transfered directly into an array
 	 * This is 10 times faster than creating a set of objects, and makes sense when optimization is required
+     * But this speed comes at the cost of not obtaining the easy to manipulates DBObject instances but simple array structure.
+     *
+     * @internal
 	 *
-	 * @param array $aColumns
+	 * @param array $aColumns The columns you'd like to fetch.
 	 * @param array $aOrderBy Array of '[<classalias>.]attcode' => bAscending
 	 * @param array $aArgs
 	 *
 	 * @return array|void
+     *
 	 * @throws \CoreException
 	 * @throws \MissingQueryArgument
 	 * @throws \MySQLException
@@ -506,7 +853,11 @@ abstract class DBSearch
 	protected static $m_aQueryStructCache = array();
 
 
-	/** Generate a Group By SQL request from a search
+    /**
+     * Generate a Group By SQL query from the current search
+     *
+     * @internal
+     *
 	 * @param array $aArgs
 	 * @param array $aGroupByExpr array('alias' => Expression)
 	 * @param bool $bExcludeNullValues
@@ -514,7 +865,9 @@ abstract class DBSearch
 	 * @param array $aOrderBy array('alias' => bool) true = ASC false = DESC
 	 * @param int $iLimitCount
 	 * @param int $iLimitStart
+     *
 	 * @return string SQL query generated
+     *
 	 * @throws Exception
 	 */
 	public function MakeGroupByQuery($aArgs, $aGroupByExpr, $bExcludeNullValues = false, $aSelectExpr = array(), $aOrderBy = array(), $iLimitCount = 0, $iLimitStart = 0)
@@ -590,6 +943,10 @@ abstract class DBSearch
 
 
 	/**
+     * Generate a SQL query from the current search
+     *
+     * @internal
+     *
 	 * @param array|hash $aOrderBy Array of '[<classalias>.]attcode' => bAscending
 	 * @param array $aArgs
 	 * @param null $aAttToLoad
@@ -684,9 +1041,33 @@ abstract class DBSearch
 		return $sRes;
 	}
 
+    /**
+     * @internal
+     * @return mixed
+     */
 	protected abstract function IsDataFiltered();
+
+    /**
+     * @internal
+     * @return mixed
+     */
 	protected abstract function SetDataFiltered();
 
+    /**
+     * @internal
+     *
+     * @param      $aOrderBy
+     * @param      $aArgs
+     * @param      $aAttToLoad
+     * @param      $aExtendedDataSpec
+     * @param      $iLimitCount
+     * @param      $iLimitStart
+     * @param      $bGetCount
+     * @param null $aGroupByExpr
+     * @param null $aSelectExpr
+     *
+     * @return mixed
+     */
 	protected function GetSQLQuery($aOrderBy, $aArgs, $aAttToLoad, $aExtendedDataSpec, $iLimitCount, $iLimitStart, $bGetCount, $aGroupByExpr = null, $aSelectExpr = null)
 	{
 		$oSearch = $this;
@@ -727,18 +1108,46 @@ abstract class DBSearch
 		return $oSQLQuery;
 	}
 
+    /**
+     * @internal
+     *
+     * @param      $aAttToLoad
+     * @param      $bGetCount
+     * @param null $aGroupByExpr
+     * @param null $aSelectedClasses
+     * @param null $aSelectExpr
+     *
+     * @return mixed
+     */
 	public abstract function GetSQLQueryStructure(
 		$aAttToLoad, $bGetCount, $aGroupByExpr = null, $aSelectedClasses = null, $aSelectExpr = null
 	);
 
 	/**
+     * Get the current search conditions
+     *
+     * @internal
+     * @see DBSearch $m_oSearchCondition
+     *
 	 * @return \Expression
 	 */
 	public abstract function GetCriteria();
 
+    /**
+     * Shortcut to add efficient IN condition
+     *
+     * @internal
+     *
+     * @param      $sFilterCode
+     * @param      $aValues
+     * @param bool $bPositiveMatch if true a `IN` is performed, if false, a `NOT IN` is performed
+     *
+     * @return mixed
+     */
 	public abstract function AddConditionForInOperatorUsingParam($sFilterCode, $aValues, $bPositiveMatch = true);
 
 	/**
+     * @internal
 	 * @return string a unique param name
 	 */
 	protected function GenerateUniqueParamName() {
@@ -759,36 +1168,78 @@ abstract class DBSearch
 	protected static $m_bIndentQueries = false;
 	protected static $m_bOptimizeQueries = false;
 
+    /**
+     * @internal
+     */
 	public static function StartDebugQuery()
 	{
 		$aBacktrace = debug_backtrace();
 		self::$m_bDebugQuery = true;
 	}
+
+    /**
+     * @internal
+     */
 	public static function StopDebugQuery()
 	{
 		self::$m_bDebugQuery = false;
 	}
-	
+
+    /**
+     * @internal
+     *
+     * @param bool $bEnabled
+     * @param bool $bUseAPC
+     * @param int  $iTimeToLive
+     */
 	public static function EnableQueryCache($bEnabled, $bUseAPC, $iTimeToLive = 3600)
 	{
 		self::$m_bQueryCacheEnabled = $bEnabled;
 		self::$m_bUseAPCCache = $bUseAPC;
 		self::$m_iQueryCacheTTL = $iTimeToLive;
 	}
+
+    /**
+     * @internal
+     * @param $bEnabled
+     */
 	public static function EnableQueryTrace($bEnabled)
 	{
 		self::$m_bTraceQueries = $bEnabled;
 	}
+
+    /**
+     * @internal
+     * @param $bEnabled
+     */
 	public static function EnableQueryIndentation($bEnabled)
 	{
 		self::$m_bIndentQueries = $bEnabled;
 	}
+
+    /**
+     * @internal
+     * @param $bEnabled
+     */
 	public static function EnableOptimizeQuery($bEnabled)
 	{
 		self::$m_bOptimizeQueries = $bEnabled;
 	}
 
-
+    /**
+     * @internal
+     *
+     * @param $aOrderBy
+     * @param $aArgs
+     * @param $aAttToLoad
+     * @param $aExtendedDataSpec
+     * @param $iLimitCount
+     * @param $iLimitStart
+     * @param $bGetCount
+     * @param $sSql
+     *
+     * @throws MySQLException
+     */
 	protected function AddQueryTraceSelect($aOrderBy, $aArgs, $aAttToLoad, $aExtendedDataSpec, $iLimitCount, $iLimitStart, $bGetCount, $sSql)
 	{
 		if (self::$m_bTraceQueries)
@@ -808,7 +1259,16 @@ abstract class DBSearch
 			self::AddQueryTrace($aQueryData, $sOql, $sSql);
 		}
 	}
-	
+
+    /**
+     * @internal
+     *
+     * @param $aArgs
+     * @param $aGroupByExpr
+     * @param $sSql
+     *
+     * @throws MySQLException
+     */
 	protected function AddQueryTraceGroupBy($aArgs, $aGroupByExpr, $sSql)
 	{
 		if (self::$m_bTraceQueries)
@@ -824,6 +1284,15 @@ abstract class DBSearch
 		}
 	}
 
+    /**
+     * @internal
+     *
+     * @param $aQueryData
+     * @param $sOql
+     * @param $sSql
+     *
+     * @throws MySQLException
+     */
 	protected static function AddQueryTrace($aQueryData, $sOql, $sSql)
 	{
 		if (self::$m_bTraceQueries)
@@ -854,6 +1323,9 @@ abstract class DBSearch
 		}
 	}
 
+    /**
+     * @internal
+     */
 	public static function RecordQueryTrace()
 	{
 		if (!self::$m_bTraceQueries)
@@ -914,6 +1386,10 @@ abstract class DBSearch
 		file_put_contents($sAllQueries, $sLog);
 	}
 
+    /**
+     * @internal
+     * @param $value
+     */
 	protected static function DbgTrace($value)
 	{
 		if (!self::$m_bDebugQuery)
@@ -949,7 +1425,9 @@ abstract class DBSearch
 
 	/**
 	 * Experimental!
-	 * todo: implement the change tracking
+	 * @todo implement the change tracking
+     *
+     * @internal
 	 *
 	 * @param $bArchive
 	 * @throws Exception
@@ -1025,6 +1503,9 @@ abstract class DBSearch
 		}
 	}
 
+    /**
+     * @internal
+     */
 	public function UpdateContextFromUser()
 	{
 		$this->SetShowObsoleteData(utils::ShowObsoleteData());
diff --git a/core/dbunionsearch.class.php b/core/dbunionsearch.class.php
index 32721c45e..dada399a9 100644
--- a/core/dbunionsearch.class.php
+++ b/core/dbunionsearch.class.php
@@ -18,10 +18,21 @@
 
 
 /**
- * A union of DBObjectSearches 
+ * A union of DBObjectSearches
+ *
+ * This search class represent an union over a collection of DBObjectSearch.
+ * For clarity purpose, since only the constructor vary between DBObjectSearch and DBUnionSearch, all the API is documented on the common ancestor: DBSearch
+ * Please refer to DBSearch's documentation
  *
  * @copyright   Copyright (C) 2015-2017 Combodo SARL
  * @license     http://opensource.org/licenses/AGPL-3.0
+ *
+ *
+ * @package     iTopORM
+ * @phpdoc-tunning-exclude-inherited this tag prevent PHPdoc from displaying inherited methods. This is done in order to force the API doc. location into DBSearch only.
+ * @api
+ * @see DBSearch
+ * @see DBObjectSearch
  */
  
 class DBUnionSearch extends DBSearch
@@ -29,6 +40,15 @@ class DBUnionSearch extends DBSearch
 	protected $aSearches; // source queries
 	protected $aSelectedClasses; // alias => classes (lowest common ancestors) computed at construction
 
+    /**
+     * DBUnionSearch constructor.
+     *
+     * @api
+     *
+     * @param $aSearches
+     *
+     * @throws CoreException
+     */
 	public function __construct($aSearches)
 	{
 		if (count ($aSearches) == 0)
diff --git a/core/metamodel.class.php b/core/metamodel.class.php
index c37083da1..0fcfc383c 100644
--- a/core/metamodel.class.php
+++ b/core/metamodel.class.php
@@ -97,8 +97,9 @@ define('MYSQL_ENGINE', 'innodb');
 
 
 /**
- * (API) The objects definitions as well as their mapping to the database
+ * The objects definitions as well as their mapping to the database
  *
+ * @api
  * @package     iTopORM
  */
 abstract class MetaModel
@@ -1233,6 +1234,7 @@ abstract class MetaModel
 	}
 
 	/**
+	 * @deprecated
 	 * @param string $sClass
 	 *
 	 * @return array
@@ -1285,9 +1287,12 @@ abstract class MetaModel
 	}
 
 	/**
-	 * @param string $sClass
-	 * @param string $sAttCode
-	 * @param bool $bExtended
+	 * Check it the given attribute exists in the specified class
+	 *
+	 * @api
+	 * @param string $sClass Class name
+	 * @param string $sAttCode Attribute code
+	 * @param bool $bExtended Allow the extended syntax: extkey_id->remote_attcode
 	 *
 	 * @return bool
 	 * @throws \Exception
@@ -1341,6 +1346,7 @@ abstract class MetaModel
 	}
 
 	/**
+	 * @deprecated
 	 * @param string $sClass
 	 * @param string $sFilterCode
 	 *
@@ -1356,6 +1362,9 @@ abstract class MetaModel
 	}
 
 	/**
+	 * Check if the given class name is actually a persistent class
+	 *
+	 * @api
 	 * @param string $sClass
 	 *
 	 * @return bool
@@ -1630,17 +1639,20 @@ abstract class MetaModel
 	/**
 	 * array of ("classname" => array filterdef)
 	 *
+	 * @deprecated
 	 * @var array
 	 */
 	private static $m_aFilterDefs = array();
 	/**
 	 * array of ("classname" => array of ("attcode"=>"sourceclass"))
 	 *
+	 * @deprecated
 	 * @var array
 	 */
 	private static $m_aFilterOrigins = array();
 
 	/**
+	 * @deprecated
 	 * @param string $sClass
 	 *
 	 * @return mixed
@@ -1653,6 +1665,7 @@ abstract class MetaModel
 	}
 
 	/**
+	 * @deprecated
 	 * @param string $sClass
 	 * @param string $sFilterCode
 	 *
@@ -1670,6 +1683,7 @@ abstract class MetaModel
 	}
 
 	/**
+	 * @deprecated
 	 * @param string $sClass
 	 * @param string $sFilterCode
 	 *
@@ -1688,6 +1702,7 @@ abstract class MetaModel
 	}
 
 	/**
+	 * @deprecated
 	 * @param string $sClass
 	 * @param string $sFilterCode
 	 *
@@ -1705,6 +1720,7 @@ abstract class MetaModel
 	}
 
 	/**
+	 * @deprecated
 	 * @param string $sClass
 	 * @param string $sFilterCode
 	 *
@@ -1722,6 +1738,7 @@ abstract class MetaModel
 	}
 
 	/**
+	 * @deprecated
 	 * @param string $sClass
 	 * @param string $sFilterCode
 	 *
@@ -1740,6 +1757,7 @@ abstract class MetaModel
 	}
 
 	/**
+	 * @deprecated
 	 * @param string $sClass
 	 * @param string $sFilterCode
 	 * @param string $sOpCode
@@ -1759,6 +1777,7 @@ abstract class MetaModel
 	}
 
 	/**
+	 * @deprecated
 	 * @param string $sFilterCode
 	 *
 	 * @return string
@@ -1856,7 +1875,7 @@ abstract class MetaModel
 	private static $m_aRelationInfos = array();
 
 	/**
-	 * TO BE DEPRECATED: use EnumRelationsEx instead
+	 * @deprecated Use EnumRelationsEx instead
 	 *
 	 * @param string $sClass
 	 *
@@ -6643,12 +6662,13 @@ abstract class MetaModel
 	}
 
 	/**
-	 * Search for the specified class and id.
+	 * Instantiate an object already persisted to the Database.
 	 *
+	 * @api
 	 * @param string $sClass
 	 * @param int $iKey id value of the object to retrieve
 	 * @param bool $bMustBeFound see throws ArchivedObjectException
-	 * @param bool $bAllowAllData if true then no rights filtering
+	 * @param bool $bAllowAllData if true then user rights will be bypassed - use with care!
 	 * @param null $aModifierProperties
 	 *
 	 * @return DBObject|null null if : (the object is not found) or (archive mode disabled and object is archived and
@@ -6859,8 +6879,11 @@ abstract class MetaModel
 	}
 
 	/**
-	 * @param string $sClass
-	 * @param array|null $aValues array of attcode => value
+	 * Instantiate a persistable object (not yet persisted)
+	 *
+	 * @api
+	 * @param string $sClass A persistable class
+	 * @param array|null $aValues array of attcode => attribute value to preset
 	 *
 	 * @return DBObject
 	 * @throws \CoreException
@@ -6905,6 +6928,8 @@ abstract class MetaModel
 	 * @todo: protect it against forbidden usages (in such a case, delete objects one by one)
 	 *
 	 * @param \DBObjectSearch $oFilter
+	 * @deprecated
+	 * @experimental
 	 *
 	 * @throws \MySQLException
 	 * @throws \MySQLHasGoneAwayException
@@ -6922,6 +6947,8 @@ abstract class MetaModel
 	 * @param DBObjectSearch $oFilter
 	 * @param array $aValues array of attcode => value
 	 *
+	 * @deprecated
+	 * @experimental
 	 * @return int Modified objects
 	 * @throws \MySQLException
 	 * @throws \MySQLHasGoneAwayException
diff --git a/Jenkinsfile b/jenkinsfile
similarity index 100%
rename from Jenkinsfile
rename to jenkinsfile
diff --git a/phpdoc.dist.xml b/phpdoc.dist.xml
deleted file mode 100644
index f095b5c9b..000000000
--- a/phpdoc.dist.xml
+++ /dev/null
@@ -1,13 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" ?>
-<phpdoc>
-  <title><![CDATA[iTop extensions]]></title>
-  <parser>
-    <target>/var/www/doc-extensions</target>
-  </parser>
-  <transformer>
-    <target>/var/www/doc-extensions</target>
-  </transformer>
-  <files>
-    <file>/home/romain/itop-trunk/application/applicationextension.inc.php</file>
-  </files>
-</phpdoc>
diff --git a/readme.md b/readme.md
new file mode 100644
index 000000000..112ff6114
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,140 @@
+<p align="center"><a href="https://www.combodo.com/itop-193" target="_blank">
+    <img src="https://www.combodo.com/logos/logo-itop.svg">
+</a></p>
+
+
+# iTop - ITSM & CMDB
+ 
+iTop stands for *IT Operations Portal*.
+It is a complete open source, ITIL, web based service management tool including a fully customizable CMDB, a helpdesk system and a document management tool. 
+iTop also offers mass import tools and web services to integrate with your IT
+
+## Features
+- Fully configurable [Configuration Management (CMDB)][10]
+- [HelpDesk][11] and Incident Management
+- [Service and Contract Management][12]
+- [Change][13] Management
+- Configurable [SLA][14] Management
+- Graphical [impact analysis][15]
+- [CSV import][16] tool for any data
+- Consistency [audit][17] to check data quality
+- [Data synchronization][18] (for data federation)
+
+
+## Resources
+
+ - [iTop Forums][1]: for support request
+ - [iTop Tickets][2]: for feature requests and bug reports
+ - [Releases download][3]
+ - [iTop documentation][4] for iTop and official extensions
+ - [iTop extensions][5] for discovering and installing extensions
+
+ 
+## Releases
+### Version 2.6  
+ - [Changes since the previous version][58]
+ - [New features][59]
+ - [Migration notes][60]
+ - [Download iTop 2.6.0][61]
+
+
+### Version 2.5  
+ - [Changes since the previous version][54]
+ - [New features][55]
+ - [Migration notes][56]
+ - [Download iTop 2.5.1][57]
+ 
+
+### Version 2.4  
+ - [Changes since the previous version][50]
+ - [New features][51]
+ - [Migration notes][52]
+ - [Download iTop 2.4.1][53]
+
+
+# About Us
+
+iTop development is sponsored, led and supported by [Combodo][0].
+
+
+# Contributors
+
+We would like to give a special thank you to the people from the community who contributed to this project, including:
+ - Alves, David
+ - Beck, Pedro
+ - Bilger, Jean-François
+ - Bostoen, Jeffrey
+ - Cardoso, Anderson
+ - Cassaro, Bruno
+ - Casteleyn, Thomas
+ - Castro, Randall Badilla
+ - Colantoni, Maria Laura
+ - Dvořák, Lukáš
+ - Goethals, Stefan
+ - Gumble, David
+ - Hippler, Lars
+ - Khamit, Shamil
+ - Konečný, Kamil
+ - Kunin, Vladimir
+ - Lassiter, Dennis
+ - Lucas, Jonathan
+ - Malik, Remie
+ - Rosenke, Stephan
+ - Seki, Shoji
+ - Shilov, Vladimir
+ - Tulio, Marco
+ - Turrubiates, Miguel
+
+#### Aliases
+ - chifu1234
+ - cprobst
+ - Karkoff1212
+ - larhip
+ - Laura
+ - Purple Grape
+ - Schlobinux
+ - theBigOne
+ - ulmerspatz
+
+#### Companies
+ - Hardis
+ - ITOMIG
+
+
+
+[0]: https://www.combodo.com
+
+[1]: https://sourceforge.net/p/itop/discussion/
+[2]: https://sourceforge.net/p/itop/tickets/
+[3]: https://sourceforge.net/projects/itop/files/itop/
+[4]: https://www.itophub.io/wiki
+[5]: https://store.itophub.io/en_US/
+
+
+
+[10]: https://www.itophub.io/wiki/page?id=2_5_0%3Adatamodel%3Astart#configuration_management_cmdb
+[11]: https://www.itophub.io/wiki/page?id=2_5_0%3Adatamodel%3Astart#ticketing
+[12]: https://www.itophub.io/wiki/page?id=2_5_0%3Adatamodel%3Astart#service_management
+[13]: https://www.itophub.io/wiki/page?id=2_5_0%3Adatamodel%3Astart#change_management
+[14]: https://www.itophub.io/wiki/page?id=2_5_0%3Aimplementation%3Astart#service_level_agreements_and_targets
+[15]: https://www.itophub.io/wiki/page?id=2_5_0%3Auser%3Aactions#relations
+[16]: https://www.itophub.io/wiki/page?id=2_5_0%3Auser%3Abulk_modify#uploading_data
+[17]: https://www.itophub.io/wiki/page?id=2_5_0%3Aadmin%3Aaudit
+[18]: https://www.itophub.io/wiki/page?id=2_5_0%3Aadvancedtopics%3Adata_synchro_overview
+
+
+
+[50]: https://www.itophub.io/wiki/page?id=2_4_0:release:change_log
+[51]: https://www.itophub.io/wiki/page?id=2_4_0:release:2_4_whats_new
+[52]: https://www.itophub.io/wiki/page?id=2_4_0:install:230_to_240_migration_notes
+[53]: https://sourceforge.net/projects/itop/files/itop/2.4.1
+
+[54]: https://www.itophub.io/wiki/page?id=2_5_0:release:change_log
+[55]: https://www.itophub.io/wiki/page?id=2_5_0:release:2_5_whats_new
+[56]: https://www.itophub.io/wiki/page?id=2_5_0:install:240_to_250_migration_notes
+[57]: https://sourceforge.net/projects/itop/files/itop/2.5.1
+
+[58]: https://www.itophub.io/wiki/page?id=2_6_0:release:change_log
+[59]: https://www.itophub.io/wiki/page?id=2_6_0:release:2_6_whats_new
+[60]: https://www.itophub.io/wiki/page?id=2_6_0:install:250_to_260_migration_notes
+[61]: https://sourceforge.net/projects/itop/files/itop/2.6.0