自定义模型类

2019-08-12 14:45:25 浏览数 (1)

模型类并非必须定义,只有当存在独立的业务逻辑或者属性的时候才需要定义。模型类的作用大多数情况是操作数据表的,如果按照系统的规范来命名模型类的话,大多数情况下是可以自动对应数据表。

1.模型类通常需要继承系统的ThinkModel类或其子类,下面是一个HomeModelUserModel类的定义:

  1. namespace HomeModel;
  2. use ThinkModel;
  3. class UserModel extends Model {
  4. }

模型类的命名规则是除去表前缀的数据表名称,采用驼峰法命名,并且首字母大写,然后加上模型层的名称(默认定义是Model),例如:

如果你的规则和上面的系统约定不符合,那么需要设置Model类的数据表名称属性,以确保能够找到对应的数据表。

2.表信息定义:设置tablePrefix, tableName, trueTableName,dbName属性 (可选)

如果你的类名和配置文件这些都设置的刚刚好就无需设置上面那些属性。

数据表定义

举个例子来加深理解,例如,在数据库里面有一个think_categories表,而我们定义的模型类名称是CategoryModel,按照系统的约定,这个模型的名称是Category,对应的数据表名称应该是think_category(全部小写),但是现在的数据表名称是think_categories,因此我们就需要设置tableName属性来改变默认的规则(假设我们已经在配置文件里面定义了DB_PREFIX 为 think_)。

  1. namespace HomeModel;
  2. use ThinkModel;
  3. class CategoryModel extends Model {
  4. protected $tableName = 'categories';
  5. }

注意这个属性的定义不需要加表的前缀think_

如果我们需要CategoryModel模型对应操作的数据表是 top_category,那么我们只需要设置数据表前缀即可:

  1. namespace HomeModel;
  2. use ThinkModel;
  3. class CategoryModel extends Model {
  4. protected $tablePrefix = 'top_';
  5. }

如果你的数据表直接就是category,而没有前缀,则可以设置tablePrefix为空字符串。

  1. namespace HomeModel;
  2. use ThinkModel;
  3. class CategoryModel extends Model {
  4. protected $tablePrefix = '';
  5. }

没有表前缀的情况必须设置,否则会获取当前配置文件中的 DB_PREFIX

而对于另外一种特殊情况,我们需要操作的数据表是top_categories,这个时候我们就需要定义 trueTableName 属性

  1. namespace HomeModel;
  2. use ThinkModel;
  3. class CategoryModel extends Model {
  4. protected $trueTableName = 'top_categories';
  5. }

注意trueTableName需要完整的表名定义。

除了数据表的定义外,还可以对数据库进行定义(用于操作当前数据库以外的数据表),例如 top.top_categories

  1. namespace HomeModel;
  2. use ThinkModel;
  3. class CategoryModel extends Model {
  4. protected $trueTableName = 'top_categories';
  5. protected $dbName = 'top';
  6. }

系统的规则下,tableName会转换为小写定义,但是trueTableName定义的数据表名称是保持原样。

3. 表字段定义(属性,可选)

1.部署模式 -自动生成

系统会在模型首次实例化的时候自动获取数据表的字段信息(而且只需要一次,以后会永久缓存字段信息,除非设置不缓存或者删除)

  2.调试模式-自动生成

不会生成字段缓存文件,每次都会重新获取数据表字段信息。

3.手动定义 优点:可以避免IO加载的效率开销 缺点:定义了fields属性之后,就不会自动获取数据表的字段信息了。如果有修改或者增加字段,必须手动修改fields属性的值。

代码语言:javascript复制
protected $fields = array(
                'id', 'username', 'email', 'age', 
                // _pk 表示主键字段名称 
                '_pk' => 'id',
                //_autoinc 表示主键是否自动增长类型
                 '_autoinc' => true
            );

字段的访问

thinkphp支持对象和数组两种方式来访问数据属性

对象访问

代码语言:javascript复制
//实例化User模型
$User = D('User');
//查询用户数据
$User->find(1);
//获取name属性的值
echo $User->name;
//设置name属性的值
$User->name = 'ThinkPHP';
$User->create();
echo $User->name;

数组访问

代码语言:javascript复制
 //实例化User模型
$User = D('User');
//查询用户数据
$data = $User->find(1);
//获取name属性的值
echo $data['name'];
//设置name属性的值

$data['name'] = 'ThinkPHP';

4. 一个完整的Model的定义

代码语言:javascript复制
<?php

class UserModel extends Model{

/*****第一部分:表信息定义 (可选),参考2 ********/

代码语言:javascript复制
    //不需要加表的前缀,表前缀在配置文件中定义
    protected $tableName = 'categories'; 
    //数据库中有一个表(top_depts)的前缀和其它表前缀不同。这一条属性与前一条不同时出现
    protected $trueTableName = 'top_depts'; 
    注意trueTableName需要完整的表名定义
    //可选 - 对数据库进行定义

protected $dbName = 'top';

/*****第二部分:表字段定义 (可选)参考3********/

protected $fields = array(

代码语言:javascript复制
            'id', 'username', 'email', 'age', 
            // _pk 表示主键字段名称 
            '_pk' => 'id',
            //_autoinc 表示主键是否自动增长类型
             '_autoinc' => true

);

/*****第三部分:业务逻辑定义 (可选)********/

代码语言:javascript复制
 public function getTopUser(){
            //添加自己的业务逻辑
             // ...
        }
    }

0 人点赞