N°2060 [WIP] Initialisation of the portal application: Make AggregatePageBrick work again

This commit is contained in:
Molkobain
2019-07-11 17:45:43 +02:00
parent cd6fe171cd
commit 5a18769336
2 changed files with 135 additions and 147 deletions

View File

@@ -1,147 +0,0 @@
<?php
// Copyright (c) 2010-2018 Combodo SARL
//
// This file is part of iTop.
//
// iTop is free software; you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// iTop is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with iTop. If not, see <http://www.gnu.org/licenses/>
//
namespace Combodo\iTop\Portal\Controller;
use Combodo\iTop\Portal\Helper\ApplicationHelper;
use Silex\Application;
use Symfony\Component\HttpFoundation\Request;
/**
* Class AggregatePageBrickController
*
* @package Combodo\iTop\Portal\Controller
* @author Pierre Goiffon <pierre.goiffon@combodo.com>
* @since 2.5.0
*/
class AggregatePageBrickController
{
/**
* @param \Symfony\Component\HttpFoundation\Request $oRequest
* @param \Silex\Application $oApp
* @param string $sBrickId
*
* @return \Symfony\Component\HttpFoundation\Response
*
* @throws \Exception
*/
public function DisplayAction(Request $oRequest, Application $oApp, $sBrickId)
{
/** @var \Combodo\iTop\Portal\Brick\AggregatePageBrick $oBrick */
$oBrick = ApplicationHelper::GetLoadedBrickFromId($oApp, $sBrickId);
$aPortalInstanceBricks = $oApp['combodo.portal.instance.conf']['bricks'];
$aAggregatePageBricksConf = $oBrick->GetAggregatePageBricks();
$aAggregatePageBricks = $this->GetOrderedAggregatePageBricksObjectsById($aPortalInstanceBricks,
$aAggregatePageBricksConf);
$aTilesRendering = $this->GetBricksTileRendering($oRequest, $oApp, $aAggregatePageBricks);
$sLayoutTemplate = $oBrick->GetPageTemplatePath();
$aData = array(
'oBrick' => $oBrick,
'aggregatepage_bricks' => $aAggregatePageBricks,
'aTilesRendering' => $aTilesRendering,
);
$oResponse = $oApp['twig']->render($sLayoutTemplate, $aData);
return $oResponse;
}
/**
* @param \Combodo\iTop\Portal\Brick\PortalBrick[] $aPortalInstanceBricks
* @param array $aAggregatePageBricksConf
*
* @return array
* @throws \Exception
*/
private function GetOrderedAggregatePageBricksObjectsById($aPortalInstanceBricks, $aAggregatePageBricksConf)
{
$aAggregatePageBricks = array();
foreach ($aAggregatePageBricksConf as $sBrickId => $iBrickRank)
{
$oPortalBrick = $this->GetBrickFromId($aPortalInstanceBricks, $sBrickId);
if (!isset($oPortalBrick))
{
throw new \Exception("AggregatePageBrick : non existing brick '$sBrickId'");
}
$aAggregatePageBricks[] = $oPortalBrick;
}
return $aAggregatePageBricks;
}
/**
* @param \Combodo\iTop\Portal\Brick\PortalBrick[] $aBrickList
* @param string $sBrickId
*
* @return \Combodo\iTop\Portal\Brick\PortalBrick found brick using the given id, null if not found
*/
private function GetBrickFromId($aBrickList, $sBrickId)
{
$aFilteredBricks = array_filter(
$aBrickList,
function ($oSearchBrick) use ($sBrickId) {
return ($oSearchBrick->GetId() == $sBrickId);
}
);
$oFoundBrick = null;
if (count($aFilteredBricks) > 0)
{
$oFoundBrick = reset($aFilteredBricks);
}
return $oFoundBrick;
}
/**
* @param \Symfony\Component\HttpFoundation\Request $oRequest
* @param \Silex\Application $oApp
* @param \Combodo\iTop\Portal\Brick\PortalBrick[] $aBricks
*
* @return array rendering for each included tile (key = brick id, value = rendering)
*/
private function GetBricksTileRendering(Request $oRequest, Application $oApp, $aBricks)
{
$aTilesRendering = array();
foreach ($aBricks as $oBrick)
{
if ($oBrick->GetTileControllerAction() !== null)
{
$aControllerActionParts = explode('::', $oBrick->GetTileControllerAction());
if (count($aControllerActionParts) !== 2)
{
$oApp->abort(500,
'Tile controller action must be of form "\Namespace\ControllerClass::FunctionName" for brick "'.$oBrick->GetId().'"');
}
$sControllerName = $aControllerActionParts[0];
$sControllerAction = $aControllerActionParts[1];
$oController = new $sControllerName($oRequest, $oApp, $oBrick->GetId());
$aTilesRendering[$oBrick->GetId()] = $oController->$sControllerAction($oRequest, $oApp,
$oBrick->GetId());
}
}
return $aTilesRendering;
}
}

