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

N°4621 Fix naming inconsistencies in sources/*

Browse Source
This commit is contained in:
Pierre Goiffon
2021-12-31 15:21:08 +01:00
parent 16142bd979
commit 5f575d524a
192 changed files with 384 additions and 380 deletions
Download Patch File Download Diff File Expand all files Collapse all files

69
sources/Application/UI/Base/Component/DataTable/StaticTable/FormTable/FormTable.php Normal file
View File

@@ -0,0 +1,69 @@
<?php
/**
* @copyright Copyright (C) 2010-2021 Combodo SARL
* @license http://opensource.org/licenses/AGPL-3.0
*/
namespace Combodo\iTop\Application\UI\Base\Component\DataTable\StaticTable\FormTable;
use Combodo\iTop\Application\UI\Base\Component\DataTable\StaticTable\FormTableRow\FormTableRow;
use Combodo\iTop\Application\UI\Base\Component\DataTable\StaticTable\StaticTable;
use Combodo\iTop\Application\UI\Base\iUIBlock;
/**
* Class FormTable
*
* @package Combodo\iTop\Application\UI\Base\Component\FormTable
*/
class FormTable extends StaticTable
{
// Overloaded constants
public const BLOCK_CODE = 'ibo-formtable';
public const REQUIRES_ANCESTORS_DEFAULT_JS_FILES = true;
public const REQUIRES_ANCESTORS_DEFAULT_CSS_FILES = true;
public const DEFAULT_HTML_TEMPLATE_REL_PATH = 'base/components/datatable/static/formtable/layout';
public const DEFAULT_JS_ON_READY_TEMPLATE_REL_PATH = 'base/components/datatable/static/formtable/layout';
/** @var string */
private $sRef;
/** @var iUIBlock[] */
private $aRows;
public function __construct(string $sRef, array $aContainerCSSClasses = [])
{
parent::__construct($sRef, $aContainerCSSClasses);
$this->SetRef($sRef);
$this->aRows = [];
}
/**
* @return string
*/
public function GetRef(): string
{
return $this->sRef;
}
/**
* @param string $sRef
*/
public function SetRef(string $sRef)
{
$this->sRef = $sRef;
return $this;
}
public function GetRows(): array
{
return $this->aRows;
}
public function AddRow(FormTableRow $oRow)
{
$this->aRows[] = $oRow;
return $this;
}
}

139
sources/Application/UI/Base/Component/DataTable/StaticTable/FormTableRow/FormTableRow.php Normal file
View File

@@ -0,0 +1,139 @@
<?php
/**
* @copyright Copyright (C) 2010-2021 Combodo SARL
* @license http://opensource.org/licenses/AGPL-3.0
*/
namespace Combodo\iTop\Application\UI\Base\Component\DataTable\StaticTable\FormTableRow;
use Combodo\iTop\Application\UI\Base\UIBlock;
/**
* Class FormTableRow
*
* @package Combodo\iTop\Application\UI\Base\Component\FormTableRow
*/
class FormTableRow extends UIBlock
{
// Overloaded constants
public const BLOCK_CODE = 'ibo-formtablerow';
public const DEFAULT_HTML_TEMPLATE_REL_PATH = 'base/components/datatable/static/formtablerow/layout';
/** @var string */
private $sRef;
/** @var int */
private $iRowId;
/**
* @var array
* [
* 'entry name' => [
* 'description' => tooltip,
* 'label' => label to display,
* 'class' => cell CSS class,
* 'metadata' => [key => value] transformed into data-key="value"
* ], ...
* ]
*/
private $aColumns;
/**
* @var array
* [
* 'entry name' => [
* 'value_html' => value to display in the cell,
* 'value_raw' => real value put into data-value-raw
* ], ...
* ]
*/
private $aData;
public function __construct(string $sRef, array $aColumns, array $aData, int $iRowId)
{
parent::__construct();
$this->SetRef($sRef);
$this->SetColumns($aColumns);
$this->SetData($aData);
$this->SetRowId($iRowId);
}
/**
* @return string
*/
public function GetRef(): string
{
return $this->sRef;
}
/**
* @param string $sRef
*
* @return $this
*/
public function SetRef(string $sRef)
{
$this->sRef = $sRef;
return $this;
}
/**
* @return array
*/
public function GetColumns(): array
{
return $this->aColumns;
}
/**
* @param array $aColumns
*
* @return $this
*/
public function SetColumns(array $aColumns)
{
$this->aColumns = $aColumns;
return $this;
}
/**
* @return array
*/
public function GetData(): array
{
return $this->aData;
}
/**
* @param array $aData
*
* @return $this
*/
public function SetData(array $aData)
{
$this->aData = $aData;
return $this;
}
/**
* @return int
*/
public function GetRowId(): int
{
return $this->iRowId;
}
/**
* @param int $iRowId
*
* @return $this
*/
public function SetRowId(int $iRowId)
{
$this->iRowId = $iRowId;
return $this;
}
}

