iListId}\" style=\"display: none;\">";
@@ -362,13 +430,27 @@ EOF;
return $sHtml;
}
-
+
+ /**
+ * @param $oSetting
+ *
+ * @return array
+ */
public function GetAsHash($oSetting)
{
$aSettings = array('iDefaultPageSize' => $oSetting->iDefaultPageSize, 'oColumns' => $oSetting->aColumns);
return $aSettings;
}
-
+
+ /**
+ * @param $aColumns
+ * @param $sSelectMode
+ * @param $bViewLink
+ *
+ * @return array
+ * @throws \CoreException
+ * @throws \DictExceptionMissingString
+ */
protected function GetHTMLTableConfig($aColumns, $sSelectMode, $bViewLink)
{
$aAttribs = array();
@@ -401,7 +483,21 @@ EOF;
}
return $aAttribs;
}
-
+
+ /**
+ * @param $aColumns
+ * @param $sSelectMode
+ * @param $iPageSize
+ * @param $bViewLink
+ * @param $aExtraParams
+ *
+ * @return array
+ * @throws \CoreException
+ * @throws \CoreUnexpectedValue
+ * @throws \MissingQueryArgument
+ * @throws \MySQLException
+ * @throws \MySQLHasGoneAwayException
+ */
protected function GetHTMLTableValues($aColumns, $sSelectMode, $iPageSize, $bViewLink, $aExtraParams)
{
$bLocalize = true;
@@ -484,7 +580,24 @@ EOF;
}
return $aValues;
}
-
+
+ /**
+ * @param \WebPage $oPage
+ * @param $aColumns
+ * @param $sSelectMode
+ * @param $iPageSize
+ * @param $bViewLink
+ * @param $aExtraParams
+ *
+ * @return string
+ * @throws \ArchivedObjectException
+ * @throws \CoreException
+ * @throws \CoreUnexpectedValue
+ * @throws \DictExceptionMissingString
+ * @throws \MissingQueryArgument
+ * @throws \MySQLException
+ * @throws \MySQLHasGoneAwayException
+ */
public function GetHTMLTable(WebPage $oPage, $aColumns, $sSelectMode, $iPageSize, $bViewLink, $aExtraParams)
{
$iNbPages = ($iPageSize < 1) ? 1 : ceil($this->iNbObjects / $iPageSize);
@@ -585,7 +698,12 @@ EOF
}
return $sHtml;
}
-
+
+ /**
+ * @param \WebPage $oPage
+ * @param $iDefaultPageSize
+ * @param $iStart
+ */
public function UpdatePager(WebPage $oPage, $iDefaultPageSize, $iStart)
{
$iPageSize = $iDefaultPageSize;
@@ -609,11 +727,48 @@ EOF
*/
class PrintableDataTable extends DataTable
{
+ /**
+ * @param \WebPage $oPage
+ * @param $iPageSize
+ * @param $iDefaultPageSize
+ * @param $iPageIndex
+ * @param $aColumns
+ * @param $bActionsMenu
+ * @param $bToolkitMenu
+ * @param $sSelectMode
+ * @param $bViewLink
+ * @param $aExtraParams
+ *
+ * @return string
+ * @throws \ArchivedObjectException
+ * @throws \CoreException
+ * @throws \CoreUnexpectedValue
+ * @throws \DictExceptionMissingString
+ * @throws \MissingQueryArgument
+ * @throws \MySQLException
+ * @throws \MySQLHasGoneAwayException
+ */
public function GetAsHTML(WebPage $oPage, $iPageSize, $iDefaultPageSize, $iPageIndex, $aColumns, $bActionsMenu, $bToolkitMenu, $sSelectMode, $bViewLink, $aExtraParams)
{
return $this->GetHTMLTable($oPage, $aColumns, $sSelectMode, -1, $bViewLink, $aExtraParams);
}
-
+
+ /**
+ * @param \WebPage $oPage
+ * @param $aColumns
+ * @param $sSelectMode
+ * @param $iPageSize
+ * @param $bViewLink
+ * @param $aExtraParams
+ *
+ * @return string
+ * @throws \CoreException
+ * @throws \CoreUnexpectedValue
+ * @throws \DictExceptionMissingString
+ * @throws \MissingQueryArgument
+ * @throws \MySQLException
+ * @throws \MySQLHasGoneAwayException
+ */
public function GetHTMLTable(WebPage $oPage, $aColumns, $sSelectMode, $iPageSize, $bViewLink, $aExtraParams)
{
$iNbPages = ($iPageSize < 1) ? 1 : ceil($this->iNbObjects / $iPageSize);
@@ -638,7 +793,13 @@ class DataTableSettings implements Serializable
public $iDefaultPageSize;
public $aColumns;
-
+
+ /**
+ * DataTableSettings constructor.
+ *
+ * @param $aClassAliases
+ * @param null $sTableId
+ */
public function __construct($aClassAliases, $sTableId = null)
{
$this->aClassAliases = $aClassAliases;
@@ -646,14 +807,22 @@ class DataTableSettings implements Serializable
$this->iDefaultPageSize = 10;
$this->aColumns = array();
}
-
+
+ /**
+ * @param $iDefaultPageSize
+ * @param $aSortOrder
+ * @param $aColumns
+ */
protected function Init($iDefaultPageSize, $aSortOrder, $aColumns)
{
$this->iDefaultPageSize = $iDefaultPageSize;
$this->aColumns = $aColumns;
$this->FixVisibleColumns();
}
-
+
+ /**
+ * @return string
+ */
public function serialize()
{
// Save only the 'visible' columns
@@ -679,7 +848,12 @@ class DataTableSettings implements Serializable
)
);
}
-
+
+ /**
+ * @param string $sData
+ *
+ * @throws \Exception
+ */
public function unserialize($sData)
{
$aData = unserialize($sData);
@@ -712,7 +886,16 @@ class DataTableSettings implements Serializable
}
$this->FixVisibleColumns();
}
-
+
+ /**
+ * @param $aClassAliases
+ * @param $bViewLink
+ * @param $aDefaultLists
+ *
+ * @return \DataTableSettings
+ * @throws \CoreException
+ * @throws \DictExceptionMissingString
+ */
static public function GetDataModelSettings($aClassAliases, $bViewLink, $aDefaultLists)
{
$oSettings = new DataTableSettings($aClassAliases);
@@ -762,7 +945,10 @@ class DataTableSettings implements Serializable
$oSettings->Init($iDefaultPageSize, $aSortOrder, $aColumns);
return $oSettings;
}
-
+
+ /**
+ * @throws \CoreException
+ */
protected function FixVisibleColumns()
{
foreach($this->aClassAliases as $sAlias => $sClass)
@@ -799,7 +985,15 @@ class DataTableSettings implements Serializable
}
}
}
-
+
+ /**
+ * @param $aClassAliases
+ * @param null $sTableId
+ * @param bool $bOnlyOnTable
+ *
+ * @return \DataTableSettings|null
+ * @throws \Exception
+ */
static public function GetTableSettings($aClassAliases, $sTableId = null, $bOnlyOnTable = false)
{
$pref = null;
@@ -828,7 +1022,10 @@ class DataTableSettings implements Serializable
return $oSettings;
}
-
+
+ /**
+ * @return array
+ */
public function GetSortOrder()
{
$aSortOrder = array();
@@ -846,7 +1043,12 @@ class DataTableSettings implements Serializable
}
return $aSortOrder;
}
-
+
+ /**
+ * @param null $sTargetTableId
+ *
+ * @return bool
+ */
public function Save($sTargetTableId = null)
{
$sSaveId = is_null($sTargetTableId) ? $this->sTableId : $sTargetTableId;
@@ -857,6 +1059,9 @@ class DataTableSettings implements Serializable
return true;
}
+ /**
+ * @return bool
+ */
public function SaveAsDefault()
{
$sSettings = $this->serialize();
@@ -886,7 +1091,12 @@ class DataTableSettings implements Serializable
}
return true;
}
-
+
+ /**
+ * @param null $sTableId
+ *
+ * @return string
+ */
protected function GetPrefsKey($sTableId = null)
{
if ($sTableId == null) $sTableId = '*';
@@ -897,7 +1107,18 @@ class DataTableSettings implements Serializable
}
return implode('/', $aKeys).'|'.$sTableId;
}
-
+
+ /**
+ * @param $sAlias
+ * @param $sAttCode
+ * @param $oAttDef
+ * @param $bChecked
+ * @param $sSort
+ *
+ * @return array|bool
+ * @throws \CoreException
+ * @throws \DictExceptionMissingString
+ */
protected function GetFieldData($sAlias, $sAttCode, $oAttDef, $bChecked, $sSort)
{
$ret = false;
diff --git a/application/webpage.class.inc.php b/application/webpage.class.inc.php
index 4f02cc4bd..cf227f59b 100644
--- a/application/webpage.class.inc.php
+++ b/application/webpage.class.inc.php
@@ -1,45 +1,80 @@
-
-
/**
- * Class WebPage
+ * Copyright (C) 2013-2019 Combodo SARL
*
- * @copyright Copyright (C) 2010-2015 Combodo SARL
- * @license http://opensource.org/licenses/AGPL-3.0
+ * 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
*/
-
/**
* Generic interface common to CLI and Web pages
*/
Interface Page
{
+ /**
+ * Outputs (via some echo) the complete HTML page by assembling all its elements
+ *
+ * @return mixed
+ */
public function output();
+ /**
+ * Add any text or HTML fragment to the body of the page
+ *
+ * @param string $sText
+ *
+ * @return mixed
+ */
public function add($sText);
+ /**
+ * Add a paragraph to the body of the page
+ *
+ * @param string $sText
+ *
+ * @return mixed
+ */
public function p($sText);
+ /**
+ * Add a pre-formatted text to the body of the page
+ *
+ * @param string $sText
+ *
+ * @return mixed
+ */
public function pre($sText);
+ /**
+ * Add a comment
+ *
+ * @param string $sText
+ *
+ * @return mixed
+ */
public function add_comment($sText);
+ /**
+ * Adds a tabular content to the web page
+ *
+ * @param string[] $aConfig Configuration of the table: hash array of 'column_id' => 'Column Label'
+ * @param string[] $aData Hash array. Data to display in the table: each row is made of 'column_id' => Data. A
+ * column 'pkey' is expected for each row
+ * @param array $aParams Hash array. Extra parameters for the table.
+ *
+ * @return void
+ */
public function table($aConfig, $aData, $aParams = array());
}
@@ -86,7 +121,12 @@ class WebPage implements Page
protected $bPrintable;
protected $bHasCollapsibleSection;
-
+ /**
+ * WebPage constructor.
+ *
+ * @param string $s_title
+ * @param bool $bPrintable
+ */
public function __construct($s_title, $bPrintable = false)
{
$this->s_title = $s_title;
@@ -115,6 +155,8 @@ class WebPage implements Page
/**
* Change the title of the page after its creation
+ *
+ * @param string $s_title
*/
public function set_title($s_title)
{
@@ -123,6 +165,9 @@ class WebPage implements Page
/**
* Specify a default URL and a default target for all links on a page
+ *
+ * @param string $s_href
+ * @param string $s_target
*/
public function set_base($s_href = '', $s_target = '')
{
@@ -131,7 +176,7 @@ class WebPage implements Page
}
/**
- * Add any text or HTML fragment to the body of the page
+ * @inheritDoc
*/
public function add($s_html)
{
@@ -142,6 +187,9 @@ class WebPage implements Page
* Add any text or HTML fragment (identified by an ID) at the end of the body of the page
* This is useful to add hidden content, DIVs or FORMs that should not
* be embedded into each other.
+ *
+ * @param string $s_html
+ * @param string $sId
*/
public function add_at_the_end($s_html, $sId = '')
{
@@ -149,7 +197,7 @@ class WebPage implements Page
}
/**
- * Add a paragraph to the body of the page
+ * @inheritDoc
*/
public function p($s_html)
{
@@ -157,7 +205,7 @@ class WebPage implements Page
}
/**
- * Add a pre-formatted text to the body of the page
+ * @inheritDoc
*/
public function pre($s_html)
{
@@ -165,7 +213,7 @@ class WebPage implements Page
}
/**
- * Add a comment
+ * @inheritDoc
*/
public function add_comment($sText)
{
@@ -174,6 +222,10 @@ class WebPage implements Page
/**
* Add a paragraph to the body of the page
+ *
+ * @param string $s_html
+ *
+ * @return string
*/
public function GetP($s_html)
{
@@ -181,20 +233,22 @@ class WebPage implements Page
}
/**
- * Adds a tabular content to the web page
- *
- * @param string[] $aConfig Configuration of the table: hash array of 'column_id' => 'Column Label'
- * @param string[] $aData Hash array. Data to display in the table: each row is made of 'column_id' => Data. A
- * column 'pkey' is expected for each row
- * @param array $aParams Hash array. Extra parameters for the table.
- *
- * @return void
+ * @inheritDoc
+ * @throws \Exception
*/
public function table($aConfig, $aData, $aParams = array())
{
$this->add($this->GetTable($aConfig, $aData, $aParams));
}
+ /**
+ * @param array $aConfig
+ * @param array $aData
+ * @param array $aParams
+ *
+ * @return string
+ * @throws \Exception
+ */
public function GetTable($aConfig, $aData, $aParams = array())
{
$oAppContext = new ApplicationContext();
@@ -222,6 +276,12 @@ class WebPage implements Page
return $sHtml;
}
+ /**
+ * @param array $aRow
+ * @param array $aConfig
+ *
+ * @return string
+ */
public function GetTableRow($aRow, $aConfig)
{
$sHtml = '';
@@ -246,6 +306,8 @@ class WebPage implements Page
/**
* Add some Javascript to the header of the page
+ *
+ * @param string $s_script
*/
public function add_script($s_script)
{
@@ -254,6 +316,8 @@ class WebPage implements Page
/**
* Add some Javascript to the header of the page
+ *
+ * @param $s_script
*/
public function add_ready_script($s_script)
{
@@ -286,12 +350,18 @@ class WebPage implements Page
$this->a_dict_entries_prefixes[] = $s_entriesPrefix;
}
+ /**
+ * @return string
+ */
protected function get_dict_signature()
{
return str_replace('_', '', Dict::GetUserLanguage()).'-'.md5(implode(',',
$this->a_dict_entries).'|'.implode(',', $this->a_dict_entries_prefixes));
}
+ /**
+ * @return string
+ */
protected function get_dict_file_content()
{
$aEntries = array();
@@ -311,6 +381,8 @@ class WebPage implements Page
/**
* Add some CSS definitions to the header of the page
+ *
+ * @param string $s_style
*/
public function add_style($s_style)
{
@@ -330,12 +402,20 @@ class WebPage implements Page
/**
* Add a CSS stylesheet (as an include, i.e. link) to the header of the page
+ *
+ * @param string $s_linked_stylesheet
+ * @param string $s_condition
*/
public function add_linked_stylesheet($s_linked_stylesheet, $s_condition = "")
{
$this->a_linked_stylesheets[] = array('link' => $s_linked_stylesheet, 'condition' => $s_condition);
}
+ /**
+ * @param string $sSaasRelPath
+ *
+ * @throws \Exception
+ */
public function add_saas($sSaasRelPath)
{
$sCssRelPath = utils::GetCSSFromSASS($sSaasRelPath);
@@ -351,6 +431,8 @@ class WebPage implements Page
/**
* Add some custom header to the page
+ *
+ * @param string $s_header
*/
public function add_header($s_header)
{
@@ -368,6 +450,8 @@ class WebPage implements Page
/**
* Build a special kind of TABLE useful for displaying the details of an object from a hash array of data
+ *
+ * @param array $aFields
*/
public function details($aFields)
{
@@ -413,6 +497,10 @@ class WebPage implements Page
/**
* Build a special kind of TABLE useful for displaying the details of an object from a hash array of data
+ *
+ * @param array $aFields
+ *
+ * @return string
*/
public function GetDetails($aFields)
{
@@ -457,7 +545,7 @@ class WebPage implements Page
/**
* Build a set of radio buttons suitable for editing a field/attribute of an object (including its validation)
*
- * @param $aAllowedValues hash Array of value => display_value
+ * @param $aAllowedValues array Array of value => display_value
* @param $value mixed Current value for the field/attribute
* @param $iId mixed Unique Id for the input control in the page
* @param $sFieldName string The name of the field, attr_<$sFieldName> will hold the value for the field
@@ -477,13 +565,13 @@ class WebPage implements Page
if ((count($aAllowedValues) == 1) && ($bMandatory == 'true'))
{
// When there is only once choice, select it by default
- $sSelected = ' checked';
+ $sSelected = 'checked';
}
else
{
- $sSelected = ($value == $key) ? ' checked' : '';
+ $sSelected = ($value == $key) ? 'checked' : '';
}
- $sHTMLValue .= "
";
+ $sHTMLValue .= "
";
if ($bVertical)
{
if ($idx == 0)
@@ -522,6 +610,8 @@ class WebPage implements Page
* Possible improvement: I've noticed that several output buffers are stacked,
* if they are not empty, the output will be corrupted. The solution would
* consist in unstacking all of them (and concatenate the contents).
+ *
+ * @throws \Exception
*/
protected function ob_get_clean_safe()
{
@@ -559,7 +649,8 @@ class WebPage implements Page
}
/**
- * Outputs (via some echo) the complete HTML page by assembling all its elements
+ * @inheritDoc
+ * @throws \Exception
*/
public function output()
{
@@ -659,6 +750,9 @@ class WebPage implements Page
/**
* Build a series of hidden field[s] from an array
+ *
+ * @param string $sLabel
+ * @param array $aData
*/
public function add_input_hidden($sLabel, $aData)
{
@@ -837,6 +931,12 @@ class WebPage implements Page
}
}
+ /**
+ * @param array $aActions
+ * @param array $aFavoriteActions
+ *
+ * @return string
+ */
public function RenderPopupMenuItems($aActions, $aFavoriteActions = array())
{
$sPrevUrl = '';
@@ -845,10 +945,10 @@ class WebPage implements Page
{
foreach ($aActions as $aAction)
{
- $sClass = isset($aAction['css_classes']) ? ' class="'.implode(' ', $aAction['css_classes']).'"' : '';
- $sOnClick = isset($aAction['onclick']) ? ' onclick="'.htmlspecialchars($aAction['onclick'], ENT_QUOTES,
+ $sClass = isset($aAction['css_classes']) ? 'class="'.implode(' ', $aAction['css_classes']).'"' : '';
+ $sOnClick = isset($aAction['onclick']) ? 'onclick="'.htmlspecialchars($aAction['onclick'], ENT_QUOTES,
"UTF-8").'"' : '';
- $sTarget = isset($aAction['target']) ? " target=\"{$aAction['target']}\"" : "";
+ $sTarget = isset($aAction['target']) ? "target=\"{$aAction['target']}\"" : "";
if (empty($aAction['url']))
{
if ($sPrevUrl != '') // Don't output consecutively two separators...
@@ -859,7 +959,7 @@ class WebPage implements Page
}
else
{
- $sHtml .= "
{$aAction['label']}";
+ $sHtml .= "
{$aAction['label']}";
$sPrevUrl = $aAction['url'];
}
}
@@ -874,6 +974,11 @@ class WebPage implements Page
return $sHtml;
}
+ /**
+ * @param bool $bReturnOutput
+ *
+ * @throws \Exception
+ */
protected function output_dict_entries($bReturnOutput = false)
{
if ((count($this->a_dict_entries) > 0) || (count($this->a_dict_entries_prefixes) > 0))
@@ -927,11 +1032,27 @@ $("#LnkCollapse_"+iSectionId).click(function(e) {
EOD
);
}
+
+ /**
+ * @param string $sSectionLabel
+ * @param bool $bOpenedByDefault
+ * @param string $sSectionStateStorageBusinessKey
+ *
+ * @throws \Exception
+ */
public function StartCollapsibleSection($sSectionLabel, $bOpenedByDefault = false, $sSectionStateStorageBusinessKey = '')
{
$this->add($this->GetStartCollapsibleSection($sSectionLabel, $bOpenedByDefault, $sSectionStateStorageBusinessKey));
}
+ /**
+ * @param string $sSectionLabel
+ * @param bool $bOpenedByDefault
+ * @param string $sSectionStateStorageBusinessKey
+ *
+ * @return string
+ * @throws \Exception
+ */
public function GetStartCollapsibleSection($sSectionLabel, $bOpenedByDefault = false, $sSectionStateStorageBusinessKey = '')
{
$this->bHasCollapsibleSection = true;
@@ -956,6 +1077,9 @@ EOD
$this->add($this->GetEndCollapsibleSection());
}
+ /**
+ * @return string
+ */
public function GetEndCollapsibleSection()
{
return "