diff --git a/docs/classes/Gac-Routing-DIContainer.html b/docs/classes/Gac-Routing-DIContainer.html index 022bdad..f0c950a 100644 --- a/docs/classes/Gac-Routing-DIContainer.html +++ b/docs/classes/Gac-Routing-DIContainer.html @@ -54,7 +54,7 @@

Doc Menu + private static int @@ -430,6 +442,8 @@

+ +
+ private static string @@ -465,6 +480,8 @@

+ +

@@ -503,6 +520,9 @@

+ + +
Return values
@@ -543,6 +563,9 @@

+ + +
Return values
@@ -583,6 +606,9 @@

+ + +
Return values
@@ -623,6 +649,9 @@

+ + +
Return values
@@ -663,6 +692,7 @@

+

Tags @@ -681,6 +711,8 @@
+ +
Return values
string|bool @@ -718,6 +750,7 @@

+

Parameters
@@ -757,6 +790,8 @@
+ +
Return values
Response @@ -794,6 +829,7 @@

+

Parameters
@@ -809,6 +845,8 @@
Parameters
+ +
Return values
Response @@ -846,6 +884,7 @@

+

Parameters
@@ -861,6 +900,8 @@
Parameters
+ +
Return values
Response @@ -898,6 +939,7 @@

+

Parameters
@@ -913,6 +955,8 @@
Parameters
+ +
Return values
Response @@ -950,6 +994,7 @@

+

Parameters
@@ -965,6 +1010,8 @@
Parameters
+ +
Return values
Response @@ -1002,6 +1049,7 @@

+

Parameters
@@ -1026,6 +1074,8 @@
Parameters
+ +
Return values
Response @@ -1063,6 +1113,7 @@

+

Parameters
@@ -1087,6 +1138,8 @@
Parameters
+ +
Return values
Response @@ -1124,6 +1177,7 @@

+

