YII框架常用技巧总结

发布于

本文实例总结了YII框架常用技巧。分享给大家供大家参考，具体如下：

获取当前Controller name和action name（在控制器里面使用）

代码语言：javascript
复制
echo $this- id;
echo $this- action- id;

控制器获取当前模块

代码语言：javascript
复制
$this- module- id

不生成label标签

代码语言：javascript
复制
// ActiveForm类
$form- field($model, '字段名')- passwordInput(['maxlength' =  true])- label(false)

Yii2 获取接口传过来的 JSON 数据：

代码语言：javascript
复制
Yii::$app- request- rawBody;

防止 SQL 和 Script 注入:

代码语言：javascript
复制
use yii\helpers\Html;
use yii\helpers\HtmlPurifier;
echo Html::encode($view_hello_str) //可以原样显示<script </script 代码
echo HtmlPurifier::process($view_hello_str) //可以过滤掉<script </script 代码

大于、小于条件查询

代码语言：javascript
复制
// SELECT * FROM `order` WHERE `subtotal`   200 ORDER BY `id`
$orders = $customer- getOrders()
- where([' ', 'subtotal', 200])
- orderBy('id')
- all();

搜索的时候添加条件筛选

代码语言：javascript
复制
$dataProvider = $searchModel- search(Yii::$app- request- queryParams);
// $dataProvider- query- andWhere(['pid' =  0]);
$dataProvider- query- andWhere([' ', 'pid', 0]);
//可选传参
$dataProvider- query- andFilterWhere(['id'= isset($id)?$id:null]);

有两种方式获取查询出来的 name 为数组的集合 [name1, name2, name3]：

方式一：

代码语言：javascript
复制
return \yii\helpers\ArrayHelper::getColumn(User::find()- all(), 'name');

方式二：

代码语言：javascript
复制
return User::find()- select('name')- asArray()- column();

打印数据：

代码语言：javascript
复制
// 引用命名空间
use yii\helpers\VarDumper;
// 使用
VarDumper::dump($var);
// 使用2 第二个参数是数组的深度 第三个参数是是否显示代码高亮（默认不显示）
VarDumper::dump($var, 10 ,true);die;

表单验证，只要需要一个参数：

代码语言：javascript
复制
public function rules()
{
  return [
    [['card_id', 'card_code'], function ($attribute, $param) {//至少要一个
      if (empty($this- card_code) && empty($this- card_id)) {
        $this- addError($attribute, 'card_id/card_code至少要填一个');
      }
    }, 'skipOnEmpty' =  false],
  ];
}

SQL is not null条件查询

代码语言：javascript
复制
// ['not' =  ['attribute' =  null]]
//['ISNULL(`attribute`)'= true]
$query = new Query;
$query- select('ID, City,State,StudentName')
  - from('student')
  - where(['IsActive' =  1])
  - andWhere(['not', ['City' =  null]])
  - andWhere(['not', ['State' =  null]])
  - orderBy(['rand()' =  SORT_DESC])
  - limit(10);

校验 point_template_id 在 PointTemplate 是否存在

代码语言：javascript
复制
public function rules()
{
  return [
    [['point_template_id'], 'exist',
      'targetClass' =  PointTemplate::className(),
      'targetAttribute' =  'id',
      'message' =  '此{attribute}不存在。'
    ],
  ];
}

Yii给必填项加星

代码语言：javascript
复制
div . required label:after {
  content:
  " *";
  color:
  red;
}

执行SQL查询并缓存结果

代码语言：javascript
复制
$styleId = Yii::$app- request- get('style');
$collection = Yii::$app- db- cache(function ($db) use ($styleId) {
  return Collection::findOne(['style_id' =  $styleId]);
}, self::SECONDS_IN_MINITUE * 10);

场景:

数据库有user表有个avatar_path字段用来保存用户头像路径

需求: 头像url需要通过域名http://b.com/作为基本url

目标: 提高代码复用

此处http://b.com/可以做成一个配置

示例:

User.php

代码语言：javascript
复制
class User extends \yii\db\ActiveRecord
{
...
  public function extraFields()
  {
    $fields = parent::extraFields();
    $fields['avatar_url'] = function () {
      return empty($this- avatar_path) ? '可以设置一个默认的头像地址' : 'http://b.com/' . $this- avatar_path;
    };
    return $fields;
  }
...
}

ExampleController.php

代码语言：javascript
复制
class ExampleController extends \yii\web\Controller
{
  public function actionIndex()
  {
    $userModel = User::find()- one();
    $userData = $userModel- toArray([], ['avatar_url']);
    echo $userData['avatar_url']; // 输出内容: http://b.com/头像路径
  }
}

