<?php // $Id: object.php,v 1.3 2006/04/06 17:55:28 mithyt2 Exp $ // ------------------------------------------------------------------------ // // XOOPS - PHP Content Management System // // Copyright (c) 2000 XOOPS.org // // <https://xoops.org/> // // ------------------------------------------------------------------------ // // This program is free software; you can redistribute it and/or modify // // it under the terms of the GNU General Public License as published by // // the Free Software Foundation; either version 2 of the License, or // // (at your option) any later version. // // // // You may not change or alter any portion of this comment or credits // // of supporting developers from this source code or any supporting // // source code which is considered copyrighted (c) material of the // // original comment or credit authors. // // // // This program is distributed in the hope that it will be useful, // // but WITHOUT ANY WARRANTY; without even the implied warranty of // // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // // GNU General Public License for more details. // // // // You should have received a copy of the GNU General Public License // // along with this program; if not, write to the Free Software // // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA // // ------------------------------------------------------------------------ // // Author: Kazumi Ono (AKA onokazu) // // URL: http://www.myweb.ne.jp/, https://xoops.org/, http://www.xoopscube.jp/ // // Project: The XOOPS Project // // ------------------------------------------------------------------------- // /** * Persistable Object Handler class. * This class is responsible for providing data access mechanisms to the data source * of derived class objects. * * @author Jan Keller Pedersen <mithrandir@xoops.org> - IDG Danmark A/S <www.idg.dk> * @copyright copyright (c) 2000-2004 XOOPS.org * @package Kernel */ class XoopsPersistableObjectHandler extends XoopsObjectHandler { /**#@+ * Information about the class, the handler is managing * * @var string */ var $table; var $keyName; var $className; var $identifierName; /**#@-*/ /** * Constructor - called from child classes * @param object $db {@link XoopsDatabase} object * @param string $tablename Name of database table * @param string $classname Name of Class, this handler is managing * @param string $keyname Name of the property, holding the key * * @return void */ function XoopsPersistableObjectHandler(&$db, $tablename, $classname, $keyname, $idenfierName = false) { $this->XoopsObjectHandler($db); $this->table = $db->prefix($tablename); $this->keyName = $keyname; $this->className = $classname; if ($idenfierName != false) { $this->identifierName = $idenfierName; } } /** * create a new user * * @param bool $isNew Flag the new objects as "new"? * * @return object */ function &create($isNew = true) { $obj =& new $this->className(); if ($isNew === true) { $obj->setNew(); } return $obj; } /** * retrieve an object * * @param mixed $id ID of the object - or array of ids for joint keys. Joint keys MUST be given in the same order as in the constructor * @param bool $as_object whether to return an object or an array * @return mixed reference to the object, FALSE if failed */ function &get($id, $as_object = true) { if (is_array($this->keyName)) { $criteria = new CriteriaCompo(); for ($i = 0; $i < count($this->keyName); $i++) { $criteria->add(new Criteria($this->keyName[$i], intval($id[$i]))); } } else { $criteria = new Criteria($this->keyName, intval($id)); } $criteria->setLimit(1); $obj_array = $this->getObjects($criteria, false, $as_object); if (count($obj_array) != 1) { $obj = $this->create(); return $obj; } return $obj_array[0]; } /** * retrieve objects from the database * * @param object $criteria {@link CriteriaElement} conditions to be met * @param bool $id_as_key use the ID as key for the array? * @param bool $as_object return an array of objects? * * @return array */ function getObjects($criteria = null, $id_as_key = false, $as_object = true) { $ret = array(); $limit = $start = 0; $sql = 'SELECT * FROM '.$this->table; if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) { $sql .= ' '.$criteria->renderWhere(); if ($criteria->getSort() != '') { $sql .= ' ORDER BY '.$criteria->getSort().' '.$criteria->getOrder(); } $limit = $criteria->getLimit(); $start = $criteria->getStart(); } $result = $this->db->query($sql, $limit, $start); if (!$result) { return $ret; } return $this->convertResultSet($result, $id_as_key, $as_object); } /** * Convert a database resultset to a returnable array * * @param object $result database resultset * @param bool $id_as_key - should NOT be used with joint keys * @param bool $as_object * * @return array */ function convertResultSet($result, $id_as_key = false, $as_object = true) { $ret = array(); while ($myrow = $this->db->fetchArray($result)) { $obj =& $this->create(false); $obj->assignVars($myrow); if (!$id_as_key) { if ($as_object) { $ret[] =& $obj; } else { $row = array(); $vars = $obj->getVars(); foreach (array_keys($vars) as $i) { $row[$i] = $obj->getVar($i); } $ret[] = $row; } } else { if ($as_object) { $ret[$myrow[$this->keyName]] =& $obj; } else { $row = array(); $vars = $obj->getVars(); foreach (array_keys($vars) as $i) { $row[$i] = $obj->getVar($i); } $ret[$myrow[$this->keyName]] = $row; } } unset($obj); } return $ret; } /** * Retrieve a list of objects as arrays - DON'T USE WITH JOINT KEYS * * @param object $criteria {@link CriteriaElement} conditions to be met * @param int $limit Max number of objects to fetch * @param int $start Which record to start at * * @return array */ function getList($criteria = null, $limit = 0, $start = 0) { $ret = array(); if ($criteria == null) { $criteria = new CriteriaCompo(); } if ($criteria->getSort() == '') { $criteria->setSort($this->identifierName); } $sql = 'SELECT '.$this->keyName; if(!empty($this->identifierName)){ $sql .= ', '.$this->identifierName; } $sql .= ' FROM '.$this->table; if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) { $sql .= ' '.$criteria->renderWhere(); if ($criteria->getSort() != '') { $sql .= ' ORDER BY '.$criteria->getSort().' '.$criteria->getOrder(); } $limit = $criteria->getLimit(); $start = $criteria->getStart(); } $result = $this->db->query($sql, $limit, $start); if (!$result) { return $ret; } $myts =& MyTextSanitizer::getInstance(); while ($myrow = $this->db->fetchArray($result)) { //identifiers should be textboxes, so sanitize them like that $ret[$myrow[$this->keyName]] = empty($this->identifierName)?1:$myts->htmlSpecialChars($myrow[$this->identifierName]); } return $ret; } /** * count objects matching a condition * * @param object $criteria {@link CriteriaElement} to match * @return int count of objects */ function getCount($criteria = null) { $field = ""; $groupby = false; if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) { if ($criteria->groupby != "") { $groupby = true; $field = $criteria->groupby.", "; //Not entirely secure unless you KNOW that no criteria's groupby clause is going to be mis-used } } $sql = 'SELECT '.$field.'COUNT(*) FROM '.$this->table; if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) { $sql .= ' '.$criteria->renderWhere(); if ($criteria->groupby != "") { $sql .= $criteria->getGroupby(); } } $result = $this->db->query($sql); if (!$result) { return 0; } if ($groupby == false) { list($count) = $this->db->fetchRow($result); return $count; } else { $ret = array(); while (list($id, $count) = $this->db->fetchRow($result)) { $ret[$id] = $count; } return $ret; } } /** * delete an object from the database * * @param object $obj reference to the object to delete * @param bool $force * @return bool FALSE if failed. */ function delete(&$obj, $force = false) { if (is_array($this->keyName)) { $clause = array(); for ($i = 0; $i < count($this->keyName); $i++) { $clause[] = $this->keyName[$i]." = ".$obj->getVar($this->keyName[$i]); } $whereclause = implode(" AND ", $clause); } else { $whereclause = $this->keyName." = ".$obj->getVar($this->keyName); } $sql = "DELETE FROM ".$this->table." WHERE ".$whereclause; if (false != $force) { $result = $this->db->queryF($sql); } else { $result = $this->db->query($sql); } if (!$result) { return false; } return true; } /** * insert a new object in the database * * @param object $obj reference to the object * @param bool $force whether to force the query execution despite security settings * @param bool $checkObject check if the object is dirty and clean the attributes * @return bool FALSE if failed, TRUE if already present and unchanged or successful */ function insert(&$obj, $force = false, $checkObject = true) { if ($checkObject != false) { if (!is_object($obj)) { var_dump($obj); return false; } /** * @TODO: Change to if (!(class_exists($this->className) && $obj instanceof $this->className)) when going fully PHP5 */ if (!is_a($obj, $this->className)) { $obj->setErrors(get_class($obj)." Differs from ".$this->className); return false; } if (!$obj->isDirty()) { $obj->setErrors("Not dirty"); //will usually not be outputted as errors are not displayed when the method returns true, but it can be helpful when troubleshooting code - Mith return true; } } if (!$obj->cleanVars()) { return false; } foreach ($obj->cleanVars as $k => $v) { if ($obj->vars[$k]['data_type'] == XOBJ_DTYPE_INT) { $cleanvars[$k] = intval($v); } elseif ( is_array( $v ) ) { $cleanvars[ $k ] = $this->db->quoteString( implode( ',', $v ) ); } else { $cleanvars[$k] = $this->db->quoteString($v); } } if ($obj->isNew()) { if (!is_array($this->keyName)) { if ($cleanvars[$this->keyName] < 1) { $cleanvars[$this->keyName] = $this->db->genId($this->table.'_'.$this->keyName.'_seq'); } } $sql = "INSERT INTO ".$this->table." (".implode(',', array_keys($cleanvars)).") VALUES (".implode(',', array_values($cleanvars)) .")"; } else { $sql = "UPDATE ".$this->table." SET"; foreach ($cleanvars as $key => $value) { if ((!is_array($this->keyName) && $key == $this->keyName) || (is_array($this->keyName) && in_array($key, $this->keyName))) { continue; } if (isset($notfirst) ) { $sql .= ","; } $sql .= " ".$key." = ".$value; $notfirst = true; } if (is_array($this->keyName)) { $whereclause = ""; for ($i = 0; $i < count($this->keyName); $i++) { if ($i > 0) { $whereclause .= " AND "; } $whereclause .= $this->keyName[$i]." = ".$obj->getVar($this->keyName[$i]); } } else { $whereclause = $this->keyName." = ".$obj->getVar($this->keyName); } $sql .= " WHERE ".$whereclause; } if (false != $force) { $result = $this->db->queryF($sql); } else { $result = $this->db->query($sql); } if (!$result) { return false; } if ($obj->isNew() && !is_array($this->keyName)) { $obj->assignVar($this->keyName, $this->db->getInsertId()); } return true; } /** * Change a value for objects with a certain criteria * * @param string $fieldname Name of the field * @param string $fieldvalue Value to write * @param object $criteria {@link CriteriaElement} * * @return bool **/ function updateAll($fieldname, $fieldvalue, $criteria = null, $force = false) { $set_clause = $fieldname . ' = '; if ( is_numeric( $fieldvalue ) ) { $set_clause .= $fieldvalue; } elseif ( is_array( $fieldvalue ) ) { $set_clause .= $this->db->quoteString( implode( ',', $fieldvalue ) ); } else { $set_clause .= $this->db->quoteString( $fieldvalue ); } $sql = 'UPDATE '.$this->table.' SET '.$set_clause; if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) { $sql .= ' '.$criteria->renderWhere(); } if (false != $force) { $result = $this->db->queryF($sql); } else { $result = $this->db->query($sql); } if (!$result) { return false; } return true; } /** * delete all objects meeting the conditions * * @param object $criteria {@link CriteriaElement} with conditions to meet * @return bool */ function deleteAll($criteria = null) { if (isset($criteria) && is_subclass_of($criteria, 'criteriaelement')) { $sql = 'DELETE FROM '.$this->table; $sql .= ' '.$criteria->renderWhere(); if (!$this->db->queryF($sql)) { return false; } $rows = $this->db->getAffectedRows(); return $rows > 0 ? $rows : true; } return false; } } ?>
