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 * Sets a value, sanitizes it, and verifies it
152 * @param string Field name
154 * @param bool Do clean?
155 * @param bool Do verify?
157 function set($field, $value, $doclean = true
, $doverify = true
)
159 if (!isset($this->fields
["$field"]))
161 trigger_error('Field `' . $field . '` is not valid', E_USER_WARNING
);
165 $this->values
["$field"] = ($doclean ?
$this->registry
->clean($value, $this->fields
["$field"][F_TYPE
]) : $value);
167 $this->setfields
[] = $field;
169 if (isset($this->fields
["$field"][F_VERIFY
]) AND $doverify)
171 if ($this->fields
["$field"][F_VERIFY
] == ':self')
173 $verify = $this->{"verify_$field"}($field);
177 $verify = $this->{$this->fields
["$field"][F_VERIFY
]}($field);
183 trigger_error('Validation of `' . $field . '` failed', E_USER_ERROR
);
189 * Sets the condition to use in the WHERE clause; if not passed, then it calculates it
190 * from the REQ_AUTO field
192 * @param string WHERE conditional bit
194 function set_condition($condition = '')
196 if ($condition != '')
198 $this->condition
= $condition;
202 foreach ($this->fields
AS $name => $options)
204 if ($options[F_REQ
] == REQ_AUTO
)
206 if (!$this->values
["$name"])
208 trigger_error('Cannot determine condition from the REQ_AUTO field because it is not set', E_USER_WARNING
);
212 $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"]);
216 if ($this->condition
== '')
218 trigger_error('No REQ_AUTO fields are present and therefore the condition cannot be created', E_USER_WARNING
);
224 * Sets existing data into $values where it's not already present
226 function set_existing()
236 foreach ($this->objdata
AS $field => $value)
238 if (!isset($this->values
["$field"]))
240 $this->values
["$field"] = $value;
248 * Fetches a record based on the condition
252 if ($this->condition
== '')
254 trigger_error('Condition is empty: cannot fetch', E_USER_ERROR
);
257 $this->run_action_method('pre_fetch');
259 $result = $this->registry
->modules
['db_mysql']->query_first("SELECT * FROM {$this->prefix}{$this->table} WHERE {$this->condition}");
263 trigger_error('No record was returned', E_USER_ERROR
);
267 $this->run_action_method('post_fetch');
269 $this->objdata
= $result;
273 * Inserts a record in the database
279 $this->run_action_method('pre_insert');
281 foreach ($this->setfields
AS $field)
284 $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"]);
287 $this->registry
->modules
['db_mysql']->query("INSERT INTO {$this->prefix}{$this->table} (" . implode(',', $fields) . ") VALUES (" . implode(',', $values) . ")");
288 $this->insertid
= $this->registry
->modules
['db_mysql']->insert_id();
290 $this->run_action_method('post_insert');
294 * Updates a record in the database using the data in $vaues
298 if ($this->condition
== '')
300 trigger_error('Condition is empty: cannot fetch', E_USER_ERROR
);
303 $this->run_action_method('pre_update');
305 foreach ($this->setfields
AS $field)
307 $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"]);
309 $updates = implode(', ', $updates);
311 $this->registry
->modules
['db_mysql']->query("UPDATE {$this->prefix}{$this->table} SET $updates WHERE {$this->condition}");
313 $this->run_action_method('post_update');
321 if ($this->condition
== '')
323 trigger_error('Condition is empty: cannot fetch', E_USER_ERROR
);
326 $this->set_existing();
328 $this->run_action_method('pre_delete');
330 $this->registry
->modules
['db_mysql']->query("DELETE FROM {$this->prefix}{$this->table} WHERE {$this->condition}");
332 $this->run_action_method('post_delete');
336 * Verifies that all required fields are set
340 foreach ($this->fields
AS $name => $options)
342 if ($options[F_REQ
] == REQ_YES
)
344 if (!isset($this->values
["$name"]))
347 trigger_error('Field `' . $name . '` was not set', E_USER_ERROR
);
350 else if ($options[F_REQ
] == REQ_SET
)
352 $this->{"set_$name"}();
358 * Runs a pre- or post-action method for database commands
360 * @param string Action to run
362 function run_action_method($method)
364 if (in_array($method, $this->norunners
))
369 $actmethod = (method_exists($this, $method) ?
$this->$method() : '');
373 * Verify field: not a zero value
375 function verify_nozero($field)
377 if ($this->values
["$field"] == 0)
386 * Verify field: not empty
388 function verify_noempty($field)
390 if (empty($this->values
["$field"]))
399 /*=====================================================================*\
400 || ###################################################################
403 || ###################################################################
404 \*=====================================================================*/