In Yii framework configuration files, the components array is used to define and configure application components that provide essential services. 1) Built-in components like db, user, cache, request, response, urlManager, and errorHandler offer core functionality such as database connectivity, authentication, caching, and error handling. 2) Custom components can be added by creating a class, registering it in the components array with its namespace and configuration, and accessing it via Yii::$app->componentID. 3) Components are lazy-loaded, so they only impact performance when actually used, and unused components should be removed for clarity and efficiency.

In Yii framework configuration files, the components array is where you define and configure various core objects or services your application will use. These are known as application components, and they provide essential functionality — things like database connections, user authentication, caching, request handling, and more.

Yii comes with a set of built-in components (like db, user, cache, etc.), but you can also register your own custom components here.

What goes inside the components array?

Each entry in the components array defines a single component. The key is the ID (name) you'll use to access it later, and the value is an array that tells Yii how to create or configure that component.

Here’s a basic example:

'components' => [
    'db' => [
        'class' => 'yii\db\Connection',
        'dsn' => 'mysql:host=localhost;dbname=mydatabase',
        'username' => 'root',
        'password' => '',
    ],
    'cache' => [
        'class' => 'yii\caching\FileCache',
    ],
],

You can then access these components anywhere in your app using Yii::$app->componentID, like Yii::$app->db or Yii::$app->cache.

Commonly used built-in components

Here are some standard components you’ll often see defined in the components array:

• db – Handles database connection and queries.
• user – Manages user authentication and identity.
• session – Handles session data storage and retrieval.
• request – Processes incoming HTTP requests.
• response – Prepares and sends HTTP responses.
• cache – Enables caching for performance optimization.
• urlManager – Controls URL formatting and parsing (useful for pretty URLs).
• errorHandler – Catches and displays errors gracefully.

These are just a few examples — there are more available, and you can even create your own.

How to add a custom component

Adding a custom component is straightforward. You just need to:

1. Create a class file for your component.
2. Register it in the components array using its namespace and configuration.
3. Access it via Yii::$app->yourComponentID.

For example:

'components' => [
    'myService' => [
        'class' => 'app\components\MyCustomService',
        'someParam' => 'value',
    ],
],

Now you can call it like this:

Yii::$app->myService->doSomething();

This is especially useful when you have reusable logic or external service integrations.

A few important notes

• Components are lazy-loaded, meaning they’re only created when you first access them. So defining many components doesn’t hurt performance unless you actually use them.
• If you don't need a component, don’t include it — it helps keep config clean and improves clarity.
• You can override default component settings by redefining them in your config file.

That’s the general idea behind the components array in Yii configuration. It's basically a list of all the tools your app needs to run, each one ready to be called when needed.

The above is the detailed content of What is the components array in the Yii configuration file?. For more information, please follow other related articles on the PHP Chinese website!