composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-04-30 22:18:46 +02:00
Code Issues Packages Projects Releases Wiki Activity

N°8796 - Add PHP code style validation in iTop and extensions - format whole code base

Browse Source
This commit is contained in:
odain
2025-11-07 20:39:38 +01:00
parent 7681c157ec
commit b0a792afab
369 changed files with 22041 additions and 26866 deletions
Download Patch File Download Diff File Expand all files Collapse all files

71
datamodels/2.x/itop-attachments/module.itop-attachments.php
View File

@@ -1,9 +1,10 @@
<?php
// Copyright (C) 2010-2024 Combodo SAS
//
// This file is part of iTop.
//
// iTop is free software; you can redistribute it and/or modify
// 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.
@@ -16,11 +17,10 @@
// You should have received a copy of the GNU Affero General Public License
// along with iTop. If not, see <http://www.gnu.org/licenses/>
SetupWebPage::AddModule(
__FILE__, // Path to the current file, all other file names are relative to the directory containing this file
'itop-attachments/3.3.0',
array(
[
// Identification
//
'label' => 'Tickets Attachments',
@@ -28,52 +28,51 @@ SetupWebPage::AddModule(
// Setup
//
'dependencies' => array(),
'dependencies' => [],
'mandatory' => false,
'visible' => true,
'installer' => 'AttachmentInstaller',
// Components
//
'datamodel' => array(
'datamodel' => [
'vendor/autoload.php',
'main.itop-attachments.php',
'src/Trigger/TriggerOnAttachmentCreate.php',
'src/Trigger/TriggerOnAttachmentDelete.php',
'src/Trigger/TriggerOnAttachmentDownload.php',
'renderers.itop-attachments.php',
),
'webservice' => array(
),
'dictionary' => array(
],
'webservice' => [
),
'data.struct' => array(
],
'dictionary' => [
],
'data.struct' => [
// add your 'structure' definition XML files here,
),
'data.sample' => array(
],
'data.sample' => [
// add your sample data XML files here,
),
],
// Documentation
//
'doc.manual_setup' => '', // hyperlink to manual setup documentation, if any
'doc.more_information' => '', // hyperlink to more information, if any
'doc.more_information' => '', // hyperlink to more information, if any
// Default settings
//
'settings' => array(
'allowed_classes' => array('Ticket'), // List of classes for which to manage "Attachments"
'settings' => [
'allowed_classes' => ['Ticket'], // List of classes for which to manage "Attachments"
'position' => 'relations', // Where to display the attachments: relations | properties
'preview_max_width' => 290,
'icon_preview_max_size' => 500000, // Maximum size for attachment preview to be displayed as an icon. In bits
),
)
],
]
);
if (!class_exists('AttachmentInstaller'))
{
if (!class_exists('AttachmentInstaller')) {
// Module installation handler
//
class AttachmentInstaller extends ModuleInstallerAPI
@@ -94,7 +93,8 @@ if (!class_exists('AttachmentInstaller'))
* @throws \MySQLException
* @throws \MySQLHasGoneAwayException
*/
public static function GetOrphanAttachmentIds($sTableName, $iBulkSize){
public static function GetOrphanAttachmentIds($sTableName, $iBulkSize)
{
$sSqlQuery = <<<SQL
SELECT id as attachment_id FROM `$sTableName` WHERE (`item_id`='' OR `item_id` IS NULL) LIMIT {$iBulkSize};
SQL;
@@ -102,7 +102,7 @@ SQL;
$oQueryResult = CMDBSource::Query($sSqlQuery);
$aIds = [];
while($aRow = $oQueryResult->fetch_array()){
while ($aRow = $oQueryResult->fetch_array()) {
$aIds[] = $aRow['attachment_id'];
}
@@ -117,15 +117,13 @@ SQL;
*/
public static function BeforeDatabaseCreation(Config $oConfiguration, $sPreviousVersion, $sCurrentVersion)
{
if ($sPreviousVersion != '')
{
if ($sPreviousVersion != '') {
// Migrating from a previous version
// Check for records where item_id = '', since they are not attached to any object and cannot be migrated to the objkey schema
$sTableName = MetaModel::DBGetTable('Attachment');
$sCountQuery = "SELECT COUNT(*) FROM `$sTableName` WHERE (`item_id`='' OR `item_id` IS NULL)";
$iCount = CMDBSource::QueryToScalar($sCountQuery);
if ($iCount > 0)
{
if ($iCount > 0) {
SetupLog::Info("Cleanup of orphan attachments that cannot be migrated to the new ObjKey model: $iCount record(s) must be deleted.");
$iBulkSize = 100;
@@ -141,7 +139,7 @@ SQL;
$iDeletedCount += count($aIds);
$fElapsed = microtime(true) - $fStartTime;
if ($fElapsed > $iMaxDuration){
if ($fElapsed > $iMaxDuration) {
SetupLog::Info(sprintf("Cleanup of orphan attachments interrupted after %.3f s. $iDeletedCount records were deleted among $iCount.", $fElapsed));
break;
}
@@ -149,12 +147,10 @@ SQL;
$aIds = self::GetOrphanAttachmentIds($sTableName, $iBulkSize);
}
if (count($aIds) === 0){
if (count($aIds) === 0) {
SetupLog::Info("Cleanup of orphan attachments successfully completed.");
}
}
else
{
} else {
SetupLog::Info("No orphan attachment found.");
}
}
@@ -169,7 +165,7 @@ SQL;
public static function AfterDatabaseCreation(Config $oConfiguration, $sPreviousVersion, $sCurrentVersion)
{
// For each record having item_org_id unset,
// get the org_id from the container object
// get the org_id from the container object
//
// Prerequisite: change null into 0 (workaround to the fact that we cannot use IS NULL in OQL)
SetupLog::Info("Initializing attachment/item_org_id - null to zero");
@@ -185,11 +181,10 @@ SQL;
'Attachment' => [
'item_class',
'item_id',
]
],
]);
$iUpdated = 0;
while ($oAttachment = $oSet->Fetch())
{
while ($oAttachment = $oSet->Fetch()) {
if (empty($oAttachment->Get('item_class'))) {
//do not treat orphan attachment
continue;