View File

@@ -0,0 +1,135 @@
<?php
/**
* Copyright (C) 2013-2019 Combodo SARL
*
* This file is part of iTop.
*
* iTop is free software; you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* iTop is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
*
*
*/
namespace Combodo\iTop\Portal\Controller;
use Exception;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Exception\HttpException;
/**
* Class AggregatePageBrickController
*
* @package Combodo\iTop\Portal\Controller
* @author Pierre Goiffon <pierre.goiffon@combodo.com>
* @author Stephen Abello <stephen.abello@combodo.com>
* @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
* @since 2.5.0
*/
class AggregatePageBrickController extends BrickController
{
/**
* @param \Symfony\Component\HttpFoundation\Request $oRequest
* @param string $sBrickId
*
* @return \Symfony\Component\HttpFoundation\Response
*
* @throws \Combodo\iTop\Portal\Brick\BrickNotFoundException
* @throws \Exception
*/
public function DisplayAction(Request $oRequest, $sBrickId)
{
/** @var \Combodo\iTop\Portal\Brick\BrickCollection $oBrickCollection */
$oBrickCollection = $this->get('brick_collection');
/** @var \Combodo\iTop\Portal\Brick\AggregatePageBrick $oBrick */
$oBrick = $oBrickCollection->GetBrickById($sBrickId);
$aAggregatePageBricksConf = $oBrick->GetAggregatePageBricks();
$aAggregatePageBricks = $this->GetOrderedAggregatePageBricksObjectsById($aAggregatePageBricksConf);
$aTilesRendering = $this->GetBricksTileRendering($oRequest, $aAggregatePageBricks);
$sLayoutTemplate = $oBrick->GetPageTemplatePath();
$aData = array(
'oBrick' => $oBrick,
'aggregatepage_bricks' => $aAggregatePageBricks,
'aTilesRendering' => $aTilesRendering,
);
$oResponse = $this->render($sLayoutTemplate, $aData);
return $oResponse;
}
/**
* @param array $aAggregatePageBricksConf
*
* @return array
* @throws \Combodo\iTop\Portal\Brick\BrickNotFoundException
* @throws \Exception
*/
private function GetOrderedAggregatePageBricksObjectsById($aAggregatePageBricksConf)
{
/** @var \Combodo\iTop\Portal\Brick\BrickCollection $oBrickCollection */
$oBrickCollection = $this->get('brick_collection');
$aAggregatePageBricks = array();
foreach ($aAggregatePageBricksConf as $sBrickId => $iBrickRank)
{
$oPortalBrick = $oBrickCollection->GetBrickById($sBrickId);
if (!isset($oPortalBrick))
{
throw new Exception("AggregatePageBrick : non existing brick '$sBrickId'");
}
$aAggregatePageBricks[] = $oPortalBrick;
}
return $aAggregatePageBricks;
}
/**
* @param \Symfony\Component\HttpFoundation\Request $oRequest
* @param \Combodo\iTop\Portal\Brick\PortalBrick[] $aBricks
*
* @return array rendering for each included tile (key = brick id, value = rendering)
*/
private function GetBricksTileRendering(Request $oRequest, $aBricks)
{
$aTilesRendering = array();
foreach ($aBricks as $oBrick)
{
if ($oBrick->GetTileControllerAction() !== null)
{
$aControllerActionParts = explode('::', $oBrick->GetTileControllerAction());
if (count($aControllerActionParts) !== 2)
{
throw new HttpException(Response::HTTP_INTERNAL_SERVER_ERROR, 'Tile controller action must be of form "\Namespace\ControllerClass::FunctionName" for brick "'.$oBrick->GetId().'"');
}
$aRouteParams = array();
// Add sBrickId in the route params as it is necessary for each brick actions
if (is_a($aControllerActionParts[0], BrickController::class, true))
{
$aRouteParams['sBrickId'] = $oBrick->GetId();
}
/** @var \Symfony\Component\HttpFoundation\Response $oResponse */
$oResponse = $this->forward($oBrick->GetTileControllerAction(), $aRouteParams, $oRequest->query->all());
$aTilesRendering[$oBrick->GetId()] = $oResponse->getContent();
}
}
return $aTilesRendering;
}
}