Parameters
@@ -1140,6 +1194,8 @@
Parameters
+ +
@@ -1254,30 +1310,30 @@
Parameters
  • Properties
  • Methods
    • diff --git a/docs/classes/Gac-Routing-Routes.html b/docs/classes/Gac-Routing-Routes.html index 891b051..c862fd0 100644 --- a/docs/classes/Gac-Routing-Routes.html +++ b/docs/classes/Gac-Routing-Routes.html @@ -54,7 +54,7 @@

    Doc Menu

    -

    Callback method, an anonymous function or a class and method name to be executed

    +

    The callback function, class method, or callable for the route.

    @@ -919,7 +966,7 @@
    Parameters
    : string|array<string|int, mixed>|null = self::GET
    -

    Allowed request method(s) (GET, POST, PUT, PATCH, DELETE)

    +

    The HTTP methods the route responds to (e.g., GET, POST).

    @@ -928,6 +975,8 @@
    Parameters
    + +
    -

    Method used to append more routes to the main route handler

    +

    Appends additional routes to the main route handler.

    public @@ -956,6 +1005,7 @@

    +

    Parameters
    @@ -963,7 +1013,7 @@
    Parameters
    : array<string|int, mixed>
    -

    List of routes from other route classes

    +

    List of routes from other route classes.

    @@ -971,11 +1021,13 @@
    Parameters
    + +
    Return values
    Routes — -

    Returns an instance of itself so that other methods could be chained onto it

    +

    Returns the current Routes instance to allow method chaining.

    @@ -995,11 +1047,11 @@

    -

    Wrapper method used for adding new DELETE routes

    +

    Wrapper method for adding a new DELETE route.

    public @@ -1008,6 +1060,7 @@

    +

    Parameters
    @@ -1015,7 +1068,7 @@
    Parameters
    : string
    -

    Path for the route

    +

    The URL path for the route.

    @@ -1024,7 +1077,7 @@
    Parameters
    : callable|array<string|int, mixed>|string|null = NULL

    -

    Callback method, an anonymous function or a class and method name to be executed

    +

    The callback function, class method, or callable for the route.

    @@ -1032,11 +1085,13 @@
    Parameters
    + +
    Return values
    Routes — -

    Returns an instance of itself so that other methods could be chained onto it

    +

    Returns the current Routes instance to allow method chaining.

    @@ -1056,11 +1111,11 @@

    -

    Wrapper method used for adding new GET routes

    +

    Wrapper method for adding a new GET route.

    public @@ -1069,6 +1124,7 @@

    +

    Parameters
    @@ -1076,7 +1132,7 @@
    Parameters
    : string
    -

    Path for the route

    +

    The URL path for the route.

    @@ -1085,7 +1141,7 @@
    Parameters
    : callable|array<string|int, mixed>|string|null = NULL

    -

    Callback method, an anonymous function or a class and method name to be executed

    +

    The callback function, class method, or callable for the route.

    @@ -1093,11 +1149,13 @@
    Parameters
    + +
    Return values
    Routes — -

    Returns an instance of itself so that other methods could be chained onto it

    +

    Returns the current Routes instance to allow method chaining.

    @@ -1117,11 +1175,11 @@

    -

    Method used for fetching a list of all the created routes

    +

    Retrieves a list of all defined routes.

    public @@ -1132,12 +1190,15 @@

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

    Return the list of defined routes

    +

    The list of registered routes.

    @@ -1157,11 +1218,11 @@

    -

    Method used to handle execution of routes and middlewares

    +

    Handles the execution of the routes and their associated middlewares.

    public @@ -1172,6 +1233,7 @@

    +

    Tags @@ -1184,7 +1246,7 @@
    RouteNotFoundException -

    When the route was not found

    +

    If the route cannot be found.

    @@ -1194,13 +1256,15 @@
    CallbackNotFound -

    When the callback for the route was not found

    +

    If the callback for the route cannot be found.

    + +
    -

    Method used to set the middlewares for routes

    +

    Sets the middlewares to be applied to routes.

    public @@ -1229,6 +1293,7 @@

    +

    Parameters
    @@ -1236,7 +1301,7 @@
    Parameters
    : array<string|int, mixed>
    -

    List of middlewares to be executed before the routes

    +

    List of middlewares to be executed before the routes.

    @@ -1244,11 +1309,13 @@
    Parameters
    + +
    Return values
    Routes — -

    Returns an instance of itself so that other methods could be chained onto it

    +

    Returns the current Routes instance to allow method chaining.

    @@ -1268,11 +1335,11 @@

    -

    Wrapper method used for adding new OPTIONS routes

    +

    Wrapper method for adding a new OPTIONS route.

    public @@ -1281,6 +1348,7 @@

    +

    Parameters
    @@ -1288,7 +1356,7 @@
    Parameters
    : string
    -

    Path for the route

    +

    The URL path for the route.

    @@ -1297,7 +1365,7 @@
    Parameters
    : callable|array<string|int, mixed>|string|null = NULL

    -

    Callback method, an anonymous function or a class and method name to be executed

    +

    The callback function, class method, or callable for the route.

    @@ -1305,11 +1373,13 @@
    Parameters
    + +
    Return values
    Routes — -

    Returns an instance of itself so that other methods could be chained onto it

    +

    Returns the current Routes instance to allow method chaining.

    @@ -1329,11 +1399,11 @@

    -

    Wrapper method used for adding new PATCH routes

    +

    Wrapper method for adding a new PATCH route.

    public @@ -1342,6 +1412,7 @@

    +

    Parameters
    @@ -1349,7 +1420,7 @@
    Parameters
    : string
    -

    Path for the route

    +

    The URL path for the route.

    @@ -1358,7 +1429,7 @@
    Parameters
    : callable|array<string|int, mixed>|string|null = NULL

    -

    Callback method, an anonymous function or a class and method name to be executed

    +

    The callback function, class method, or callable for the route.

    @@ -1366,11 +1437,13 @@
    Parameters
    + +
    Return values
    Routes — -

    Returns an instance of itself so that other methods could be chained onto it

    +

    Returns the current Routes instance to allow method chaining.

    @@ -1390,11 +1463,11 @@

    -

    Wrapper method used for adding new POST routes

    +

    Wrapper method for adding a new POST route.

    public @@ -1403,6 +1476,7 @@

    +

    Parameters
    @@ -1410,7 +1484,7 @@
    Parameters
    : string
    -

    Path for the route

    +

    The URL path for the route.

    @@ -1419,7 +1493,7 @@
    Parameters
    : callable|array<string|int, mixed>|string|null = NULL
    -

    Callback method, an anonymous function or a class and method name to be executed

    +

    The callback function, class method, or callable for the route.

    @@ -1427,11 +1501,13 @@
    Parameters
    + +
    Return values
    Routes — -

    Returns an instance of itself so that other methods could be chained onto it

    +

    Returns the current Routes instance to allow method chaining.

    @@ -1451,11 +1527,11 @@

    -

    Method used to set the prefix for routes

    +

    Sets a prefix to be applied to all routes defined within the chain.

    public @@ -1464,6 +1540,7 @@

    +

    Parameters
    @@ -1471,7 +1548,7 @@
    Parameters
    : string = ''
    -

    Prefix to be added to all the routes in the chain.

    +

    The prefix to be added to all routes.

    @@ -1479,11 +1556,13 @@
    Parameters
    + +
    Return values
    Routes — -

    Returns an instance of itself so that other methods could be chained onto it

    +

    Returns the current Routes instance to allow method chaining.

    @@ -1503,11 +1582,11 @@

    -

    Wrapper method used for adding new PUT routes

    +

    Wrapper method for adding a new PUT route.

    public @@ -1516,6 +1595,7 @@

    +

    Parameters
    @@ -1523,7 +1603,7 @@
    Parameters
    : string
    -

    Path for the route

    +

    The URL path for the route.

    @@ -1532,7 +1612,7 @@
    Parameters
    : callable|array<string|int, mixed>|string|null = NULL
    -

    Callback method, an anonymous function or a class and method name to be executed

    +

    The callback function, class method, or callable for the route.

    @@ -1540,11 +1620,13 @@
    Parameters
    + +
    Return values
    Routes — -

    Returns an instance of itself so that other methods could be chained onto it

    +

    Returns the current Routes instance to allow method chaining.

    @@ -1564,11 +1646,11 @@

    -

    Method used for adding new routes into the temporary list when using chained method approach

    +

    Adds a new route to the temporary route list for chained method calls.

    public @@ -1577,6 +1659,7 @@

    +

    Parameters
    @@ -1584,7 +1667,7 @@
    Parameters
    : string
    -

    Path for the route

    +

    The URL path for the route.

    @@ -1593,7 +1676,7 @@
    Parameters
    : callable|array<string|int, mixed>|string|null
    -

    Callback method, an anonymous function or a class and method name to be executed

    +

    The callback function, class method, or callable for the route.

    @@ -1602,7 +1685,7 @@
    Parameters
    : string|array<string|int, mixed> = self::GET
    -

    Allowed request method(s) (GET, POST, PUT, PATCH, DELETE)

    +

    The HTTP methods the route responds to (e.g., GET, POST).

    @@ -1610,11 +1693,13 @@
    Parameters
    + +
    Return values
    Routes — -

    Returns an instance of itself so that other methods could be chained onto it

    +

    Returns the current Routes instance to allow method chaining.

    @@ -1634,19 +1719,20 @@

    -

    Method used for saving routing information into the global $routes array

    +

    Commits temporary routes to the main route list.

    public - save([bool $cleanData = true ]) : self + save([bool $cleanData = true ]) : Routes
    +

    Parameters
    @@ -1654,7 +1740,7 @@
    Parameters
    : bool = true
    -

    should the data from the tmpRoutes be cleared or not when this method runs

    +

    If true, clears the temporary data after saving.

    @@ -1662,9 +1748,15 @@
    Parameters
    + +
    Return values
    - self + Routes + — +

    Returns the current Routes instance to allow method chaining.

    +
    +
    @@ -1682,11 +1774,11 @@

    -

    Method which executes each specified middleware before the route's callback is executed

    +

    Executes all specified middleware before the route's callback.

    private @@ -1695,6 +1787,7 @@

    +

    Parameters
    @@ -1702,7 +1795,7 @@
    Parameters
    : array<string|int, mixed>
    -

    List of middlewares to be executed before accessing the endpoint

    +

    List of middleware to be executed.

    @@ -1721,13 +1814,15 @@
    CallbackNotFound -

    When the specified middleware method is not found

    +

    If the specified middleware is not found.

    + +
    -

    Private method used to fetch the arguments of the route's callback methods

    +

    Retrieves the arguments for the route's callback method.

    private @@ -1756,6 +1851,7 @@

    +

    Parameters
    @@ -1763,17 +1859,21 @@
    Parameters
    : object|array<string|int, mixed>|string
    - +

    The callback function or method.

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

    Returns a list of arguments for a method or null on error

    +

    Returns an associative array of arguments for the callback, or null on error.

    @@ -1793,11 +1893,11 @@

    -

    Method which returns the current path the user is trying to access

    +

    Returns the current URL path.

    private @@ -1808,12 +1908,15 @@

    + + +
    Return values
    string — -

    Returns the current path

    +

    The current path being accessed.

    @@ -1833,11 +1936,11 @@

    -

    Method used for getting a list of arguments for a route

    +

    Retrieves the arguments for a given route based on the URL path.

    private @@ -1846,6 +1949,7 @@

    +

    Parameters
    @@ -1853,22 +1957,32 @@
    Parameters
    : array<string|int, mixed>
    - +

    The route configuration.

    +
    +
    $path : string
    - +

    The current URL path.

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

    An associative array of arguments extracted from the path.

    +
    +

    @@ -1886,11 +2000,11 @@

    -

    Method used to set up callback properties for routes

    +

    Sets up the callback properties for a route.

    private @@ -1899,6 +2013,7 @@

    +

    Parameters
    @@ -1906,7 +2021,7 @@
    Parameters
    : Closure|string|array<string|int, mixed>
    -

    Callback data of a route

    +

    The callback configuration.

    @@ -1914,11 +2029,13 @@
    Parameters
    + +
    Return values
    mixed — -

    Return data needed to execute callback

    +

    Returns the callable data needed to execute the route callback.

    @@ -2037,51 +2154,51 @@
    Return values
  • Constants
  • Properties
  • Methods
    • diff --git a/docs/css/base.css b/docs/css/base.css index 3482dfb..030ba07 100644 --- a/docs/css/base.css +++ b/docs/css/base.css @@ -99,6 +99,7 @@ /* Base Styles -------------------------------------------------- */ body { + background-color: #fff; color: var(--text-color); font-family: var(--font-primary); font-size: var(--text-md); @@ -494,7 +495,7 @@ div.phpdocumentor-list > ul, ol.phpdocumentor-list, ul.phpdocumentor-list { margin-top: 0; - padding-left: var(--spacing-md); + padding-left: var(--spacing-lg); margin-bottom: var(--spacing-sm); } @@ -1215,6 +1216,10 @@ is too big a fix and needs to be done in a new design iteration. word-break: break-all; line-height: normal; } + + .phpdocumentor-on-this-page__content li.-deprecated { + text-decoration: line-through; + } } /* Used for screen readers and such */ diff --git a/docs/css/template.css b/docs/css/template.css index 898b676..875ebaf 100644 --- a/docs/css/template.css +++ b/docs/css/template.css @@ -126,6 +126,10 @@ flex: 0 1 auto; } +.phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry > a.-deprecated { + text-decoration: line-through; +} + .phpdocumentor-table-of-contents .phpdocumentor-table-of-contents__entry > span { flex: 1; white-space: nowrap; diff --git a/docs/files/src-dicontainer.html b/docs/files/src-dicontainer.html index b433001..f55a68e 100644 --- a/docs/files/src-dicontainer.html +++ b/docs/files/src-dicontainer.html @@ -54,7 +54,7 @@

    Doc Menu