]>
src.bluestatic.org Git - isso.git/blob - api.php
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();
131 // ###################################################################
133 * Constructor: cannot instantiate class directly
135 function __construct(&$registry)
137 if (!is_subclass_of($this, 'API'))
139 trigger_error('Cannot instantiate the API module directly', E_USER_ERROR
);
142 if (!is_object($registry))
144 trigger_error('The passed registry is not an object', E_USER_ERROR
);
147 $this->registry
=& $registry;
150 // ###################################################################
152 * (PHP 4) Constructor
154 function API(&$registry)
156 $this->__construct($registry);
159 // ###################################################################
161 * Constructs an error for the error handler to receive
165 * @param string Error message
167 function error($message)
169 call_user_func(APIError(), $message);
172 // ###################################################################
174 * Sets a value, sanitizes it, and verifies it
178 * @param string Field name
180 * @param bool Do clean?
181 * @param bool Do verify?
183 function set($field, $value, $doclean = true, $doverify = true)
185 if (!isset($this->fields
["$field"]))
187 trigger_error('Field `' . $field . '` is not valid', E_USER_WARNING);
191 $this->values["$field"] = ($doclean ? $this->registry
->clean($value, $this->fields
["$field"][F_TYPE]) : $value);
193 $this->setfields["$field"] = $field;
195 if (isset($this->fields
["$field"][F_VERIFY]) AND $doverify)
197 if ($this->fields["$field"][F_VERIFY
] == ':self')
199 $verify = $this->{"verify_$field"}($field);
203 $verify = $this->{$this
->fields
["$field"][F_VERIFY
]}($field);
208 $this->error(sprintf($this->registry
->modules
['localize']->string('Validation of %1$s failed'), $field));
213 // ###################################################################
215 * Sets the condition to use in the WHERE clause; if not passed, then
216 * it calculates it from the REQ_AUTO field
220 * @param string WHERE conditional bit
222 function set_condition($condition = '')
224 if ($condition != '')
226 $this->condition
= $condition;
230 foreach ($this->fields
AS $name => $options)
232 if ($options[F_REQ
] == REQ_AUTO
)
234 if (!$this->values
["$name"])
236 trigger_error('Cannot determine condition from the REQ_AUTO field because it is not set', E_USER_WARNING);
240 $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"]);
244 if ($this->condition
== '')
246 trigger_error('No REQ_AUTO fields are present and therefore the condition cannot be created', E_USER_WARNING
);
251 // ###################################################################
253 * Sets existing data into $values where it's not already present
257 function set_existing()
267 foreach ($this->objdata
AS $field => $value)
269 if (!isset($this->values
["$field"]))
271 $this->values["$field"] = $value;
278 // ###################################################################
280 * Fetches a record based on the condition
286 if ($this->condition
== '')
288 trigger_error('Condition is empty: cannot fetch', E_USER_ERROR
);
291 $this->run_action_method('pre_fetch');
293 $result = $this->registry
->modules
['db_mysql']->query_first("SELECT * FROM {$this->prefix}{$this->table} WHERE {$this->condition}");
296 $this->error($this->registry
->modules
['localize']->string('No records were returned'));
300 $this->run_action_method('post_fetch');
302 $this->objdata
= $result;
305 // ###################################################################
307 * Inserts a record in the database
315 $this->run_action_method('pre_insert');
317 foreach ($this->setfields
AS $field)
320 $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"]);
323 $this->registry
->modules
['db_mysql']->query("INSERT INTO {$this->prefix}{$this->table} (" . implode(',', $fields) . ") VALUES (" . implode(',', $values) . ")");
324 $this->insertid
= $this->registry
->modules
['db_mysql']->insert_id();
326 $this->run_action_method('post_insert');
329 // ###################################################################
331 * Updates a record in the database using the data in $vaues
337 if ($this->condition
== '')
339 trigger_error('Condition is empty: cannot fetch', E_USER_ERROR
);
342 $this->run_action_method('pre_update');
344 foreach ($this->setfields
AS $field)
346 $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"]);
348 $updates = implode(', ', $updates);
350 $this->registry
->modules
['db_mysql']->query("UPDATE {$this->prefix}{$this->table} SET $updates WHERE {$this->condition}");
352 $this->run_action_method('post_update');
355 // ###################################################################
363 if ($this->condition
== '')
365 trigger_error('Condition is empty: cannot fetch', E_USER_ERROR
);
368 $this->set_existing();
370 $this->run_action_method('pre_delete');
372 $this->registry
->modules
['db_mysql']->query("DELETE FROM {$this->prefix}{$this->table} WHERE {$this->condition}");
374 $this->run_action_method('post_delete');
377 // ###################################################################
379 * Verifies that all required fields are set
385 foreach ($this->fields
AS $name => $options)
387 if ($options[F_REQ
] == REQ_YES
)
389 if (!isset($this->values
["$name"]))
391 $this->error(sprintf($this->registry->modules['localize']->string('Required field %1$s was not set'), $name));
394 else if ($options[F_REQ] == REQ_SET)
396 $this->{"set_$name"}();
401 // ###################################################################
403 * Runs a pre- or post-action method for database commands
407 * @param string Action to run
409 function run_action_method($method)
411 if (in_array($method, $this->norunners))
416 $actmethod = (method_exists($this, $method) ? $this->$method() : '');
419 // ###################################################################
421 * Verify field: not a zero value
425 function verify_nozero($field)
427 if ($this->values["$field"] == 0)
435 // ###################################################################
437 * Verify field: not empty
441 function verify_noempty($field)
443 if (empty($this->values
["$field"]))
452 // ###################################################################
454 * Setter and getter method for the API error reporting system. Passing
455 * a name will cause the set, no arguments will cause the get.
459 * @param mixed Method name in callable form
461 * @return mixed Method name in callable form
463 function APIError($new = null)
475 /*=====================================================================*\
476 || ###################################################################
479 || ###################################################################
480 \*=====================================================================*/