2 /*=====================================================================*\
3 || ###################################################################
4 || # Iris Studios Shared Object Framework [#]version[#]
5 || # Copyright ©2002-[#]year[#] Iris Studios, Inc.
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.
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
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 \*=====================================================================*/
23 * Abstract Datamanger API
29 if (!defined('REQ_AUTO'))
32 * Auto-increasing value
34 define('REQ_AUTO', -1);
37 * Set by a cusotm set_*() function
42 * Index for cleaning type
47 * Index for requirement type
52 * Index for verification type
54 define('F_VERIFY', 2);
59 define('F_RELATION', 3);
62 * Relation index for file name, relative to ISSO->apppath
64 define('F_RELATION_FILE', 0);
67 * Relation index for class name
69 define('F_RELATION_CLASS', 1);
72 * Relation index for field-link alternate name
74 define('F_RELATION_ALTFIELD', 2);
80 * Abstract class that is used as an API base for most common database interaction
81 * schemes. Creates a simple structure that holds data and can update, delete, and
84 * @author Iris Studios, Inc.
85 * @copyright Copyright ©2002 - [#]year[#], Iris Studios, Inc.
100 * Fields: used for verification and sanitization
101 * NAME => array(TYPE, REQUIRED, VERIFY METHOD (:self for self-named method), RELATION => array(FILE, CLASS IN FILE, ALTERNATE FIELD NAME))
105 var $fields = array();
108 * Values array: sanitized and verified field values
112 var $values = array();
115 * Fields that were manually set with set(), not by using set_existing()
119 var $setfields = array();
122 * An array of all of the processed relations on an object
126 var $relations = array();
136 * The object table row; a fetched row that represents this instance
140 var $objdata = array();
143 * Insert ID from the insert() command
150 * Pre- and post-action method stoppers
154 var $norunners = array();
157 * The relations to execute on
161 var $dorelations = array('fetch');
163 // ###################################################################
165 * Constructor: cannot instantiate class directly
167 function __construct(&$registry)
169 if (!is_subclass_of($this, 'API'))
171 trigger_error('Cannot instantiate the API module directly', E_USER_ERROR
);
174 if (!is_object($registry))
176 trigger_error('The passed registry is not an object', E_USER_ERROR
);
179 $this->registry
=& $registry;
182 // ###################################################################
184 * (PHP 4) Constructor
186 function API(&$registry)
188 $this->__construct($registry);
191 // ###################################################################
193 * Constructs an error for the error handler to receive
197 * @param string Error message
199 function error($message)
201 if (!is_callable(APIError()))
203 trigger_error('No APIError() handler has been set', E_USER_WARNING
);
206 call_user_func(APIError(), $message);
209 // ###################################################################
211 * Sets a value, sanitizes it, and verifies it
215 * @param string Field name
217 * @param bool Do clean?
218 * @param bool Do verify?
220 function set($field, $value, $doclean = true, $doverify = true)
222 if (!isset($this->fields
["$field"]))
224 trigger_error('Field `' . $field . '` is not valid', E_USER_WARNING);
228 $this->values["$field"] = ($doclean ? $this->registry
->clean($value, $this->fields
["$field"][F_TYPE]) : $value);
230 $this->setfields["$field"] = $field;
232 if (isset($this->fields
["$field"][F_VERIFY]) AND $doverify)
234 if ($this->fields["$field"][F_VERIFY
] == ':self')
236 $verify = $this->{"verify_$field"}($field);
240 $verify = $this->{$this
->fields
["$field"][F_VERIFY
]}($field);
245 $this->error(sprintf($this->registry
->modules
['localize']->string('Validation of %1$s failed'), $field));
250 // ###################################################################
252 * Sets the condition to use in the WHERE clause; if not passed, then
253 * it calculates it from the REQ_AUTO field
257 * @param string WHERE conditional bit
259 function set_condition($condition = '')
261 if ($condition != '')
263 $this->condition
= $condition;
267 foreach ($this->fields
AS $name => $options)
269 if ($options[F_REQ
] == REQ_AUTO
)
271 if (!$this->values
["$name"])
273 trigger_error('Cannot determine condition from the REQ_AUTO field because it is not set', E_USER_WARNING);
277 $this->condition = "$name = " . $this->prepare_field_for_sql($name);
281 if ($this->condition == '')
283 trigger_error('No REQ_AUTO fields are present and therefore the condition cannot be created', E_USER_WARNING);
288 // ###################################################################
290 * Sets existing data into $values where it's not already present
294 function set_existing()
304 foreach ($this->objdata AS $field => $value)
306 if (!isset($this->values["$field"]))
308 $this->values
["$field"] = $value;
315 // ###################################################################
317 * Fetches a record based on the condition
323 if ($this->condition == '')
325 trigger_error('Condition is empty: cannot fetch', E_USER_ERROR);
328 $this->run_action_method('pre_fetch');
330 $result = $this->registry->modules[ISSO_DB_LAYER]->query_first("SELECT
* FROM {$this
->prefix
}{$this
->table
} WHERE {$this
->condition
}");
333 $this->error($this->registry->modules['localize']->string('No records were returned'));
337 $this->run_action_method('post_fetch');
339 $this->objdata = $result;
341 $this->call_relations('fetch');
344 // ###################################################################
346 * Inserts a record in the database
354 $this->run_action_method('pre_insert');
356 foreach ($this->setfields AS $field)
359 $values[] = $this->prepare_field_for_sql($field);
362 $this->registry->modules[ISSO_DB_LAYER]->query("INSERT INTO {$this
->prefix
}{$this
->table
} (" . implode(',', $fields) . ") VALUES (" . implode(',', $values) . ")");
363 $this->insertid = $this->registry->modules[ISSO_DB_LAYER]->insert_id();
365 $this->run_action_method('post_insert');
368 // ###################################################################
370 * Updates a record in the database using the data in $vaues
376 if ($this->condition == '')
378 trigger_error('Condition is empty: cannot fetch', E_USER_ERROR);
381 $this->run_action_method('pre_update');
383 foreach ($this->setfields AS $field)
385 $updates[] = "$field = " . $this->prepare_field_for_sql($field);
387 $updates = implode(', ', $updates);
389 $this->registry->modules[ISSO_DB_LAYER]->query("UPDATE {$this
->prefix
}{$this
->table
} SET
$updates WHERE {$this
->condition
}");
391 $this->run_action_method('post_update');
394 // ###################################################################
402 if ($this->condition == '')
404 trigger_error('Condition is empty: cannot fetch', E_USER_ERROR);
407 $this->set_existing();
409 $this->run_action_method('pre_delete');
411 $this->registry->modules[ISSO_DB_LAYER]->query("DELETE FROM {$this
->prefix
}{$this
->table
} WHERE {$this
->condition
}");
413 $this->run_action_method('post_delete');
416 // ###################################################################
418 * Verifies that all required fields are set
424 foreach ($this->fields AS $name => $options)
426 if ($options[F_REQ] == REQ_YES)
428 if (!isset($this->values["$name"]))
430 $this->error(sprintf($this->registry
->modules
['localize']->string('Required field %1$s was not set'), $name));
433 else if ($options[F_REQ
] == REQ_SET
)
435 $this->{"set_$name"}();
440 // ###################################################################
442 * Runs a pre- or post-action method for database commands
446 * @param string Action to run
448 function run_action_method($method)
450 if (in_array($method, $this->norunners
))
455 $actmethod = (method_exists($this, $method) ? $this->$method() : '');
458 // ###################################################################
460 * Determines if it's safe to run a relation; if so, it will return
461 * the WHERE SQL clause
465 * @param string Field name
466 * @param string Operation to run
468 function call_relations($method)
470 if (!in_array($method, $this->dorelations
))
475 foreach ($this->fields
AS $field => $info)
477 $value = (isset($this->values
["$field"]) ? $this->values["$field"] : $this->objdata
["$field"]);
478 if ($value == null OR !is_array($info[F_RELATION]))
483 if (!file_exists($this->registry->get('apppath') . $info[F_RELATION][F_RELATION_FILE]))
485 trigger_error("Could not load the relation file
for field
'$field'");
488 require_once($this->registry->get('apppath
') . $info[F_RELATION][F_RELATION_FILE]);
490 $this->relations["$field"] = new $info[F_RELATION][F_RELATION_CLASS]($this->registry);
491 $this->relations["$field"]->set(($info[F_RELATION][F_RELATION_ALTFIELD] ? $info[F_RELATION][F_RELATION_ALTFIELD] : $field), $value);
492 $this->relations["$field"]->set_condition();
493 $this->relations["$field"]->$method();
497 // ###################################################################
499 * Prepares a value for use in a SQL query; it encases and escapes
500 * strings and string-like values
504 * @param string Field name
506 * @return string Prepared value entry
508 function prepare_field_for_sql($name)
510 $type = $this->fields["$name"][F_TYPE];
512 if ($type == TYPE_NOCLEAN OR $type == TYPE_STR OR $type == TYPE_STRUN)
514 return "'" . $this->registry->escape($this->values["$name"]) . "'";
516 else if ($type == TYPE_BOOL
)
518 return (int)$this->values
["$name"];
522 return $this->values["$name"];
526 // ###################################################################
528 * Verify field: not a zero value
532 function verify_nozero($field)
534 if ($this->values
["$field"] == 0)
542 // ###################################################################
544 * Verify field: not empty
548 function verify_noempty($field)
550 if (empty($this->values["$field"]))
559 // ###################################################################
561 * Setter and getter method for the API error reporting system. Passing
562 * a name will cause the set, no arguments will cause the get.
566 * @param mixed Method name in callable form
568 * @return mixed Method name in callable form
570 function APIError($new = null)
582 /*=====================================================================*\
583 || ###################################################################
586 || ###################################################################
587 \*=====================================================================*/