Yii2 params access within local config file in common directory

Question

I'm using Yii2 advanced template, I want to access params.php in main-local.php file, I called this ways:

main-local.php:

'mailer' => [
            'class' => 'myClass',
             'apikey' => \Yii::$app->params['mandrill_api_key'],
             'viewPath' => '@common/mail',            
        ],

and I have stored this mandrill_api_key in params.php

params.php:

<?php
return [
    'adminEmail' => 'admin@example.com',
    'supportEmail' => 'support@example.com',
    'user.passwordResetTokenExpire' => 3600,
     'mandrill_api_key' => 'mykey'
];

I'm getting this error:

Notice: Trying to get property of non-object in C:\xampp\htdocs\myproject\common\config\main-local.php on line 25

What should I do to access these parameters?

did you try adding a \, so something like: \Yii::$app->params['mandrill_api_key'] — Criesto, Sep 21 '15 at 07:49
Yes I have tried this but not working, may be I need to define something when application bootstraping. — Muhammad Shahzad, Sep 21 '15 at 07:52

topher · Accepted Answer · 2015-09-21T09:07:46.900

The config files are read before the application is instantiated as explained in the request lifecycle:

A user makes a request to the entry script web/index.php.

The entry script loads the application configuration and creates an application instance to handle the request.

The application resolves the requested route with the help of the request application component.

...

As such \Yii::$app does not yet exist hence the error. I would suggest moving your api_key definition to the main-local.php config such that there is no confusion over where it is being set:

'mailer' => [
    'class' => 'myClass',
    'apikey' => 'actual api key',
    'viewPath' => '@common/mail',            
],

Alternatively, you can use Yii2's dependancy injection container to set the apikey in your application's entry script:

...
$app = new yii\web\Application($config);
\Yii::$container->set('\fully\qualified\myClass', [
    'apikey' => \Yii::$app->params['mandrill_api_key'],
]);
$app->run();

Thanks I will try, but my issue is, I have to get this API key from database and set in config. — Muhammad Shahzad, Sep 21 '15 at 11:44
as @huss pointed you could directly use $params in local config files — , Apr 08 '16 at 10:34

score 3 · Answer 2 · answered Feb 26 '16 at 13:53

3

You can just do

$params['mandrill_api_key']

you dont need to use

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

answered Feb 26 '16 at 13:53

huss

31
1

This should be the accepted answer. Yii2 config loads the params file at starting main-config script $params = require(__DIR__ . '/params.php'); So you can use $params array in any part of your file – Leonardo Sapuy Oct 08 '17 at 18:26

Amir Mohsen · Answer 3 · 2015-09-22T06:13:17.540

1

The params is a part of config and you can not call this in your config .

the best way for handel this you can use this in your class :

myClass:

class myClass extends ... {

    public $apikey;

    public function __construct(){
        $this->apikey =  \Yii::$app->params['mandrill_api_key'];
    }


}

edited Sep 22 '15 at 06:13

answered Sep 21 '15 at 12:14

Amir Mohsen

853
2
9
23

Yii2 params access within local config file in common directory

3 Answers3

Linked