TableLink.php

浏览该文件的文档。

<?php
// FleaPHP Framework
//
// Copyright (c) 2005 - 2008 QeeYuan China Inc. (http://www.qeeyuan.com)
//
// 许可协议，请查看源代码中附带的 LICENSE.txt 文件，
// 或者访问 http://www.fleaphp.org/ 获得详细信息。

class FLEA_Db_TableLink
{
    var $name;

    var $tableClass;

    var $foreignKey;

    var $mappingName;

    var $oneToOne;

    var $type;

    var $sort;

    var $conditions;

    var $fields = '*';

    var $limit = null;

    var $enabled = true;

    var $countOnly = false;

    var $counterCache = null;

    var $linkRead = true;

    var $linkCreate = true;

    var $linkUpdate = true;

    var $linkRemove = true;

    var $linkRemoveFillValue = 0;

    var $saveAssocMethod = 'save';

    var $mainTDG;

    var $assocTDG = null;

    var $_req = array(
        'name',             // 关联的名字
        'tableClass',       // 关联的表数据入口对象名
        'mappingName',      // 字段映射名
    );

    var $_optional = array(
        'foreignKey',
        'sort',
        'conditions',
        'fields',
        'limit',
        'enabled',
        'countOnly',
        'counterCache',
        'linkRead',
        'linkCreate',
        'linkUpdate',
        'linkRemove',
        'linkRemoveFillValue',
        'saveAssocMethod',
    );

    var $qforeignKey;

    var $dbo;

    var $assocTDGObjectId;

    var $init = false;

    function FLEA_Db_TableLink($define, $type, & $mainTDG)
    {
        static $defaultDsnId = null;

        // 检查必须的属性是否都已经提供
        foreach ($this->_req as $key) {
            if (!isset($define[$key]) || $define[$key] == '') {
                FLEA::loadClass('FLEA_Db_Exception_MissingLinkOption');
                return __THROW(new FLEA_Db_Exception_MissingLinkOption($key));
            } else {
                $this->{$key} = $define[$key];
            }
        }
        // 设置可选属性
        foreach ($this->_optional as $key) {
            if (isset($define[$key])) {
                $this->{$key} = $define[$key];
            }
        }
        $this->type = $type;
        $this->mainTDG =& $mainTDG;
        $this->dbo =& $this->mainTDG->getDBO();
        $dsnid = $this->dbo->dsn['id'];

        if (is_null($defaultDsnId)) {
            $defaultDSN = FLEA::getAppInf('dbDSN');
            if ($defaultDSN) {
                $defaultDSN = FLEA::parseDSN($defaultDSN);
                $defaultDsnId = $defaultDSN['id'];
            } else {
                $defaultDsnId = -1;
            }
        }
        if ($dsnid == $defaultDsnId) {
            $this->assocTDGObjectId = null;
        } else {
            $this->assocTDGObjectId = "{$this->tableClass}-{$dsnid}";
        }
    }

    function & createLink($define, $type, & $mainTDG)
    {
        static $typeMap = array(
            HAS_ONE         => 'FLEA_Db_HasOneLink',
            BELONGS_TO      => 'FLEA_Db_BelongsToLink',
            HAS_MANY        => 'FLEA_Db_HasManyLink',
            MANY_TO_MANY    => 'FLEA_Db_ManyToManyLink',
        );
        static $instances = array();

        // 检查 $type 参数
        if (!isset($typeMap[$type])) {
            FLEA::loadClass('FLEA_Db_Exception_InvalidLinkType');
            return __THROW(new FLEA_Db_Exception_InvalidLinkType($type));
        }

        // tableClass 属性是必须提供的
        if (!isset($define['tableClass'])) {
            FLEA::loadClass('FLEA_Db_Exception_MissingLinkOption');
            return __THROW(new FLEA_Db_Exception_MissingLinkOption('tableClass'));
        }
        // 如果没有提供 mappingName 属性，则使用 tableClass 作为 mappingName
        if (!isset($define['mappingName'])) {
            $define['mappingName'] = $define['tableClass'];
        }
        // 如果没有提供 name 属性，则使用 mappingName 属性作为 name
        if (!isset($define['name'])) {
            $define['name'] = $define['mappingName'];
        }

        // 如果是 MANY_TO_MANY 连接，则检查是否提供了 joinTable 属性或者 joinTableClass 属性，
        // 以及assocForeignKey 属性
        if ($type == MANY_TO_MANY) {
            if (!isset($define['joinTable']) && !isset($define['joinTableClass'])) {
                FLEA::loadClass('FLEA_Db_Exception_MissingLinkOption');
                return __THROW(new FLEA_Db_Exception_MissingLinkOption('joinTable'));
            }
        }

        $instances[$define['name']] =& new $typeMap[$type]($define, $type, $mainTDG);
        return $instances[$define['name']];
    }

