From b58391c02c8abf2898bfa79516852b5e21e14681 Mon Sep 17 00:00:00 2001 From: Daniel Seifert Date: Tue, 25 Mar 2025 09:20:39 +0100 Subject: [PATCH] improve code style --- .php-cs-fixer.php | 40 ++++++++++---- Application/Component/DebugBarComponent.php | 6 ++- Application/Models/AvailabilityCheck.php | 6 ++- .../Models/Collectors/OxidConfigCollector.php | 12 +++-- .../Models/Collectors/OxidShopCollector.php | 6 ++- .../Collectors/OxidVersionCollector.php | 6 ++- .../Collectors/TemplateVariablesCollector.php | 7 +-- Application/Models/DebugBarHandler.php | 6 ++- .../Exceptions/CompileErrorException.php | 6 ++- .../Models/Exceptions/CoreErrorException.php | 6 ++- .../Models/Exceptions/ParseException.php | 6 ++- .../Exceptions/UnavailableException.php | 6 ++- .../Models/Exceptions/UserErrorException.php | 6 ++- .../Models/TimeDataCollectorHandler.php | 9 ++-- Application/views/admin/de/debugbar_lang.php | 6 ++- Application/views/admin/en/debugbar_lang.php | 6 ++- Core/DebugBarErrorHandler.php | 30 +++++------ Core/DebugBarExceptionHandler.php | 53 +++++++++---------- IntelliSenseHelper.php | 6 ++- Modules/Core/Config_DebugBar.php | 6 ++- Modules/Core/ShopControl_DebugBar.php | 23 ++++++-- Modules/functions.php | 11 ++-- Setup/Events.php | 6 ++- ToDo.md | 1 - composer.json | 3 ++ metadata.php | 6 ++- 26 files changed, 178 insertions(+), 107 deletions(-) diff --git a/.php-cs-fixer.php b/.php-cs-fixer.php index f0512a0..0594e2e 100644 --- a/.php-cs-fixer.php +++ b/.php-cs-fixer.php @@ -1,13 +1,35 @@ in(__DIR__) -; +declare(strict_types=1); + +$finder = PhpCsFixer\Finder::create()->in(__DIR__); + +$header = << +@link https://www.oxidmodule.com +EOF; $config = new PhpCsFixer\Config(); -return $config->setRules([ - '@PHP73Migration' => true, - '@PSR12' => true - ]) - ->setFinder($finder) -; \ No newline at end of file +return $config->setRules( + [ + '@PHP80Migration' => true, + '@PSR12' => true, + 'header_comment' => [ + 'comment_type' => 'PHPDoc', + 'header' => $header, + 'location' => 'after_open', + 'separate' => 'both', + ], + 'php_unit_test_class_requires_covers' => true, + 'doctrine_annotation_indentation' => true, + ] +) + ->setFinder($finder); diff --git a/Application/Component/DebugBarComponent.php b/Application/Component/DebugBarComponent.php index a283539..53a4ae6 100644 --- a/Application/Component/DebugBarComponent.php +++ b/Application/Component/DebugBarComponent.php @@ -1,8 +1,10 @@ configVars as $group => $values) { - array_walk( $this->configVars[$group], function( $item, $key ) use ( $group, $search ) { - if ( in_array( $key, $search ) ) { + array_walk($this->configVars[$group], function ($item, $key) use ($group, $search) { + if (in_array($key, $search)) { $this->configVars[$group][ $key ] = self::HIDDEN_TEXT; } - } ); + }); } } diff --git a/Application/Models/Collectors/OxidShopCollector.php b/Application/Models/Collectors/OxidShopCollector.php index ea47094..e710d53 100644 --- a/Application/Models/Collectors/OxidShopCollector.php +++ b/Application/Models/Collectors/OxidShopCollector.php @@ -1,8 +1,10 @@ * @link https://www.oxidmodule.com diff --git a/Application/Models/DebugBarHandler.php b/Application/Models/DebugBarHandler.php index e3d0eae..eb11c29 100644 --- a/Application/Models/DebugBarHandler.php +++ b/Application/Models/DebugBarHandler.php @@ -1,8 +1,10 @@ handleUnregisteredErrorTypes($message, $severity, $file, $line); - } + throw match ($severity) { + E_CORE_ERROR => new CoreErrorException($message, 0, $severity, $file, $line), + E_COMPILE_ERROR => new CompileErrorException($message, 0, $severity, $file, $line), + E_USER_ERROR => new UserErrorException($message, 0, $severity, $file, $line), + E_PARSE => new ParseException($message, 0, $severity, $file, $line), + E_ERROR => new ErrorException($message, 0, $severity, $file, $line), + default => $this->handleUnregisteredErrorTypes($message, $severity, $file, $line), + }; } /** @@ -75,7 +71,7 @@ class DebugBarErrorHandler protected function getSmartyTemplateLocationFromError(string $messsage): ?array { if (stristr($messsage, 'Smarty error: [in ')) { - $start = strpos($messsage, '[')+1; + $start = strpos($messsage, '[') + 1; $end = strpos($messsage, ']'); $parts = explode(' ', substr($messsage, $start, $end - $start)); return [Registry::getConfig()->getTemplateDir(isAdmin()).$parts[1], (int) $parts[3]]; diff --git a/Core/DebugBarExceptionHandler.php b/Core/DebugBarExceptionHandler.php index cf11678..7f6277a 100644 --- a/Core/DebugBarExceptionHandler.php +++ b/Core/DebugBarExceptionHandler.php @@ -1,8 +1,10 @@ getVar('iDebug'); - $defaultExceptionHandler = new ExceptionHandler($debugMode); - $defaultExceptionHandler->writeExceptionToLog($exception); - } catch (Throwable $loggerException) { + Registry::getLogger()->error( + $exception->getMessage(), + [$exception] + ); + } catch (Throwable) { /** * It's not possible to get the logger from the DI container. * Try again to log original exception (without DI container) in order to show the root cause of a problem. */ - try { - $loggerServiceFactory = new LoggerServiceFactory(new Context()); - $logger = $loggerServiceFactory->getLogger(); - $logger->error($exception->getTraceAsString()); - } catch (Throwable $throwableWithoutPossibilityToWriteToLogFile) { - // It's not possible to log because e.g. the log file is not writable. - } + $loggerServiceFactory = new LoggerServiceFactory(new Context()); + $logger = $loggerServiceFactory->getLogger(); + $logger->error($exception); } if (AvailabilityCheck::isAvailable() && AvailabilityCheck::ifDebugBarNotSet()) { @@ -66,23 +65,23 @@ class DebugBarExceptionHandler $excCollector->addThrowable($exception); echo << - - - -HTML; + + + + + HTML; echo $debugBarComponent->getRenderer()->renderHead(); $debugBarComponent->addTimelineMeasures(); echo << - -HTML; + + + HTML; AvailabilityCheck::markDebugBarAsSet(); echo $debugBarComponent->getRenderer()->render(); echo << - -HTML; + + + HTML; } catch (DebugBarException|UnavailableException $e) { Registry::getLogger()->error($e->getMessage()); Registry::getUtilsView()->addErrorToDisplay($e); diff --git a/IntelliSenseHelper.php b/IntelliSenseHelper.php index 9a3cc12..e32c2e7 100644 --- a/IntelliSenseHelper.php +++ b/IntelliSenseHelper.php @@ -1,8 +1,10 @@ getDebugBar()->getCollector('messages'); $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS); - //$location = $trace[1]['class'] . '::' . $trace[1]['function']. '(' . $trace[0]['line'] . ')'; $location = $trace[1]['class'] . '::' . $trace[1]['function']; $messages->addMessage($mVar, $location); - } catch (UnavailableException $e) { + } catch (UnavailableException) { dumpVar($mVar, $blToFile); } } diff --git a/Setup/Events.php b/Setup/Events.php index 768f5b6..3ee76c6 100644 --- a/Setup/Events.php +++ b/Setup/Events.php @@ -1,8 +1,10 @@