From f76d4782636b86e6d99b0a829530df9b90a3552b Mon Sep 17 00:00:00 2001 From: Igor Ilic Date: Fri, 7 Apr 2023 21:09:32 +0000 Subject: [PATCH] [AUTO] Update documentation --- docs/classes/Gac-Routing-Request.html | 60 +++++++-- docs/classes/Gac-Routing-Routes.html | 175 ++++++++++++++++++++------ docs/js/searchIndex.js | 25 +++- docs/reports/markers.html | 2 +- 4 files changed, 209 insertions(+), 53 deletions(-) diff --git a/docs/classes/Gac-Routing-Request.html b/docs/classes/Gac-Routing-Request.html index 93f03d6..36f8301 100644 --- a/docs/classes/Gac-Routing-Request.html +++ b/docs/classes/Gac-Routing-Request.html @@ -164,7 +164,7 @@

 : array<string|int, mixed>|string|null -
Returns list of all the header items or a value of a specific item
+
Returns list of all the header items or a value of a specified key.
send() @@ -180,6 +180,13 @@

Sets the header status code for the response
+
+ get_request_headers() + +  : array<string|int, mixed> +
+
Method used for getting all request headers
+
parse_patch_and_put_request_data() @@ -333,7 +340,7 @@

@@ -389,17 +396,19 @@

-

Returns list of all the header items or a value of a specific item

+

Returns list of all the header items or a value of a specified key.

public headers([string $key = '' ]) : array<string|int, mixed>|string|null - +

It will return NULL if the specified key can't be found.

+
+

Parameters
@@ -436,7 +445,7 @@

@@ -490,7 +499,7 @@

@@ -532,6 +541,41 @@

Return values
+ +
+

+ get_request_headers() + +

+ + +

Method used for getting all request headers

+ + + private + get_request_headers() : array<string|int, mixed> + + + + + +
Return values
+ array<string|int, mixed> + — +

It will return an array containing all the header values or an empty array

+
+ +
Request.php : - 108 + 139 diff --git a/docs/classes/Gac-Routing-Routes.html b/docs/classes/Gac-Routing-Routes.html index 42f034d..f5ecaae 100644 --- a/docs/classes/Gac-Routing-Routes.html +++ b/docs/classes/Gac-Routing-Routes.html @@ -143,6 +143,13 @@

 = 'GET'

+
+ +
+ OPTIONS + +  = 'OPTIONS' +
@@ -234,7 +241,7 @@

 : Routes

-
Wrapper method used for adding new POST routes
+
Wrapper method used for adding new DELETE routes
get() @@ -264,12 +271,19 @@

Method used to set the middlewares for routes
+
+ options() + +  : Routes +
+
Wrapper method used for adding new OPTIONS routes
+
patch()  : Routes
-
Wrapper method used for adding new POS routes
+
Wrapper method used for adding new PATCH routes
post() @@ -290,7 +304,7 @@

 : Routes

-
Wrapper method used for adding new POST routes
+
Wrapper method used for adding new PUT routes
route() @@ -332,7 +346,7 @@

 : array<string|int, mixed>

-
+
Method used for getting a list of arguments for a route
setup_callback() @@ -408,6 +422,35 @@

+ +
+

+ OPTIONS + +

+ + + + + + public + string + OPTIONS + = 'OPTIONS' + + + + +

OPTIONS Constant representing a OPTIONS request method

+
+ + +

@@ -520,7 +563,7 @@

@@ -554,7 +597,7 @@

@@ -588,7 +631,7 @@

@@ -622,7 +665,7 @@

@@ -656,7 +699,7 @@

@@ -690,7 +733,7 @@

@@ -728,7 +771,7 @@

@@ -761,7 +804,7 @@

@@ -824,7 +867,7 @@

@@ -871,11 +914,11 @@

-

Wrapper method used for adding new POST routes

+

Wrapper method used for adding new DELETE routes

public @@ -927,7 +970,7 @@

@@ -983,7 +1026,7 @@

@@ -1018,7 +1061,7 @@

@@ -1077,7 +1120,7 @@

@@ -1110,6 +1153,62 @@

Return values
+

+
+

+ options() + +

+ + +

Wrapper method used for adding new OPTIONS routes

+ + + public + options(string $path[, callable|array<string|int, mixed>|string|null $callback = NULL ]) : Routes + + +
Parameters
+
+
+ $path + : string +
+
+

Path for the route

+
+ +
+
+ $callback + : callable|array<string|int, mixed>|string|null + = NULL
+
+

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

+
+ +
+
+ + + +
Return values
+ Routes + — +

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

+
+ +
-

Wrapper method used for adding new POS routes

+

Wrapper method used for adding new PATCH routes

public @@ -1180,7 +1279,7 @@

@@ -1236,7 +1335,7 @@

@@ -1283,11 +1382,11 @@

-

Wrapper method used for adding new POST routes

+

Wrapper method used for adding new PUT routes

public @@ -1339,7 +1438,7 @@

@@ -1404,7 +1503,7 @@