Model 里面 rules 联合唯一规则

复制代码 代码如下:

[[‘store_id’, ‘member_name’], ‘unique’, ‘targetAttribute’ = [‘store_id’, ‘member_name’], ‘message’ = ‘The combination of Store ID and Member Name has already been taken.’],

Model多个字段一条规则不同提示

代码语言：javascript
复制
[['name', 'email', 'subject', 'body'], 'required','message'= '{attribute} 必须'],

标量查询

代码语言：javascript
复制
Post::find()- select('title')- where(['user_id' =  $userId])- scalar();

生成 SQL：

代码语言：javascript
复制
SELECT `title` FROM `post` WHERE `user_id` = 1

直接输出 title 的值。

如果 select(‘title’) 不写的话，生成 SQL 是：

代码语言：javascript
复制
`SELECT * FROM `post` WHERE `user_id`=1`

直接输出 id 的值

表单验证，去除首尾空格：

代码语言：javascript
复制
public function rules()
{
  return [[title', 'content'],'trim']];
}

单独为某个Action关闭 Csrf 验证

新建一个Behavior

代码语言：javascript
复制
use Yii;
use yii\base\Behavior;
use yii\web\Controller;
class NoCsrf extends Behavior
{
  public $actions = [];
  public $controller;
  public function events()
  {
    return [Controller::EVENT_BEFORE_ACTION =  'beforeAction'];
  }
  public function beforeAction($event)
  {
    $action = $event- action- id;
    if (in_array($action, $this- actions)) {
      $this- controller- enableCsrfValidation = false;
    }
  }
}

然后在Controller中添加Behavior

代码语言：javascript
复制
public function behaviors()
{
  return [
    'csrf' =  [
      'class' =  NoCsrf::className(),
      'controller' =  $this,
      'actions' =  [
        'action - name'
      ]
    ]
  ];
}

LIKE 查询 单边加 %

代码语言：javascript
复制
['like', 'name', 'tester'] 会生成 name LIKE ' % tester % '。
['like', 'name', ' % tester', false] =  name LIKE ' % tester'
$query = User::find()- where(['LIKE', 'name', $id . ' % ', false]);

SQL 随机抽取十名幸运用户

代码语言：javascript
复制
$query = new Query;
$query- select('ID, City,State,StudentName')
  - from('student')
  - where(['IsActive' =  1])
  - andWhere(['not', ['State' =  null]])
  - orderBy(['rand()' =  SORT_DESC])
  - limit(10);

关于事务：

代码语言：javascript
复制
Yii::$app- db- transaction(function () {
  $order = new Order($customer);
  $order- save();
  $order- addItems($items);
});
// 这相当于下列冗长的代码：
$transaction = Yii::$app- db- beginTransaction();
try {
  $order = new Order($customer);
  $order- save();
  $order- addItems($items);
  $transaction- commit();
} catch (\Exception $e) {
  $transaction- rollBack();
  throw $e;
}

批量插入数据

第一种方法

代码语言：javascript
复制
$model = new User();
foreach ($data as $attributes) {
  $_model = clone $model;
  $_model- setAttributes($attributes);
  $_model- save();
}

第二种方法

代码语言：javascript
复制
$model = new User();
foreach ($data as $attributes) {
  $model- isNewRecord = true;
  $model- setAttributes($attributes);
  $model- save() && $model- id = 0;
}

URL操作

获取url中的host信息

代码语言：javascript
复制
Yii::$app- request- getHostInfo()

获取url中的路径信息（不包含host和参数）：

代码语言：javascript
复制
Yii::$app- request- getPathInfo()

获取不包含host信息的url（含参数）：

代码语言：javascript
复制
# /public/index.php?r=news&id=1
Yii::$app- request- url

或者

代码语言：javascript
复制
Yii::$app- request- requestUri

只想获取url中的参数部分

代码语言：javascript
复制
# r=news&id=1
Yii::$app- getRequest()- queryString;

获取某个参数的值，比如id

代码语言：javascript
复制
Yii::$app- getRequest()- getQuery('id'); //get parameter 'id'

获取（除域名外的）首页地址

代码语言：javascript
复制
# /public/index.php
Yii::$app- user- returnUrl;

获取Referer

代码语言：javascript
复制
Yii::$app- request- headers['Referer']

或者

代码语言：javascript
复制
Yii::$app- getRequest()- getReferrer()
#sql#http#yii#php