    function getMiddleTableName($table1, $table2)
    {
        if (strcmp($table1, $table2) < 0) {
            return $this->dbo->dsn['prefix'] . "{$table1}_{$table2}";
        } else {
            return $this->dbo->dsn['prefix'] . "{$table2}_{$table1}";
        }
    }

    function saveAssocData(& $row, $pkv)
    {
        FLEA::loadClass('FLEA_Exception_NotImplemented');
        return __THROW(new FLEA_Exception_NotImplemented('saveAssocData()', 'FLEA_Db_TableLink'));
    }

    function init()
    {
        if ($this->init) { return; }
        if (FLEA::isRegistered($this->assocTDGObjectId)) {
            $this->assocTDG =& FLEA::registry($this->assocTDGObjectId);
        } else {
            if ($this->assocTDGObjectId) {
                FLEA::loadClass($this->tableClass);
                $this->assocTDG =& new $this->tableClass(array('dbo' => & $this->dbo));
                FLEA::register($this->assocTDG, $this->assocTDGObjectId);
            } else {
                $this->assocTDG =& FLEA::getSingleton($this->tableClass);
            }
        }
        $this->init = true;
    }

    function calcCount(& $assocRowset, $mappingName, $in)
    {
        FLEA::loadClass('FLEA_Exception_NotImplemented');
        return __THROW(new FLEA_Exception_NotImplemented('calcCount()', 'FLEA_Db_TableLink'));
    }

    function _getFindSQLBase($sql, $in)
    {
        if ($in) {
            $sql .= " WHERE {$this->qforeignKey} {$in}";
        }
        if ($this->conditions) {
            if (is_array($this->conditions)) {
                $conditions = FLEA_Db_SqlHelper::parseConditions($this->conditions, $this->assocTDG);
                if (is_array($conditions)) {
                    $conditions = $conditions[0];
                }
            } else {
                $conditions =& $this->conditions;
            }
            if ($conditions) {
                $sql .= " AND {$conditions}";
            }
        }
        if ($this->sort && $this->countOnly == false) {
            $sql .= " ORDER BY {$this->sort}";
        }

        return $sql;
    }

    function _saveAssocDataBase(& $row)
    {
        switch (strtolower($this->saveAssocMethod)) {
        case 'create':
            return $this->assocTDG->create($row);
        case 'update':
            return $this->assocTDG->update($row);
        case 'replace':
            return $this->assocTDG->replace($row);
        default:
            return $this->assocTDG->save($row);
        }
    }
}

class FLEA_Db_HasOneLink extends FLEA_Db_TableLink
{
    var $oneToOne = true;

    function FLEA_Db_HasOneLink($define, $type, & $mainTDG)
    {
        parent::FLEA_Db_TableLink($define, $type, $mainTDG);
    }

    function getFindSQL($in)
    {
        if (!$this->init) { $this->init(); }
        $fields = $this->qforeignKey . ' AS ' . $this->mainTDG->pka . ', ' . $this->dbo->qfields($this->fields, $this->assocTDG->fullTableName, $this->assocTDG->schema);
        $sql = "SELECT {$fields} FROM {$this->assocTDG->qtableName} ";
        return parent::_getFindSQLBase($sql, $in);
    }

    function saveAssocData(& $row, $pkv)
    {
        if (empty($row)) { return true; }
        if (!$this->init) { $this->init(); }
        $row[$this->foreignKey] = $pkv;
        return $this->_saveAssocDataBase($row);
    }

    function deleteByForeignKey($qpkv)
    {
        if (!$this->init) { $this->init(); }
        $conditions = "{$this->qforeignKey} = {$qpkv}";
        if ($this->linkRemove) {
            return $this->assocTDG->removeByConditions($conditions);
        } else {
            return $this->assocTDG->updateField($conditions, $this->foreignKey, $this->linkRemoveFillValue);
        }
    }

