官术网_书友最值得收藏!

Configuring widget defaults

In Yii, code pieces commonly used in views are placed into widgets. For example, a widget can render a tag cloud or provide a custom form input type. Core widgets are highly configurable and are used in views as follows:

<?$this->widget('CLinkPager', array(
'pages' => $pages,
'pageSize' => 15,
))?>

In the preceding code, we are using $this->widget that calls a CLinkPager widget with an array of parameters to display a pagination. pages and pageSize are both assigned to the corresponding public properties of CLinkPager before it is being rendered.

Note that we have changed the count of items per page to 15 in our example. If we want our pagination to display 15 items per page on all pages of our application, then we will need to provide a pageSize parameter with value 15 for all CLinkPager widget calls. Is there a better way? Definitely, yes.

How to do it…

A Yii web application provides a bunch of components. One of them is a widget factory that since Yii 1.1.3 can be used to set widget defaults.

  1. Let's use it to set pageSize application-wide. We will need to edit the application configuration file main.php as follows:
    return array(
      …
      'components'=>array(
        'widgetFactory'=>array(
          'widgets'=>array(
            'CLinkPager'=>array(
              'pageSize'=>15,
            ),
            …
          ),
        ),
        …
      ),
    );
  2. Now, the default value for CLinkPager's pageSize will be 15, so if we omit this parameter for all the application CLinkPagers then it will be 15, application-wide.
  3. Moreover, we still can override the pageSize value for a specific widget:
    <?$this->widget('CLinkPager', array(
    'pages' => $pages,
    'pageSize' => 5,
    ))?>

This works much like the CSS cascade. You are setting the default overall style in an external file, but are still able to override this through inline styles for individual widgets.

See also

  • The recipe named Configuring components in this chapter
主站蜘蛛池模板: 达拉特旗| 乌什县| 延边| 彰武县| 五寨县| 安康市| 南乐县| 勃利县| 扎鲁特旗| 闽侯县| 大安市| 左云县| 枣庄市| 清水河县| 津南区| 丰镇市| 平遥县| 嘉禾县| 五台县| 文化| 彭阳县| 宝坻区| 田东县| 怀远县| 潼南县| 皮山县| 青河县| 含山县| 白沙| 汤阴县| 泸溪县| 阳山县| 克拉玛依市| 蒙自县| 民县| 兰溪市| 宜兴市| 新巴尔虎左旗| 临颍县| 五寨县| 榆林市|