1. <?php
  3. /**
  4. * Wraps configuration file loading with error logging for maintenance tasks.
  5. *
  6. * @param string $filePath Path to the configuration file.
  7. * @param array $defaultValues Array of default values to use if the file fails to load.
  8. * @param string $logFile Path to the error log file.
  9. * @return array|null Configuration array on success, null on failure.
  10. */
  11. function loadConfigWithLogging(string $filePath, array $defaultValues = [], string $logFile = 'config_errors.log'): ?array
  12. {
  13. try {
  14. // Attempt to load the configuration file.
  15. $config = require($filePath);
  16. } catch (Exception $e) {
  17. // Log the error.
  18. error_log("Error loading configuration file: $filePath - " . $e->getMessage(), 3, $logFile);
  19. // Optionally, add more context to the log message.
  20. error_log("Original error message: " . $e->getTraceAsString(), 3, $logFile);
  22. // Return default values if loading fails.
  23. return $defaultValues;
  24. }
  26. // Check if the configuration is valid.
  27. if (!is_array($config)) {
  28. error_log("Configuration file $filePath returned an invalid value. Returning default values.", 3, $logFile);
  29. return $defaultValues;
  30. }
  32. return $config;
  33. }
  36. // Example Usage (within your maintenance task):
  38. // Define default configuration values.
  39. $defaultConfig = [
  40. 'database_host' => 'localhost',
  41. 'database_name' => 'default_db',
  42. 'api_key' => 'default_api_key',
  43. ];
  46. // Load the configuration file.
  47. $config = loadConfigWithLogging('config.php', $defaultConfig, 'maintenance_errors.log');
  49. // Check if the configuration was loaded successfully.
  50. if ($config === null) {
  51. // Handle the case where the configuration file failed to load.
  52. echo "Error: Configuration file failed to load. Using default values.\n";
  53. // Perform maintenance task using default values.
  54. } else {
  55. // Perform maintenance task using the loaded configuration.
  56. echo "Configuration loaded successfully.\n";
  57. print_r($config);
  58. // ... your maintenance task logic here ...
  59. }
  62. ?>

Add your comment