Create custom params file in yii framework

Create custom params in yii framework

Yii Framework comes with powerful inbuilt features special create custom params in yii framework eg.

1. Model-View-Controller (MVC) design pattern
2. Database Access Objects (DAO)
3. Custom Query Builder, Active Record (AR) and DB Migration
4. Form input and validation
5. AJAX-enabled widgets
6. Authentication and authorization
7. Layout Skinning and theming
8. Web services
9. Internationalization (I18N) and localization (L10N)
10. Layered caching scheme
11. Error handling and logging
12. Security
13. Unit and functionality testing
14. Automatic code generation (Gii Module)
15. Friendly with third-party code
16. Detailed documentation and Active Community
17. Extension library
18. Widget-Based Development
19. Event-Driven Programming
20. Scaffolding
21. Multi-Tier Caching
22. Dependency Injection Container
23. Console Applications
24. Lazy Loading and Eager Loading
25. Web Services and SOAP Support
26. Debugging Tools: Yii’s debug toolbar provides real-time insights into application performance, database queries, and memory usage during development.
27. Queue Support: Yii includes built-in support for queuing systems, enabling background job processing using drivers like RabbitMQ, Redis, and Beanstalk.
28. Cloud Integration: Yii integrates easily with cloud services like AWS, Azure, and Google Cloud for storage, computing, and APIs.
29. Asset Management: Yii manages CSS, JavaScript, and other assets efficiently, supporting features like bundling and minimizing to improve performance.
30. Dynamic Querying: Yii allows dynamic query construction with its query builder, supporting complex joins, conditions, and relations in a readable format.

Most of the Yii beginner use main.php file to create custom params in yii framework because that’s pattern comes in installed Yii framework. This is fine if you have less parameter but if you are building large web portal or application then it’s very hard to manage everything in mail.php because of its main config file. So the best way is creating separate params.php in the same directory and includes it in your main.php file. The check is the example of params.php and main.php files for create custom params in yii framework.

config/main.php :

'params'=>require(dirname(__FILE__).'/params.php'),

config/params.php :

<?php
return array(
 'defaultPageSize'=>10,
 'websiteName'=>'ezeelive.com',
 'copyrightInfo'=>'Copyright &copy; '.date("Y").' Ezeelive Technologies. All Rights Reserved.',
 ...
 ...
);
?>

In Yii2 Framework:

1. config/main.php (advance backend application):

<?php // You can add your custom params file here $params = array_merge( require(__DIR__ . '/../../common/config/params.php'), require(__DIR__ . '/../../common/config/params-local.php'), require(__DIR__ . '/params.php'), require(__DIR__ . '/params-local.php') ); return [ 'id' => 'backend-app',
        'name' => 'Backend App',
        'basePath' => dirname(__DIR__),
        'bootstrap' => ['log'],
        'controllerNamespace' => 'backend\controllers',
        'modules' => [],
        'components' => [
            'log' => [
                'traceLevel' => YII_DEBUG ? 3 : 0,
                'targets' => [
                    [
                        'class' => 'yii\log\FileTarget',
                        'levels' => ['error', 'warning'],
                    ],
                ],
            ],
            'errorHandler' => [
                'errorAction' => 'site/error',
            ],
        ],
        'params' => $params,
    ];

In this example, we are using params.php file.

2. In params.php:

<?php return [ 'adminEmail' => 'info@ezeelive.com',
 ];

3. Access param variable:

$params['mandrill_api_key'] 
  OR 
  \Yii::$app->params['mandrill_api_key']