From c2ea3226259c6dddf776d95fe9896287d466f065 Mon Sep 17 00:00:00 2001 From: Igor Ilic Date: Sun, 5 Jun 2022 00:12:14 +0000 Subject: [PATCH] [AUTO] Update documentation --- docs/classes/Gac-Routing-DIContainer.html | 305 ++++++++++++++++++++++ docs/classes/Gac-Routing-Routes.html | 121 ++------- docs/files/src-dicontainer.html | 153 +++++++++++ docs/indices/files.html | 6 +- docs/js/searchIndex.js | 25 +- docs/namespaces/gac-routing.html | 2 + docs/packages/Application.html | 2 + docs/reports/markers.html | 2 +- 8 files changed, 512 insertions(+), 104 deletions(-) create mode 100644 docs/classes/Gac-Routing-DIContainer.html create mode 100644 docs/files/src-dicontainer.html diff --git a/docs/classes/Gac-Routing-DIContainer.html b/docs/classes/Gac-Routing-DIContainer.html new file mode 100644 index 0000000..8c70539 --- /dev/null +++ b/docs/classes/Gac-Routing-DIContainer.html @@ -0,0 +1,305 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
+

Documentation

+ + +
+ +
+ + +
+ +
+
+ + + + +
+ + +
+

+ DIContainer + + +
+ in package + +
+ + +

+ + + +

Class used for handling dependency injection for the library

+ + + + + + + + + +

+ Table of Contents + +

+ +
+
+ get() + +  : array<string|int, mixed> +
+
Method used for handling dependency injection
+ +
+ + + + + + + +
+

+ Methods + +

+
+

+ get() + +

+ + +

Method used for handling dependency injection

