php的db类库Eloquent单独使用系列（4）- 事件监听

我的Eloquent单独使用系列文章
php的db类库Eloquent单独使用系列（1）
php的db类库Eloquent单独使用系列（2） - 分页
php的db类库Eloquent单独使用系列（3） - sql日志
php的db类库Eloquent单独使用系列（4）- 事件监听
php的db类库Eloquent单独使用系列（5）- 模型转数组
php的db类库Eloquent单独使用系列（6）- 一对一关联
php的db类库Eloquent单独使用系列（7）- 一对多关联
php的db类库Eloquent单独使用系列（8）- 多对多关联
php的db类库Eloquent单独使用系列（9）- 多对多关联 - 表关联自身
php的db类库Eloquent单独使用系列（10）- 多对多关联 - 远程一对多
php的db类库Eloquent单独使用系列（11）- 多对多关联 - 添加模型属性
php的db类库Eloquent单独使用系列（12）- 结果集模型转数组 - 2


本系列文章的目的就是脱离laravel环境使用Eloquent，因为它好用。
本系列文章所有代码均测试通过。Eloquent版本：5.4.27

本文的目的是使用事件，即钩子函数，用于保存前后，修改数据模型前后，删除前后。

下面的代码假定使用了一个表test2。

主要是4个文件，名字都可以自己改。路径也可以自己改，只要改namespace即可。
1）User是模型文件，里面啥都没有，从我目前测试结果看，也无法在类里面写监听。
2）程序主文件。Ill.php
3）sql日志事件文件。SqlListener
4）User观察者类。需被手动注册到User类上面。
文件层次：
app
  - control
     - Ill.php
  - model
     - SqlListener.php
     - User.php
     - UserObserver.php
模型文件User.php

<?php
namespace app\model;
use \Illuminate\Database\Eloquent\Model;

/**
 * User模型类
 */
class User extends Model 
{
    protected $table = 'test2';
    public $timestamps = false;
    
    // 这是我自己添加的，记录错误信息
    private $errinfo='';
    
    public function set_errinfo($info)
    {
        $this->errinfo = $info;
    }
    
    public function get_errinfo()
    {
        return $this->errinfo ;
    }
}

观察者类UserObserver.php

<?php
namespace app\model;
use app\model\User;

/**
 * User类的观察者。放置了各种钩子函数
 *
 */
class UserObserver
{
    
    /**
     * 添加用户钩子
     *
     * 特别点在于，前置类型的钩子，如返回假则后面不执行。
     * 后缀是ing的钩子函数，就是前置类型的钩子。如updating，deleting等。共5个。
     *
     * @param  User  $user
     * @return void
     */
    public function creating(User $user)
    {
        if ( strlen( $user->user) <2  ) {
            $user->set_errinfo("creating: 用户名至少两个字符");
            return false;
        }
    }
   
    /**
     * 添加用户钩子
     *
     * @param  User  $user
     * @return void
     */
    public function created(User $user)
    {
        echo "<b>in UserObserver.created：". $user->id ."</b><br>";
    }
    
    /**
     * 修改用户钩子
     *
     * @param  User  $user
     * @return void
     */
    public function updated(User $user)
    {
        echo "<b>in UserObserver.updated：". $user->id ."</b><br>";
    }
}

sql日志文件

<?php
namespace app\model;
use Illuminate\Events\Dispatcher;
use Illuminate\Database\Events\QueryExecuted;

/**
 * sql监听类，记录sql日志。
 */
class SqlListener extends Dispatcher
{
    /**
     * 注意：就改这个函数。也可以记录到文件日志里。
     *
     * @param  string|object  $event
     * @param  mixed  $payload
     * @param  bool  $halt
     * @return array|null
     */
    public function dispatch($event, $payload = [], $halt = false)
    {
        if ($event instanceof  QueryExecuted) {
            $sql=$event->sql;
            if ($event->bindings) {
                foreach($event->bindings as $v) {
                    $sql = preg_replace('/\\?/', "'". addslashes( $v)."'", $sql,1);
                }
            }
            echo "log: ".$sql."<br>";
        }
    }
}

主程序

<?php
namespace app\control;

use Illuminate\Database\Capsule\Manager;
use Illuminate\Events\Dispatcher;
use app\model\User;
use app\model\SqlListener;

class Ill 
{
    /**
     * 主程序。
     */
    public function hook() 
    {
        $capsule = new Manager ();
        $capsule->addConnection ( [ 
            'driver' => 'mysql',
            'host' => '127.0.0.1',
            'database' => 'test1',
            'username' => 'root',
            'password' => 'root',
            'charset' => 'utf8mb4',
            'collation' => 'utf8mb4_unicode_ci',
            'prefix' => '' 
        ] );
        $capsule->setAsGlobal ();
        $capsule->bootEloquent ();
        // 设置sql日志监听
        $capsule->setEventDispatcher ( new SqlListener () );
        // User模型类加钩子
        User::setEventDispatcher ( new Dispatcher () );
        User::observe ( \app\model\UserObserver::class );
        // 这句话单纯测试log
        $users = $capsule::select ( 'SELECT * FROM test2 limit 1' );
        
        // 下面几句测log + 钩子
        $user = new User ();
        $user->user = '11';
        $result = $user->save (); // 新模型添加
        $user->user = '22';
        $result = $user->save (); // 已经不是新模型，是已存在模型，所以是修改。
        
        $user = new User ();
        $user->user = '3'; // 故意填写过短的用户名
        $result = $user->save (); // 注意这里！因为创建模型前置函数creating返回假。
        if (! $result) {
            echo $user->get_errinfo () . "<br>";
        }
        
        echo 'all ok！';
    }
}

下面是浏览器输出结果

log: SELECT * FROM test2 limit 1
log: insert into `test2` (`user`) values ('11')
in UserObserver.created：120
log: update `test2` set `user` = '22' where `id` = '120'
in UserObserver.updated：120
creating: 用户名至少两个字符
all ok！

总结：总的来说，还是很好用的。但是，手动注册观察者的代码需要封装到函数里，在php应用程序的公共起始文件里被调用。