N°6208 - Router: Move to Service folder

This commit is contained in:
Molkobain
2023-04-19 17:14:16 +02:00
parent e3252da5a9
commit f026e6f4b8
16 changed files with 47 additions and 43 deletions

View File

@@ -24,7 +24,7 @@ use Combodo\iTop\Application\UI\DisplayBlock\BlockChartAjaxBars\BlockChartAjaxBa
use Combodo\iTop\Application\UI\DisplayBlock\BlockChartAjaxPie\BlockChartAjaxPie;
use Combodo\iTop\Application\UI\DisplayBlock\BlockCsv\BlockCsv;
use Combodo\iTop\Application\UI\DisplayBlock\BlockList\BlockList;
use Combodo\iTop\Router\Router;
use Combodo\iTop\Service\Router\Router;
require_once(APPROOT.'/application/utils.inc.php');

View File

@@ -438,9 +438,6 @@ return array(
'Combodo\\iTop\\Renderer\\FieldRenderer' => $baseDir . '/sources/Renderer/FieldRenderer.php',
'Combodo\\iTop\\Renderer\\FormRenderer' => $baseDir . '/sources/Renderer/FormRenderer.php',
'Combodo\\iTop\\Renderer\\RenderingOutput' => $baseDir . '/sources/Renderer/RenderingOutput.php',
'Combodo\\iTop\\Router\\Exception\\RouteNotFoundException' => $baseDir . '/sources/Router/Exception/RouteNotFoundException.php',
'Combodo\\iTop\\Router\\Exception\\RouterException' => $baseDir . '/sources/Router/Exception/RouterException.php',
'Combodo\\iTop\\Router\\Router' => $baseDir . '/sources/Router/Router.php',
'Combodo\\iTop\\Service\\Base\\ObjectRepository' => $baseDir . '/sources/Service/Base/ObjectRepository.php',
'Combodo\\iTop\\Service\\Base\\iDataPostProcessor' => $baseDir . '/sources/Service/Base/iDataPostProcessor.php',
'Combodo\\iTop\\Service\\Events\\Description\\EventDataDescription' => $baseDir . '/sources/Service/Events/Description/EventDataDescription.php',
@@ -455,6 +452,9 @@ return array(
'Combodo\\iTop\\Service\\Links\\LinkSetModel' => $baseDir . '/sources/Service/Links/LinkSetModel.php',
'Combodo\\iTop\\Service\\Links\\LinkSetRepository' => $baseDir . '/sources/Service/Links/LinkSetRepository.php',
'Combodo\\iTop\\Service\\Links\\LinksBulkDataPostProcessor' => $baseDir . '/sources/Service/Links/LinksBulkDataPostProcessor.php',
'Combodo\\iTop\\Service\\Router\\Exception\\RouteNotFoundException' => $baseDir . '/sources/Service/Router/Exception/RouteNotFoundException.php',
'Combodo\\iTop\\Service\\Router\\Exception\\RouterException' => $baseDir . '/sources/Service/Router/Exception/RouterException.php',
'Combodo\\iTop\\Service\\Router\\Router' => $baseDir . '/sources/Service/Router/Router.php',
'CompileCSSService' => $baseDir . '/application/compilecssservice.class.inc.php',
'Composer\\InstalledVersions' => $vendorDir . '/composer/InstalledVersions.php',
'Config' => $baseDir . '/core/config.class.inc.php',

View File

@@ -803,9 +803,6 @@ class ComposerStaticInit7f81b4a2a468a061c306af5e447a9a9f
'Combodo\\iTop\\Renderer\\FieldRenderer' => __DIR__ . '/../..' . '/sources/Renderer/FieldRenderer.php',
'Combodo\\iTop\\Renderer\\FormRenderer' => __DIR__ . '/../..' . '/sources/Renderer/FormRenderer.php',
'Combodo\\iTop\\Renderer\\RenderingOutput' => __DIR__ . '/../..' . '/sources/Renderer/RenderingOutput.php',
'Combodo\\iTop\\Router\\Exception\\RouteNotFoundException' => __DIR__ . '/../..' . '/sources/Router/Exception/RouteNotFoundException.php',
'Combodo\\iTop\\Router\\Exception\\RouterException' => __DIR__ . '/../..' . '/sources/Router/Exception/RouterException.php',
'Combodo\\iTop\\Router\\Router' => __DIR__ . '/../..' . '/sources/Router/Router.php',
'Combodo\\iTop\\Service\\Base\\ObjectRepository' => __DIR__ . '/../..' . '/sources/Service/Base/ObjectRepository.php',
'Combodo\\iTop\\Service\\Base\\iDataPostProcessor' => __DIR__ . '/../..' . '/sources/Service/Base/iDataPostProcessor.php',
'Combodo\\iTop\\Service\\Events\\Description\\EventDataDescription' => __DIR__ . '/../..' . '/sources/Service/Events/Description/EventDataDescription.php',
@@ -820,6 +817,9 @@ class ComposerStaticInit7f81b4a2a468a061c306af5e447a9a9f
'Combodo\\iTop\\Service\\Links\\LinkSetModel' => __DIR__ . '/../..' . '/sources/Service/Links/LinkSetModel.php',
'Combodo\\iTop\\Service\\Links\\LinkSetRepository' => __DIR__ . '/../..' . '/sources/Service/Links/LinkSetRepository.php',
'Combodo\\iTop\\Service\\Links\\LinksBulkDataPostProcessor' => __DIR__ . '/../..' . '/sources/Service/Links/LinksBulkDataPostProcessor.php',
'Combodo\\iTop\\Service\\Router\\Exception\\RouteNotFoundException' => __DIR__ . '/../..' . '/sources/Service/Router/Exception/RouteNotFoundException.php',
'Combodo\\iTop\\Service\\Router\\Exception\\RouterException' => __DIR__ . '/../..' . '/sources/Service/Router/Exception/RouterException.php',
'Combodo\\iTop\\Service\\Router\\Router' => __DIR__ . '/../..' . '/sources/Service/Router/Router.php',
'CompileCSSService' => __DIR__ . '/../..' . '/application/compilecssservice.class.inc.php',
'Composer\\InstalledVersions' => __DIR__ . '/..' . '/composer/InstalledVersions.php',
'Config' => __DIR__ . '/../..' . '/core/config.class.inc.php',

View File

@@ -19,7 +19,7 @@ use Combodo\iTop\Application\UI\Base\Layout\PageContent\PageContentFactory;
use Combodo\iTop\Application\UI\Base\Layout\UIContentBlock;
use Combodo\iTop\Application\UI\Base\Layout\UIContentBlockUIBlockFactory;
use Combodo\iTop\Controller\Base\Layout\ObjectController;
use Combodo\iTop\Router\Router;
use Combodo\iTop\Service\Router\Router;
/**
* Displays a popup welcome message, once per session at maximum

View File

@@ -15,7 +15,7 @@ use Combodo\iTop\Controller\Base\Layout\ObjectController;
use Combodo\iTop\Controller\PreferencesController;
use Combodo\iTop\Renderer\Console\ConsoleBlockRenderer;
use Combodo\iTop\Renderer\Console\ConsoleFormRenderer;
use Combodo\iTop\Router\Router;
use Combodo\iTop\Service\Router\Router;
require_once('../approot.inc.php');

View File

@@ -31,7 +31,7 @@ class AjaxDataProvider extends SimpleDataProvider
const DEFAULT_MAX_RESULTS = 25;
/**
* @see \Combodo\iTop\Router\Router
* @see \Combodo\iTop\Service\Router\Router
* @var string $sAjaxRoute Router route name
*/
private string $sRoute;

View File

@@ -85,7 +85,7 @@ class SetUIBlockFactory extends AbstractUIBlockFactory
* If a group field is provided, options will be grouped according to this setting.
*
* @param string $sId Block identifier
* @param string $sAjaxRoute Ajax route @see \Combodo\iTop\Router\Router
* @param string $sAjaxRoute Ajax route @see \Combodo\iTop\Service\Router\Router
* @param array $aAjaxRouteParams Url query parameters
* @param string $sLabelFields Field used for label
* @param string $sValueField Field used for value

View File

@@ -11,7 +11,7 @@ use Combodo\iTop\Application\UI\Base\Component\PopoverMenu\PopoverMenuItem\Popov
use Combodo\iTop\Application\UI\Base\tUIContentAreas;
use Combodo\iTop\Application\UI\Base\UIBlock;
use Combodo\iTop\Core\MetaModel\FriendlyNameType;
use Combodo\iTop\Router\Router;
use Combodo\iTop\Service\Router\Router;
use DBObject;
use Dict;
use MetaModel;

View File

@@ -18,7 +18,7 @@ use Combodo\iTop\Application\UI\Base\Component\QuickCreate\QuickCreateHelper;
use Combodo\iTop\Application\UI\Base\Layout\Object\ObjectSummary;
use Combodo\iTop\Application\UI\Base\Layout\PageContent\PageContentFactory;
use Combodo\iTop\Controller\AbstractController;
use Combodo\iTop\Router\Router;
use Combodo\iTop\Service\Router\Router;
use Combodo\iTop\Service\Base\ObjectRepository;
use CoreCannotSaveObjectException;
use DeleteException;

View File

@@ -11,7 +11,7 @@ use cmdbAbstractObject;
use Combodo\iTop\Application\Helper\LegacyFormHelper;
use Combodo\iTop\Application\UI\Base\Component\Form\FormUIBlockFactory;
use Combodo\iTop\Controller\AbstractController;
use Combodo\iTop\Router\Router;
use Combodo\iTop\Service\Router\Router;
use Combodo\iTop\Service\Base\ObjectRepository;
use Exception;
use JsonPage;

View File

@@ -4,7 +4,7 @@
* @license http://opensource.org/licenses/AGPL-3.0
*/
namespace Combodo\iTop\Router\Exception;
namespace Combodo\iTop\Service\Router\Exception;
/**
* Class RouteNotFoundException
@@ -12,7 +12,7 @@ namespace Combodo\iTop\Router\Exception;
* Means that a said route (eg. "object.modify") could not be found
*
* @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
* @package Combodo\iTop\Router\Exception
* @package Combodo\iTop\Service\Router\Exception
* @since 3.1.0
* @internal
*/

View File

@@ -4,7 +4,7 @@
* @license http://opensource.org/licenses/AGPL-3.0
*/
namespace Combodo\iTop\Router\Exception;
namespace Combodo\iTop\Service\Router\Exception;
use Exception;
@@ -14,7 +14,7 @@ use Exception;
* Base router exception class in case we need to catch all kind of router exceptions (see derived exceptions)
*
* @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
* @package Combodo\iTop\Router\Exception
* @package Combodo\iTop\Service\Router\Exception
* @since 3.1.0
* @internal
*/

View File

@@ -4,9 +4,9 @@
* @license http://opensource.org/licenses/AGPL-3.0
*/
namespace Combodo\iTop\Router;
namespace Combodo\iTop\Service\Router;
use Combodo\iTop\Router\Exception\RouteNotFoundException;
use Combodo\iTop\Service\Router\Exception\RouteNotFoundException;
use ReflectionClass;
use ReflectionMethod;
use utils;
@@ -17,13 +17,13 @@ use utils;
* Service to find the corresponding controller / method for a given "route" parameter
*
* @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
* @package Combodo\iTop\Router
* @package Combodo\iTop\Service\Router
* @since 3.1.0
* @internal
*/
class Router
{
/** @var \Combodo\iTop\Router\Router|null Singleton instance */
/** @var \Combodo\iTop\Service\Router\Router|null Singleton instance */
protected static ?Router $oSingleton = null;
/**
@@ -81,7 +81,7 @@ class Router
/**********************/
/**
* Singleton pattern, can't use the constructor. Use {@see \Combodo\iTop\Router\Router::GetInstance()} instead.
* Singleton pattern, can't use the constructor. Use {@see \Combodo\iTop\Service\Router\Router::GetInstance()} instead.
*
* @return void
*/

View File

@@ -6,7 +6,7 @@
use Combodo\iTop\Controller\AbstractController;
use Combodo\iTop\Core\MetaModel\FriendlyNameType;
use Combodo\iTop\Router\Router;
use Combodo\iTop\Service\Router\Router;
/**
* Class SummaryCardService

View File

@@ -1,6 +1,10 @@
<?php
/*
* @copyright Copyright (C) 2010-2023 Combodo SARL
* @license http://opensource.org/licenses/AGPL-3.0
*/
namespace Combodo\iTop\Test\UnitTest\Application\Service;
namespace Combodo\iTop\Test\UnitTest\Service\Events;
use Combodo\iTop\Service\Events\Description\EventDescription;
use Combodo\iTop\Service\Events\EventData;
@@ -96,8 +100,8 @@ class EventTest extends ItopTestCase
return array(
'method' => array(array($oReceiver, 'OnEvent1')),
'static' => array('Combodo\iTop\Test\UnitTest\Application\Service\TestEventReceiver::OnStaticEvent1'),
'static2' => array(array('Combodo\iTop\Test\UnitTest\Application\Service\TestEventReceiver', 'OnStaticEvent1')),
'static' => array('Combodo\iTop\Test\UnitTest\Service\Events\TestEventReceiver::OnStaticEvent1'),
'static2' => array(array('Combodo\iTop\Test\UnitTest\Service\Events\TestEventReceiver', 'OnStaticEvent1')),
);
}
@@ -137,13 +141,13 @@ class EventTest extends ItopTestCase
$oReceiver = new TestEventReceiver();
EventService::RegisterListener('event_a', array($oReceiver, 'OnEvent1'));
EventService::RegisterListener('event_a', array($oReceiver, 'OnEvent2'));
EventService::RegisterListener('event_a', array('Combodo\iTop\Test\UnitTest\Application\Service\TestEventReceiver', 'OnStaticEvent1'));
EventService::RegisterListener('event_a', 'Combodo\iTop\Test\UnitTest\Application\Service\TestEventReceiver::OnStaticEvent2');
EventService::RegisterListener('event_a', array('Combodo\iTop\Test\UnitTest\Service\Events\TestEventReceiver', 'OnStaticEvent1'));
EventService::RegisterListener('event_a', 'Combodo\iTop\Test\UnitTest\Service\Events\TestEventReceiver::OnStaticEvent2');
EventService::RegisterListener('event_b', array($oReceiver, 'OnEvent1'));
EventService::RegisterListener('event_b', array($oReceiver, 'OnEvent2'));
EventService::RegisterListener('event_b', array('Combodo\iTop\Test\UnitTest\Application\Service\TestEventReceiver', 'OnStaticEvent1'));
EventService::RegisterListener('event_b', 'Combodo\iTop\Test\UnitTest\Application\Service\TestEventReceiver::OnStaticEvent2');
EventService::RegisterListener('event_b', array('Combodo\iTop\Test\UnitTest\Service\Events\TestEventReceiver', 'OnStaticEvent1'));
EventService::RegisterListener('event_b', 'Combodo\iTop\Test\UnitTest\Service\Events\TestEventReceiver::OnStaticEvent2');
self::$iEventCalls = 0;
EventService::FireEvent(new EventData('event_a'));
@@ -234,10 +238,10 @@ class EventTest extends ItopTestCase
$oReceiver = new TestEventReceiver();
EventService::RegisterListener('event1', [$oReceiver, 'OnEvent1'], 'A', [], null, 0);
EventService::RegisterListener('event1', [$oReceiver, 'OnEvent2'], 'A', [], null, 1);
EventService::RegisterListener('event1', 'Combodo\iTop\Test\UnitTest\Application\Service\TestEventReceiver::OnStaticEvent1', null, [], null, 2);
EventService::RegisterListener('event1', 'Combodo\iTop\Test\UnitTest\Service\Events\TestEventReceiver::OnStaticEvent1', null, [], null, 2);
EventService::RegisterListener('event2', [$oReceiver, 'OnEvent1'], 'A', [], null, 1);
EventService::RegisterListener('event2', 'Combodo\iTop\Test\UnitTest\Application\Service\TestEventReceiver::OnStaticEvent1', null, [], null, 2);
EventService::RegisterListener('event2', 'Combodo\iTop\Test\UnitTest\Service\Events\TestEventReceiver::OnStaticEvent1', null, [], null, 2);
EventService::RegisterListener('event2', [$oReceiver, 'OnEvent2'], 'B', [], null, 0);
self::$iEventCalls = 0;

View File

@@ -4,10 +4,10 @@
* @license http://opensource.org/licenses/AGPL-3.0
*/
namespace Combodo\iTop\Test\UnitTest\useCombodo\iTop\Router;
namespace Combodo\iTop\Test\UnitTest\Service\Router;
use Combodo\iTop\Router\Exception\RouteNotFoundException;
use Combodo\iTop\Router\Router;
use Combodo\iTop\Service\Router\Exception\RouteNotFoundException;
use Combodo\iTop\Service\Router\Router;
use Combodo\iTop\Test\UnitTest\ItopTestCase;
use utils;
@@ -16,12 +16,12 @@ use utils;
*
* @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
* @since 3.1.0
* @covers \Combodo\iTop\Router\Router
* @covers \Combodo\iTop\Service\Router\Router
*/
class RouterTest extends ItopTestCase
{
/**
* @covers \Combodo\iTop\Router\Router::GenerateUrl
* @covers \Combodo\iTop\Service\Router\Router::GenerateUrl
* @dataProvider GenerateUrlProvider
*
* @param string $sExpectedUrl URL contains a <APP_ROOT_URL> placeholder that will be replaced with the real app root url at run time
@@ -117,7 +117,7 @@ class RouterTest extends ItopTestCase
/**
* @dataProvider CanDispatchRouteProvider
* @covers \Combodo\iTop\Router\Router::CanDispatchRoute
* @covers \Combodo\iTop\Service\Router\Router::CanDispatchRoute
*
* @param string $sRoute
* @param $bExpectedResult
@@ -168,7 +168,7 @@ class RouterTest extends ItopTestCase
/**
* @dataProvider GetRouteNamespaceProvider
* @covers \Combodo\iTop\Router\Router::GetRouteNamespace
* @covers \Combodo\iTop\Service\Router\Router::GetRouteNamespace
*
* @param string $sRoute
* @param string|null $sExpectedNamespace
@@ -203,7 +203,7 @@ class RouterTest extends ItopTestCase
/**
* @dataProvider GetRouteOperationProvider
* @covers \Combodo\iTop\Router\Router::GetRouteOperation
* @covers \Combodo\iTop\Service\Router\Router::GetRouteOperation
*
* @param string $sRoute
* @param string|null $sExpectedOperation
@@ -238,7 +238,7 @@ class RouterTest extends ItopTestCase
/**
* @dataProvider FindControllerFromRouteNamespaceProvider
* @covers \Combodo\iTop\Router\Router::FindControllerFromRouteNamespace
* @covers \Combodo\iTop\Service\Router\Router::FindControllerFromRouteNamespace
*
* @param string $sRouteNamespace
* @param string $sExpectedControllerFQCN
@@ -271,7 +271,7 @@ class RouterTest extends ItopTestCase
/**
* @dataProvider GetOperationMethodNameFromRouteOperationProvider
* @covers \Combodo\iTop\Router\Router::MakeOperationMethodNameFromOperation
* @covers \Combodo\iTop\Service\Router\Router::MakeOperationMethodNameFromOperation
*
* @param string $sRoute
* @param string $sExpectedMethodName