zxf/tools 使用手册

数据操作模型类 Model

Model 是一个通过pdo驱动查询mysql的 模型操作类
只需要继承 Model 类，就可以使用 Model类 和 Db类 的所有方法

说明

对模型列表的操作是基于 [集合操作Collection] 实现的

安装

composer require zxf/tools

配置

需要在config目录下创建tools_database.php文件，内容如下
<?php
// ====================================================
// 数据库相关的配置，mysql、redis、elastic 等
// ====================================================
return [
    'default' => [
        'driver'     => 'mysql', // 默认数据库驱动名称，和下面default同级的键名对应，支持: mysql、pgsql、sqlite、sqlserver、oracle
        'connection' => 'default', // 默认连接名称
    ],
    'redis'   => [
        'default' => [
            'host'    => env('REDIS_HOST', ''),
            'port'    => env('REDIS_PORT', '6379'),
            'timeout' => env('TOOLS_REDIS_TIME_OUT', '5'),
            'auth'    => env('REDIS_PASSWORD', ''),
        ],
    ],
    //  mysql
    'mysql'   => [
        'default' => [
            'host'     => env('DB_HOST', '127.0.0.1'),
            'username' => env('DB_USERNAME', 'root'),
            'password' => env('DB_PASSWORD', ''),
            'db_name'   => env('DB_DATABASE', 'test'),
            'port'     => env('DB_PORT', 3306),
            // 'prefix'   => env('DB_PREFIX', ''),
            'charset'  => env('DB_CHARSET', 'utf8mb4'),
            'socket'   => env('DB_SOCKET', null),
        ],
    ],
    //  sqlite
    'sqlite'  => [
        'default' => [
            // SQLite数据库文件路径
            'host'     => '',
            'username' => '',
            'password' => '',
            'db_name'   => '',
            'port'     => '',
            'charset'  => '',
            'socket'   => '',
        ],
    ],
];

并且可以通过 config('tools_database.mysql.default') 函数获取到上面的配置信息，如果你实在没有或者没有使用框架，那么可以使用下面的暴力方法读取mysql连接配置信息

下面这种做法这是一个无奈之举

if (!function_exists('config')) {
   function config($key='tools_database.mysql.default')
   {
       return [
           'host'     => '127.0.0.1',
           'db_name'   => 'test',
           'username' => 'root',
           'password' => '',
       ];
   }
}

在 模型类/实体类 中使用

假设我们有一个user表，表结构如下
主键| 名称 | ... | 所属国家id | 状态 |创建时间 | 更新时间
id | name | ... | country_id | status |created_at | updated_at

先定义一个 User 类，继承 Model 类

use zxf\Database\Model;

// 用户实体/模型类
class User extends Model
{
    /**
     * 表的主键id,默认为 id，如果不是 id，需要定义 $primaryKey 属性，如果主键值是id，可以不定义
     *
     * @var string
     */
    protected $primaryKey = 'id';
    
    /**
     * 表名称，如果不设置则默认为类名的 [下划线] 形式,如果表名和类名不一致，需要定义 $table 属性
     *     例如：如果类名为 User 对应的数据库表名为 user，如果不是就需要定义 $table 属性
     *          如果类名为 UserRole 对应的数据库表名为 user_role
     *
     * @var string
     */
    protected $tables = 'users';
    
    /**
     * 定义一个用户有多个关联地址 (一对多关系)
     */
    public function address(){
        return $this->hasMany(Address::class, 'user_id', 'id');
    }
    
    /**
     * 定义一个用户从属于一个国家 (多对一关系)
     */
    public function country(){
        return $this->belongsTo(Country::class, 'country_id', 'id');
    }
    
    /**
    * 定义一个用户有一个身份证信息 (一对一关系)
    */
    public function idCard(){
        return $this->hasOne(IdCard::class, 'user_id', 'id');
    }
    
    /**
    * 定义一个用户在多个文章中发表了评论 (远程一对多关系)
    */
    public function posts(){
        return $this->belongsToMany(Post::class, Articel::class, 'user_id', 'article_id','id','id');
    }
    