    function init()
    {
        parent::init();
        if (is_null($this->foreignKey)) {
            $this->foreignKey = $this->mainTDG->primaryKey;
        }
        $this->qforeignKey = $this->dbo->qfield($this->foreignKey, $this->assocTDG->fullTableName, $this->assocTDG->schema);
    }

    function calcCount(& $assocRowset, $mappingName, $in)
    {
        if (!$this->init) { $this->init(); }
        $sql = "SELECT {$this->qforeignKey} AS pid, COUNT({$this->qforeignKey}) AS c FROM {$this->assocTDG->qtableName} ";
        $sql = parent::_getFindSQLBase($sql, $in);
        $sql .= " GROUP BY {$this->qforeignKey}";

        $r = $this->dbo->execute($sql);
        while ($row = $this->dbo->fetchAssoc($r)) {
            $assocRowset[$row['pid']][$mappingName] = (int)$row['c'];
        }
        $this->dbo->freeRes($r);
    }
}

class FLEA_Db_BelongsToLink extends FLEA_Db_TableLink
{
    var $oneToOne = true;

    function FLEA_Db_BelongsToLink($define, $type, & $mainTDG)
    {
        $this->linkUpdate = $this->linkCreate = $this->linkRemove = false;
        parent::FLEA_Db_TableLink($define, $type, $mainTDG);
    }

    function getFindSQL($in)
    {
        if (!$this->init) { $this->init(); }
        $fields = $this->mainTDG->qpk . ' AS ' . $this->mainTDG->pka . ', ' . $this->dbo->qfields($this->fields, $this->assocTDG->fullTableName, $this->assocTDG->schema);

        $sql = "SELECT {$fields} FROM {$this->assocTDG->qtableName} LEFT JOIN {$this->mainTDG->qtableName} ON {$this->mainTDG->qpk} {$in} WHERE {$this->qforeignKey} = {$this->assocTDG->qpk} ";
        $in = '';
        return parent::_getFindSQLBase($sql, $in);
    }

    function saveAssocData(& $row, $pkv)
    {
        if (empty($row)) { return true; }
        if (!$this->init) { $this->init(); }
        return $this->_saveAssocDataBase($row);
    }

    function init()
    {
        parent::init();
        if (is_null($this->foreignKey)) {
            $this->foreignKey = $this->assocTDG->primaryKey;
        }
        $this->qforeignKey = $this->dbo->qfield($this->foreignKey, $this->mainTDG->fullTableName, $this->mainTDG->schema);
    }
}

class FLEA_Db_HasManyLink extends FLEA_Db_HasOneLink
{
    var $oneToOne = false;

    function saveAssocData(& $row, $pkv)
    {
        if (empty($row)) { return true; }
        if (!$this->init) { $this->init(); }

        foreach ($row as $arow) {
            if (!is_array($arow)) { continue; }
            $arow[$this->foreignKey] = $pkv;
            if (!$this->_saveAssocDataBase($arow)) {
                return false;
            }
        }
        return true;
    }
}

class FLEA_Db_ManyToManyLink extends FLEA_Db_TableLink
{
    var $oneToOne = false;

    var $joinTableIsEntity = false;

    var $joinTDG = null;

    var $joinTable = null;

    var $qjoinTable = null;

    var $assocForeignKey = null;

    var $qassocForeignKey = null;

    var $joinTableClass = null;

    function FLEA_Db_ManyToManyLink($define, $type, & $mainTDG)
    {
        $this->_optional[] = 'joinTable';
        $this->_optional[] = 'joinTableClass';
        $this->_optional[] = 'assocForeignKey';
        parent::FLEA_Db_TableLink($define, $type, $mainTDG);

        if ($this->joinTableClass != '') {
            $this->joinTableIsEntity = true;
        }
    }

    function getFindSQL($in)
    {
        static $joinFields = array();

        if (!$this->init) { $this->init(); }

        $fields = $this->qforeignKey . ' AS ' . $this->mainTDG->pka . ', ' . $this->assocTDG->qfields($this->fields);

        if ($this->joinTableIsEntity) {
            if (!isset($joinFields[$this->joinTDG->fullTableName])) {
                $f = '';
                foreach ($this->joinTDG->meta as $field) {
                    $f .= ', ' . $this->joinTDG->qfield($field['name']) . '  AS _join_' . $field['name'];
                }
                $joinFields[$this->joinTDG->fullTableName] = $f;
            }
            $fields .= $joinFields[$this->joinTDG->fullTableName];

            $sql = "SELECT {$fields} FROM {$this->joinTDG->qtableName} INNER JOIN {$this->assocTDG->qtableName} ON {$this->assocTDG->qpk} = {$this->qassocForeignKey} ";
        } else {
            $sql = "SELECT {$fields} FROM {$this->qjoinTable} INNER JOIN {$this->assocTDG->qtableName} ON {$this->assocTDG->qpk} = {$this->qassocForeignKey} ";
        }

        return parent::_getFindSQLBase($sql, $in);
    }

