Book Image

Yii Application Development Cookbook - Second Edition - Second Edition

Book Image

Yii Application Development Cookbook - Second Edition - Second Edition

Overview of this book

The Yii framework is a rapidly growing PHP5 MVC framework often referred to as Rails for PHP. It has already become a solid base for many exciting web applications such as Stay.com and can be a good base for your developments, too. This book will help you to learn Yii quickly and in more depth for use in for your developments."Yii Application Development Cookbook" will show you how to use Yii efficiently. You will learn about taking shortcuts using core features, creating your own reusable code base, using test driven development, and many more topics that will give you a lot of experience in a moderate amount of time.The second edition fixes all errata found in the first edition and also features new recipes on the client side, HTTP caching, and using Composer with Yii.The chapters of the book are generally independent and since this book's goal is to enhance a practical approach to Yii development, you can start reading from the chapter you need most, be it Ajax and jQuery, Database, Active Record, and Model Tricks, or Extending Yii."Yii Application Development Cookbook" will help you to learn more about the Yii framework and application development practices in general, showing shortcuts and dangerous things you shouldn't do.With all the recipes grouped in 13 chapters, you will write your applications more efficiently using shortcuts and using Yii core functionality in a good way. The most interesting topics are; Yii application deployment, a guide to writing your own extensions, advanced error handling, debugging and logging, application security, performance tuning, and much more."Yii Application Development Cookbook" will help you to learn more about the Yii framework and application development practices in general. You will write your applications more efficiently using shortcuts and using Yii core functionality in a good way.
Table of Contents (20 chapters)
Yii Application Development Cookbook Second Edition
Credits
About the Author
About the Reviewers
www.PacktPub.com
Preface
Index

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 the CLinkPager widget before it is 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 a value of 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 main.php application configuration file as follows:

    return array(
      …
      'components'=>array(
        'widgetFactory'=>array(
          'widgets'=>array(
            'CLinkPager'=>array(
              'pageSize'=>15,
            ),
            …
          ),
        ),
        …
      ),
    );
  2. Now, the default value for pageSize of CLinkPager will be 15, so if we omit this parameter for all the CLinkPager classes of the application 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 set the default overall style in an external file, but can still override this through inline styles for individual widgets.

See also

  • The Configuring components recipe