Skip to content
Snippets Groups Projects
Commit dfda14cb authored by Hahn Axel (hahn)'s avatar Hahn Axel (hahn)
Browse files

update doc for class methods

parent 94f256b9
No related branches found
No related tags found
No related merge requests found
...@@ -2,13 +2,15 @@ ...@@ -2,13 +2,15 @@
<!-- BEGIN DOC-COMMENT H2 ../src/tinyrouter.class.php --> <!-- BEGIN DOC-COMMENT H2 ../src/tinyrouter.class.php -->
## namespace iml ---
## `namespace iml`
Axels first router Axels first router
--------------------------------------------------------------------------------<br> <br> THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE <br> LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR <br> OTHER PARTIES PROVIDE THE PROGRAM ?AS IS? WITHOUT WARRANTY OF ANY KIND, <br> EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED <br> WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE <br> ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. <br> SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY <br> SERVICING, REPAIR OR CORRECTION.<br> <br> --------------------------------------------------------------------------------<br> * --------------------------------------------------------------------------------<br> <br> THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE <br> LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR <br> OTHER PARTIES PROVIDE THE PROGRAM ?AS IS? WITHOUT WARRANTY OF ANY KIND, <br> EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED <br> WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE <br> ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. <br> SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY <br> SERVICING, REPAIR OR CORRECTION.<br> <br> --------------------------------------------------------------------------------<br> *
## public function __construct($aRoutes=[],$sUrl=false) ---
## `public function __construct($aRoutes=[],$sUrl=false)`
constructor constructor
**Parameters:** **Parameters:**
...@@ -22,14 +24,16 @@ string | $sUrl | incoming url ...@@ -22,14 +24,16 @@ string | $sUrl | incoming url
boolean boolean
## protected function _getRoute() ---
## `protected function _getRoute()`
detect last matching route item if no route matches then it returns false detect last matching route item if no route matches then it returns false
**Return:** **Return:**
array array
## public function setRoutes($aRoutes=[]) ---
## `public function setRoutes($aRoutes=[])`
set routes set routes
**Parameters:** **Parameters:**
...@@ -42,7 +46,8 @@ $aRoutes | array | list of [ route, more params ... ] ...@@ -42,7 +46,8 @@ $aRoutes | array | list of [ route, more params ... ]
boolean boolean
## public function setUrl($sUrl) ---
## `public function setUrl($sUrl)`
set incoming url, add the request behind protocol and domain. set incoming url, add the request behind protocol and domain.
**Parameters:** **Parameters:**
...@@ -55,7 +60,8 @@ sUrl | string | url to fetch; /api/v1/productbyid/3424084 ...@@ -55,7 +60,8 @@ sUrl | string | url to fetch; /api/v1/productbyid/3424084
boolean boolean
## public function getUrlParts($sUrl=false) ---
## `public function getUrlParts($sUrl=false)`
helper function: get url request parts as array helper function: get url request parts as array
**Parameters:** **Parameters:**
...@@ -68,35 +74,40 @@ $sUrl | string | url to handle; /api/v1/productbyid/3424084 ...@@ -68,35 +74,40 @@ $sUrl | string | url to handle; /api/v1/productbyid/3424084
array array
## public function getRoute() ---
## `public function getRoute()`
detect last matching route item if no route matches then it returns false detect last matching route item if no route matches then it returns false
**Return:** **Return:**
array|bool array|bool
## public function getCallback() ---
## `public function getCallback()`
return the callback iten of the matching route If no route was matching it returns false return the callback iten of the matching route If no route was matching it returns false
**Return:** **Return:**
{*} {*}
## public function getVars() ---
## `public function getVars()`
return the variables as keys in route parts with starting @ character return the variables as keys in route parts with starting @ character
**Return:** **Return:**
array array
## public function getVar($sVarname) ---
## `public function getVar($sVarname)`
return the variables as keys in route parts with starting @ character return the variables as keys in route parts with starting @ character
**Return:** **Return:**
string string
## public function getSubitems() ---
## `public function getSubitems()`
get an array with next level route entries releative to the current route get an array with next level route entries releative to the current route
**Return:** **Return:**
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment