composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-05-21 16:22:20 +02:00
Code Issues Packages Projects Releases Wiki Activity

📝 Some @since annotations were missing complete version (ex 2.5 instead of 2.5.0)

Browse Source
This commit is contained in:
Pierre Goiffon
2020-02-21 18:01:08 +01:00
parent 096c3a3f13
commit 04fc58b55c
21 changed files with 41 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
application/applicationextension.inc.php
View File

@@ -1065,7 +1065,7 @@ abstract class AbstractPageUIExtension implements iPageUIExtension
* *
* @api * @api
* @package Extensibility * @package Extensibility
* @since 2.4 * @since 2.4.0
*/ */
interface iPortalUIExtension interface iPortalUIExtension
{ {

4
application/cmdbabstract.class.inc.php
View File

@@ -150,7 +150,7 @@ EOF
* @param bool $bMustNotExist * @param bool $bMustNotExist
* *
* @see SetSessionMessage() * @see SetSessionMessage()
* @since 2.6 * @since 2.6.0
*/ */
protected function SetSessionMessageFromInstance($sMessageId, $sMessage, $sSeverity, $fRank, $bMustNotExist = false) protected function SetSessionMessageFromInstance($sMessageId, $sMessage, $sSeverity, $fRank, $bMustNotExist = false)
{ {
@@ -4025,7 +4025,7 @@ EOF
/** /**
* @param string $sMessageIdPrefix * @param string $sMessageIdPrefix
* *
* @since 2.6 * @since 2.6.0
*/ */
protected function SetWarningsAsSessionMessages($sMessageIdPrefix) protected function SetWarningsAsSessionMessages($sMessageIdPrefix)
{ {

2
application/dashlet.class.inc.php
View File

@@ -514,7 +514,7 @@ EOF
* *
* Used as a fallback in iTop for unknown dashlet classes. * Used as a fallback in iTop for unknown dashlet classes.
* *
* @since 2.5 * @since 2.5.0
*/ */
class DashletUnknown extends Dashlet class DashletUnknown extends Dashlet
{ {

2
application/itopwebpage.class.inc.php
View File

@@ -1645,7 +1645,7 @@ EOF;
* @param string $sCssClasses CSS classes to add to the container * @param string $sCssClasses CSS classes to add to the container
* *
* @throws \Exception * @throws \Exception
* @since 2.6 * @since 2.6.0
*/ */
public function AddHeaderMessage($sContent, $sCssClasses = 'message_info') public function AddHeaderMessage($sContent, $sCssClasses = 'message_info')
{ {

2
application/pdfpage.class.inc.php
View File

@@ -40,7 +40,7 @@ class iTopPDF extends TCPDF
* *
* @uses \TCPDF::SetFont() * @uses \TCPDF::SetFont()
* @uses \iTopPDF::GetPdfFont() * @uses \iTopPDF::GetPdfFont()
* @since 2.7 * @since 2.7.0
*/ */
public function SetFontParams($style, $size, $fontfile='', $subset='default', $out=true) public function SetFontParams($style, $size, $fontfile='', $subset='default', $out=true)
{ {

4
core/attributedef.class.inc.php
View File

@@ -3740,7 +3740,7 @@ class AttributeFinalClass extends AttributeString
/** /**
* @return bool * @return bool
* @since 2.7 * @since 2.7.0 N°2272 OQL perf finalclass in all intermediary tables
*/ */
public function CopyOnAllTables() public function CopyOnAllTables()
{ {
@@ -10829,7 +10829,7 @@ class AttributeQueryAttCodeSet extends AttributeSet
* Multi value list of tags * Multi value list of tags
* *
* @see TagSetFieldData * @see TagSetFieldData
* @since 2.6 N°931 tag fields * @since 2.6.0 N°931 tag fields
*/ */
class AttributeTagSet extends AttributeSet class AttributeTagSet extends AttributeSet
{ {

12
core/cmdbsource.class.inc.php
View File

@@ -64,7 +64,7 @@ class MySQLException extends CoreException
/** /**
* Class MySQLQueryHasNoResultException * Class MySQLQueryHasNoResultException
* *
* @since 2.5 * @since 2.5.0
*/ */
class MySQLQueryHasNoResultException extends MySQLException class MySQLQueryHasNoResultException extends MySQLException
{ {
@@ -74,7 +74,7 @@ class MySQLQueryHasNoResultException extends MySQLException
/** /**
* Class MySQLHasGoneAwayException * Class MySQLHasGoneAwayException
* *
* @since 2.5 * @since 2.5.0
* @see itop bug 1195 * @see itop bug 1195
* @see https://dev.mysql.com/doc/refman/5.7/en/gone-away.html * @see https://dev.mysql.com/doc/refman/5.7/en/gone-away.html
*/ */
@@ -126,12 +126,12 @@ class CMDBSource
protected static $m_sDBName; protected static $m_sDBName;
/** /**
* @var boolean * @var boolean
* @since 2.5 N°1260 MySQL TLS first implementation * @since 2.5.0 N°1260 MySQL TLS first implementation
*/ */
protected static $m_bDBTlsEnabled; protected static $m_bDBTlsEnabled;
/** /**
* @var string * @var string
* @since 2.5 N°1260 MySQL TLS first implementation * @since 2.5.0 N°1260 MySQL TLS first implementation
*/ */
protected static $m_sDBTlsCA; protected static $m_sDBTlsCA;
@@ -1390,7 +1390,7 @@ class CMDBSource
* @return string query to upgrade table charset and collation if needed, null if not * @return string query to upgrade table charset and collation if needed, null if not
* @throws \MySQLException * @throws \MySQLException
* *
* @since 2.5 N°1001 switch to utf8mb4 * @since 2.5.0 N°1001 switch to utf8mb4
* @see https://dev.mysql.com/doc/refman/5.7/en/charset-table.html * @see https://dev.mysql.com/doc/refman/5.7/en/charset-table.html
*/ */
public static function DBCheckTableCharsetAndCollation($sTableName) public static function DBCheckTableCharsetAndCollation($sTableName)
@@ -1540,7 +1540,7 @@ class CMDBSource
* @return string query to upgrade database charset and collation if needed, null if not * @return string query to upgrade database charset and collation if needed, null if not
* @throws \MySQLException * @throws \MySQLException
* *
* @since 2.5 N°1001 switch to utf8mb4 * @since 2.5.0 N°1001 switch to utf8mb4
* @see https://dev.mysql.com/doc/refman/5.7/en/charset-database.html * @see https://dev.mysql.com/doc/refman/5.7/en/charset-database.html
*/ */
public static function DBCheckCharsetAndCollation() public static function DBCheckCharsetAndCollation()

2
core/config.class.inc.php
View File

@@ -361,7 +361,7 @@ class Config
'source_of_value' => '', 'source_of_value' => '',
'show_in_conf_sample' => true, 'show_in_conf_sample' => true,
), ),
'export_pdf_font' => array( // @since 2.7 PR #49 'export_pdf_font' => array( // @since 2.7.0 PR #49 / N°1947
'type' => 'string', 'type' => 'string',
'description' => 'Font used when generating a PDF file', 'description' => 'Font used when generating a PDF file',
'default' => 'DejaVuSans', // DejaVuSans is a UTF-8 Unicode font, embedded in the TCPPDF lib we're using 'default' => 'DejaVuSans', // DejaVuSans is a UTF-8 Unicode font, embedded in the TCPPDF lib we're using

2
core/coreexception.class.inc.php
View File

@@ -115,7 +115,7 @@ class CoreException extends Exception
* @see \DBObject::DBInsertNoReload() * @see \DBObject::DBInsertNoReload()
* @see \DBObject::DBUpdate() * @see \DBObject::DBUpdate()
* *
* @since 2.6 N°659 uniqueness constraint * @since 2.6.0 N°659 uniqueness constraint
*/ */
class CoreCannotSaveObjectException extends CoreException class CoreCannotSaveObjectException extends CoreException
{ {

10
core/dbobject.class.php
View File

@@ -116,7 +116,7 @@ abstract class DBObject implements iDisplay
/** /**
* @var null|string[] list of warnings thrown during DB write * @var null|string[] list of warnings thrown during DB write
* @see CheckToWrite() * @see CheckToWrite()
* @since 2.6 N°659 uniqueness constraints * @since 2.6.0 N°659 uniqueness constraints
*/ */
protected $m_aCheckWarnings = null; protected $m_aCheckWarnings = null;
protected $m_aDeleteIssues = null; protected $m_aDeleteIssues = null;
@@ -645,7 +645,7 @@ abstract class DBObject implements iDisplay
* @throws \CoreException * @throws \CoreException
* @throws \CoreUnexpectedValue * @throws \CoreUnexpectedValue
* @throws \Exception * @throws \Exception
* @since 2.6 * @since 2.6.0
*/ */
public function SetIfNull($sAttCode, $value) public function SetIfNull($sAttCode, $value)
{ {
@@ -1987,7 +1987,7 @@ abstract class DBObject implements iDisplay
* @throws \CoreException * @throws \CoreException
* @throws \OQLException * @throws \OQLException
* *
* @since 2.6 N°659 uniqueness constraint * @since 2.6.0 N°659 uniqueness constraint
* @api * @api
*/ */
protected function DoCheckUniqueness() protected function DoCheckUniqueness()
@@ -2035,7 +2035,7 @@ abstract class DBObject implements iDisplay
* @return string dict key : Class:$sClassName/UniquenessRule:$sUniquenessRuleId if none then will use Core:UniquenessDefaultError * @return string dict key : Class:$sClassName/UniquenessRule:$sUniquenessRuleId if none then will use Core:UniquenessDefaultError
* Dictionary keys can contain "$this" placeholders * Dictionary keys can contain "$this" placeholders
* *
* @since 2.6 N°659 uniqueness constraint * @since 2.6.0 N°659 uniqueness constraint
*/ */
protected function GetUniquenessRuleMessage($sUniquenessRuleId) protected function GetUniquenessRuleMessage($sUniquenessRuleId)
{ {
@@ -2087,7 +2087,7 @@ abstract class DBObject implements iDisplay
* @return \DBSearch * @return \DBSearch
* @throws \CoreException * @throws \CoreException
* @throws \OQLException * @throws \OQLException
* @since 2.6 N°659 uniqueness constraint * @since 2.6.0 N°659 uniqueness constraint
* @api * @api
*/ */
protected function GetSearchForUniquenessRule($sUniquenessRuleId, $aUniquenessRuleProperties) protected function GetSearchForUniquenessRule($sUniquenessRuleId, $aUniquenessRuleProperties)

2
core/dbobjectsearch.class.php
View File

@@ -528,7 +528,7 @@ class DBObjectSearch extends DBSearch
* *
* @throws \CoreException * @throws \CoreException
* *
* @since 2.5 N°1418 * @since 2.5.0 N°1418
*/ */
public function AddConditionForInOperatorUsingParam($sFilterCode, $aValues, $bPositiveMatch = true) public function AddConditionForInOperatorUsingParam($sFilterCode, $aValues, $bPositiveMatch = true)
{ {

2
core/legacy/dbobjectsearchlegacy.class.php
View File

@@ -546,7 +546,7 @@ class DBObjectSearch extends DBSearch
* *
* @throws \CoreException * @throws \CoreException
* *
* @since 2.5 N°1418 * @since 2.5.0 N°1418
*/ */
public function AddConditionForInOperatorUsingParam($sFilterCode, $aValues, $bPositiveMatch = true) public function AddConditionForInOperatorUsingParam($sFilterCode, $aValues, $bPositiveMatch = true)
{ {

8
core/metamodel.class.php
View File

@@ -543,7 +543,7 @@ abstract class MetaModel
* *
* @return array rule id as key, rule properties as value * @return array rule id as key, rule properties as value
* @throws \CoreException * @throws \CoreException
* @since 2.6 N°659 uniqueness constraint * @since 2.6.0 N°659 uniqueness constraint
* @see #SetUniquenessRuleRootClass that fixes a specific 'root_class' property to know which class is root per rule * @see #SetUniquenessRuleRootClass that fixes a specific 'root_class' property to know which class is root per rule
*/ */
final public static function GetUniquenessRules($sClass, $bClassDefinitionOnly = false) final public static function GetUniquenessRules($sClass, $bClassDefinitionOnly = false)
@@ -688,7 +688,7 @@ abstract class MetaModel
* @param array $aRuleProperties * @param array $aRuleProperties
* *
* @return bool * @return bool
* @since 2.6 N°659 uniqueness constraint * @since 2.6.0 N°659 uniqueness constraint
*/ */
private static function IsUniquenessRuleContainingOnlyDisabledKey($aRuleProperties) private static function IsUniquenessRuleContainingOnlyDisabledKey($aRuleProperties)
{ {
@@ -3241,7 +3241,7 @@ abstract class MetaModel
* *
* @throws \CoreUnexpectedValue if the rule is invalid * @throws \CoreUnexpectedValue if the rule is invalid
* *
* @since 2.6 N°659 uniqueness constraint * @since 2.6.0 N°659 uniqueness constraint
* @since 2.6.1 N°1968 (joli mois de mai...) disallow overrides of 'attributes' properties * @since 2.6.1 N°1968 (joli mois de mai...) disallow overrides of 'attributes' properties
*/ */
public static function CheckUniquenessRuleValidity($aUniquenessRuleProperties, $bRuleOverride = true, $aExistingClassFields = array()) public static function CheckUniquenessRuleValidity($aUniquenessRuleProperties, $bRuleOverride = true, $aExistingClassFields = array())
@@ -6799,7 +6799,7 @@ abstract class MetaModel
* @throws CoreException if no result found and $bMustBeFound=true * @throws CoreException if no result found and $bMustBeFound=true
* @throws \Exception * @throws \Exception
* *
* @since 2.4 introduction of the archive functionalities * @since 2.4.0 introduction of the archive functionality
* *
* @see MetaModel::GetObject() same but returns null or ArchivedObjectFoundException if object exists but is * @see MetaModel::GetObject() same but returns null or ArchivedObjectFoundException if object exists but is
* archived * archived

2
core/oql/expression.class.inc.php
View File

@@ -811,7 +811,7 @@ class BinaryExpression extends Expression
/** /**
* @since 2.6 N°931 tag fields * @since 2.6.0 N°931 tag fields
*/ */
class MatchExpression extends BinaryExpression class MatchExpression extends BinaryExpression
{ {

2
core/tagsetfield.class.inc.php
View File

@@ -25,7 +25,7 @@
* \MFCompiler::CompileClass).<br> Only this abstract class will exists in the DB : the implementations won't had any * \MFCompiler::CompileClass).<br> Only this abstract class will exists in the DB : the implementations won't had any
* new field. * new field.
* *
* @since 2.6 N°931 tag fields * @since 2.6.0 N°931 tag fields
*/ */
abstract class TagSetFieldData extends cmdbAbstractObject abstract class TagSetFieldData extends cmdbAbstractObject
{ {

2
datamodels/2.x/itop-portal-base/portal/templates/helpers/tagset_clic_handler.js.twig
View File

@@ -1,6 +1,6 @@
/** /**
* When clicking on a TagSet item in a list (BrowseBrick or ManageBrick), filters the list using the item label * When clicking on a TagSet item in a list (BrowseBrick or ManageBrick), filters the list using the item label
* @since 2.6 N°931 AttributeTagSet * @since 2.6.0 N°931 AttributeTagSet
*/ */
$("#main-content").on("click", ".table.dataTable .attribute.attribute-set.attribute-tag-set > .attribute-set-item", function () { $("#main-content").on("click", ".table.dataTable .attribute.attribute-set.attribute-tag-set > .attribute-set-item", function () {
var $this = $(this), var $this = $(this),

8
setup/applicationinstaller.class.inc.php
View File

@@ -493,10 +493,12 @@ class ApplicationInstaller
* @param Config $oConfig * @param Config $oConfig
* @param string $sBackupFileFormat * @param string $sBackupFileFormat
* @param string $sSourceConfigFile * @param string $sSourceConfigFile
* @param string $sMySQLBinDir
* *
* @throws \Exception * @throws \BackupException
* * @throws \CoreException
* @since 2.5 uses a {@link Config} object to store DB parameters * @throws \MySQLException
* @since 2.5.0 uses a {@link Config} object to store DB parameters
*/ */
protected static function DoBackup($oConfig, $sBackupFileFormat, $sSourceConfigFile, $sMySQLBinDir = null) protected static function DoBackup($oConfig, $sBackupFileFormat, $sSourceConfigFile, $sMySQLBinDir = null)
{ {

6
setup/backup.class.inc.php
View File

@@ -80,7 +80,7 @@ class DBBackup
/** /**
* utf8mb4 was added in MySQL 5.5.3 but works with programs like mysqldump only since MySQL 5.5.33 * utf8mb4 was added in MySQL 5.5.3 but works with programs like mysqldump only since MySQL 5.5.33
* *
* @since 2.5 see N°1001 * @since 2.5.0 see N°1001
*/ */
const MYSQL_VERSION_WITH_UTF8MB4_IN_PROGRAMS = '5.5.33'; const MYSQL_VERSION_WITH_UTF8MB4_IN_PROGRAMS = '5.5.33';
@@ -112,7 +112,7 @@ class DBBackup
* @param Config $oConfig object containing the database configuration.<br> * @param Config $oConfig object containing the database configuration.<br>
* If null then uses the default configuration ({@see MetaModel::GetConfig}) * If null then uses the default configuration ({@see MetaModel::GetConfig})
* *
* @since 2.5 uses a Config object instead of passing each attribute (there were far too many with the addition of MySQL TLS parameters * @since 2.5.0 uses a Config object instead of passing each attribute (there were far too many with the addition of MySQL TLS parameters
* !) * !)
*/ */
public function __construct($oConfig = null) public function __construct($oConfig = null)
@@ -468,7 +468,7 @@ EOF;
* *
* @return string TLS arguments for CLI programs such as mysqldump. Empty string if the config does not use TLS. * @return string TLS arguments for CLI programs such as mysqldump. Empty string if the config does not use TLS.
* *
* @since 2.5 * @since 2.5.0
*/ */
public static function GetMysqlCliTlsOptions($oConfig) public static function GetMysqlCliTlsOptions($oConfig)
{ {

2
setup/runtimeenv.class.inc.php
View File

@@ -904,7 +904,7 @@ class RunTimeEnvironment
* *
* @param string $sQuery * @param string $sQuery
* *
* @since 2.5 N°1001 utf8mb4 switch * @since 2.5.0 N°1001 utf8mb4 switch
* @uses \SetupUtils::GetSetupQueriesFilePath() * @uses \SetupUtils::GetSetupQueriesFilePath()
*/ */
protected function log_db_query($sQuery) protected function log_db_query($sQuery)

2
test/core/MetaModelTest.php
View File

@@ -13,7 +13,7 @@ use MetaModel;
* @preserveGlobalState disabled * @preserveGlobalState disabled
* @backupGlobals disabled * @backupGlobals disabled
* *
* @since 2.6 * @since 2.6.0
* @package Combodo\iTop\Test\UnitTest\Core * @package Combodo\iTop\Test\UnitTest\Core
*/ */
class MetaModelTest extends ItopDataTestCase class MetaModelTest extends ItopDataTestCase

2
test/core/UniquenessConstraintTest.php
View File

@@ -10,7 +10,7 @@ use MetaModel;
/** /**
* Class UniquenessConstraintTest * Class UniquenessConstraintTest
* *
* @since 2.6 N°659 uniqueness constraint * @since 2.6.0 N°659 uniqueness constraint
* *
* @package Combodo\iTop\Test\UnitTest\Core * @package Combodo\iTop\Test\UnitTest\Core
*/ */