diff --git a/application/menunode.class.inc.php b/application/menunode.class.inc.php index d4f66201cc..5cabc1d589 100644 --- a/application/menunode.class.inc.php +++ b/application/menunode.class.inc.php @@ -263,12 +263,15 @@ EOF /** * Handles the display of the sub-menus (called recursively if necessary) + * * @param \WebPage $oPage * @param array $aMenus * @param array $aExtraParams * @param int $iActiveMenu + * * @return true if the currently selected menu is one of the submenus - * @throws DictExceptionMissingString + * @throws DictExceptionMissingString*@throws \Exception + * @throws \Exception */ static protected function DisplaySubMenu($oPage, $aMenus, $aExtraParams, $iActiveMenu = -1) { @@ -692,8 +695,8 @@ abstract class MenuNode public abstract function RenderContent(WebPage $oPage, $aExtraParams = array()); /** - * @param $sHyperlink - * @param $aExtraParams + * @param string $sHyperlink + * @param array $aExtraParams * @return string */ protected function AddParams($sHyperlink, $aExtraParams) @@ -737,8 +740,7 @@ class MenuGroup extends MenuNode } /** - * @param WebPage $oPage - * @param array $aExtraParams + * @inheritDoc */ public function RenderContent(WebPage $oPage, $aExtraParams = array()) { @@ -776,8 +778,7 @@ class TemplateMenuNode extends MenuNode } /** - * @param $aExtraParams - * @return string + * @inheritDoc */ public function GetHyperlink($aExtraParams) { @@ -786,10 +787,8 @@ class TemplateMenuNode extends MenuNode } /** - * @param WebPage $oPage - * @param array $aExtraParams - * @return mixed|void - * @throws DictExceptionMissingString + * @inheritDoc + * @throws \Exception */ public function RenderContent(WebPage $oPage, $aExtraParams = array()) { @@ -878,12 +877,8 @@ class OQLMenuNode extends MenuNode } /** - * @param WebPage $oPage - * @param array $aExtraParams - * @return mixed|void - * @throws CoreException - * @throws DictExceptionMissingString - * @throws OQLException + * @inheritDoc + * @throws \Exception */ public function RenderContent(WebPage $oPage, $aExtraParams = array()) { @@ -902,11 +897,11 @@ class OQLMenuNode extends MenuNode } /** - * @param $sOql - * @param $sTitle - * @param $sUsageId - * @param $bSearchPane - * @param $bSearchOpen + * @param string $sOql + * @param string $sTitle + * @param string $sUsageId + * @param bool $bSearchPane + * @param bool $bSearchOpen * @param WebPage $oPage * @param array $aExtraParams * @param bool $bEnableBreadcrumb @@ -979,11 +974,9 @@ class SearchMenuNode extends MenuNode } /** - * @param \iTopWebPage $oPage - * @param array $aExtraParams - * @return mixed|void - * @throws DictExceptionMissingString - * @throws Exception + * @inheritDoc + * @throws \DictExceptionMissingString + * @throws \Exception */ public function RenderContent(WebPage $oPage, $aExtraParams = array()) { @@ -1039,8 +1032,7 @@ class WebPageMenuNode extends MenuNode } /** - * @param array $aExtraParams - * @return string + * @inheritDoc */ public function GetHyperlink($aExtraParams) { @@ -1048,14 +1040,16 @@ class WebPageMenuNode extends MenuNode return $this->AddParams( $this->sHyperlink, $aExtraParams); } + /** + * @inheritDoc + */ public function IsHyperLinkInNewWindow() { return $this->bIsLinkInNewWindow; } /** - * @param WebPage $oPage - * @param array $aExtraParams + * @inheritDoc */ public function RenderContent(WebPage $oPage, $aExtraParams = array()) { @@ -1096,10 +1090,7 @@ class NewObjectMenuNode extends MenuNode } /** - * @param string[] $aExtraParams - * - * @return string - * @throws \Exception + * @inheritDoc */ public function GetHyperlink($aExtraParams) { @@ -1133,8 +1124,7 @@ class NewObjectMenuNode extends MenuNode } /** - * @param WebPage $oPage - * @param string[] $aExtraParams + * @inheritDoc */ public function RenderContent(WebPage $oPage, $aExtraParams = array()) { @@ -1172,8 +1162,7 @@ class DashboardMenuNode extends MenuNode } /** - * @param string[] $aExtraParams - * @return string + * @inheritDoc */ public function GetHyperlink($aExtraParams) { @@ -1192,10 +1181,8 @@ class DashboardMenuNode extends MenuNode } /** - * @param \iTopWebPage $oPage - * @param string[] $aExtraParams - * @throws CoreException - * @throws Exception + * @inheritDoc + * @throws \Exception */ public function RenderContent(WebPage $oPage, $aExtraParams = array()) { @@ -1290,8 +1277,7 @@ class DashboardMenuNode extends MenuNode class ShortcutContainerMenuNode extends MenuNode { /** - * @param string[] $aExtraParams - * @return string + * @inheritDoc */ public function GetHyperlink($aExtraParams) { @@ -1299,15 +1285,14 @@ class ShortcutContainerMenuNode extends MenuNode } /** - * @param WebPage $oPage - * @param string[] $aExtraParams - * @return mixed|void + * @inheritDoc */ public function RenderContent(WebPage $oPage, $aExtraParams = array()) { } /** + * @inheritDoc * @throws CoreException * @throws Exception */ @@ -1362,9 +1347,7 @@ class ShortcutMenuNode extends MenuNode } /** - * @param string[] $aExtraParams - * @return string - * @throws CoreException + * @inheritDoc */ public function GetHyperlink($aExtraParams) { @@ -1382,10 +1365,8 @@ class ShortcutMenuNode extends MenuNode } /** - * @param WebPage $oPage - * @param string[] $aExtraParams - * @return mixed|void - * @throws DictExceptionMissingString + * @inheritDoc + * @throws \Exception */ public function RenderContent(WebPage $oPage, $aExtraParams = array()) { @@ -1394,8 +1375,9 @@ class ShortcutMenuNode extends MenuNode } /** - * @return string - * @throws CoreException + * @inheritDoc + * + * @throws \Exception */ public function GetTitle() { @@ -1403,8 +1385,9 @@ class ShortcutMenuNode extends MenuNode } /** - * @return string - * @throws CoreException + * @inheritDoc + * + * @throws \Exception */ public function GetLabel() { diff --git a/core/dbobject.class.php b/core/dbobject.class.php index db6dddf84e..ac7d8e6683 100644 --- a/core/dbobject.class.php +++ b/core/dbobject.class.php @@ -701,21 +701,22 @@ abstract class DBObject implements iDisplay return $oAttDef->GetLabel(); } - /** - * Getter : get a value from the current object of from a related object - * - * Get the value of the attribute $sAttCode - * This call may involve an object reload if the object was not completely loaded (lazy loading) - * - * @api - * - * @param string $sAttCode Could be an extended attribute code in the form extkey_id->anotherkey_id->remote_attr - * - * @return mixed|string - * - * @throws ArchivedObjectException - * @throws CoreException - */ + /** + * Getter : get a value from the current object of from a related object + * + * Get the value of the attribute $sAttCode + * This call may involve an object reload if the object was not completely loaded (lazy loading) + * + * @api + * + * @param string $sAttCode Could be an extended attribute code in the form extkey_id->anotherkey_id->remote_attr + * + * @return mixed|string + * + * @throws \ArchivedObjectException + * @throws \CoreException + * @throws \Exception + */ public function Get($sAttCode) { if (($iPos = strpos($sAttCode, '->')) === false) diff --git a/setup/modelfactory.class.inc.php b/setup/modelfactory.class.inc.php index d6fcd8320c..c67b2774db 100644 --- a/setup/modelfactory.class.inc.php +++ b/setup/modelfactory.class.inc.php @@ -559,6 +559,7 @@ class ModelFactory * @param bool $bReturnRes * * @return mixed + * @throws \Exception */ public function Dump($oNode = null, $bReturnRes = false) { @@ -1063,6 +1064,7 @@ class ModelFactory * @param string $sValue * * @return mixed + * @throws \Exception */ public function CreateElement($sTagName, $sValue = '') { @@ -1258,7 +1260,7 @@ EOF * @param string $sClassName * @param bool $bIncludeMetas Look for $sClassName also in meta declaration (PHP classes) if not found in XML classes * - * @return null|\DOMElement + * @return \DOMNode */ public function GetClass($sClassName, $bIncludeMetas = false) { @@ -1275,9 +1277,10 @@ EOF } /** - * @param $sWellKnownParent + * @param string $sWellKnownParent * * @return mixed + * @throws \Exception */ public function AddWellKnownParent($sWellKnownParent) { @@ -2161,9 +2164,12 @@ class MFElement extends Combodo\iTop\DesignElement * Modify a node and set the flags that will be used to compute the delta * * @param MFElement $oNode The node (including all subnodes) to set - * @param null $sSearchId + * @param string|null $sSearchId + * + * @return void * * @throws \MFException + * @throws \Exception */ public function RedefineChildNode(MFElement $oNode, $sSearchId = null) { @@ -2503,14 +2509,16 @@ class MFDocument extends \Combodo\iTop\DesignDocument * * @see DOMDocument::createElement() * - * @param $sName + * @param string $sName * @param null $value * @param null $namespaceURI * - * @return \DOMNode + * @return \MFElement + * @throws \Exception */ function createElement($sName, $value = null, $namespaceURI = null) { + /** @var \MFElement $oElement */ $oElement = $this->importNode(new MFElement($sName, null, $namespaceURI)); if (($value !== '') && ($value !== null)) {