tp5 关联模型

现在我们设计了一个如下的数据库表，需要设计出 tp5 相应的关联模型，并能进行相应的查询。

image image image

我们先来分析一下各个表的关系，首先 banner 表和 banner_item 表是一对多的关系，banner_item 表和 image 表是一对一的关系。

我们用以下命令行来快速创建三个对应的模型：

php think make:model api/XxxXxx

创建 Banner 、BannerItem 和 Image 模块。
然后我们创建 Banner 控制器类，通过 banner 的 id 拿到下面的 banner_item 和对应的 image 图片，返回给前端。
在 Banner 模块中：
我们首先对一些于前端无意的值进行隐藏。
然后通过 items 方法中的 hasMany 进行关联 banner_item 表。第二个参数是外键，第三个参数是主键，由于是一对多的关系，所以 banner 表是主键表，banner_item 是外键表，所以第二个参数填 banner_id，第三个参数填 id。
最后一个 getBannerByID 方法是由控制器调用的，其中的 with 起到了关联查询的作用，数组中的参数对应着 Banner 模块的 items 方法和 BannerItem 模块中的 img 方法。

protected $hidden = ['delete_time','update_time'];

public function items(){
  return $this->hasMany('BannerItem','banner_id','id');
}

public static function getBannerByID($id){
  $banenr = self::with(['items','items.img'])
      ->find($id);
  return $banner;
}

在 BannerItem 模块中：
belongsTo 方法虽然是一对一关系，但是是有指向性的，与 hasOne 有区别，可以认为 belongsTo 略带从属意味，所以第二个参数（外键）是 banner_item 表的 img_id 字段，而第三个参数（主键）是 image 表的 id 字段。

protected $hidden = ['delete_time','update_time','id','img_id','banner_id'];

public function img(){
  return $this->belongsTo('Image','img_id','id');
}

在 Image 模块中我们有图片的 url 路径需要处理，在数据库中我们的 url 路径是相对路径，如果 from 的值是1，那么我们需要在其前面拼接根路径，而对于 from 的值是2的我们不需要拼接，而是直接返回（因为他是一个网络路径）。
但是由于 url 的处理很多地方都会用到，为了提高此处的复用性，我们可以写一个 Model 基类：BaseModel，让它继承 Model，而其他我们自己的模块类继承 BaseModel，这样就可以用到它的方法：

class BaseModel extends Model
{
    protected function prefixImgUrl($value,$data)
    {
        $finalUrl = $value;
        if ($data['from'] == 1){
            $finalUrl = config('setting.img_prefix').$value;
        }
        return $finalUrl;
    }
}

这里的 config('setting.img_prefix')
是我们自己的配置文件的配置项。

image

<?php
return [
    'img_prefix' => 'http://z.cn/images'
];

image

现在基类编写完了，我们写一下 Image 模块：

class Image extends BaseModel
{
    protected $hidden = ['delete_time', 'update_time', 'id', 'from'];

    public function getUrlAttr($value,$data){
        return $this->prefixImgUrl($value,$data);
    }
}  

getUrlAttr 这个方法的名字并不是我们自己随便起的，而是遵从这种命名规范的方法会被 tp5 自动视为读取器，将会对名为 url 的字段进行相应处理后，返回的值才是 $banner 对象中的对应的值。其中 $value 参数是 url 的一个个的值，而$data参数包含着这条记录的所有的字段。
另外，这里我们不直接在 BaseModel 中写 getUrlAttr，是因为如果这样做了，我们所有的模块类都继承 BaseModel，所以会自动继承 getUrlAttr，如果遇到了特殊的 url 处理情况并不能很好应对，所以我们做了简单封装，在 Image 模块中写 getUrlAttr 方法，返回 prefixImgUrl 方法。
至此，模块类都已经写完了。
下面我们写一下控制器类：

class Banner
{
    /**
     * 获取指定id的banner信息（为了通用性，需要传入$id，应对多个Banner位的情况）
     * @url /banner/:id
     * @http GET
     * @id banner的id号
     */
    public function getBanner($id)
    {
        (new IDMustBePositiveInt())->goCheck();

        $banner = BannerModule::getBannerByID($id);

        if (!$banner) {
            throw new BannerMissException();
        }

        return $banner;
    }
}

最后我们看一下运行结果：

image

这样我们没有写过 join 查询，而且将所有对前端有意义的字段就都展示出来了。

上面我们没有用到 hasOne，而是用了 belongsTo，下面总结一下这两者的区别：
用 hasOne 的模块对应的表自己有主键，它关联的表有外键。而用 belongsTo 的模块对应的表自己有外键，它关联的表有主键。
一定要注意一对一关系实际上并不是对等的