3 * Abstract base class for representing objects that are stored in some DB table.
4 * This is basically an ORM-like wrapper around rows in database tables that
5 * aims to be both simple and very flexible. It is centered around an associative
6 * array of fields and various methods to do common interaction with the database.
8 * Documentation inline and at https://www.mediawiki.org/wiki/Manual:ORMTable
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23 * http://www.gnu.org/copyleft/gpl.html
30 * @license GNU GPL v2 or later
31 * @author Jeroen De Dauw < jeroendedauw@gmail.com >
34 abstract class ORMRow
implements IORMRow
{
37 * The fields of the object.
38 * field name (w/o prefix) => value
43 protected $fields = array( 'id' => null );
52 * If the object should update summaries of linked items when changed.
53 * For example, update the course_count field in universities when a course in courses is deleted.
54 * Settings this to false can prevent needless updating work in situations
55 * such as deleting a university, which will then delete all it's courses.
60 protected $updateSummaries = true;
63 * Indicates if the object is in summary mode.
64 * This mode indicates that only summary fields got updated,
65 * which allows for optimizations.
70 protected $inSummaryMode = false;
77 * @param IORMTable $table
78 * @param array|null $fields
79 * @param boolean $loadDefaults
81 public function __construct( IORMTable
$table, $fields = null, $loadDefaults = false ) {
82 $this->table
= $table;
84 if ( !is_array( $fields ) ) {
88 if ( $loadDefaults ) {
89 $fields = array_merge( $this->table
->getDefaults(), $fields );
92 $this->setFields( $fields );
96 * Load the specified fields from the database.
100 * @param array|null $fields
101 * @param boolean $override
102 * @param boolean $skipLoaded
104 * @return bool Success indicator
106 public function loadFields( $fields = null, $override = true, $skipLoaded = false ) {
107 if ( is_null( $this->getId() ) ) {
111 if ( is_null( $fields ) ) {
112 $fields = array_keys( $this->table
->getFields() );
116 $fields = array_diff( $fields, array_keys( $this->fields
) );
119 if ( !empty( $fields ) ) {
120 $result = $this->table
->rawSelectRow(
121 $this->table
->getPrefixedFields( $fields ),
122 array( $this->table
->getPrefixedField( 'id' ) => $this->getId() ),
123 array( 'LIMIT' => 1 )
126 if ( $result !== false ) {
127 $this->setFields( $this->table
->getFieldsFromDBResult( $result ), $override );
137 * Gets the value of a field.
141 * @param $name string: Field name
142 * @param $default mixed: Default value to return when none is found
145 * @throws MWException
148 public function getField( $name, $default = null ) {
149 if ( $this->hasField( $name ) ) {
150 return $this->fields
[$name];
151 } elseif ( !is_null( $default ) ) {
154 throw new MWException( 'Attempted to get not-set field ' . $name );
159 * Gets the value of a field but first loads it if not done so already.
163 * @param $name string
167 public function loadAndGetField( $name ) {
168 if ( !$this->hasField( $name ) ) {
169 $this->loadFields( array( $name ) );
172 return $this->getField( $name );
180 * @param string $name
182 public function removeField( $name ) {
183 unset( $this->fields
[$name] );
187 * Returns the objects database id.
191 * @return integer|null
193 public function getId() {
194 return $this->getField( 'id' );
198 * Sets the objects database id.
202 * @param integer|null $id
204 public function setId( $id ) {
205 $this->setField( 'id', $id );
209 * Gets if a certain field is set.
213 * @param string $name
217 public function hasField( $name ) {
218 return array_key_exists( $name, $this->fields
);
222 * Gets if the id field is set.
228 public function hasIdField() {
229 return $this->hasField( 'id' )
230 && !is_null( $this->getField( 'id' ) );
234 * Sets multiple fields.
238 * @param array $fields The fields to set
239 * @param boolean $override Override already set fields with the provided values?
241 public function setFields( array $fields, $override = true ) {
242 foreach ( $fields as $name => $value ) {
243 if ( $override ||
!$this->hasField( $name ) ) {
244 $this->setField( $name, $value );
250 * Gets the fields => values to write to the table.
256 protected function getWriteValues() {
259 foreach ( $this->table
->getFields() as $name => $type ) {
260 if ( array_key_exists( $name, $this->fields
) ) {
261 $value = $this->fields
[$name];
265 $value = (array)$value;
268 $value = serialize( $value );
272 $values[$this->table
->getPrefixedField( $name )] = $value;
280 * Serializes the object to an associative array which
281 * can then easily be converted into JSON or similar.
285 * @param null|array $fields
286 * @param boolean $incNullId
290 public function toArray( $fields = null, $incNullId = false ) {
292 $setFields = array();
294 if ( !is_array( $fields ) ) {
295 $setFields = $this->getSetFieldNames();
297 foreach ( $fields as $field ) {
298 if ( $this->hasField( $field ) ) {
299 $setFields[] = $field;
304 foreach ( $setFields as $field ) {
305 if ( $incNullId ||
$field != 'id' ||
$this->hasIdField() ) {
306 $data[$field] = $this->getField( $field );
314 * Load the default values, via getDefaults.
318 * @param boolean $override
320 public function loadDefaults( $override = true ) {
321 $this->setFields( $this->table
->getDefaults(), $override );
325 * Writes the answer to the database, either updating it
326 * when it already exists, or inserting it when it doesn't.
330 * @param string|null $functionName
332 * @return boolean Success indicator
334 public function save( $functionName = null ) {
335 if ( $this->hasIdField() ) {
336 return $this->saveExisting( $functionName );
338 return $this->insert( $functionName );
343 * Updates the object in the database.
347 * @param string|null $functionName
349 * @return boolean Success indicator
351 protected function saveExisting( $functionName = null ) {
352 $dbw = $this->table
->getWriteDbConnection();
354 $success = $dbw->update(
355 $this->table
->getName(),
356 $this->getWriteValues(),
357 $this->table
->getPrefixedValues( $this->getUpdateConditions() ),
358 is_null( $functionName ) ? __METHOD__
: $functionName
361 $this->table
->releaseConnection( $dbw );
363 // DatabaseBase::update does not always return true for success as documented...
364 return $success !== false;
368 * Returns the WHERE considtions needed to identify this object so
375 protected function getUpdateConditions() {
376 return array( 'id' => $this->getId() );
380 * Inserts the object into the database.
384 * @param string|null $functionName
385 * @param array|null $options
387 * @return boolean Success indicator
389 protected function insert( $functionName = null, array $options = null ) {
390 $dbw = $this->table
->getWriteDbConnection();
392 $success = $dbw->insert(
393 $this->table
->getName(),
394 $this->getWriteValues(),
395 is_null( $functionName ) ? __METHOD__
: $functionName,
399 // DatabaseBase::insert does not always return true for success as documented...
400 $success = $success !== false;
403 $this->setField( 'id', $dbw->insertId() );
406 $this->table
->releaseConnection( $dbw );
412 * Removes the object from the database.
416 * @return boolean Success indicator
418 public function remove() {
419 $this->beforeRemove();
421 $success = $this->table
->delete( array( 'id' => $this->getId() ) );
423 // DatabaseBase::delete does not always return true for success as documented...
424 $success = $success !== false;
434 * Gets called before an object is removed from the database.
438 protected function beforeRemove() {
439 $this->loadFields( $this->getBeforeRemoveFields(), false, true );
443 * Before removal of an object happens, @see beforeRemove gets called.
444 * This method loads the fields of which the names have been returned by this one (or all fields if null is returned).
445 * This allows for loading info needed after removal to get rid of linked data and the like.
451 protected function getBeforeRemoveFields() {
456 * Gets called after successfull removal.
457 * Can be overriden to get rid of linked data.
461 protected function onRemoved() {
462 $this->setField( 'id', null );
466 * Return the names and values of the fields.
472 public function getFields() {
473 return $this->fields
;
477 * Return the names of the fields.
483 public function getSetFieldNames() {
484 return array_keys( $this->fields
);
488 * Sets the value of a field.
489 * Strings can be provided for other types,
490 * so this method can be called from unserialization handlers.
494 * @param string $name
495 * @param mixed $value
497 * @throws MWException
499 public function setField( $name, $value ) {
500 $fields = $this->table
->getFields();
502 if ( array_key_exists( $name, $fields ) ) {
503 switch ( $fields[$name] ) {
505 $value = (int)$value;
508 $value = (float)$value;
511 if ( is_string( $value ) ) {
512 $value = $value !== '0';
513 } elseif ( is_int( $value ) ) {
514 $value = $value !== 0;
518 if ( is_string( $value ) ) {
519 $value = unserialize( $value );
522 if ( !is_array( $value ) ) {
527 if ( is_string( $value ) ) {
528 $value = unserialize( $value );
532 if ( is_string( $value ) ) {
533 $value = (int)$value;
538 $this->fields
[$name] = $value;
540 throw new MWException( 'Attempted to set unknown field ' . $name );
545 * Add an amount (can be negative) to the specified field (needs to be numeric).
546 * TODO: most off this stuff makes more sense in the table class
550 * @param string $field
551 * @param integer $amount
553 * @return boolean Success indicator
555 public function addToField( $field, $amount ) {
556 if ( $amount == 0 ) {
560 if ( !$this->hasIdField() ) {
564 $absoluteAmount = abs( $amount );
565 $isNegative = $amount < 0;
567 $dbw = $this->table
->getWriteDbConnection();
569 $fullField = $this->table
->getPrefixedField( $field );
571 $success = $dbw->update(
572 $this->table
->getName(),
573 array( "$fullField=$fullField" . ( $isNegative ?
'-' : '+' ) . $absoluteAmount ),
574 array( $this->table
->getPrefixedField( 'id' ) => $this->getId() ),
578 if ( $success && $this->hasField( $field ) ) {
579 $this->setField( $field, $this->getField( $field ) +
$amount );
582 $this->table
->releaseConnection( $dbw );
588 * Return the names of the fields.
594 public function getFieldNames() {
595 return array_keys( $this->table
->getFields() );
599 * Computes and updates the values of the summary fields.
603 * @param array|string|null $summaryFields
605 public function loadSummaryFields( $summaryFields = null ) {
610 * Sets the value for the @see $updateSummaries field.
614 * @param boolean $update
616 public function setUpdateSummaries( $update ) {
617 $this->updateSummaries
= $update;
621 * Sets the value for the @see $inSummaryMode field.
625 * @param boolean $summaryMode
627 public function setSummaryMode( $summaryMode ) {
628 $this->inSummaryMode
= $summaryMode;
632 * Return if any fields got changed.
636 * @param IORMRow $object
637 * @param boolean|array $excludeSummaryFields
638 * When set to true, summary field changes are ignored.
639 * Can also be an array of fields to ignore.
643 protected function fieldsChanged( IORMRow
$object, $excludeSummaryFields = false ) {
644 $exclusionFields = array();
646 if ( $excludeSummaryFields !== false ) {
647 $exclusionFields = is_array( $excludeSummaryFields ) ?
$excludeSummaryFields : $this->table
->getSummaryFields();
650 foreach ( $this->fields
as $name => $value ) {
651 $excluded = $excludeSummaryFields && in_array( $name, $exclusionFields );
653 if ( !$excluded && $object->getField( $name ) !== $value ) {
662 * Returns the table this IORMRow is a row in.
668 public function getTable() {