api.php

   1 <?php
   2 /*=====================================================================*\
   3 || ###################################################################
   4 || # Iris Studios Shared Object Framework [#]version[#]
   5 || # Copyright ©2002-[#]year[#] Iris Studios, Inc.
   6 || #
   7 || # This program is free software; you can redistribute it and/or modify
   8 || # it under the terms of the GNU General Public License as published by
   9 || # the Free Software Foundation; version [#]gpl[#] of the License.
  10 || #
  11 || # This program is distributed in the hope that it will be useful, but
  12 || # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  13 || # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  14 || # more details.
  15 || #
  16 || # You should have received a copy of the GNU General Public License along
  17 || # with this program; if not, write to the Free Software Foundation, Inc.,
  18 || # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  19 || ###################################################################
  20 \*=====================================================================*/
  21
  22 /**
  23 * Abstract Datamanger API
  24 * api.php
  25 *
  26 * @package      ISSO
  27 */
  28
  29 if (!defined('REQ_YES'))
  30 {
  31         /**
  32         * Yes, required
  33         */
  34         define('REQ_YES', 1);
  35
  36         /**
  37         * No, not required
  38         */
  39         define('REQ_NO', 0);
  40
  41         /**
  42         * Auto-increasing value
  43         */
  44         define('REQ_AUTO', -1);
  45
  46         /**
  47         * Set by a cusotm set_*() function
  48         */
  49         define('REQ_SET', 2);
  50
  51         /**
  52         * Index for cleaning type
  53         */
  54         define('F_TYPE', 0);
  55
  56         /**
  57         * Index for requirement type
  58         */
  59         define('F_REQ', 1);
  60
  61         /**
  62         * Index for verification type
  63         */
  64         define('F_VERIFY', 2);
  65 }
  66
  67 /**
  68 * Abstract API
  69 *
  70 * Abstract class that is used as an API base for most common database interaction
  71 * schemes. Creates a simple structure that holds data and can update, delete, and
  72 * insert.
  73 *
  74 * @author               Iris Studios, Inc.
  75 * @copyright    Copyright ©2002 - [#]year[#], Iris Studios, Inc.
  76 * @version              $Revision$
  77 * @package              ISSO
  78 *
  79 */
  80 class API
  81 {
  82         /**
  83         * Registry object
  84         * @var  object
  85         */
  86         var $registry = null;
  87
  88         /**
  89         * Fields: used for verification and sanitization
  90         * NAME => array(TYPE, REQUIRED, VERIFY METHOD (:self for self-named method))
  91         * @var  array
  92         */
  93         var $fields = array();
  94
  95         /**
  96         * Values array: sanitized and verified field values
  97         * @var  array
  98         */
  99         var $values = array();
 100
 101         /**
 102         * Fields that were manually set with set(), not by using set_existing()
 103         * @var  array
 104         */
 105         var $setfields = array();
 106
 107         /**
 108         * WHERE condition
 109         * @var  string
 110         */
 111         var $condition = '';
 112
 113         /**
 114         * The object table row; a fetched row that represents this instance
 115         * @var  array
 116         */
 117         var $objdata = array();
 118
 119         /**
 120         * Insert ID from the insert() command
 121         * @var  integer
 122         */
 123         var $insertid = 0;
 124
 125         /**
 126         * Pre- and post-action method stoppers
 127         * @var  array
 128         */
 129         var $norunners = array();
 130
 131         /**
 132         * Constructor: cannot instantiate class directly
 133         */
 134         function __construct(&$registry)
 135         {
 136                 if (!is_subclass_of($this, 'API'))
 137                 {
 138                         trigger_error('Cannot instantiate the API module directly', E_USER_ERROR);
 139                 }
 140
 141                 if (!is_object($registry))
 142                 {
 143                         trigger_error('The passed registry is not an object', E_USER_ERROR);
 144                 }
 145
 146                 $this->registry =& $registry;
 147         }
 148
 149         /**
 150         * (PHP 4) Constructor
 151         */
 152         function API(&$registry)
 153         {
 154                 $this->__construct($registry);
 155         }
 156
 157         /**
 158         * Constructs an error for the error handler to receive
 159         *
 160         * @param        string  Error message
 161         */
 162         function error($message)
 163         {
 164                 call_user_func(APIError(), $message);
 165         }
 166
 167         /**
 168         * Sets a value, sanitizes it, and verifies it
 169         *
 170         * @param        string  Field name
 171         * @param        mixed   Value
 172         * @param        bool    Do clean?
 173         * @param        bool    Do verify?
 174         */
 175         function set($field, $value, $doclean = true, $doverify = true)
 176         {
 177                 if (!isset($this->fields["$field"]))
 178                 {
 179                         trigger_error('Field `' . $field . '` is not valid', E_USER_WARNING);
 180                         return;
 181                 }
 182
 183                 $this->values["$field"] = ($doclean ? $this->registry->clean($value, $this->fields["$field"][F_TYPE]) : $value);
 184
 185                 $this->setfields["$field"] = $field;
 186
 187                 if (isset($this->fields["$field"][F_VERIFY]) AND $doverify)
 188                 {
 189                         if ($this->fields["$field"][F_VERIFY] == ':self')
 190                         {
 191                                 $verify = $this->{"verify_$field"}($field);
 192                         }
 193                         else
 194                         {
 195                                 $verify = $this->{$this->fields["$field"][F_VERIFY]}($field);
 196                         }
 197
 198                         if (!$verify)
 199                         {
 200                                 $this->error(sprintf($this->registry->modules['localize']->string('Validation of %1$s failed'), $field));
 201                         }
 202                 }
 203         }
 204
 205         /**
 206         * Sets the condition to use in the WHERE clause; if not passed, then it calculates it
 207         * from the REQ_AUTO field
 208         *
 209         * @param        string  WHERE conditional bit
 210         */
 211         function set_condition($condition = '')
 212         {
 213                 if ($condition != '')
 214                 {
 215                         $this->condition = $condition;
 216                 }
 217                 else
 218                 {
 219                         foreach ($this->fields AS $name => $options)
 220                         {
 221                                 if ($options[F_REQ] == REQ_AUTO)
 222                                 {
 223                                         if (!$this->values["$name"])
 224                                         {
 225                                                 trigger_error('Cannot determine condition from the REQ_AUTO field because it is not set', E_USER_WARNING);
 226                                                 continue;
 227                                         }
 228
 229                                         $this->condition = "$name = " . (($options[F_TYPE] == TYPE_NOCLEAN OR $options[F_TYPE] == TYPE_STR OR $options[F_TYPE] == TYPE_STRUN) ? "'" . $this->values["$name"] . "'" : $this->values["$name"]);
 230                                 }
 231                         }
 232
 233                         if ($this->condition == '')
 234                         {
 235                                 trigger_error('No REQ_AUTO fields are present and therefore the condition cannot be created', E_USER_WARNING);
 236                         }
 237                 }
 238         }
 239
 240         /**
 241         * Sets existing data into $values where it's not already present
 242         */
 243         function set_existing()
 244         {
 245                 static $run;
 246                 if ($run)
 247                 {
 248                         return;
 249                 }
 250
 251                 $this->fetch();
 252
 253                 foreach ($this->objdata AS $field => $value)
 254                 {
 255                         if (!isset($this->values["$field"]))
 256                         {
 257                                 $this->values["$field"] = $value;
 258                         }
 259                 }
 260
 261                 $run = true;
 262         }
 263
 264         /**
 265         * Fetches a record based on the condition
 266         */
 267         function fetch()
 268         {
 269                 if ($this->condition == '')
 270                 {
 271                         trigger_error('Condition is empty: cannot fetch', E_USER_ERROR);
 272                 }
 273
 274                 $this->run_action_method('pre_fetch');
 275
 276                 $result = $this->registry->modules['db_mysql']->query_first("SELECT * FROM {$this->prefix}{$this->table} WHERE {$this->condition}");
 277                 if (!$result)
 278                 {
 279                         $this->error($this->registry->modules['localize']->string('No records were returned'));
 280                         return;
 281                 }
 282
 283                 $this->run_action_method('post_fetch');
 284
 285                 $this->objdata = $result;
 286         }
 287
 288         /**
 289         * Inserts a record in the database
 290         */
 291         function insert()
 292         {
 293                 $this->verify();
 294
 295                 $this->run_action_method('pre_insert');
 296
 297                 foreach ($this->setfields AS $field)
 298                 {
 299                         $fields[] = $field;
 300                         $values[] = (($this->fields["$field"][F_TYPE] == TYPE_NOCLEAN OR $this->fields["$field"][F_TYPE] == TYPE_STR OR $this->fields["$field"][F_TYPE] == TYPE_STRUN) ? "'" . $this->values["$field"] . "'" : $this->values["$field"]);
 301                 }
 302
 303                 $this->registry->modules['db_mysql']->query("INSERT INTO {$this->prefix}{$this->table} (" . implode(',', $fields) . ") VALUES (" . implode(',', $values) . ")");
 304                 $this->insertid = $this->registry->modules['db_mysql']->insert_id();
 305
 306                 $this->run_action_method('post_insert');
 307         }
 308
 309         /**
 310         * Updates a record in the database using the data in $vaues
 311         */
 312         function update()
 313         {
 314                 if ($this->condition == '')
 315                 {
 316                         trigger_error('Condition is empty: cannot fetch', E_USER_ERROR);
 317                 }
 318
 319                 $this->run_action_method('pre_update');
 320
 321                 foreach ($this->setfields AS $field)
 322                 {
 323                         $updates[] = "$field = " . (($this->fields["$field"][F_TYPE] == TYPE_NOCLEAN OR $this->fields["$field"][F_TYPE] == TYPE_STR OR $this->fields["$field"][F_TYPE] == TYPE_STRUN) ? "'" . $this->values["$field"] . "'" : $this->values["$field"]);
 324                 }
 325                 $updates = implode(', ', $updates);
 326
 327                 $this->registry->modules['db_mysql']->query("UPDATE {$this->prefix}{$this->table} SET $updates WHERE {$this->condition}");
 328
 329                 $this->run_action_method('post_update');
 330         }
 331
 332         /**
 333         * Deletes a record
 334         */
 335         function delete()
 336         {
 337                 if ($this->condition == '')
 338                 {
 339                         trigger_error('Condition is empty: cannot fetch', E_USER_ERROR);
 340                 }
 341
 342                 $this->set_existing();
 343
 344                 $this->run_action_method('pre_delete');
 345
 346                 $this->registry->modules['db_mysql']->query("DELETE FROM {$this->prefix}{$this->table} WHERE {$this->condition}");
 347
 348                 $this->run_action_method('post_delete');
 349         }
 350
 351         /**
 352         * Verifies that all required fields are set
 353         */
 354         function verify()
 355         {
 356                 foreach ($this->fields AS $name => $options)
 357                 {
 358                         if ($options[F_REQ] == REQ_YES)
 359                         {
 360                                 if (!isset($this->values["$name"]))
 361                                 {
 362                                         $this->error(sprintf($this->registry->modules['localize']->string('Required field %1$s was not set'), $name));
 363                                 }
 364                         }
 365                         else if ($options[F_REQ] == REQ_SET)
 366                         {
 367                                 $this->{"set_$name"}();
 368                         }
 369                 }
 370         }
 371
 372         /**
 373         * Runs a pre- or post-action method for database commands
 374         *
 375         * @param        string  Action to run
 376         */
 377         function run_action_method($method)
 378         {
 379                 if (in_array($method, $this->norunners))
 380                 {
 381                         return;
 382                 }
 383
 384                 $actmethod = (method_exists($this, $method) ? $this->$method() : '');
 385         }
 386
 387         /**
 388         * Verify field: not a zero value
 389         */
 390         function verify_nozero($field)
 391         {
 392                 if ($this->values["$field"] == 0)
 393                 {
 394                         return false;
 395                 }
 396
 397                 return true;
 398         }
 399
 400         /**
 401         * Verify field: not empty
 402         */
 403         function verify_noempty($field)
 404         {
 405                 if (empty($this->values["$field"]))
 406                 {
 407                         return false;
 408                 }
 409
 410                 return true;
 411         }
 412 }
 413
 414 /**
 415 * Setter and getter method for the API error reporting
 416 * system. Passing a name will cause the set, no arguments
 417 * will cause the get.
 418 *
 419 * @param        mixed   Method name in callable form
 420 *
 421 * @return       mixed   Method name in callable form
 422 */
 423 function APIError($new = null)
 424 {
 425         static $caller;
 426
 427         if ($new !== null)
 428         {
 429                 $caller = $new;
 430         }
 431
 432         return $caller;
 433 }
 434
 435 /*=====================================================================*\
 436 || ###################################################################
 437 || # $HeadURL$
 438 || # $Id$
 439 || ###################################################################
 440 \*=====================================================================*/
 441 ?>