3 * Interface for objects representing a single database table.
4 * Documentation inline and at https://www.mediawiki.org/wiki/Manual:ORMTable
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
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 * http://www.gnu.org/copyleft/gpl.html
26 * @license GNU GPL v2 or later
27 * @author Jeroen De Dauw < jeroendedauw@gmail.com >
33 * Returns the name of the database table objects of this type are stored in.
39 public function getName();
42 * Returns the name of a IORMRow implementing class that
43 * represents single rows in this table.
49 public function getRowClass();
52 * Returns an array with the fields and their types this object contains.
53 * This corresponds directly to the fields in the database, without prefix.
66 * TODO: get rid of the id field. Every row instance needs to have
67 * one so this is just causing hassle at various locations by requiring an extra check for field name.
73 public function getFields();
76 * Returns a list of default field values.
77 * field name => field value
83 public function getDefaults();
86 * Returns a list of the summary fields.
87 * These are fields that cache computed values, such as the amount of linked objects of $type.
88 * This is relevant as one might not want to do actions such as log changes when these get updated.
94 public function getSummaryFields();
97 * Selects the the specified fields of the records matching the provided
98 * conditions and returns them as DBDataObject. Field names get prefixed.
102 * @param array|string|null $fields
103 * @param array $conditions
104 * @param array $options
105 * @param string|null $functionName
109 public function select( $fields = null, array $conditions = array(),
110 array $options = array(), $functionName = null );
113 * Selects the the specified fields of the records matching the provided
114 * conditions and returns them as DBDataObject. Field names get prefixed.
118 * @param array|string|null $fields
119 * @param array $conditions
120 * @param array $options
121 * @param string|null $functionName
123 * @return array of self
125 public function selectObjects( $fields = null, array $conditions = array(),
126 array $options = array(), $functionName = null );
129 * Do the actual select.
133 * @param null|string|array $fields
134 * @param array $conditions
135 * @param array $options
136 * @param null|string $functionName
138 * @return ResultWrapper
140 public function rawSelect( $fields = null, array $conditions = array(),
141 array $options = array(), $functionName = null );
144 * Selects the the specified fields of the records matching the provided
145 * conditions and returns them as associative arrays.
146 * Provided field names get prefixed.
147 * Returned field names will not have a prefix.
149 * When $collapse is true:
150 * If one field is selected, each item in the result array will be this field.
151 * If two fields are selected, each item in the result array will have as key
152 * the first field and as value the second field.
153 * If more then two fields are selected, each item will be an associative array.
157 * @param array|string|null $fields
158 * @param array $conditions
159 * @param array $options
160 * @param boolean $collapse Set to false to always return each result row as associative array.
161 * @param string|null $functionName
163 * @return array of array
165 public function selectFields( $fields = null, array $conditions = array(),
166 array $options = array(), $collapse = true, $functionName = null );
169 * Selects the the specified fields of the first matching record.
170 * Field names get prefixed.
174 * @param array|string|null $fields
175 * @param array $conditions
176 * @param array $options
177 * @param string|null $functionName
179 * @return IORMRow|bool False on failure
181 public function selectRow( $fields = null, array $conditions = array(),
182 array $options = array(), $functionName = null );
185 * Selects the the specified fields of the records matching the provided
186 * conditions. Field names do NOT get prefixed.
190 * @param array $fields
191 * @param array $conditions
192 * @param array $options
193 * @param string|null $functionName
195 * @return ResultWrapper
197 public function rawSelectRow( array $fields, array $conditions = array(),
198 array $options = array(), $functionName = null );
201 * Selects the the specified fields of the first record matching the provided
202 * conditions and returns it as an associative array, or false when nothing matches.
203 * This method makes use of selectFields and expects the same parameters and
204 * returns the same results (if there are any, if there are none, this method returns false).
205 * @see IORMTable::selectFields
209 * @param array|string|null $fields
210 * @param array $conditions
211 * @param array $options
212 * @param boolean $collapse Set to false to always return each result row as associative array.
213 * @param string|null $functionName
215 * @return mixed|array|bool False on failure
217 public function selectFieldsRow( $fields = null, array $conditions = array(),
218 array $options = array(), $collapse = true, $functionName = null );
221 * Returns if there is at least one record matching the provided conditions.
222 * Condition field names get prefixed.
226 * @param array $conditions
230 public function has( array $conditions = array() );
233 * Checks if the table exists
239 public function exists();
242 * Returns the amount of matching records.
243 * Condition field names get prefixed.
245 * Note that this can be expensive on large tables.
246 * In such cases you might want to use DatabaseBase::estimateRowCount instead.
250 * @param array $conditions
251 * @param array $options
255 public function count( array $conditions = array(), array $options = array() );
258 * Removes the object from the database.
262 * @param array $conditions
263 * @param string|null $functionName
265 * @return boolean Success indicator
267 public function delete( array $conditions, $functionName = null );
270 * Get API parameters for the fields supported by this object.
274 * @param boolean $requireParams
275 * @param boolean $setDefaults
279 public function getAPIParams( $requireParams = false, $setDefaults = false );
282 * Returns an array with the fields and their descriptions.
284 * field name => field description
290 public function getFieldDescriptions();
293 * Get the database type used for read operations.
297 * @return integer DB_ enum
299 public function getReadDb();
302 * Set the database type to use for read operations.
308 public function setReadDb( $db );
312 * Get the ID of the any foreign wiki to use as a target for database operations
316 * @return String|bool The target wiki, in a form that LBFactory understands (or false if the local wiki is used)
318 public function getTargetWiki();
321 * Set the ID of the any foreign wiki to use as a target for database operations
323 * @param String|bool $wiki The target wiki, in a form that LBFactory understands (or false if the local wiki shall be used)
327 public function setTargetWiki( $wiki );
330 * Get the database type used for read operations.
331 * This is to be used instead of wfGetDB.
333 * @see LoadBalancer::getConnection
337 * @return DatabaseBase The database object
339 public function getReadDbConnection();
342 * Get the database type used for read operations.
343 * This is to be used instead of wfGetDB.
345 * @see LoadBalancer::getConnection
349 * @return DatabaseBase The database object
351 public function getWriteDbConnection();
354 * Get the database type used for read operations.
360 * @return LoadBalancer The database load balancer object
362 public function getLoadBalancer();
365 * Releases the lease on the given database connection. This is useful mainly
366 * for connections to a foreign wiki. It does nothing for connections to the local wiki.
368 * @see LoadBalancer::reuseConnection
370 * @param DatabaseBase $db the database
374 public function releaseConnection( DatabaseBase
$db );
377 * Update the records matching the provided conditions by
378 * setting the fields that are keys in the $values param to
379 * their corresponding values.
383 * @param array $values
384 * @param array $conditions
386 * @return boolean Success indicator
388 public function update( array $values, array $conditions = array() );
391 * Computes the values of the summary fields of the objects matching the provided conditions.
395 * @param array|string|null $summaryFields
396 * @param array $conditions
398 public function updateSummaryFields( $summaryFields = null, array $conditions = array() );
401 * Takes in an associative array with field names as keys and
402 * their values as value. The field names are prefixed with the
407 * @param array $values
411 public function getPrefixedValues( array $values );
414 * Takes in a field or array of fields and returns an
415 * array with their prefixed versions, ready for db usage.
419 * @param array|string $fields
423 public function getPrefixedFields( array $fields );
426 * Takes in a field and returns an it's prefixed version, ready for db usage.
430 * @param string|array $field
434 public function getPrefixedField( $field );
437 * Takes an array of field names with prefix and returns the unprefixed equivalent.
441 * @param array $fieldNames
445 public function unprefixFieldNames( array $fieldNames );
448 * Takes a field name with prefix and returns the unprefixed equivalent.
452 * @param string $fieldName
456 public function unprefixFieldName( $fieldName );
459 * Get an array with fields from a database result,
460 * that can be fed directly to the constructor or
465 * @param stdClass $result
469 public function getFieldsFromDBResult( stdClass
$result );
472 * Get a new instance of the class from a database result.
476 * @param stdClass $result
480 public function newRowFromDBResult( stdClass
$result );
483 * Get a new instance of the class from an array.
488 * @param boolean $loadDefaults
492 public function newRow( array $data, $loadDefaults = false );
495 * Return the names of the fields.
501 public function getFieldNames();
504 * Gets if the object can take a certain field.
508 * @param string $name
512 public function canHaveField( $name );