$string['invalidpagesize'] = 'Invalid page size';
$string['invalidpaymentmethod'] = 'Invalid payment method: $a';
$string['invalidqueryparam'] = 'ERROR: Incorrect number of query parameters. Expected $a->expected, got $a->actual.';
+$string['invalidrecord'] = 'Can not find data record in database table $a.';
+$string['invalidrecordunknown'] = 'Can not find data record in database.';
$string['invalidrequest'] = 'Invalid request';
$string['invalidrole'] = 'Invalid role';
$string['invalidroleid'] = 'Invalid role ID';
$string['moduledisable'] = 'This module ($a) has been disabled for this particular course';
$string['modulemissingcode'] = 'Module $a is missing the code needed to perform this function';
$string['mustbeteacher'] = 'You must be a teacher to look at this page';
+$string['multiplerecordsfound'] = 'Multiple records found, only one record expected.';
$string['multiplerestorenotallow'] = 'Multiple restore execution not allowed!';
$string['mustbeloggedin'] = 'You must be logged in to do this';
$string['needphpext'] = 'You need to add $a support to your PHP installation';
$this->assertEqual($columns['oneinteger']->has_default , true);
$this->assertEqual($columns['oneinteger']->default_value, 2);
$this->assertEqual($columns['oneinteger']->meta_type ,'I');
- $this->assertEqual($DB->get_field('test_table1', 'oneinteger', array()), 2); //check default has been applied
+ $this->assertEqual($DB->get_field('test_table1', 'oneinteger', array(), 1), 2); //check default has been applied
/// add one numeric field and check it
$field = new xmldb_field('onenumber');
$this->assertEqual($columns['onenumber']->has_default , true);
$this->assertEqual($columns['onenumber']->default_value, 2.550);
$this->assertEqual($columns['onenumber']->meta_type ,'N');
- $this->assertEqual($DB->get_field('test_table1', 'onenumber', array()), 2.550); //check default has been applied
+ $this->assertEqual($DB->get_field('test_table1', 'onenumber', array(), 1), 2.550); //check default has been applied
/// add one float field and check it (not official type - must work as number)
$field = new xmldb_field('onefloat');
$this->assertEqual($columns['onefloat']->has_default , true);
$this->assertEqual($columns['onefloat']->default_value, 3.550);
$this->assertEqual($columns['onefloat']->meta_type ,'N');
- $this->assertEqual($DB->get_field('test_table1', 'onefloat', array()), 3.550); //check default has been applied
+ $this->assertEqual($DB->get_field('test_table1', 'onefloat', array(), 1), 3.550); //check default has been applied
/// add one char field and check it
$field = new xmldb_field('onechar');
$this->assertEqual($columns['onechar']->has_default , true);
$this->assertEqual($columns['onechar']->default_value,'Nice dflt!');
$this->assertEqual($columns['onechar']->meta_type ,'C');
- $this->assertEqual($DB->get_field('test_table1', 'onechar', array()), 'Nice dflt!'); //check default has been applied
+ $this->assertEqual($DB->get_field('test_table1', 'onechar', array(), 1), 'Nice dflt!'); //check default has been applied
/// add one text field and check it
$field = new xmldb_field('onetext');
* @param string $table The table to select from.
* @param array $conditions optional array $fieldname=>requestedvalue with AND in between
* @param string $fields A comma separated list of fields to be returned from the chosen table.
- * @param bool $ignoremultiple ignore multiple records if found
- * @return maixed a fieldset object containing the first mathcing record or false if not found
+ * @param int $strictness 0 means compatible mode, false returned if record not found, debug message if more found;
+ * 1 means ignore multiple records found, return first (not recommended);
+ * 2 means throw exception if no record or multiple records found (MUST_EXIST constant)
+ * @return mixed a fieldset object containing the first matching record, false or exception if error not found depending on mode
* @throws dml_exception if error
*/
- public function get_record($table, array $conditions, $fields='*', $ignoremultiple=false) {
+ public function get_record($table, array $conditions, $fields='*', $strictness=0) {
list($select, $params) = $this->where_clause($conditions);
- return $this->get_record_select($table, $select, $params, $fields, $ignoremultiple);
+ return $this->get_record_select($table, $select, $params, $fields, $strictness);
}
/**
* @param string $table The database table to be checked against.
* @param string $select A fragment of SQL to be used in a where clause in the SQL call.
* @param array $params array of sql parameters
- * @param string $fields A comma separated list of fields to be returned from the chosen table.
- * @param bool $ignoremultiple ignore multiple records if found
- * @return maixed a fieldset object containing the first mathcing record or false if not found
+ * @param int $strictness 0 means compatible mode, false returned if record not found, debug message if more found;
+ * 1 means ignore multiple records found, return first (not recommended);
+ * 2 means throw exception if no record or multiple records found (MUST_EXIST constant)
+ * @return mixed a fieldset object containing the first matching record, false or exception if error not found depending on mode
* @throws dml_exception if error
*/
- public function get_record_select($table, $select, array $params=null, $fields='*', $ignoremultiple=false) {
+ public function get_record_select($table, $select, array $params=null, $fields='*', $strictness=0) {
if ($select) {
$select = "WHERE $select";
}
- return $this->get_record_sql("SELECT $fields FROM {$this->prefix}$table $select", $params, $ignoremultiple);
+ try {
+ return $this->get_record_sql("SELECT $fields FROM {$this->prefix}$table $select", $params, $strictness);
+ } catch (dml_missing_record_exception $e) {
+ // create new exception which will contain correct table name
+ throw new dml_missing_record_exception($table, $e->sql, $e->params);
+ }
}
/**
* Get a single database record as an object using a SQL statement.
*
- * The SQL statement should normally only return one record. In debug mode
- * you will get a warning if more records are found. In non-debug mode,
- * it just returns the first record.
- *
- * Use get_records_sql() if more matches possible!
+ * The SQL statement should normally only return one record.
+ * It is recommended to use get_records_sql() if more matches possible!
*
* @param string $sql The SQL string you wish to be executed, should normally only return one record.
* @param array $params array of sql parameters
- * @param bool $ignoremultiple ignore multiple records if found
- * @return maixed a fieldset object containing the first mathcing record or false if not found
+ * @param int $strictness 0 means compatible mode, false returned if record not found, debug message if more found;
+ * 1 means ignore multiple records found, return first (not recommended);
+ * 2 means throw exception if no record or multiple records found (MUST_EXIST constant)
+ * @return mixed a fieldset object containing the first matching record, false or exception if error not found depending on mode
* @throws dml_exception if error
*/
- public function get_record_sql($sql, array $params=null, $ignoremultiple=false) {
- $count = $ignoremultiple ? 1 : 2;
-
+ public function get_record_sql($sql, array $params=null, $strictness=0) {
+ $strictness = (int)$strictness;
+ if ($strictness == 1) {
+ $count = 1;
+ } else {
+ $count = 0;
+ }
if (!$records = $this->get_records_sql($sql, $params, 0, $count)) {
// not found
+ if ($strictness == 2) { //MUST_EXIST
+ throw new dml_missing_record_exception('', $sql, $params);
+ }
return false;
}
- if (!$ignoremultiple and count($records) > 1) {
+ if (count($records) > 1) {
+ if ($strictness == 2) { //MUST_EXIST
+ throw new dml_multiple_records_exception($sql, $params);
+ }
debugging('Error: mdb->get_record() found more than one record!');
}
* @param string $table the table to query.
* @param string $return the field to return the value of.
* @param array $conditions optional array $fieldname=>requestedvalue with AND in between
+ * @param int $strictness 0 means compatible mode, false returned if record not found, debug message if more found;
+ * 1 means ignore multiple records found, return first;
+ * 2 means throw exception if no record or multiple records found (MUST_EXIST constant)
* @return mixed the specified value false if not found
* @throws dml_exception if error
*/
- public function get_field($table, $return, array $conditions) {
+ public function get_field($table, $return, array $conditions, $strictness=0) {
list($select, $params) = $this->where_clause($conditions);
- return $this->get_field_select($table, $return, $select, $params);
+ return $this->get_field_select($table, $return, $select, $params, $strictness);
}
/**
* @param string $return the field to return the value of.
* @param string $select A fragment of SQL to be used in a where clause returning one row with one column
* @param array $params array of sql parameters
+ * @param int $strictness 0 means compatible mode, false returned if record not found, debug message if more found;
+ * 1 means ignore multiple records found, return first;
+ * 2 means throw exception if no record or multiple records found (MUST_EXIST constant)
* @return mixed the specified value false if not found
* @throws dml_exception if error
*/
- public function get_field_select($table, $return, $select, array $params=null) {
+ public function get_field_select($table, $return, $select, array $params=null, $strictness=0) {
if ($select) {
$select = "WHERE $select";
}
- return $this->get_field_sql("SELECT $return FROM {" . $table . "} $select", $params);
+ try {
+ return $this->get_field_sql("SELECT $return FROM {" . $table . "} $select", $params, $strictness);
+ } catch (dml_missing_record_exception $e) {
+ // create new exception which will contain correct table name
+ throw new dml_missing_record_exception($table, $e->sql, $e->params);
+ }
}
/**
* @param string $return the field to return the value of.
* @param string $sql The SQL query returning one row with one column
* @param array $params array of sql parameters
+ * @param int $strictness 0 means compatible mode, false returned if record not found, debug message if more found;
+ * 1 means ignore multiple records found, return first;
+ * 2 means throw exception if no record or multiple records found (MUST_EXIST constant)
* @return mixed the specified value false if not found
* @throws dml_exception if error
*/
- public function get_field_sql($sql, array $params=null) {
- if ($records = $this->get_records_sql($sql, $params, 0, 1)) {
- $record = reset($records);
- $record = (array)$record;
- return reset($record); // first column
+ public function get_field_sql($sql, array $params=null, $strictness=0) {
+ if (!$record = $this->get_record_sql($sql, $params, $strictness)) {
+ return false;
}
- return false;
+
+ $record = (array)$record;
+ return reset($record); // first column
}
/**
/**
* Get a single database record as an object using a SQL statement.
*
- * The SQL statement should normally only return one record. In debug mode
- * you will get a warning if more records are found. In non-debug mode,
- * it just returns the first record.
- *
- * Use get_records_sql() if more matches possible!
+ * The SQL statement should normally only return one record.
+ * It is recommended to use get_records_sql() if more matches possible!
*
* @param string $sql The SQL string you wish to be executed, should normally only return one record.
* @param array $params array of sql parameters
- * @param bool $ignoremultiple ignore multiple records if found
- * @return maixed a fieldset object containing the first mathcing record or false if not found
+ * @param int $mode 0 means compatible mode, false returned if record not found, debug message if more found;
+ * 1 means ignore multiple records found, return first (not recommended);
+ * 2 means throw exception if no record or multiple records found (MUST_EXIST constant)
+ * @return mixed a fieldset object containing the first matching record, false or exception if error not found depending on mode
* @throws dml_exception if error
*/
- public function get_record_sql($sql, array $params=null, $ignoremultiple=false) {
- // do not limit here - ORA does not like that
- if (!$records = $this->get_records_sql($sql, $params)) {
- // not found
+ public function get_record_sql($sql, array $params=null, $mode=0) {
+ $mode = (int)$mode;
+ if ($mode == 1) {
+ // do not limit here - ORA does not like that
+ if (!$rs = $this->get_recordset_sql($sql, $params)) {
+ return false;
+ }
+ foreach ($rs as $result) {
+ $rs->close();
+ return $result;
+ }
+ $rs->close();
return false;
}
-
- if (!$ignoremultiple and count($records) > 1) {
- debugging('Error: mdb->get_record() found more than one record!');
- }
-
- $return = reset($records);
- return $return;
- }
-
- /**
- * Get a single field value (first field) using a SQL statement.
- *
- * @param string $table the table to query.
- * @param string $return the field to return the value of.
- * @param string $sql The SQL query returning one row with one column
- * @param array $params array of sql parameters
- * @return mixed the specified value false if not found
- * @throws dml_exception if error
- */
- public function get_field_sql($sql, array $params=null) {
- // do not limit here - ORA does not like that
- if ($records = $this->get_records_sql($sql, $params)) {
- $record = reset($records);
- $record = (array)$record;
- return reset($record); // first column
- }
- return false;
+ return parent::get_record_sql($sql, $params, $mode);
}
/**
$this->assertEqual(2, $record->course);
+ // record not found
+ $this->assertFalse($record = $DB->get_record_sql("SELECT * FROM {".$tablename."} WHERE id = ?", array(666), 0));
+ $this->assertFalse($record = $DB->get_record_sql("SELECT * FROM {".$tablename."} WHERE id = ?", array(666), 1));
+ try {
+ $DB->get_record_sql("SELECT * FROM {".$tablename."} WHERE id = ?", array(666), 2);
+ $this->fail("Exception expected");
+ } catch (dml_missing_record_exception $e) {
+ $this->assertTrue(true);
+ }
+
+ // multiple matches
+ ob_start(); // hide debug warning
+ $this->assertTrue($record = $DB->get_record_sql("SELECT * FROM {".$tablename."}", array(), 0));
+ ob_end_clean();
+ $this->assertTrue($record = $DB->get_record_sql("SELECT * FROM {".$tablename."}", array(), 1));
+ try {
+ $DB->get_record_sql("SELECT * FROM {".$tablename."}", array(), 2);
+ $this->fail("Exception expected");
+ } catch (dml_multiple_records_exception $e) {
+ $this->assertTrue(true);
+ }
}
public function test_get_field() {
// Require the essential
require_once($CFG->libdir.'/dml/moodle_database.php');
+/** Indicates some record is required to exist */
+define('MUST_EXIST', 2);
+
/**
* DML exception class, use instead of error() in dml code.
*/
*/
class dml_connection_exception extends dml_exception {
/**
+ * Constructor
* @param string $error
*/
function __construct($error) {
class dml_read_exception extends dml_exception {
/** @var string */
public $error;
+ /** @var string */
public $sql;
/** @var array */
public $params;
/**
+ * Constructor
* @param string $error
* @param string $sql
* @param array $params
}
/**
- * DML read exception - triggered by SQL syntax errors, missing tables, etc.
+ * Caused by multiple records found in get_record() call.
+ */
+class dml_multiple_records_exception extends dml_exception {
+ /** @var string */
+ public $sql;
+ /** @var array */
+ public $params;
+
+ /**
+ * Constructor
+ * @param string $table table name if known, '' if unknown
+ * @param string $sql
+ * @param array $params
+ */
+ function __construct($sql='', array $params=null) {
+ $errorinfo = s($sql).'<br />['.s(var_export($params, true)).']';
+ parent::__construct('multiplerecordsfound', null, $errorinfo);
+ }
+}
+
+/**
+ * Caused by missing record that is required for normal operation.
+ */
+class dml_missing_record_exception extends dml_exception {
+ /** @var string */
+ public $table;
+ /** @var string */
+ public $sql;
+ /** @var array */
+ public $params;
+
+ /**
+ * Constructor
+ * @param string $table table name if known, '' if unknown
+ * @param string $sql
+ * @param array $params
+ */
+ function __construct($tablename, $sql='', array $params=null) {
+ if (empty($tablename)) {
+ $tablename = null;
+ }
+ $this->tablename = $tablename;
+ $this->sql = $sql;
+ $this->params = $params;
+
+ switch ($tablename) {
+ case null:
+ $errcode = 'invalidrecordunknown';
+ break;
+ case 'course':
+ $errocode = empty($sql) ? 'invalidcourseid' : 'invalidrecord';
+ break;
+ case 'course_module':
+ $errocode = 'invalidcoursemodule';
+ break;
+ case 'user':
+ $errcode = 'invaliduser';
+ break;
+ default:
+ $errcode = 'invalidrecord';
+ break;
+ }
+ $errorinfo = s($sql).'<br />['.s(var_export($params, true)).']';
+ parent::__construct($errcode, $tablename, $errorinfo);
+ }
+}
+
+/**
+ * DML write exception - triggered by SQL syntax errors, missing tables, etc.
*/
class dml_write_exception extends dml_exception {
/** @var string */
public $error;
+ /** @var string */
public $sql;
/** @var array */
public $params;
/**
+ * Constructor
* @param string $error
* @param string $sql
* @param array $params
projects / moodle.git / commitdiff