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');
164 * Error list that has been generated
168 var $errors = array();
170 // ###################################################################
172 * Constructor: cannot instantiate class directly
174 function __construct(&$registry)
176 if (!is_subclass_of($this, 'API'))
178 trigger_error('Cannot instantiate the API module directly', E_USER_ERROR
);
181 if (!is_object($registry))
183 trigger_error('The passed registry is not an object', E_USER_ERROR
);
186 $this->registry
=& $registry;
189 // ###################################################################
191 * (PHP 4) Constructor
193 function API(&$registry)
195 $this->__construct($registry);
198 // ###################################################################
200 * Constructs an error for the error handler to receive
204 * @param string Error message
206 function error($message)
208 $this->errors
[] = $message;
210 // we want to explicitly specify silence
211 if (APIError() == 'silent')
216 if (!is_callable(APIError()))
218 trigger_error('No APIError() handler has been set', E_USER_WARNING
);
221 call_user_func(APIError(), $message);
224 // ###################################################################
226 * Returns the error list. This is because we don't want people mucking
227 * with the error system. It will return an empty array if there are
232 * @return array Array of errors
234 function check_errors()
236 if (sizeof($this->errors
) < 1)
241 return $this->errors
;
244 // ###################################################################
246 * Sets a value, sanitizes it, and verifies it
250 * @param string Field name
252 * @param bool Do clean?
253 * @param bool Do verify?
255 function set($field, $value, $doclean = true, $doverify = true)
257 if (!isset($this->fields
["$field"]))
259 trigger_error('Field `' . $field . '` is not valid', E_USER_WARNING);
263 $this->values["$field"] = ($doclean ? $this->registry
->clean($value, $this->fields
["$field"][F_TYPE]) : $value);
265 $this->setfields["$field"] = $field;
267 if (isset($this->fields
["$field"][F_VERIFY]) AND $doverify)
269 if ($this->fields["$field"][F_VERIFY
] == ':self')
271 $verify = $this->{"verify_$field"}($field);
275 $verify = $this->{$this
->fields
["$field"][F_VERIFY
]}($field);
280 $this->error(sprintf($this->registry
->modules
['localize']->string('Validation of %1$s failed'), $field));
285 // ###################################################################
287 * Sets the condition to use in the WHERE clause; if not passed, then
288 * it calculates it from the REQ_AUTO field
292 * @param string WHERE conditional bit
294 function set_condition($condition = '')
296 if ($condition != '')
298 $this->condition
= $condition;
302 foreach ($this->fields
AS $name => $options)
304 if ($options[F_REQ
] == REQ_AUTO
)
306 if (!$this->values
["$name"])
308 trigger_error('Cannot determine condition from the REQ_AUTO field because it is not set', E_USER_WARNING);
312 $this->condition = "$name = " . $this->prepare_field_for_sql($name);
316 if ($this->condition == '')
318 trigger_error('No REQ_AUTO fields are present and therefore the condition cannot be created', E_USER_WARNING);
323 // ###################################################################
325 * Sets existing data into $values where it's not already present
329 function set_existing()
339 foreach ($this->objdata AS $field => $value)
341 if (!isset($this->values["$field"]))
343 $this->values
["$field"] = $value;
350 // ###################################################################
352 * Fetches a record based on the condition
358 if ($this->condition == '')
360 trigger_error('Condition is empty: cannot fetch', E_USER_ERROR);
363 $this->run_action_method('pre_fetch');
365 $result = $this->registry->modules[ISSO_DB_LAYER]->query_first("SELECT
* FROM {$this
->prefix
}{$this
->table
} WHERE {$this
->condition
}");
368 $this->error($this->registry->modules['localize']->string('No records were returned'));
372 $this->run_action_method('post_fetch');
374 $this->objdata = $result;
376 $this->call_relations('fetch');
379 // ###################################################################
381 * Inserts a record in the database
389 $this->run_action_method('pre_insert');
391 foreach ($this->setfields AS $field)
394 $values[] = $this->prepare_field_for_sql($field);
397 $this->registry->modules[ISSO_DB_LAYER]->query("INSERT INTO {$this
->prefix
}{$this
->table
} (" . implode(',', $fields) . ") VALUES (" . implode(',', $values) . ")");
399 if (strcasecmp(ISSO_DB_LAYER, 'DB_PostgreSQL') == 0)
401 foreach ($this->fields AS $field => $info)
403 if ($info[F_REQ] == REQ_AUTO)
410 $this->insertid = $this->registry->modules[ISSO_DB_LAYER]->insert_id($this->prefix . $this->table, $autofield);
414 $this->insertid = $this->registry->modules[ISSO_DB_LAYER]->insert_id();
417 $this->run_action_method('post_insert');
420 // ###################################################################
422 * Updates a record in the database using the data in $vaues
428 if ($this->condition == '')
430 trigger_error('Condition is empty: cannot fetch', E_USER_ERROR);
433 $this->run_action_method('pre_update');
435 foreach ($this->setfields AS $field)
437 $updates[] = "$field = " . $this->prepare_field_for_sql($field);
439 $updates = implode(', ', $updates);
441 $this->registry->modules[ISSO_DB_LAYER]->query("UPDATE {$this
->prefix
}{$this
->table
} SET
$updates WHERE {$this
->condition
}");
443 $this->run_action_method('post_update');
446 // ###################################################################
454 if ($this->condition == '')
456 trigger_error('Condition is empty: cannot fetch', E_USER_ERROR);
459 $this->set_existing();
461 $this->run_action_method('pre_delete');
463 $this->registry->modules[ISSO_DB_LAYER]->query("DELETE FROM {$this
->prefix
}{$this
->table
} WHERE {$this
->condition
}");
465 $this->run_action_method('post_delete');
468 // ###################################################################
470 * Verifies that all required fields are set
476 foreach ($this->fields AS $name => $options)
478 if ($options[F_REQ] == REQ_YES)
480 if (!isset($this->values["$name"]))
482 $this->error(sprintf($this->registry
->modules
['localize']->string('Required field %1$s was not set'), $name));
485 else if ($options[F_REQ
] == REQ_SET
)
487 $this->{"set_$name"}();
492 // ###################################################################
494 * Runs a pre- or post-action method for database commands
498 * @param string Action to run
500 function run_action_method($method)
502 if (in_array($method, $this->norunners
))
507 $actmethod = (method_exists($this, $method) ? $this->$method() : '');
510 // ###################################################################
512 * Determines if it's safe to run a relation; if so, it will return
513 * the WHERE SQL clause
517 * @param string Operation to run
519 function call_relations($method)
521 if (!in_array($method, $this->dorelations
))
526 foreach ($this->fields
AS $field => $info)
528 $value = (isset($this->values
["$field"]) ? $this->values["$field"] : $this->objdata
["$field"]);
529 if ($value == null OR !is_array($info[F_RELATION]))
534 if (!file_exists($this->registry->get('apppath') . $info[F_RELATION][F_RELATION_FILE]))
536 trigger_error("Could not load the relation file
for field
'$field'");
539 require_once($this->registry->get('apppath
') . $info[F_RELATION][F_RELATION_FILE]);
541 $this->relations["$field"] = new $info[F_RELATION][F_RELATION_CLASS]($this->registry);
542 $this->relations["$field"]->set(($info[F_RELATION][F_RELATION_ALTFIELD] ? $info[F_RELATION][F_RELATION_ALTFIELD] : $field), $value);
543 $this->relations["$field"]->set_condition();
544 $this->relations["$field"]->$method();
548 // ###################################################################
550 * Prepares a value for use in a SQL query; it encases and escapes
551 * strings and string-like values
555 * @param string Field name
557 * @return string Prepared value entry
559 function prepare_field_for_sql($name)
561 $type = $this->fields["$name"][F_TYPE];
563 if ($type == TYPE_NOCLEAN OR $type == TYPE_STR OR $type == TYPE_STRUN)
565 return "'" . $this->registry->escape($this->values["$name"]) . "'";
567 else if ($type == TYPE_BOOL
)
569 return ($this->values
["$name"] == true ? "'1'" : "'0'");
573 return $this->values["$name"];
577 // ###################################################################
579 * Verify field: not a zero value
583 function verify_nozero($field)
585 if ($this->values
["$field"] == 0)
593 // ###################################################################
595 * Verify field: not empty
599 function verify_noempty($field)
601 if (empty($this->values["$field"]))
610 // ###################################################################
612 * Setter and getter method for the API error reporting system. Passing
613 * a name will cause the set, no arguments will cause the get.
617 * @param mixed Method name in callable form
619 * @return mixed Method name in callable form
621 function APIError($new = null)
623 static $caller, $prev;
629 else if ($new !== null)
638 /*=====================================================================*\
639 || ###################################################################
642 || ###################################################################
643 \*=====================================================================*/