{"id":1097,"date":"2022-03-10T09:21:46","date_gmt":"2022-03-10T09:21:46","guid":{"rendered":"https:\/\/editjournal.redakt.eu\/faxmodem\/?p=1097"},"modified":"2024-02-12T19:08:34","modified_gmt":"2024-02-12T19:08:34","slug":"plugin-load-custom-config","status":"publish","type":"post","link":"https:\/\/editjournal.redakt.eu\/faxmodem\/blog\/development\/cakephp\/plugin-load-custom-config\/","title":{"rendered":"Loading custom config for a CakePHP plugin"},"content":{"rendered":"

Say you're creating a plugin that integrates some ExampleAPI<\/code> and you need to store the API client configuration. You will have to create a custom config file inside your plugin, then tell the plugin bootstrap to load the config file. Finally, make sure you're loading your plugin with the bootstrap<\/code> flag.<\/p>\n

    \n
  1. \n

    Create your custom config file under plugins\/ExamplePlugin\/config\/ExampleAPI.php<\/code> with the following content:<\/p>\n

     [ \/\/ group\n        'host' => '',\n        'username' => '',\n        'key' => '',\n    ],\n];<\/code><\/pre>\n<\/li>\n
  2. \n
    Create the plugin bootstrap file plugins\/ExamplePlugin\/config\/bootstrap.php<\/code>:<\/p>\n
    <\/pre>\n<\/li>\n
  3. \n
    In your src\/Application.php<\/code>:<\/p>\n
    \n
    Note<\/strong>: 'bootstrap' => true<\/code> is required<\/p>\n<\/blockquote>\n
    $this->addPlugin('ExampleAPI', ['bootstrap' => true, 'routes' => false]);\n\/\/ ExampleAPI matches the plugin name\n\/\/ the bootstrap flag tells the app to execute the bootstrap file\n\/\/ the routes flag is specific to my use case, this plugin is for external API only, so no need for any routes<\/code><\/pre>\n<\/li>\n<\/ol>\n
    \n
    Note<\/strong>: be careful with configuration settings because plugin config files will override matching app settings, it is better to name settings with a plugin prefix<\/p>\n<\/blockquote>\n
    Finally, when you need to read the configuration, call \\Cake\\Core\\Configure::read('ExampleAPI');<\/code> where ExampleAPI<\/code> matches the config group. If you're trying to read the config inside plugins\/ExamplePlugin\/src\/Plugin.php<\/code>, make sure you do it after the parent::bootstrap($app)<\/code> call.<\/p>\n
    Sources:<\/p>\n