3 * Interface 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 >
41 * @param IORMTable $table
42 * @param array|null $fields
43 * @param boolean $loadDefaults
45 public function __construct( IORMTable
$table, $fields = null, $loadDefaults = false );
48 * Load the specified fields from the database.
52 * @param array|null $fields
53 * @param boolean $override
54 * @param boolean $skipLoaded
56 * @return bool Success indicator
58 public function loadFields( $fields = null, $override = true, $skipLoaded = false );
61 * Gets the value of a field.
66 * @param mixed $default
71 public function getField( $name, $default = null );
74 * Gets the value of a field but first loads it if not done so already.
82 public function loadAndGetField( $name );
91 public function removeField( $name );
94 * Returns the objects database id.
98 * @return integer|null
100 public function getId();
103 * Sets the objects database id.
107 * @param integer|null $id
109 public function setId( $id );
112 * Gets if a certain field is set.
116 * @param string $name
120 public function hasField( $name );
123 * Gets if the id field is set.
129 public function hasIdField();
132 * Sets multiple fields.
136 * @param array $fields The fields to set
137 * @param boolean $override Override already set fields with the provided values?
139 public function setFields( array $fields, $override = true );
142 * Serializes the object to an associative array which
143 * can then easily be converted into JSON or similar.
147 * @param null|array $fields
148 * @param boolean $incNullId
152 public function toArray( $fields = null, $incNullId = false );
155 * Load the default values, via getDefaults.
159 * @param boolean $override
161 public function loadDefaults( $override = true );
164 * Writes the answer to the database, either updating it
165 * when it already exists, or inserting it when it doesn't.
169 * @param string|null $functionName
171 * @return boolean Success indicator
173 public function save( $functionName = null );
176 * Removes the object from the database.
180 * @return boolean Success indicator
182 public function remove();
185 * Return the names and values of the fields.
191 public function getFields();
194 * Return the names of the fields.
200 public function getSetFieldNames();
203 * Sets the value of a field.
204 * Strings can be provided for other types,
205 * so this method can be called from unserialization handlers.
209 * @param string $name
210 * @param mixed $value
212 * @throws MWException
214 public function setField( $name, $value );
217 * Add an amount (can be negative) to the specified field (needs to be numeric).
218 * TODO: most off this stuff makes more sense in the table class
222 * @param string $field
223 * @param integer $amount
225 * @return boolean Success indicator
227 public function addToField( $field, $amount );
230 * Return the names of the fields.
236 public function getFieldNames();
239 * Computes and updates the values of the summary fields.
243 * @param array|string|null $summaryFields
245 public function loadSummaryFields( $summaryFields = null );
248 * Sets the value for the @see $updateSummaries field.
252 * @param boolean $update
254 public function setUpdateSummaries( $update );
257 * Sets the value for the @see $inSummaryMode field.
261 * @param boolean $summaryMode
263 public function setSummaryMode( $summaryMode );
266 * Returns the table this IORMRow is a row in.
272 public function getTable();