Merge branch 'develop' into feature/faf_event_service

2026-04-23 18:48:51 +02:00 · 2022-03-15 10:52:45 +01:00
parent 99819527db f4ecdf116a
commit cea6c557ce
932 changed files with 14689 additions and 8581 deletions
--- a/sources/Application/WebPage/JsonPage.php
+++ b/sources/Application/WebPage/JsonPage.php
@@ -0,0 +1,109 @@
+<?php
+/*
+ * @copyright   Copyright (C) 2010-2021 Combodo SARL
+ * @license     http://opensource.org/licenses/AGPL-3.0
+ */
+
+use Combodo\iTop\Service\EventName;
+use Combodo\iTop\Service\EventService;
+
+/**
+ * Class JsonPage
+ *
+ * @author Anne-Catherine Cognet <anne-catherine.cognet@combodo.com>
+ * @author Eric Espie <eric.espie@combodo.com>
+ * @since 3.0.0
+ */
+class JsonPage extends WebPage
+{
+	/** @var array Bags of data to include in the response */
+	protected $aData = [];
+	/**
+	 * @var bool If true, only static::$aData will be output; otherwise data and scripts will be output in a structured object.
+	 * This can be useful when feeding response to a third party lib that doesn't understand the structured format.
+	 */
+	protected $bOutputDataOnly = false;
+
+	/**
+	 * JsonPage constructor.
+	 */
+	public function __construct()
+	{
+		$oKpi = new ExecutionKPI();
+		parent::__construct('');
+		$oKpi->ComputeStats(get_class($this).' creation', 'JsonPage');
+	}
+
+	/**
+	 * @return array
+	 */
+	public function GetData(): array
+	{
+		return $this->aData;
+	}
+
+	/**
+	 * @param array $aData
+	 *
+	 * @return $this
+	 */
+	public function SetData(array $aData)
+	{
+		$this->aData = $aData;
+
+		return $this;
+	}
+
+	/**
+	 * @param array $aDataRow
+	 *
+	 * @return $this
+	 */
+	public function AddData(array $aDataRow)
+	{
+		$this->aData[] = $aDataRow;
+
+		return $this;
+	}
+
+	/**
+	 * @see static::$bOutputDataOnly
+	 * @param bool $bFlag
+	 *
+	 * @return $this
+	 */
+	public function SetOutputDataOnly(bool $bFlag)
+	{
+		$this->bOutputDataOnly = $bFlag;
+
+		return $this;
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	public function output()
+	{
+		$oKpi = new ExecutionKPI();
+		$this->add_header('Content-type: application/json');
+
+		foreach ($this->a_headers as $s_header) {
+			header($s_header);
+		}
+
+		$aScripts = array_merge($this->a_init_scripts, $this->a_scripts, $this->a_ready_scripts);
+
+		$aJson = $this->bOutputDataOnly ? $this->aData : [
+			'data'    => $this->aData,
+			'scripts' => $aScripts,
+		];
+		$sJSON = json_encode($aJson);
+		$oKpi->ComputeAndReport(get_class($this).' output');
+
+		echo $sJSON;
+		$oKpi->ComputeAndReport('Echoing ('.round(strlen($sJSON) / 1024).' Kb)');
+		$this->FireAfterDisplayEvent();
+		ExecutionKPI::ReportStats();
+	}
+
+}