Yii PHP Framework Guide — High-Performance Component-Based MVC

Yii is a high-performance, component-based PHP framework known for excellent benchmarks, comprehensive tooling with Gii code generator, and efficient lazy-loading architecture.

What You’ll Learn

By the end of this guide, you’ll understand Yii’s component architecture, use Gii for rapid code generation, work with Active Record, implement REST APIs, and leverage caching for performance.

Why Yii Matters

Yii performs exceptionally well in benchmarks — it’s slower only than raw PHP and Phalcon among major frameworks. At DodaTech, Yii powers high-traffic components of Durga Antivirus Pro’s update distribution system, where millions of daily signature updates require maximum throughput. DodaZIP uses Yii for its file conversion API where response time directly impacts user experience.

Yii Architecture

    flowchart TD
  A[Request] --> B[Application]
  B --> C[Module]
  C --> D[Controller]
  D --> E[Active Record]
  D --> F[Widget]
  D --> G[View]
  E --> H[(Database)]
  G --> I[Response]
  

Key Concepts

Gii — Web-Based Code Generator

Yii’s Gii is a web-based code generator that creates models, CRUD controllers, forms, and modules through a visual interface:

# Enable Gii in config
'gii' => [
    'class' => 'yii\gii\Module',
],

Access /gii in your browser — point it at your database table and it generates working code instantly.

Active Record

class Product extends ActiveRecord
{
    public static function tableName()
    {
        return 'products';
    }

    public function rules()
    {
        return [
            [['name', 'price'], 'required'],
            ['price', 'number', 'min' => 0],
            ['name', 'string', 'max' => 100],
        ];
    }

    public function getCategory()
    {
        return $this->hasOne(Category::class, ['id' => 'category_id']);
    }
}

// Usage
$products = Product::find()
    ->where(['active' => true])
    ->orderBy(['price' => SORT_ASC])
    ->all();

Widgets — Reusable UI Components

// GridView — data table with sorting, filtering, pagination
echo GridView::widget([
    'dataProvider' => $dataProvider,
    'columns' => [
        'id',
        'name',
        'price:currency',
        [
            'class' => 'yii\grid\ActionColumn',
        ],
    ],
]);

RESTful API Development

Yii provides excellent support for building REST APIs through the yii\rest namespace. You can create a fully functional REST controller with minimal code:

namespace app\controllers;

use yii\rest\ActiveController;

class ProductController extends ActiveController
{
    public $modelClass = 'app\models\Product';

    public function behaviors()
    {
        $behaviors = parent::behaviors();
        $behaviors['contentNegotiator'] = [
            'class' => 'yii\filters\ContentNegotiator',
            'formats' => [
                'application/json' => 'json',
            ],
        ];
        $behaviors['rateLimiter'] = [
            'class' => 'yii\filters\RateLimiter',
        ];
        return $behaviors;
    }
}

Expected output: This single controller automatically provides GET /products (list with pagination), GET /products/1 (view), POST /products (create), PUT /products/1 (update), and DELETE /products/1 (delete). Responses are JSON by default. Yii handles pagination via page and per-page query parameters, returning _links for navigation and _meta with the total count.

Configure URL rules in config/web.php:

'urlManager' => [
    'enablePrettyUrl' => true,
    'enableStrictParsing' => true,
    'showScriptName' => false,
    'rules' => [
        ['class' => 'yii\rest\UrlRule', 'controller' => 'product'],
    ],
],

Data Caching for Performance

Yii’s caching layer supports file, database, APC, Memcache, and Redis backends through a unified API:

// Configure caching
'components' => [
    'cache' => [
        'class' => 'yii\caching\FileCache',
        'cachePath' => '@runtime/cache',
    ],
],

// Usage in any model or controller
$products = Yii::$app->cache->getOrSet('products_active', function () {
    return Product::find()->where(['active' => true])->all();
}, 3600);

Expected output: The first request fetches products from the database and stores them in the cache. All subsequent requests within the 3600-second window return the cached result instantly — no database query is executed. Yii also supports dependency-based invalidation: DbDependency automatically clears the cache when the related table changes.

Request Lifecycle

Yii processes requests through a structured pipeline:

1. Entry script — web/index.php loads the application config and creates the Application instance.
2. Application bootstrap — The application registers components, modules, and error handlers.
3. Request parsing — The urlManager parses the URL and routes it to a controller and action.
4. Before action — Controller beforeAction() runs, including attached behaviors (RBAC checks, rate limiting, caching).
5. Action execution — The action runs with request data. Models are loaded, validated, and saved as needed.
6. After action — afterAction() runs for post-processing.
7. Response formatting — The response is formatted as HTML, JSON, or XML and sent to the client.

Security: Role-Based Access Control (RBAC)

Yii’s RBAC system lets you define permissions hierarchically:

// config/web.php
'authManager' => [
    'class' => 'yii\rbac\PhpManager',
],

// Create roles (run once)
$auth = Yii::$app->authManager;
$admin = $auth->createRole('admin');
$editor = $auth->createRole('editor');
$auth->add($admin);
$auth->add($editor);
$auth->assign($admin, $userId);

// Check permissions in a controller
public function actionAdminDashboard()
{
    if (!Yii::$app->user->can('admin')) {
        throw new ForbiddenHttpException('Access denied');
    }
    return $this->render('dashboard');
}

For Durga Antivirus Pro’s update distribution system, RBAC ensures only authorized administrators can push signature updates, while automated systems have read-only API access.

Common Mistakes

1. Not using Gii — Gii generates production-ready code and best-practice structure. Manually writing CRUD code wastes time.

2. Ignoring caching — Yii’s data caching, fragment caching, and HTTP caching can dramatically improve performance. Use them.

3. Missing RBAC setup — Yii’s Role-Based Access Control is powerful but requires initial configuration. Don’t leave it for later.

Practice Questions

1. What is Gii in Yii?

A web-based code generator that creates models, CRUD operations, controllers, forms, and modules from database tables through a visual interface.

2. How do you define a relation in Yii Active Record?

Using hasOne(), hasMany(), belongsTo() methods in the model class — similar to Eloquent but with explicit configuration.

3. What caching types does Yii support?

Data caching (file, DB, Redis, Memcache), fragment caching (template parts), page caching (entire pages), and HTTP caching.

4. How does Yii’s REST API support compare to other PHP frameworks?

Yii’s ActiveController auto-generates CRUD endpoints from a model class with built-in content negotiation, HATEOAS pagination, rate limiting, and authentication. A complete REST API can be created in roughly 10 lines of controller code plus URL rules.

5. What is the purpose of beforeAction() in a Yii controller?

beforeAction() runs before every action. It is commonly used for authorization checks, loading shared data, or setting the response format. Returning false stops the action from executing.

Challenge: Build a REST API for a product catalog using Yii’s ActiveController. Include a Product model with validation rules (name required, price numeric, description optional), pretty URL rules, rate limiting of 100 requests per minute, and a custom GET /products/search?q=keyword action. Configure Redis caching for the product list endpoint with a 5-minute TTL.

Mini Project — Update Distribution System: Build a Yii-based API server for Durga Antivirus Pro’s signature update distribution. Authenticate clients via API keys with RBAC, serve the latest signature pack through GET /api/updates/latest, track which version each client last downloaded, rate-limit clients to prevent abuse, and cache the signature pack in Redis. Handle millions of daily requests using Yii’s performance features.

FAQ

{< faq >}

What is Yii?

Yii refers to the core concepts and practices used to build and manage modern web applications. Understanding it is essential for web developers.

Do I need prior experience to learn Yii?

Basic familiarity with web development concepts helps, but Yii can be learned step by step even as a beginner.

How long does it take to learn Yii?

With consistent practice, you can grasp the fundamentals in a few days to a week. Mastery takes ongoing practice and real-world projects.

Where can I use Yii in real projects?

Yii is used in a wide range of applications — from simple websites to complex enterprise systems, depending on the specific tools and technologies involved.

What are common tools used with Yii?

The specific tools depend on the technology stack, but version control (Git), package managers, and testing frameworks are commonly used alongside most development topics.

{< /faq >}

What’s Next

What’s Next

Congratulations on completing this Yii tutorial! Here’s where to go from here:

• Practice daily — Consistency is more important than long study sessions
• Build a project — Apply what you learned by building something real
• Explore related topics — Check out other tutorials in the same category
• Join the community — Discuss with other learners and share your progress

Remember: every expert was once a beginner. Keep coding!