+ + + public + static get(string $class[, array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed> + +

It receives the class name that will be checked if it has any parameters that need to be injected +and a list of already defined/created arguments to be injected. It will than use the Reflection class API +to check if the provided class has any injectable parameters and if those parameters also require +any others to be injected as well using a recursion.

+
+ +
Parameters
+
+
+ $class + : string +
+
+

Name of the class for which to auto-inject arguments

+
+ +
+
+ $arguments + : array<string|int, mixed> + = []
+
+

List of arguments that will be passed alongside of auto-injected ones

+
+ +
+
+ + + +
Return values
+ array<string|int, mixed> + — +

Return a new list of arguments that holds manually provided and auto-injected arguments

+
+ + +
+
+ + + + +
+
+
+
+

Search results

+ +
+
+
    +
    +
    +
    +
    +
    + + +
    + + + + + + + + diff --git a/docs/classes/Gac-Routing-Routes.html b/docs/classes/Gac-Routing-Routes.html index 8a1907b..7beedd5 100644 --- a/docs/classes/Gac-Routing-Routes.html +++ b/docs/classes/Gac-Routing-Routes.html @@ -111,7 +111,7 @@

    @@ -299,13 +299,6 @@

    Method used for saving routing information into the global $routes array
    -
    - dependency_injection() - -  : array<string|int, mixed> -
    -
    Method used for handling dependency injection
    -
    execute_middleware() @@ -353,7 +346,7 @@

    @@ -382,7 +375,7 @@

    @@ -411,7 +404,7 @@

    @@ -440,7 +433,7 @@

    @@ -469,7 +462,7 @@

    @@ -513,7 +506,7 @@

    @@ -547,7 +540,7 @@

    @@ -581,7 +574,7 @@

    @@ -615,7 +608,7 @@

    @@ -649,7 +642,7 @@

    @@ -687,7 +680,7 @@

    @@ -720,7 +713,7 @@

    @@ -783,7 +776,7 @@

    @@ -830,7 +823,7 @@

    @@ -886,7 +879,7 @@

    @@ -942,7 +935,7 @@

    @@ -977,7 +970,7 @@

    @@ -1036,7 +1029,7 @@

    @@ -1083,7 +1076,7 @@

    @@ -1139,7 +1132,7 @@

    @@ -1195,7 +1188,7 @@

    @@ -1242,7 +1235,7 @@

    @@ -1298,7 +1291,7 @@

    @@ -1363,7 +1356,7 @@

    @@ -1394,62 +1387,6 @@

    Return values
    — - -
    -

    - dependency_injection() - -

    - - -

    Method used for handling dependency injection

    - - - private - dependency_injection(string $class[, array<string|int, mixed> $arguments = [] ]) : array<string|int, mixed> - - -
    Parameters
    -
    -
    - $class - : string -
    -
    -

    Name of the class for which to auto-inject arguments

    -
    - -
    -
    - $arguments - : array<string|int, mixed> - = []
    -
    -

    List of arguments that will be passed alongside of auto-injected ones

    -
    - -
    -
    - - - -
    Return values
    - array<string|int, mixed> - — -

    Return a new list of arguments that holds manually provided and auto-injected arguments

    -
    - -
    @@ -1525,7 +1462,7 @@

    @@ -1570,7 +1507,7 @@

    @@ -1605,7 +1542,7 @@

    diff --git a/docs/files/src-dicontainer.html b/docs/files/src-dicontainer.html new file mode 100644 index 0000000..180d3cb --- /dev/null +++ b/docs/files/src-dicontainer.html @@ -0,0 +1,153 @@ + + + + + Documentation + + + + + + + + + + + + + + + + + + + + +
    +

    Documentation

    + + +
    + +
    + + +
    + +
    +
    + + + + +
    +
      +
    + +
    +

    DIContainer.php

    + +

    Author: Igor Ilić <github@igorilic.net> +Date: 2022-06-05 +Project: PHP-routing

    + + + + + + + +

    + Interfaces, Classes, Traits and Enums + +

    + +
    + +
    DIContainer
    +
    Class used for handling dependency injection for the library
    + + +
    + + + + + + + + +
    +
    +
    +
    +

    Search results

    + +
    +
    +
      +
      +
      +
      +
      +
      + + +
      + + + + + + + + diff --git a/docs/indices/files.html b/docs/indices/files.html index 4f3c024..f5f9124 100644 --- a/docs/indices/files.html +++ b/docs/indices/files.html @@ -94,7 +94,11 @@

      C

      -

      R

      +

      D

      + +

      R

      • Request.php
      • RouteNotFoundException.php
        • diff --git a/docs/js/searchIndex.js b/docs/js/searchIndex.js index 7b651a9..8a81330 100644 --- a/docs/js/searchIndex.js +++ b/docs/js/searchIndex.js @@ -1,6 +1,16 @@ Search.appendIndex( [ { + "fqsen": "\\Gac\\Routing\\DIContainer", + "name": "DIContainer", + "summary": "Class\u0020used\u0020for\u0020handling\u0020dependency\u0020injection\u0020for\u0020the\u0020library", + "url": "classes/Gac-Routing-DIContainer.html" + }, { + "fqsen": "\\Gac\\Routing\\DIContainer\u003A\u003Aget\u0028\u0029", + "name": "get", + "summary": "Method\u0020used\u0020for\u0020handling\u0020dependency\u0020injection", + "url": "classes/Gac-Routing-DIContainer.html#method_get" + }, { "fqsen": "\\Gac\\Routing\\Exceptions\\CallbackNotFound", "name": "CallbackNotFound", "summary": "", @@ -90,11 +100,6 @@ Search.appendIndex( "name": "setup_callback", "summary": "Method\u0020used\u0020to\u0020set\u0020up\u0020callback\u0020properties\u0020for\u0020routes", "url": "classes/Gac-Routing-Routes.html#method_setup_callback" - }, { - "fqsen": "\\Gac\\Routing\\Routes\u003A\u003Adependency_injection\u0028\u0029", - "name": "dependency_injection", - "summary": "Method\u0020used\u0020for\u0020handling\u0020dependency\u0020injection", - "url": "classes/Gac-Routing-Routes.html#method_dependency_injection" }, { "fqsen": "\\Gac\\Routing\\Routes\u003A\u003Aget_path\u0028\u0029", "name": "get_path", @@ -205,11 +210,6 @@ Search.appendIndex( "name": "\\", "summary": "", "url": "namespaces/default.html" - }, { - "fqsen": "\\Gac\\Routing\\Exceptions", - "name": "Exceptions", - "summary": "", - "url": "namespaces/gac-routing-exceptions.html" }, { "fqsen": "\\Gac\\Routing", "name": "Routing", @@ -220,5 +220,10 @@ Search.appendIndex( "name": "Gac", "summary": "", "url": "namespaces/gac.html" + }, { + "fqsen": "\\Gac\\Routing\\Exceptions", + "name": "Exceptions", + "summary": "", + "url": "namespaces/gac-routing-exceptions.html" } ] ); diff --git a/docs/namespaces/gac-routing.html b/docs/namespaces/gac-routing.html index 53f8efe..48ea7de 100644 --- a/docs/namespaces/gac-routing.html +++ b/docs/namespaces/gac-routing.html @@ -112,6 +112,8 @@

        +
        DIContainer
        +
        Class used for handling dependency injection for the library
        Request
        Routes
        diff --git a/docs/packages/Application.html b/docs/packages/Application.html index a3e525f..90d7e62 100644 --- a/docs/packages/Application.html +++ b/docs/packages/Application.html @@ -103,6 +103,8 @@

        +
        DIContainer
        +
        Class used for handling dependency injection for the library
        CallbackNotFound
        RouteNotFoundException
        diff --git a/docs/reports/markers.html b/docs/reports/markers.html index a5f4417..9186bee 100644 --- a/docs/reports/markers.html +++ b/docs/reports/markers.html @@ -117,7 +117,7 @@

        Routes.php

        TODO - 195 + 194 Find a way to not check the number of / as it seems a bit hacky