composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-02-27 22:24:12 +01:00
Code Issues Packages Projects Releases Wiki Activity

(Retrofit from trunk) N.1108 return exception if $bMustBeFound and result is archived

Browse Source 
SVN:2.4[5027]
This commit is contained in:
Romain Quetiez
2017-10-17 09:04:26 +00:00
parent 8499babcb3
commit d86c211b73
3 changed files with 101 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
application/utils.inc.php
View File

@@ -141,6 +141,9 @@ class utils
}
protected static $bPageMode = null;
/**
* @var boolean[]
*/
protected static $aModes = array();
public static function InitArchiveMode()
@@ -164,6 +167,10 @@ class utils
self::$bPageMode = ($iCurrent == 1);
}
/**
* @param boolean $bMode if true then activate archive mode (archived objects are visible), otherwise archived objects are
* hidden (archive = "soft deletion")
*/
public static function PushArchiveMode($bMode)
{
array_push(self::$aModes, $bMode);
@@ -174,6 +181,9 @@ class utils
array_pop(self::$aModes);
}
/**
* @return boolean true if archive mode is enabled
*/
public static function IsArchiveMode()
{
if (count(self::$aModes) > 0)

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

@@ -112,4 +112,13 @@ class SecurityException extends CoreException
{
}
/**
* Throwned when querying on an object that exists in the database but is archived
*
* @see N.1108
*/
class ArchivedObjectException extends CoreException
{
}
?>

93
core/metamodel.class.php
View File

@@ -4691,6 +4691,18 @@ abstract class MetaModel
return $iTotalHits.' ('.implode(', ', $aRes).')';
}
/**
* @param string $sClass
* @param int $iKey
* @param bool $bMustBeFound
* @param bool $bAllowAllData if true then no rights filtering
* @param array $aModifierProperties
*
* @return string[] column name / value array
* @throws CoreException if no result found and $bMustBeFound=true
*
* @see utils::PushArchiveMode() to enable search on archived objects
*/
public static function MakeSingleRow($sClass, $iKey, $bMustBeFound = true, $bAllowAllData = false, $aModifierProperties = null)
{
// Build the query cache signature
@@ -4747,13 +4759,27 @@ abstract class MetaModel
$aRow = CMDBSource::FetchArray($res);
CMDBSource::FreeResult($res);
if ($bMustBeFound && empty($aRow))
{
throw new CoreException("No result for the single row query: '$sSQL'");
}
return $aRow;
}
/**
* Converts a column name / value array to a {@link DBObject}
*
* @param string $sClass
* @param string[] $aRow column name / value array
* @param string $sClassAlias
* @param string[] $aAttToLoad
* @param array $aExtendedDataSpec
*
* @return DBObject
* @throws CoreException if finalClass cannot be found
*/
public static function GetObjectByRow($sClass, $aRow, $sClassAlias = '', $aAttToLoad = null, $aExtendedDataSpec = null)
{
self::_check_subclass($sClass);
@@ -4787,30 +4813,75 @@ abstract class MetaModel
}
/**
* @param $sClass
* Search for the specified class and id.
*
* @param string $sClass
* @param $iKey
* @param bool $bMustBeFound
* @param bool $bAllowAllData
* @param null $aModifierProperties
* @return DBObject|null
* @return DBObject|null null if : (the object is not found) or (archive mode disabled and object is archived and $bMustBeFound=false)
* @throws CoreException if no result found and $bMustBeFound=true
* @throws ArchivedObjectException if archive mode disabled and result is archived and $bMustBeFound=true
*
* @see MetaModel::GetObjectWithArchive to get object even if it's archived
* @see utils::PushArchiveMode() to enable search on archived objects
*/
public static function GetObject($sClass, $iKey, $bMustBeFound = true, $bAllowAllData = false, $aModifierProperties = null)
{
self::_check_subclass($sClass);
$oObject = self::GetObjectWithArchive($sClass, $iKey, $bMustBeFound, $bAllowAllData, $aModifierProperties);
if (empty($oObject))
{
return null;
}
if (!utils::IsArchiveMode() && $oObject->IsArchived())
{
if ($bMustBeFound)
{
throw new ArchivedObjectException("The object $sClass::$iKey is archived");
}
else
{
return null;
}
}
return $oObject;
}
/**
* Search for the specified class and id. If the object is archived it will be returned anyway (this is for pre-2.4
* module compatibility, see N.1108)
*
* @param string $sClass
* @param int $iKey
* @param bool $bMustBeFound
* @param bool $bAllowAllData
* @param array $aModifierProperties
*
* @return DBObject|null
* @throws CoreException if no result found and $bMustBeFound=true
*
* @since 2.4 introduction of the archive functionalities
*
* @see MetaModel::GetObject() same but returns null or ArchivedObjectFoundException if object exists but is archived
*/
public static function GetObjectWithArchive($sClass, $iKey, $bMustBeFound = true, $bAllowAllData = false, $aModifierProperties = null)
{
self::_check_subclass($sClass);
utils::PushArchiveMode(true);
$aRow = self::MakeSingleRow($sClass, $iKey, $bMustBeFound, $bAllowAllData, $aModifierProperties);
utils::PopArchiveMode();
if (empty($aRow))
{
return null;
}
return self::GetObjectByRow($sClass, $aRow);
}
public static function GetObjectWithArchive($sClass, $iKey, $bMustBeFound = true, $bAllowAllData = false, $aModifierProperties = null)
{
utils::PushArchiveMode(true);
$oObject = static::GetObject($sClass, $iKey, $bMustBeFound, $bAllowAllData, $aModifierProperties);
utils::PopArchiveMode();
return $oObject;
return self::GetObjectByRow($sClass, $aRow); // null should not be returned, this is handled in the callee
}
public static function GetObjectByName($sClass, $sName, $bMustBeFound = true)