@@ -1449,7 +1548,7 @@

@@ -1510,7 +1609,7 @@

@@ -1555,7 +1654,7 @@

@@ -1590,17 +1689,17 @@

- +

Method used for getting a list of arguments for a route

+ private get_route_arguments(array<string|int, mixed> $route, string $path) : array<string|int, mixed> -
- +

Parameters
@@ -1608,16 +1707,14 @@
Parameters
: array<string|int, mixed>
-
- +
$path : string
-
- +
@@ -1642,7 +1739,7 @@

diff --git a/docs/js/searchIndex.js b/docs/js/searchIndex.js index 17e189a..69a2ade 100644 --- a/docs/js/searchIndex.js +++ b/docs/js/searchIndex.js @@ -38,8 +38,13 @@ Search.appendIndex( }, { "fqsen": "\\Gac\\Routing\\Request\u003A\u003Aheaders\u0028\u0029", "name": "headers", - "summary": "Returns\u0020list\u0020of\u0020all\u0020the\u0020header\u0020items\u0020or\u0020a\u0020value\u0020of\u0020a\u0020specific\u0020item", + "summary": "Returns\u0020list\u0020of\u0020all\u0020the\u0020header\u0020items\u0020or\u0020a\u0020value\u0020of\u0020a\u0020specified\u0020key.", "url": "classes/Gac-Routing-Request.html#method_headers" + }, { + "fqsen": "\\Gac\\Routing\\Request\u003A\u003Aget_request_headers\u0028\u0029", + "name": "get_request_headers", + "summary": "Method\u0020used\u0020for\u0020getting\u0020all\u0020request\u0020headers", + "url": "classes/Gac-Routing-Request.html#method_get_request_headers" }, { "fqsen": "\\Gac\\Routing\\Request\u003A\u003Astatus\u0028\u0029", "name": "status", @@ -98,7 +103,7 @@ Search.appendIndex( }, { "fqsen": "\\Gac\\Routing\\Routes\u003A\u003Aget_route_arguments\u0028\u0029", "name": "get_route_arguments", - "summary": "", + "summary": "Method\u0020used\u0020for\u0020getting\u0020a\u0020list\u0020of\u0020arguments\u0020for\u0020a\u0020route", "url": "classes/Gac-Routing-Routes.html#method_get_route_arguments" }, { "fqsen": "\\Gac\\Routing\\Routes\u003A\u003Asetup_callback\u0028\u0029", @@ -138,18 +143,23 @@ Search.appendIndex( }, { "fqsen": "\\Gac\\Routing\\Routes\u003A\u003Aput\u0028\u0029", "name": "put", - "summary": "Wrapper\u0020method\u0020used\u0020for\u0020adding\u0020new\u0020POST\u0020routes", + "summary": "Wrapper\u0020method\u0020used\u0020for\u0020adding\u0020new\u0020PUT\u0020routes", "url": "classes/Gac-Routing-Routes.html#method_put" }, { "fqsen": "\\Gac\\Routing\\Routes\u003A\u003Apatch\u0028\u0029", "name": "patch", - "summary": "Wrapper\u0020method\u0020used\u0020for\u0020adding\u0020new\u0020POS\u0020routes", + "summary": "Wrapper\u0020method\u0020used\u0020for\u0020adding\u0020new\u0020PATCH\u0020routes", "url": "classes/Gac-Routing-Routes.html#method_patch" }, { "fqsen": "\\Gac\\Routing\\Routes\u003A\u003Adelete\u0028\u0029", "name": "delete", - "summary": "Wrapper\u0020method\u0020used\u0020for\u0020adding\u0020new\u0020POST\u0020routes", + "summary": "Wrapper\u0020method\u0020used\u0020for\u0020adding\u0020new\u0020DELETE\u0020routes", "url": "classes/Gac-Routing-Routes.html#method_delete" + }, { + "fqsen": "\\Gac\\Routing\\Routes\u003A\u003Aoptions\u0028\u0029", + "name": "options", + "summary": "Wrapper\u0020method\u0020used\u0020for\u0020adding\u0020new\u0020OPTIONS\u0020routes", + "url": "classes/Gac-Routing-Routes.html#method_options" }, { "fqsen": "\\Gac\\Routing\\Routes\u003A\u003A\u0024prefix", "name": "prefix", @@ -190,6 +200,11 @@ Search.appendIndex( "name": "DELETE", "summary": "", "url": "classes/Gac-Routing-Routes.html#constant_DELETE" + }, { + "fqsen": "\\Gac\\Routing\\Routes\u003A\u003AOPTIONS", + "name": "OPTIONS", + "summary": "", + "url": "classes/Gac-Routing-Routes.html#constant_OPTIONS" }, { "fqsen": "\\Gac\\Routing\\Routes\u003A\u003A\u0024request", "name": "request", diff --git a/docs/reports/markers.html b/docs/reports/markers.html index a6e34f8..7d0a9cf 100644 --- a/docs/reports/markers.html +++ b/docs/reports/markers.html @@ -117,7 +117,7 @@

Routes.php

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