Configuration Utility

The ConfigUtil in the LaraUtilX package provides functionality for managing dynamic configuration settings.

• Configuration Utility
  • Methods
  • Usage
  • Result
  • Publish

Methods

1. getAllSettings(string $path = null, string $key = null): array: Retrieves all dynamic configuration settings.
2. getSetting(string $key): mixed: Retrieves a specific dynamic configuration setting.
3. setSetting(string $key, mixed $value): Sets or updates a dynamic configuration setting.
4. getAllAppSettings(): array: Retrieves all application settings.

Usage

1. Get All Settings: To retrieve all dynamic configuration settings, use the getAllSettings method:

   use omarchouman\LaraUtilX\Utilities\ConfigUtil;
   
   class MyController extends Controller
   {
      protected $configUtil;
   
      public function __construct(ConfigUtil $configUtil)
      {
          $this->configUtil = $configUtil;
      }
   
      public function index()
      {
          $settings = $this->configUtil->getAllSettings();
   
          // Use the retrieved settings
      }
   }

2. Get Specific Setting: To retrieve a specific dynamic configuration setting, use the getSetting method:

   use omarchouman\LaraUtilX\Utilities\ConfigUtil;
   
   class MyController extends Controller
   {
       protected $configUtil;
   
       public function __construct(ConfigUtil $configUtil)
       {
           $this->configUtil = $configUtil;
       }
   
       public function getSpecificSetting()
       {
           $settingKey = 'key_name';
   
           $settingValue = $this->configUtil->getSetting($settingKey);
   
           // Use the retrieved setting value
       }
   }

3. Set or Update Setting: To set or update a dynamic configuration setting, use the setSetting method:

   use omarchouman\LaraUtilX\Utilities\ConfigUtil;
   
   class MyController extends Controller
   {
       protected $configUtil;
   
       public function __construct(ConfigUtil $configUtil)
       {
           $this->configUtil = $configUtil;
       }
   
       public function setOrUpdateSetting()
       {
           $settingKey = 'key_name';
           $settingValue = 'setting_value';
   
           $this->configUtil->setSetting($settingKey, $settingValue);
       }
   }

4. Get All Application Settings: To retrieve all application settings, use the getAllAppSettings method:

   use omarchouman\LaraUtilX\Utilities\ConfigUtil;
   
   class MyController extends Controller
   {
       protected $configUtil;
   
       public function __construct(ConfigUtil $configUtil)
       {
           $this->configUtil = $configUtil;
       }
   
       public function getAllAppSettings()
       {
           $appSettings = $this->configUtil->getAllAppSettings();
   
           // Use the retrieved application settings
       }
   }

Result

The utility provides convenient methods for managing dynamic configuration settings in Laravel applications.

• Success Result: Dynamic configuration settings can be efficiently retrieved, updated, or set using the provided methods.

• Error Result: If an error occurs during retrieval, updating, or setting of configuration settings, appropriate error handling mechanisms should be implemented based on application requirements.

Publish

You can publish this utility through the below command:

php artisan vendor:publish --tag=lara-util-x-config

This utility simplifies the process of managing configuration settings in Laravel applications, providing flexibility and customization options.