composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-04-23 02:28:44 +02:00
Code Issues Packages Projects Releases Wiki Activity

Improve PHPDoc

Browse Source
This commit is contained in:
Molkobain
2023-05-03 09:46:45 +02:00
parent 3ce810ee99
commit 99376225de
1 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
sources/Service/Router/Router.php
View File

@@ -15,12 +15,12 @@ use SetupUtils;
/**
* Class Router
*
* Service to find the corresponding controller / method for a given "route" parameter
* Service to find the corresponding controller / method for a given "route" parameter.
*
* @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
* @package Combodo\iTop\Service\Router
* @since 3.1.0
* @internal
* @api
*/
class Router
{
@@ -28,6 +28,7 @@ class Router
protected static ?Router $oSingleton = null;
/**
* @api
* @return $this The singleton instance of the router
*/
public static function GetInstance(): Router
@@ -54,6 +55,9 @@ class Router
}
/**
* Generate a complete URL for a specific route and optional parameters
*
* @api
* @param string $sRoute Code of the route to generate the URL for (eg. "object.modify" => "https://itop/pages/UI.php?route=object.modify")
* @param array $aParams Parameters to add to the URL query string, they will be URL-encoded automatically.
* Note that only scalars and arrays are supported.