7.1 调用小部件的两种方式-Yii2框架从入门到精通(中)

当前位置:　首页>> 技术小册>> Yii2框架从入门到精通(中)

### 7.1 调用小部件的两种方式

在Yii2框架中，小部件（Widgets）是一种非常灵活且强大的组件，它们能够封装复杂的逻辑和视图代码，使得开发者能够在不同的地方重用这些代码片段。小部件广泛应用于生成动态内容、表单元素、菜单、导航栏等场景。掌握小部件的调用方法，对于提高开发效率和代码复用性至关重要。本章将详细介绍在Yii2中调用小部件的两种主要方式：通过视图文件直接调用和使用`Widget`类在控制器或视图中间接调用。

#### 7.1.1 通过视图文件直接调用小部件

在Yii2中，最简单直接调用小部件的方式是在视图文件中使用`Yii::$app->view->widget`方法或者通过别名直接调用。这种方式适用于直接在视图中需要展示小部件内容的场景。

##### 1. 使用`Yii::$app->view->widget`方法

`Yii::$app->view->widget`方法是Yii2提供的一个全局可访问的方法来渲染小部件。这个方法接受至少一个参数，即你想要渲染的小部件的类名，并且可以接收额外的参数来配置小部件的属性。

```php
// 在视图文件中直接调用小部件
echo Yii::$app->view->widget('path\to\WidgetClass', [
    'option1' => 'value1',
    'option2' => 'value2',
    // ... 其他配置项
]);
```

这里`'path\to\WidgetClass'`应该替换为小部件的完整命名空间路径。`['option1' => 'value1', ...]`是一个数组，包含了传递给小部件构造器或配置方法的参数。

##### 2. 使用别名直接调用

如果小部件已经在应用的配置文件中通过别名注册，那么可以直接在视图文件中使用别名来调用它，这种方式更加简洁。

首先，在应用的配置文件中注册小部件别名（通常是在`components`下的`view`组件中配置）：

```php
// 在配置文件中的components部分
'components' => [
    'view' => [
        'class' => 'yii\web\View',
        // ... 其他配置
        'widgets' => [
            'myWidget' => 'path\to\WidgetClass',
        ],
    ],
    // ... 其他组件
],
```

然后，在视图文件中，你可以直接使用别名来调用小部件：

```php
// 使用别名调用小部件
echo $this->widget('myWidget', [
    'option1' => 'value1',
    'option2' => 'value2',
    // ... 其他配置项
]);
```

注意，在视图文件中，`$this`指向的是当前的视图对象，它继承自`yii\web\View`，因此可以直接调用`widget`方法来渲染小部件。

#### 7.1.2 使用`Widget`类在控制器或视图中间接调用

虽然直接在视图文件中调用小部件是最常见的方式，但在某些情况下，你可能需要在控制器中准备数据，并在视图中以更灵活的方式展示这些数据。这时，可以在控制器中实例化小部件类，并在视图中通过变量来引用小部件的渲染结果。

##### 1. 在控制器中实例化小部件

在控制器中，你可以像实例化其他类一样实例化小部件类，并通过调用其`run`方法（如果该类继承自`yii\base\Widget`且没有重写`__invoke`方法）或者直接调用（如果重写了`__invoke`方法或使用了`yii\base\View`的`renderWidget`方法）来获取小部件的渲染结果。

```php
// 在控制器中
public function actionIndex()
{
    // 实例化小部件并获取渲染结果
    $widget = new \path\to\WidgetClass();
    $widget->option1 = 'value1';
    $widget->option2 = 'value2';
    
    // 假设小部件类没有重写__invoke方法，使用run方法
    $widgetContent = $widget->run();
    
    // 将渲染结果传递给视图
    return $this->render('index', [
        'widgetContent' => $widgetContent,
    ]);
}
```

注意，这种方法需要小部件类支持直接调用`run`方法获取渲染结果，并且这种方法在处理复杂逻辑时可能会让控制器变得过于臃肿。

##### 2. 在视图中展示小部件的渲染结果

一旦在控制器中准备好了小部件的渲染结果，就可以在视图中直接展示这些内容了。

```php
// 在视图中
<?= $widgetContent ?>
```

这种方法虽然提供了更大的灵活性，但通常不是首选，因为它将视图逻辑与控制器逻辑混合在一起，违反了MVC模式的最佳实践。不过，在某些特定场景下，比如需要在控制器中处理复杂逻辑后再展示小部件内容时，这种方法是非常有用的。

#### 总结

调用Yii2中的小部件主要有两种方式：通过视图文件直接调用和使用`Widget`类在控制器或视图中间接调用。直接调用方式简单快捷，适合在视图层面直接展示小部件内容；而间接调用方式虽然提供了更大的灵活性，但需要注意不要过度复杂化控制器的职责。掌握这两种调用方式，可以帮助你更加灵活地在Yii2项目中运用小部件，提高开发效率和代码的可维护性。

该分类下的相关小册推荐：

Workerman高性能框架-GatewayWorker

PHP8入门与项目实战（5）

PHP高并发秒杀入门与实战

Swoole高性能框架-Hyperf

全面构建Magento2电商系统

Laravel(10.x)从入门到精通(十二)

Yii2框架从入门到精通(下)

Laravel(10.x)从入门到精通(十九)

经典设计模式PHP版

Laravel(10.x)从入门到精通(一)

Swoole入门教程

PHP8入门与项目实战（2）