    /**
    * 定义一个用户有多个角色 (多对多关系)
    */
    public function roles(){
        return $this->belongsToMany(Role::class, UserRole::class, 'user_id', 'role_id','id','id');
    }
}

调用User实体类的方法

use xxx/User;// 引入上面定义的 User 类

class TestUser
{
    public function getUserList(){
        $user = new User();
        $res = $user->where('status',1)->get();
        
        foreach($res as $key => $item){

            // 打印获取到的每个用户数据
            print_r($item->toArray());

            // 获取用户的名称
            print_r($item->name);
            
            // 修改id为1的用户的名称
            if($item->id == 1){
                $item->name = 'name_测试';
                $item->save();
            }
            
            // 删除没有关联国家的用户
            if($item->country_id == 0){
                $item->delete();
            }
            // 获取用户所属国家信息
            $country = $item->country;
            
            // 根据用户所属国家关联进行其他操作查询
            $country = $item->country()->...->get(); 
        }

        dd($res,$res->toArray());
    }
    
    // ...
}

支持的操作方法

获取表名称

class TestUser
{
    public function test(){
        $user = new User();
        $user->getTableName();
    }
}

插入数据

class TestUser
{
    public function test1(){
        $user = new User();
        $user->insert([ // insert 方法返回的是插入的行数
            'name' => '...',
            ...
        ]);
    }
    
    public function test2(){
        $user = new User([
            'name' => '...',
            ...
        ]);
        $user->create(); // insert 方法返回的是插入的行数
    }
    
    public function test3(){
        $user = new User();
        $user->insertGetId([ // insertGetId 方法返回的是插入的id
            'name' => '...',
            ...
        ]);
    }
}

查询数据

class TestUser
{
    public function test1(){
        $user = User::query()->find(1);
    }
    
    public function test2(){
        $user = User::query()->where('status',1)->get();
    }
    
    public function test3(){
        $user = User::query()->where('status',1)->find();
    }
    
    public function test4(){
        $user = User::query()
          ->where(function($query){
             $query->where('age','>',21);
          })
          ->get();
    }
    
    // ...

更新数据

class TestUser
{
    public function test1(){
        $user = User::query()->find(1);
        $user->update([
            'name' => '...',
            ...
        ]);
    }
    
    public function test2(){
        $user = User::query()
            ->where('id',1)
            ->update([
                'name' => '...',
                ...
            ]);
    }

    public function test3(){
        $user = User::query()->get();
        foreach ($user as $item) {
            $item->name = 'name ' . $item->id;
            $item->save();
        }
    }

    // 批量更新数据
    public function test3(){
        // 参数1：需要更新或插入的数据
        // 参数2：需要更新或插入的数据的主键或能识别此行数据的唯一值【来自第一个字段】
        // 参数3：需要更新那个字段【来自第一个字段】
        $res = User::query()->upsert([
            [
                'id'    => 1,
                "title" => "title upsert 1 " . time(),
            ], [
                'id'    => 2,
                "title" => "title upsert 2 " . time(),
            ],
        ], [
            'id',
        ], [
            'title',
        ]);
    }
}

删除数据

class TestUser
{
    public function test1(){
        User::query()->where('id',1)->delete();
    }
}

高级用法

class TestUser
{
    // 关联数据查询
    public function test1(){
        $user = User::query()->find(1);
        $user->roles()->get();
        // OR
        $user->roles()->where(...)->get();
    }

    // 关联数据查询 idCard 是一个已定义的关联函数
    public function test2(){
        $user = User::query()->find(1);
        $idcard = $user->idCard;
    }
}
← 上一篇「MySQL-Db操作」 下一篇「Redis 操作」 →
浏览次数：331
|
更新时间：2024-06-06
著作权归编辑者所有，未经许可，禁止转载、复制此文档的任何内容。
如有问题？请与「我们」联系

文档
菜单