186
sources/Application/UI/Base/Component/DataTable/StaticTable/StaticTable.php Normal file
View File

@@ -0,0 +1,186 @@
<?php
namespace Combodo\iTop\Application\UI\Base\Component\DataTable\StaticTable;
use Combodo\iTop\Application\UI\Base\Layout\UIContentBlock;
use Combodo\iTop\Application\UI\Base\tJSRefreshCallback;
use utils;
/**
* @copyright Copyright (C) 2010-2021 Combodo SARL
* @license http://opensource.org/licenses/AGPL-3.0
*/
/**
* Tables with static data
* Class StaticTable
*/
class StaticTable extends UIContentBlock
{
use tJSRefreshCallback;
// Overloaded constants
public const BLOCK_CODE = 'ibo-datatable';
public const DEFAULT_HTML_TEMPLATE_REL_PATH = 'base/components/datatable/static/layout';
public const DEFAULT_JS_ON_READY_TEMPLATE_REL_PATH = 'base/components/datatable/static/layout';
public const DEFAULT_JS_FILES_REL_PATH = [
'node_modules/datatables.net/js/jquery.dataTables.min.js',
'node_modules/datatables.net-fixedheader/js/dataTables.fixedHeader.min.js',
'node_modules/datatables.net-responsive/js/dataTables.responsive.min.js',
'node_modules/datatables.net-scroller/js/dataTables.scroller.min.js',
'node_modules/datatables.net-select/js/dataTables.select.min.js',
'js/field_sorter.js',
'js/table-selectable-lines.js',
'js/dataTables.main.js',
'js/dataTables.settings.js',
'js/dataTables.pipeline.js',
];
/**
* @var array of 'entry name' => [
* 'description' => tooltip,
* 'label' => label to display,
* 'class' => cell CSS class,
* 'metadata' => [key => value] transformed into data-key="value"
* ]
*/
private $aColumns;
/**
* @var array of [
* '@class' => css class of the row,
* 'entry name' => [
* 'value_html' => value to display in the cell,
* 'value_raw' => real value put into data-value-raw
* ], ...
* ]
*/
private $aData;
private $aExtraParams;
/*@var string $sUrlForRefresh*/
private $sFilter;
/** @var array $aOptions
* List of specific options for display datatable
*/
private $aOptions;
public function __construct(string $sId = null, array $aContainerCSSClasses = [], array $aExtraParams = [])
{
parent::__construct($sId, $aContainerCSSClasses);
$this->aColumns = [];
$this->aData = [];
$this->aExtraParams = $aExtraParams;
$this->aOptions = [];
}
/**
* @return array
*/
public function GetColumns(): array
{
return $this->aColumns;
}
/**
* @param array $aColumns
*
* @return $this
*/
public function SetColumns(array $aColumns)
{
$this->aColumns = $aColumns;
return $this;
}
/**
* @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 string $sFilter
*
* @return $this
*/
public function SetFilter($sFilter)
{
$this->sFilter = $sFilter;
return $this;
}
public function GetJSRefresh(): string
{
//$('#".$this->sId."').DataTable().clear().rows.add(data).draw()
$aParams = [
'style' => 'list',
'filter' => $this->sFilter,
'extra_params' => $this->aExtraParams,
];
return "$.post('".utils::GetAbsoluteUrlAppRoot()."pages/ajax.render.php?operation=refreshDashletList', ".json_encode($aParams).",
function (data) {
$('#".$this->sId."').DataTable().clear();
$('#".$this->sId."').dataTable().fnAddData(data);
});";
}
/**
* @return mixed
*/
public function GetOption(string $sOption)
{
if (isset($this->aOptions[$sOption])) {
return $this->aOptions[$sOption];
}
return null;
}
/**
* @return array
*/
public function GetOptions(): array
{
return $this->aOptions;
}
/**
* @param array $aOptions
*
* @return $this
*/
public function SetOptions($aOptions)
{
$this->aOptions = $aOptions;
return $this;
}
/**
* @param array $aOptions
*
* @return $this
*/
public function AddOption($sName, $sValue)
{
$this->aOptions[$sName] = $sValue;
return $this;
}
}