PHPDoc & code cleanup

This commit is contained in:
Molkobain
2020-08-26 20:37:42 +02:00
parent 2864d48fa7
commit 77cd764b1c
16 changed files with 34 additions and 33 deletions

View File

@@ -23,7 +23,6 @@ namespace Combodo\iTop\Application\UI\Layout\ActivityPanel\ActivityEntry;
use AttributeDateTime;
use Combodo\iTop\Application\UI\UIBlock;
use DateTime;
use User;
use UserRights;
/**
@@ -48,7 +47,7 @@ class ActivityEntry extends UIBlock
/** @var string DEFAULT_DECORATION_CLASSES */
public const DEFAULT_DECORATION_CLASSES = 'fas fa-fw fa-mortar-pestle';
/** @var string $sType Type of entry, used for filtering (eg. caselog, edits, transition, ...) */
/** @var string $sType Type of entry, used for filtering (eg. case log, edits, transition, ...) */
protected $sType;
/** @var string $sDecorationClasses CSS classes to use to decorate the entry */
protected $sDecorationClasses;
@@ -106,7 +105,7 @@ class ActivityEntry extends UIBlock
}
/**
* Return the type of the entry (eg. caselog, edits, transition, ...)
* Return the type of the entry (eg. case log, edits, transition, ...)
*
* @return string
*/

View File

@@ -20,8 +20,6 @@
namespace Combodo\iTop\Application\UI\Layout\ActivityPanel\ActivityEntry\CMDBChangeOp;
use iCMDBChangeOp;
/**
* Class CMDBChangeOpAttachmentRemovedFactory
*

View File

@@ -42,6 +42,7 @@ class CMDBChangeOpSetAttributeFactory
*
* @return \Combodo\iTop\Application\UI\Layout\ActivityPanel\ActivityEntry\EditsEntry
* @throws \OQLException
* @throws \Exception
*/
public static function MakeFromCmdbChangeOp(iCMDBChangeOpSetAttribute $oChangeOp)
{

View File

@@ -54,7 +54,7 @@ class CaseLogEntry extends ActivityEntry
* @param \User $sAuthorLogin
* @param string $sAttCode
* @param string $sContent
* @param string $sId
* @param string|null $sId
*
* @throws \OQLException
*/

View File

@@ -53,7 +53,7 @@ class EditsEntry extends ActivityEntry
* @param \DateTime $oDateTime
* @param \User $sAuthorLogin
* @param string $sObjectClass Class of the object concerned by the edits
* @param string $sId
* @param string|null $sId
*
* @throws \OQLException
*/

View File

@@ -21,6 +21,7 @@ namespace Combodo\iTop\Application\UI\Layout\ActivityPanel\ActivityEntry;
use DateTime;
use MetaModel;
/**
* Class TransitionEntry
@@ -56,7 +57,7 @@ class TransitionEntry extends ActivityEntry
* @param string $sObjectClass Class of the object which made the transition
* @param string $sOriginStateCode
* @param string $sTargetStateCode
* @param string $sId
* @param string|null $sId
*
* @throws \CoreException
* @throws \OQLException
@@ -81,7 +82,7 @@ class TransitionEntry extends ActivityEntry
public function SetOriginalState($sObjectClass, $sStateCode)
{
$this->sOriginStateCode = $sStateCode;
$this->sOriginStateLabel = \MetaModel::GetStateLabel($sObjectClass, $sStateCode);
$this->sOriginStateLabel = MetaModel::GetStateLabel($sObjectClass, $sStateCode);
return $this;
}
@@ -109,16 +110,16 @@ class TransitionEntry extends ActivityEntry
/**
* Set the code / label of the state after the transition
*
* @param string $sObjectClas
* @param string $sObjectClass
* @param string $sStateCode
*
* @return $this
* @throws \CoreException
*/
public function SetTargetState($sObjectClas, $sStateCode)
public function SetTargetState($sObjectClass, $sStateCode)
{
$this->sTargetStateCode = $sStateCode;
$this->sTargetStateLabel = \MetaModel::GetStateLabel($sObjectClas, $sStateCode);
$this->sTargetStateLabel = MetaModel::GetStateLabel($sObjectClass, $sStateCode);
return $this;
}