class/PersistableObjectHandler.php
<?php namespace XoopsModules\Smartpartner;
/*
* 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.
*/
use XoopsModules\Smartpartner;
/**
* @copyright XOOPS Project https://xoops.org/
* @license GNU GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
* @package
* @since
* @author XOOPS Development Team, Kazumi Ono (AKA onokazu)
*/
/**
* 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 PersistableObjectHandler extends \XoopsObjectHandler
{
/**#@+
* Information about the class, the handler is managing
*
* @var string
*/
public $table;
public $keyName;
public $className;
public $identifierName;
/**#@-*/
/**
* Constructor - called from child classes
* @param \XoopsDatabase $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
*
* @param bool $idenfierName
*/
public function __construct(\XoopsDatabase $db, $tablename, $classname, $keyname, $idenfierName = false)
{
parent::__construct($db);
$this->table = $db->prefix($tablename);
$this->keyName = $keyname;
$this->className = $classname;
if (false !== $idenfierName) {
$this->identifierName = $idenfierName;
}
}
/**
* create a new user
*
* @param bool $isNew Flag the new objects as "new"?
*
* @return object
*/
public function create($isNew = true)
{
$obj = new $this->className();
if (true === $isNew) {
$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
*/
public function get($id, $as_object = true)
{
if (is_array($this->keyName)) {
$criteria = new \CriteriaCompo();
for ($i = 0, $iMax = count($this->keyName); $i < $iMax; ++$i) {
$criteria->add(new \Criteria($this->keyName[$i], (int)$id[$i]));
}
} else {
$criteria = new \Criteria($this->keyName, (int)$id);
}
$criteria->setLimit(1);
$obj_array =& $this->getObjects($criteria, false, $as_object);
if (1 != count($obj_array)) {
$obj = $this->create();
return $obj;
}
return $obj_array[0];
}
/**
* retrieve objects from the database
*
* @param \CriteriaElement $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
*/
public function getObjects(\CriteriaElement $criteria = null, $id_as_key = false, $as_object = true)
{
$ret = [];
$limit = $start = 0;
$sql = 'SELECT * FROM ' . $this->table;
if (null !== $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
*/
public function convertResultSet($result, $id_as_key = false, $as_object = true)
{
$ret = [];
while (false !== ($myrow = $this->db->fetchArray($result))) {
$obj = $this->create(false);
$obj->assignVars($myrow);
if (!$id_as_key) {
if ($as_object) {
$ret[] =& $obj;
} else {
$row = [];
$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 = [];
$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 \CriteriaElement $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
*/
public function getList(\CriteriaElement $criteria = null, $limit = 0, $start = 0)
{
$ret = [];
if (null === $criteria) {
$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 (null !== $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 (false !== ($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 \CriteriaElement $criteria {@link CriteriaElement} to match
* @return int count of objects
*/
public function getCount(\CriteriaElement $criteria = null)
{
$field = '';
$groupby = false;
if (null !== $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 (null !== $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 (false === $groupby) {
list($count) = $this->db->fetchRow($result);
return $count;
} else {
$ret = [];
while (false !== (list($id, $count) = $this->db->fetchRow($result))) {
$ret[$id] = $count;
}
return $ret;
}
}
/**
* delete an object from the database
*
* @param \XoopsObject $obj reference to the object to delete
* @param bool $force
* @return bool FALSE if failed.
*/
public function delete(\XoopsObject $obj, $force = false)
{
if (is_array($this->keyName)) {
$clause = [];
for ($i = 0, $iMax = count($this->keyName); $i < $iMax; ++$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 \XoopsObject $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
*/
public function insert(\XoopsObject $obj, $force = false, $checkObject = true)
{
if (false !== $checkObject) {
if (!is_object($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 (XOBJ_DTYPE_INT == $obj->vars[$k]['data_type']) {
$cleanvars[$k] = (int)$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, $iMax = count($this->keyName); $i < $iMax; ++$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 \CriteriaElement $criteria {@link CriteriaElement}
*
* @param bool $force
* @return bool
*/
public function updateAll($fieldname, $fieldvalue, \CriteriaElement $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 (null !== $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 \CriteriaElement $criteria {@link CriteriaElement} with conditions to meet
* @return bool
*/
public function deleteAll(\CriteriaElement $criteria = null)
{
if (null !== $criteria && is_subclass_of($criteria, 'CriteriaElement')) {
$sql = 'DELETE FROM ' . $this->table;
$sql .= ' ' . $criteria->renderWhere();
if (!$this->db->query($sql)) {
return false;
}
$rows = $this->db->getAffectedRows();
return $rows > 0 ? $rows : true;
}
return false;
}
}