    function saveAssocData(& $row, $pkv)
    {
        if (!$this->init) { $this->init(); }
        $apkvs = array();
        $entityRowset = array();

        foreach ($row as $arow) {
            if (!is_array($arow)) {
                $apkvs[] = $arow;
                continue;
            }

            if (!isset($arow[$this->assocTDG->primaryKey])) {
                // 如果关联记录尚未保存到数据库，则创建一条新的关联记录
                $newrowid = $this->assocTDG->create($arow);
                if ($newrowid == false) {
                    return false;
                }
                $apkv = $newrowid;
            } else {
                $apkv = $arow[$this->assocTDG->primaryKey];
            }
            $apkvs[] = $apkv;

            if ($this->joinTableIsEntity && isset($arow['#JOIN#'])) {
                $entityRowset[$apkv] =& $arow['#JOIN#'];
            }
        }

        // 首先取出现有的关联信息
        $qpkv = $this->dbo->qstr($pkv);
        $sql = "SELECT {$this->qassocForeignKey} FROM {$this->qjoinTable} WHERE {$this->qforeignKey} = {$qpkv} ";
        $existsMiddle = (array)$this->dbo->getCol($sql);

        // 然后确定要添加的关联信息
        $insertAssoc = array_diff($apkvs, $existsMiddle);
        $removeAssoc = array_diff($existsMiddle, $apkvs);

        if ($this->joinTableIsEntity) {
            $insertEntityRowset = array();
            foreach ($insertAssoc as $assocId) {
                if (isset($entityRowset[$assocId])) {
                    $row = $entityRowset[$assocId];
                } else {
                    $row = array();
                }
                $row[$this->foreignKey] = $pkv;
                $row[$this->assocForeignKey] = $assocId;
                $insertEntityRowset[] = $row;
            }
            if ($this->joinTDG->createRowset($insertEntityRowset) === false) {
                return false;
            }
        } else {
            $sql = "INSERT INTO {$this->qjoinTable} ({$this->qforeignKey}, {$this->qassocForeignKey}) VALUES ({$qpkv}, ";
            foreach ($insertAssoc as $assocId) {
                if (!$this->dbo->execute($sql . $this->dbo->qstr($assocId) . ')')) {
                    return false;
                }
            }
        }

        // 最后删除不再需要的关联信息
        if ($this->joinTableIsEntity) {
            $conditions = array($this->foreignKey => $pkv);
            foreach ($removeAssoc as $assocId) {
                $conditions[$this->assocForeignKey] = $assocId;
                if ($this->joinTDG->removeByConditions($conditions) === false) {
                    return false;
                }
            }
        } else {
            $sql = "DELETE FROM {$this->qjoinTable} WHERE {$this->qforeignKey} = {$qpkv} AND {$this->qassocForeignKey} = ";
            foreach ($removeAssoc as $assocId) {
                if (!$this->dbo->execute($sql . $this->dbo->qstr($assocId))) {
                    return false;
                }
            }
        }

        if ($this->counterCache) {
            $sql = "UPDATE {$this->mainTDG->qtableName} SET {$this->counterCache} = (SELECT COUNT(*) FROM {$this->qjoinTable} WHERE {$this->qforeignKey} = {$qpkv}) WHERE {$this->mainTDG->qpk} = {$qpkv}";
            $this->mainTDG->dbo->execute($sql);
        }

        return true;
    }

    function deleteMiddleTableDataByMainForeignKey($qpkv)
    {
        if (!$this->init) { $this->init(); }
        $sql = "DELETE FROM {$this->qjoinTable} WHERE {$this->qforeignKey} = {$qpkv} ";
        return $this->dbo->execute($sql);
    }

    function deleteMiddleTableDataByAssocForeignKey($pkv)
    {
        if (!$this->init) { $this->init(); }
        $qpkv = $this->dbo->qstr($pkv);
        $sql = "DELETE FROM {$this->qjoinTable} WHERE {$this->qassocForeignKey} = {$qpkv} ";
        return $this->dbo->execute($sql);
    }

