3si-yii2 – A Starter Kit for every yii2-based Projects of 3S

Mỗi khi start 1 dự án sử dụng Yii2 (1 PHP framework), các bạn cuder 3S đã phát ngán với việc phải config, migration thủ công cho từng dự án?

Các công việc được lặp đi lặp lại: nào là config RBAC (Role Based Access Control), rồi lại config RESTful Web Services, config i18n (Internationalization), config separate session/cookies cho backend/frontend, xong rồi lại phát triển giao diện cho trang quản lý user, quản lý log, v.v…

Các chức năng:

  • Theme AdminLTE cho backend: đẹp + open source (MIT licensed)
  • Các ngôn ngữ: tiếng Anh, tiếng Việt, tiếng Nhật…
  • Quản lý các bản dịch
  • Action đổi ngôn ngữ + behavior đổi locale dựa theo ngôn ngữ của browser
  • Các màn hình đăng nhập, đăng ký, profile…
  • Xác thực OAuth
  • Quản lý User
  • RBAC sẵn với các quyền: khách, user thường, quản lý và admin
  • Hỗ trợ migrate RBAC
  • Các component quản lý nội dung: bài viết, thể loại, trang tĩnh, menu động, carousel động, text block
  • Component lưu giữ Key-value
  • Màn hình cài đặt Ứng dụng (dựa trên component KeyStorage)
  • Module RESTful API được config sẵn
  • Component quản lý file + widget upload file
  • Tự động tạo thumbnail bằng lib trntv/yii2-glide
  • Command Bus with queued and async tasks support trntv/yii2-command-bus
  • Các behaviors hữu dụng (GlobalAccessBehavior, CacheInvalidateBehavior, MaintenanceBehavior)
  • Giao diện quản lý log Yii2
  • Component timeline Ứng dụng
  • Component chế độ bảo trì
  • Giao diện xem thông tin hệ thống
  • WYSIWYG Text Editor: Imperavi Reactor
  • Widget Ace Editor
  • Config sẵn môi trường Test
  • Nén và nối tài nguyên (JS, CSS)
  • và nhiều chức năng nữa mà tôi lười liệt kê 😀

Các bước cài cắm:

  1. Tải source về, hiện tại đang để tại path sau:
    https://drive.google.com/a/3si.vn/file/d/0BzBKjMsydtYMQ1VkU1NwU3dtZEE/view?usp=sharing
    Chú ý đăng nhập với tài khoản 3si.vn
  2. Tạo DB:
    Name: 3si-yii2 (demo thế, sau này vào product thích đổi thành gì cũng được, miễn là sửa trong file config theo)
    Character set: utf8 -- UTF-8 Unicode
    Collation: utf8_general_ci

    Dùng PhpMyAdmin hoặc Navicat để import file DB tại đường dẫn db/3si-yii2.sql vào DB vừa tạo

  3. Chỉnh sửa config DB trong source
    Đường dẫn: common/config/base.php
    Đoạn code:

    XHTML
    1
    2
    3
    4
    5
    6
    7
            'db'=>[
                'class'=>'yii\db\Connection',
                'dsn' => 'mysql:host=localhost;port=3306;dbname=3si-yii2',
                'username' => 'root',
                'password' => 'password',
                ...
            ]

    Thay bằng config DB của các bạn.

  4. Chỉnh sửa virtual host của Apache
    Tôi dùng XAMPP trên Windows để phát triển, file cần chỉnh sửa ở đường dẫn sau: C:\xampp\apache\conf\extra\httpd-vhosts.conf
    Nội dung thêm vào:

    XHTML
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    <VirtualHost *:80>
        ServerName 3si-yii2.dev
        #ErrorLog /dev/null
        #LogLevel emerg
        #CustomLog /dev/null combined
     
        RewriteEngine on
        # the main rewrite rule for the frontend application
    RewriteCond %{HTTP_HOST} ^3si-yii2.dev$ [NC]
        RewriteCond %{REQUEST_URI} !^/(backend/web|admin|storage/web)
        RewriteRule !^/frontend/web /frontend/web%{REQUEST_URI} [L]
        # redirect to the page without a trailing slash (uncomment if necessary)
        #RewriteCond %{REQUEST_URI} ^/admin/$
        #RewriteRule ^(/admin)/ $1 [L,R=301]
        # disable the trailing slash redirect
        RewriteCond %{REQUEST_URI} ^/admin$
        RewriteRule ^/admin /backend/web/index.php [L]
        # the main rewrite rule for the backend application
        RewriteCond %{REQUEST_URI} ^/admin
        RewriteRule ^/admin(.*) /backend/web$1 [L]
     
        DocumentRoot "D:\Development\3SX_Crisis\3si-yii2"
        <Directory />
            Options FollowSymLinks
            AllowOverride None
            AddDefaultCharset utf-8
        </Directory>
        <Directory "D:\Development\3SX_Crisis\3si-yii2\frontend\web">
            RewriteEngine on
            # if a directory or a file exists, use the request directly
            RewriteCond %{REQUEST_FILENAME} !-f
            RewriteCond %{REQUEST_FILENAME} !-d
            # otherwise forward the request to index.php
            RewriteRule . index.php
     
            Require all granted
        </Directory>
        <Directory "D:\Development\3SX_Crisis\3si-yii2\backend\web">
            RewriteEngine on
            # if a directory or a file exists, use the request directly
            RewriteCond %{REQUEST_FILENAME} !-f
            RewriteCond %{REQUEST_FILENAME} !-d
            # otherwise forward the request to index.php
            RewriteRule . index.php
     
            Require all granted
        </Directory>
        <Directory "D:\Development\3SX_Crisis\3si-yii2\storage\web">
            RewriteEngine on
            # if a directory or a file exists, use the request directly
            RewriteCond %{REQUEST_FILENAME} !-f
            RewriteCond %{REQUEST_FILENAME} !-d
            # otherwise forward the request to index.php
            RewriteRule . index.php
     
            Require all granted
        </Directory>
        <FilesMatch \.(htaccess|htpasswd|svn|git)>
            Require all denied
        </FilesMatch>
    </VirtualHost>

  5. Chỉnh sửa file hosts

    6. Đường dẫn: C:\Windows\System32\drivers\etc\hosts
    Nội dung thêm vào:

    XHTML
    1
    127.0.0.1 3si-yii2.dev

  6. Chỉnh sửa file php.ini của PHP

    7. Đường dẫn: C:\xampp\php\php.ini
    Un-comment/Modify/Add (tùy vào dòng đấy có hay chưa) các dòng sau:

    XHTML
    1
    2
    3
    4
    5
    extension=php_intl.dll
    extension=php_fileinfo.dll
    upload_max_filesize=8M
    [COM_DOT_NET]
    extension=php_com_dotnet.dll

  7. Restart Apache

