// +---------------------------------------------------------------------- namespace think; use think\Cache; abstract class Model implements \JsonSerializable, \ArrayAccess { // 当前实例 private static $instance; // 数据库对象池 private static $links = []; // 数据库配置 protected static $connection; // 数据表名称 protected static $tableName; // 回调事件 protected static $event = []; // 数据信息 protected $data = []; // 缓存数据 protected $cache = []; // 记录改变字段 protected $change = []; // 数据表主键 protected $pk = 'id'; // 错误信息 protected $error; // 当前模型名称 protected $name; // 字段验证规则 protected $validate; // 字段完成规则 protected $auto = []; // 新增的字段完成 protected $insert = []; // 更新的字段完成 protected $update = []; // 关联 protected $relation = []; /** * 架构函数 * @access public * @param array $data 数据 */ public function __construct($data = []) { $this->data = $data; $this->name = basename(str_replace('\\', '/', get_class($this))); } // JsonSerializable public function jsonSerialize() { return $this->data; } // ArrayAccess public function offsetSet($name, $value) { $this->__set($name, $value); } public function offsetExists($name) { return $this->__isset($name); } public function offsetUnset($name) { $this->__unset($name); } public function offsetGet($name) { return $this->__get($name); } /** * 设置数据对象值 * @access public * @param mixed $data 数据 * @return Model */ public function data($data = '') { if (is_object($data)) { $data = get_object_vars($data); } elseif (!is_array($data)) { throw new Exception('data type invalid', 10300); } $this->data = $data; return $this; } /** * 转换为数组 * @access public * @return Model */ public function toArray() { if (!empty($this->data)) { return $this->data; } else { return []; } } /** * 设置数据对象的值 修改器 * @access public * @param string $name 名称 * @param mixed $value 值 * @return void */ public function __set($name, $value) { // 检测修改器 $method = 'set' . Loader::parseName($name, 1) . 'Attr'; if (method_exists($this, $method)) { $value = $this->$method($value, $this->data); } // 设置数据对象属性 if (isset($this->data[$name]) && $this->data[$name] != $value && !in_array($name, $this->change)) { $this->change[] = $name; } $this->data[$name] = $value; } /** * 获取数据对象的值 获取器 * @access public * @param string $name 名称 * @return mixed */ public function __get($name) { $value = isset($this->data[$name]) ? $this->data[$name] : null; // 检测获取器 $method = 'get' . Loader::parseName($name, 1) . 'Attr'; if (method_exists($this, $method)) { return $this->$method($value, $this->data); } if (is_null($value)) { // 检测关联数据 $method = 'getRelation' . Loader::parseName($name, 1); if (method_exists($this, $method)) { return $this->$method(); } } return $value; } /** * 检测数据对象的值 * @access public * @param string $name 名称 * @return boolean */ public function __isset($name) { return isset($this->data[$name]); } /** * 销毁数据对象的值 * @access public * @param string $name 名称 * @return void */ public function __unset($name) { unset($this->data[$name]); } /** * 判断一个字段名是否为主键字段 * @access public * @param string $key 名称 * @return void */ protected function isPk($key) { $pk = $this->pk; if (is_string($pk) && $pk == $key) { return true; } elseif (is_array($pk) && in_array($key, $pk)) { return true; } return false; } /** * 保存当前数据对象的值 无需任何参数(自动识别新增或者更新) * @access public * @return void */ public function save() { $data = $this->data; // 数据自动验证 if (!$this->dataValidate($data)) { return false; } // 数据自动完成 foreach ($this->auto as $name => $rule) { if (!in_array($name, $this->change)) { $this->change[] = $name; } $data[$name] = is_callable($rule) ? call_user_func_array($rule, [ & $data]) : $rule; } if ($this->checkPkExists($data)) { if (false === self::trigger('before_update', $data)) { return false; } // 更新的时候检测字段更改 if (!empty($this->change)) { foreach ($data as $key => $val) { if (!in_array($key, $this->change) && !$this->isPk($key) && !isset($this->relation[$key])) { unset($data[$key]); } } } // 自动更新 foreach ($this->update as $name => $rule) { $data[$name] = is_callable($rule) ? call_user_func_array($rule, [ & $data]) : $rule; } $result = self::db()->update($data); // 关联更新 if (!empty($this->relation)) { foreach ($this->relation as $key => $val) { if (isset($data[$key])) { $this->relationUpdate($key, $data[$key], $val); } } } self::trigger('after_update', $data); return $result; } else { if (false === self::trigger('before_insert', $data)) { return false; } // 自动写入 foreach ($this->insert as $name => $rule) { $data[$name] = is_callable($rule) ? call_user_func_array($rule, [ & $data]) : $rule; } $result = self::db()->insert($data); // 获取自动增长主键 $insertId = self::db()->getLastInsID(); if (is_string($this->pk) && $insertId) { $data[$this->pk] = $insertId; $this->data[$this->pk] = $insertId; } // 关联写入 if (!empty($this->relation)) { foreach ($this->relation as $key => $val) { if (isset($data[$key])) { $this->relationInsert($key, $data[$key], $val); } } } self::trigger('after_insert', $data); return $insertId ?: $result; } } /** * 删除当前的记录 * @access public * @return integer */ public function delete() { $data = $this->data; if (false === self::trigger('before_delete', $data)) { return false; } $result = self::db()->delete($data); // 关联删除 if ($result) { if (!empty($this->relation)) { foreach ($this->relation as $key => $val) { $this->relationDelete($key, $data, $val); } } } self::trigger('after_delete', $data); return $result; } /** * 设置字段验证 * @access public * @param array|bool $rule 验证规则 true表示自动读取验证器类 * @param array $msg 提示信息 * @return Model */ public function validate($rule = true, $msg = null) { if (true === $rule) { $this->validate = $this->name; } elseif (is_array($rule)) { $this->validate = [ 'rule' => $rule, 'msg' => is_array($msg) ? $msg : [], ]; } return $this; } /** * 设置字段自动完成(包括新增和更新) * @access public * @param string $field 字段名或者数组规则 * @param array|null $rule 完成规则 * @return Model */ public function auto($field, $rule = null) { if (is_array($field)) { $this->auto = array_merge($this->auto, $field); } else { $this->auto[$field] = $rule; } return $this; } /** * 设置写入自动完成 * @access public * @param string $field 字段名或者数组规则 * @param array|null $rule 完成规则 * @return Model */ public function autoInsert($field, $rule = null) { if (is_array($field)) { $this->insert = array_merge($this->insert, $field); } else { $this->insert[$field] = $rule; } return $this; } /** * 设置更新自动完成 * @access public * @param string $field 字段名或者数组规则 * @param array|null $rule 完成规则 * @return Model */ public function autoUpdate($field, $rule = null) { if (is_array($field)) { $this->update = array_merge($this->update, $field); } else { $this->update[$field] = $rule; } return $this; } /** * 数据自动验证 * @access protected * @param array $data 数据 * @return void */ protected function dataValidate(&$data) { if (!empty($this->validate)) { $info = $this->validate; if (is_array($info)) { $validate = Loader::validate(Config::get('default_validate')); $validate->rule($info['rule']); $validate->message($info['msg']); } else { $name = is_string($info) ? $info : $this->name; if (strpos($name, '.')) { list($name, $scene) = explode('.', $name); } $validate = Loader::validate($name); if (!empty($scene)) { $validate->scene($scene); } } if (!$validate->check($data)) { $this->error = $validate->getError(); return false; } $this->validate = null; } return true; } /** * 检查数据中是否存在主键值 * @access public * @param mixed $data 数据 * @return bool */ public function checkPkExists($data = []) { $data = $data ?: $this->data; $pk = $this->pk; // 如果存在主键数据 则自动作为更新条件 if (is_string($pk) && isset($data[$pk])) { return true; } elseif (is_array($pk)) { // 增加复合主键支持 foreach ($pk as $field) { if (isset($data[$field])) { return true; } } } return false; } /** * 返回模型的错误信息 * @access public * @return string */ public function getError() { return $this->error; } /** * 注册回调方法 * @access public * @param string $event 事件名 * @param callable $callback 回调方法 */ public static function event($event, $callback) { self::$event[$event] = $callback; } /** * 触发事件 * @access public * @param string $event 事件名 * @param mixed $params 传入参数(引用) */ protected static function trigger($event, &$params) { if (isset(self::$event[$event]) && is_callable(self::$event[$event])) { $result = call_user_func_array(self::$event[$event], [ & $params]); return false === $result ? false : true; } return true; } /** * 创建数据并写入 * @access public * @param mixed $data 数据 支持数组或者对象 * @return void */ public static function create($data = []) { $model = new static(); return $model->data($data)->save(); } /** * 查找单条记录 * @access public * @param array $data 主键值 * @param bool $cache 是否缓存 * @return mixed */ public static function get($data = '', $cache = false) { if ($cache) { // 查找是否存在缓存 $name = basename(str_replace('\\', '/', get_called_class())); $guid = 'model_' . $name . '_' . $data; $result = Cache::get($guid); if ($result) { return new static($result); } } $result = self::db()->find($data); if ($cache) { // 缓存模型数据 Cache::set($guid, $result->toArray()); } return $result; } /** * 查找多条记录 * @access public * @param mixed $data 主键列表 * @return array|string */ public static function all($data = []) { return self::db()->select($data); } /** * 删除记录 * @access public * @param mixed $data 主键列表 * @param bool $findFirst 是否查询 * @return integer */ public static function destroy($data, $findFirst = false) { // 保留删除的数据备用 if ($findFirst) { $resultSet = self::all($data); } if (false === self::trigger('before_delete', $findFirst ? $resultSet : $data)) { return false; } $result = self::db()->delete($data); // 关联删除 // 删除回调 self::trigger('after_delete', $findFirst ? $resultSet : $data); return $result; } // 解析模型的完整命名空间 protected function parseModel($model) { if (false === strpos($model, '\\')) { $path = explode('\\', get_called_class()); array_pop($path); array_push($path, $model); $model = implode('\\', $path); } return $model; } // 指定关联 public function relation($name, $relation = '') { if (is_array($name)) { $this->relation = array_merge($this->relation, $name); } else { $this->relation[$name] = $relation; } return $this; } // HAS ONE public function hasOne($model, $foreignKey = '', $localKey = '') { $model = $this->parseModel($model); $localKey = $localKey ?: $this->pk; $foreignKey = $foreignKey ?: $this->name . '_id'; return $model::where($foreignKey, $this->data[$localKey])->find(); } // BELONGS TO public function belongsTo($model, $localKey = '', $foreignKey = '') { $model = $this->parseModel($model); $foreignKey = $foreignKey ?: $this->pk; $localKey = $localKey ?: basename(str_replace('\\', '/', $model)) . '_id'; return $model::where($foreignKey, $this->data[$localKey])->find(); } // HAS MANY public function hasMany($model, $foreignKey = '', $localKey = '') { $model = $this->parseModel($model); $localKey = $localKey ?: $this->pk; $foreignKey = $foreignKey ?: $this->name . '_id'; return $model::where($foreignKey, $this->data[$localKey])->select(); } // BELONGS TO MANY public function belongsToMany($model, $localKey = '', $foreignKey = '') { $model = $this->parseModel($model); $foreignKey = $foreignKey ?: $this->pk; $localKey = $localKey ?: basename(str_replace('\\', '/', $model)) . '_id'; return $model::where($foreignKey, $this->data[$localKey])->select(); } // 关联写入 public function relationInsert($className, $data, $relation = []) { if (empty($relation) && isset($this->relation[$className])) { $relation = $this->relation[$className]; } $type = isset($relation['relation_type']) ? $relation['relation_type'] : $relation; $foreignKey = isset($relation['foreign_key']) ? $relation['foreign_key'] : strtolower($this->name) . '_id'; $className = isset($relation['class_name']) ? $relation['class_name'] : $className; $model = $this->parseModel(ucfirst($className)); switch ($type) { case 'has_one': $data[$foreignKey] = $this->data[$this->pk]; $model::create($data); break; case 'belongs_to': break; case 'has_many': foreach ($data as $key => &$val) { $val[$foreignKey] = $this->data[$this->pk]; } $model::insertAll($data); break; } return $this; } // 关联更新 public function relationUpdate($className, $data, $relation = []) { if (empty($relation) && isset($this->relation[$className])) { $relation = $this->relation[$className]; } $type = isset($relation['relation_type']) ? $relation['relation_type'] : $relation; $foreignKey = isset($relation['foreign_key']) ? $relation['foreign_key'] : strtolower($this->name) . '_id'; $className = isset($relation['class_name']) ? $relation['class_name'] : $className; $model = $this->parseModel(ucfirst($className)); switch ($type) { case 'has_one': $class = new $model; if ($class->checkPkExists($data)) { $class::update($data); } else { $class::where($foreignKey, $this->data[$this->pk])->update($data); } break; case 'belongs_to': break; case 'has_many': $class = new $model; foreach ($data as $key => $val) { $class::update($val); } break; } return $this; } // 关联删除 public function relationDelete($className, $data = '', $relation = []) { if (empty($relation) && isset($this->relation[$className])) { $relation = $this->relation[$className]; } $type = isset($relation['relation_type']) ? $relation['relation_type'] : $relation; $foreignKey = isset($relation['foreign_key']) ? $relation['foreign_key'] : strtolower($this->name) . '_id'; $className = isset($relation['class_name']) ? $relation['class_name'] : $className; $model = $this->parseModel(ucfirst($className)); $id = $data ? $data[$this->pk] : $this->data[$this->pk]; switch ($type) { case 'has_one': $model::where($foreignKey, $id)->delete(); break; case 'belongs_to': break; case 'has_many': $model::where($foreignKey, $id)->delete(); break; } return $this; } /** * 实例化模型 * @access public * @param array $config 配置参数 * @return object */ public static function instance() { if (is_null(self::$instance)) { self::$instance = new static(); } return self::$instance; } /** * 初始化数据库对象 * @access private * @return object */ private static function db() { $model = get_called_class(); $name = basename(str_replace('\\', '/', $model)); if (!isset(self::$links[$model])) { self::$links[$model] = Db::connect(static::$connection); self::$links[$model]->name($name); if (isset(static::$tableName)) { self::$links[$model]->setTable(static::$tableName); } } // 设置当前模型 确保查询返回模型对象 self::$links[$model]->model($model); // 返回当前数据库对象 return self::$links[$model]; } public static function __callStatic($method, $params) { return call_user_func_array([self::db(), $method], $params); } }