    function init()
    {
        parent::init();
        if ($this->joinTableClass) {
            $this->joinTDG =& FLEA::getSingleton($this->joinTableClass);
            $this->joinTable = $this->joinTDG->tableName;
            $joinSchema = $this->joinTDG->schema;
        } else {
            $joinSchema = $this->mainTDG->schema;
        }
        if (is_null($this->joinTable)) {
            $this->joinTable = $this->getMiddleTableName($this->mainTDG->tableName, $this->assocTableName);
        }
        if (is_null($this->foreignKey)) {
            $this->foreignKey = $this->mainTDG->primaryKey;
        }
        $this->joinTable = $this->dbo->dsn['prefix'] . $this->joinTable;
        $this->qjoinTable = $this->dbo->qtable($this->joinTable, $joinSchema);
        $this->qforeignKey = $this->dbo->qfield($this->foreignKey, $this->joinTable, $joinSchema);
        if (is_null($this->assocForeignKey)) {
            $this->assocForeignKey = $this->assocTDG->primaryKey;
        }
        $this->qassocForeignKey = $this->dbo->qfield($this->assocForeignKey, $this->joinTable, $this->mainTDG->schema);
    }
}

class FLEA_Db_SqlHelper
{
    function parseConditions($conditions, & $table)
    {
        // 对于 NULL，直接返回 NULL
        if (is_null($conditions)) { return null; }

        // 如果是数字，则假定为主键字段值
        if (is_numeric($conditions)) {
            return "{$table->qpk} = {$conditions}";
        }

        // 如果是字符串，则假定为自定义条件
        if (is_string($conditions)) {
            return $conditions;
        }

        // 如果不是数组，说明提供的查询条件有误
        if (!is_array($conditions)) {
            return null;
        }

        $where = '';
        $linksWhere = array();
        $expr = '';

        foreach ($conditions as $offset => $cond) {
            $expr = 'AND';
            if (is_string($offset)) {
                if (!is_array($cond)) {
                    // 字段名 => 值
                    $cond = array($offset, $cond);
                } else {
                    if (strtolower($offset) == 'in()') {
                        if (count($cond) == 1 && is_array(reset($cond)) && is_string(key($cond))) {
                            $tmp = $table->qfield(key($cond)) . ' IN (' . implode(',', array_map(array(& $table->dbo, 'qstr'), reset($cond))). ')';
                        } else {
                            $tmp = $table->qpk . ' IN (' . implode(',', array_map(array(& $table->dbo, 'qstr'), $cond)). ')';
                        }
                        $cond = array('', $tmp, '', $expr, true);
                    } else {
                        // 字段名 => 数组
                        array_unshift($cond, $offset);
                    }
                }
            } elseif (is_int($offset)) {
                if (!is_array($cond)) {
                    // 值
                    $cond = array('', $cond, '', $expr, true);
                }
            } else {
                continue;
            }

            if (!isset($cond[0])) { continue; }
            if (!isset($cond[2])) { $cond[2] = '='; }
            if (!isset($cond[3])) { $cond[3] = $expr; }
            if (!isset($cond[4])) { $cond[4] = false; }

            list($field, $value, $op, $expr, $isCommand) = $cond;

            $str = '';
            do {
                if (strpos($field, '.') !== false) {
                    list($scheme, $field) = explode('.', $field);
                    $linkname = strtoupper($scheme);
                    if (isset($table->links[$linkname])) {
                        $linksWhere[$linkname][] = array($field, $value, $op, $expr, $isCommand);
                        break;
                    } else {
                        $field = "{$scheme}.{$field}";
                    }
                }

                if (!$isCommand) {
                    $field = $table->qfield($field);
                    $value = $table->dbo->qstr($value);
                    $str = "{$field} {$op} {$value} {$expr} ";
                } else {
                    $str = "{$value} {$expr} ";
                }
            } while (false);

            $where .= $str;
        }

        $where = substr($where, 0, - (strlen($expr) + 2));
        if (empty($linksWhere)) {
            return $where;
        } else {
            return array($where, $linksWhere);
        }
    }

    function dumpLog(& $log)
    {
        foreach ($log as $ix => $sql) {
            dump($sql, 'SQL ' . ($ix + 1));
        }
    }
}

---