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_YES'))
42 * Auto-increasing value
44 define('REQ_AUTO', -1);
47 * Set by a cusotm set_*() function
52 * Index for cleaning type
57 * Index for requirement type
62 * Index for verification type
64 define('F_VERIFY', 2);
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
74 * @author Iris Studios, Inc.
75 * @copyright Copyright ©2002 - [#]year[#], Iris Studios, Inc.
89 * Fields: used for verification and sanitization
90 * NAME => array(TYPE, REQUIRED, VERIFY METHOD (:self for self-named method))
93 var $fields = array();
96 * Values array: sanitized and verified field values
99 var $values = array();
102 * Fields that were manually set with set(), not by using set_existing()
105 var $setfields = array();
114 * The object table row; a fetched row that represents this instance
117 var $objdata = array();
120 * Insert ID from the insert() command
126 * Pre- and post-action method stoppers
129 var $norunners = array();
132 * Constructor: cannot instantiate class directly
134 function API(&$registry)
136 if (!is_subclass_of($this, 'API'))
138 trigger_error('Cannot instantiate the API module directly', E_USER_ERROR
);
141 if (!is_object($registry))
143 trigger_error('The passed registry is not an object', E_USER_ERROR
);
146 $this->registry
=& $registry;
150 * Constructs an error for the error handler to receive
152 * @param string Error message
154 function error($message)
156 call_user_func(APIError(), $message);
160 * Sets a value, sanitizes it, and verifies it
162 * @param string Field name
164 * @param bool Do clean?
165 * @param bool Do verify?
167 function set($field, $value, $doclean = true, $doverify = true)
169 if (!isset($this->fields
["$field"]))
171 trigger_error('Field `' . $field . '` is not valid', E_USER_WARNING);
175 $this->values["$field"] = ($doclean ? $this->registry
->clean($value, $this->fields
["$field"][F_TYPE]) : $value);
177 $this->setfields[] = $field;
179 if (isset($this->fields["$field"][F_VERIFY
]) AND $doverify)
181 if ($this->fields
["$field"][F_VERIFY] == ':self')
183 $verify = $this->{"verify_$field"}($field);
187 $verify = $this->{$this->fields["$field"][F_VERIFY]}($field);
192 $this->error(sprintf($this->registry->modules['localize']->string('Validation of %1$s failed'), $field));
198 * Sets the condition to use in the WHERE clause; if not passed, then it calculates it
199 * from the REQ_AUTO field
201 * @param string WHERE conditional bit
203 function set_condition($condition = '')
205 if ($condition != '')
207 $this->condition = $condition;
211 foreach ($this->fields AS $name => $options)
213 if ($options[F_REQ] == REQ_AUTO)
215 if (!$this->values["$name"])
217 trigger_error('Cannot determine condition from the REQ_AUTO field because it is not set', E_USER_WARNING
);
221 $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"]);
225 if ($this->condition == '')
227 trigger_error('No REQ_AUTO fields are present
and therefore the condition cannot be created
', E_USER_WARNING);
233 * Sets existing data into $values where it's not already present
235 function set_existing()
245 foreach ($this->objdata
AS $field => $value)
247 if (!isset($this->values
["$field"]))
249 $this->values["$field"] = $value;
257 * Fetches a record based on the condition
261 if ($this->condition
== '')
263 trigger_error('Condition is empty: cannot fetch', E_USER_ERROR
);
266 $this->run_action_method('pre_fetch');
268 $result = $this->registry
->modules
['db_mysql']->query_first("SELECT * FROM {$this->prefix}{$this->table} WHERE {$this->condition}");
271 $this->error($this->registry
->modules
['localize']->string('No records were returned'));
275 $this->run_action_method('post_fetch');
277 $this->objdata
= $result;
281 * Inserts a record in the database
287 $this->run_action_method('pre_insert');
289 foreach ($this->setfields
AS $field)
292 $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"]);
295 $this->registry
->modules
['db_mysql']->query("INSERT INTO {$this->prefix}{$this->table} (" . implode(',', $fields) . ") VALUES (" . implode(',', $values) . ")");
296 $this->insertid
= $this->registry
->modules
['db_mysql']->insert_id();
298 $this->run_action_method('post_insert');
302 * Updates a record in the database using the data in $vaues
306 if ($this->condition
== '')
308 trigger_error('Condition is empty: cannot fetch', E_USER_ERROR
);
311 $this->run_action_method('pre_update');
313 foreach ($this->setfields
AS $field)
315 $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"]);
317 $updates = implode(', ', $updates);
319 $this->registry
->modules
['db_mysql']->query("UPDATE {$this->prefix}{$this->table} SET $updates WHERE {$this->condition}");
321 $this->run_action_method('post_update');
329 if ($this->condition
== '')
331 trigger_error('Condition is empty: cannot fetch', E_USER_ERROR
);
334 $this->set_existing();
336 $this->run_action_method('pre_delete');
338 $this->registry
->modules
['db_mysql']->query("DELETE FROM {$this->prefix}{$this->table} WHERE {$this->condition}");
340 $this->run_action_method('post_delete');
344 * Verifies that all required fields are set
348 foreach ($this->fields
AS $name => $options)
350 if ($options[F_REQ
] == REQ_YES
)
352 if (!isset($this->values
["$name"]))
354 $this->error(sprintf($this->registry->modules['localize']->string('Required field %1$s was not set'), $name));
357 else if ($options[F_REQ] == REQ_SET)
359 $this->{"set_$name"}();
365 * Runs a pre- or post-action method for database commands
367 * @param string Action to run
369 function run_action_method($method)
371 if (in_array($method, $this->norunners))
376 $actmethod = (method_exists($this, $method) ? $this->$method() : '');
380 * Verify field: not a zero value
382 function verify_nozero($field)
384 if ($this->values["$field"] == 0)
393 * Verify field: not empty
395 function verify_noempty($field)
397 if (empty($this->values
["$field"]))
407 * Setter and getter method for the API error reporting
408 * system. Passing a name will cause the set, no arguments
409 * will cause the get.
411 * @param mixed Method name in callable form
413 * @return mixed Method name in callable form
415 function APIError($new = null)
427 /*=====================================================================*\
428 || ###################################################################
431 || ###################################################################
432 \*=====================================================================*/