Các component:

Đăng nhập vào hệ thống từ các URL đã define trong virtual host:
Đường dẫn đến Frontend: http://3si-yii2.dev
Đường dẫn đến Backend: http://3si-yii2.dev/admin
Username/Password: admin/3si@12345

KeyStorage

Key storage dùng để lưu trữ nhiều loại thông tin khác nhau dựa trên key-value. Ví dụ như cài đặt Ứng dụng chẳng hạn. Giá trị có thể thay đổi thông qua api hoặc component CRUD trong backend.

PHP
1
2
Yii::$app->keyStorage->set('articles-per-page', 20);
Yii::$app->keyStorage->get('articles-per-page'); // 20

Chế độ Bảo trì

Component này sẽ bắt tất cả các request tới, set cho nó HTTP header trả lại là (503, “Retry After”) và hiển thị 1 message bảo trì. Các tùy chọn config khác có thể tìm thấy trong class tương ứng.
3si-yii2 được cài đặt sẵn để bật chế độ bảo trì lên nếu giá trị frontend.maintenance trong KeyStorage được set thành true

Timeline

PHP
1
2
3
4
5
6
$addToTimelineCommand = new AddToTimelineCommand([
    'category' => 'user',
    'event' => 'signup',
    'data' => ['foo' => 'bar']
]);
Yii::$app->commandBus->handle($addToTimelineCommand);

Các Widget config được trong backend

Carousel

  1. Tạo carousel trong backend.

  2. Sử dụng:
    PHP
    1
    <?php echo DbCarousel::widget(['key' => 'index-en']) ?>

DbText

  1. Tạo text block trong backend.

  2. Sử dụng:
    PHP
    1
    <?php echo DbText::widget(['key' => 'backend_welcome']) ?>

DbMenu

  1. Tạo menu trong backend.
  2. Sử dụng:
    PHP
    1
    <?php echo DbMenu::widget(['key' => 'frontend-feature']) ?>

Các Widget khác

Grid

EnumColumn

PHP
1
2
3
4
5
[
      'class' => '\common\grid\EnumColumn',
      'attribute' => 'status',
      'enum' => User::getStatuses() // [0=>'Deleted', 1=>'Active']
]

API

3si-yii2 có module REST API được config và sẵn sàng sử dụng. Các bạn có thể truy cập nó từ link http://3si-yii2.dev/api/v1. Ví dụ GET users:

Kết quả nhận về:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
[
  {
    "id": 1,
    "username": "admin",
    "created_at": 1453089507
  },
  {
    "id": 2,
    "username": "manager",
    "created_at": 1453089508
  },
  {
    "id": 3,
    "username": "user",
    "created_at": 1453089509
  },
]

MultiModel

common\base\MultiModel – class phục vụ cho việc xử lý nhiều model trong 1 tại controller:

PHP
1
2
3
4
5
6
7
8
9
10
$model = new MultiModel([
    'models' => [
        'user' => $userModel,
        'profile' => $userProfileModel
    ]
]);
 
if ($model->load(Yii::$app->request->post()) && $model->save()) {
    ...
}

Tại view:

PHP
1
2
<?php echo $form->field($model->getModel('account'), 'username') ?>
<?php echo $form->field($model->getModel('profile'), 'middlename')->textInput(['maxlength' => 255]) ?>  

Gen code với Gii

Các bạn đã quen gen code với Gii? Đừng lo, nó ở đây:


MSF: Microsoft Source of Fame