1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 <?php
namespace Alpha\Model;
/**
* An interface that defines all of the active record methods that should be
* included in a provider that implements this interface.
*
* @since 1.1
*
* @author John Collins <dev@alphaframework.org>
* @license http://www.opensource.org/licenses/bsd-license.php The BSD License
* @copyright Copyright (c) 2018, John Collins (founder of Alpha Framework).
* All rights reserved.
*
* <pre>
* Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the
* following conditions are met:
*
* * Redistributions of source code must retain the above
* copyright notice, this list of conditions and the
* following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the
* following disclaimer in the documentation and/or other
* materials provided with the distribution.
* * Neither the name of the Alpha Framework nor the names
* of its contributors may be used to endorse or promote
* products derived from this software without specific
* prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
* </pre>
*/
interface ActiveRecordProviderInterface
{
/**
* Gets the current connection singleton, or creates a new one if none exists.
*
* @return mixed
*
* @since 1.1
*/
public static function getConnection();
/**
* Disconnects the current database connection if one exists (self::$connection is set).
*
* @since 1.1
* @return void
*/
public static function disconnect();
/**
* Returns the last database error string for the current connection.
*
* @since 1.1
*
* @return string
*/
public static function getLastDatabaseError();
/**
* Populates the record object with the properties retrived from the database for the record $ID.
*
* @param int $ID The object ID of the record to load.
* @param int $version Optionaly, provide the version to load that version from the [tablename]_history table.
*
* @since 1.1
*
* @throws \Alpha\Exception\RecordFoundException
* @return void
*/
public function load($ID, $version = 0);
/**
* Load all old versions (if any) of this record from the [tablename]_history table.
*
* @param int $ID The object ID of the record to load.
*
* @return array An array containing objects of this type of record object, order by version.
*
* @since 2.0
*
* @throws \Alpha\Exception\RecordFoundException
*/
public function loadAllOldVersions($ID);
/**
* Populates the record object from the database table by the given attribute value.
*
* @param string $attribute The name of the attribute to load the record by.
* @param string $value The value of the attribute to load the record by.
* @param bool $ignoreClassType Default is false, set to true if you want to load from overloaded tables and ignore the class type
* @param array $loadAttributes The attributes to load from the database to this object (leave blank to load all attributes)
*
* @since 1.1
*
* @throws \Alpha\Exception\RecordFoundException
* @return void
*/
public function loadByAttribute($attribute, $value, $ignoreClassType = false, $loadAttributes = array());
/**
* Loads all of the record objects of this class into an array which is returned.
*
* @param int $start The start of the SQL LIMIT clause, useful for pagination.
* @param int $limit The amount (limit) of records to load, useful for pagination.
* @param string $orderBy The name of the field to sort the records by.
* @param string $order The order to sort the records by.
* @param bool $ignoreClassType Default is false, set to true if you want to load from overloaded tables and ignore the class type
*
* @return array An array containing objects of this type of record object.
*
* @since 1.1
*
* @throws \Alpha\Exception\RecordFoundException
*/
public function loadAll($start = 0, $limit = 0, $orderBy = 'ID', $order = 'ASC', $ignoreClassType = false);
/**
* Loads all of the objects of this class by the specified attribute into an array which is returned.
*
* @param string $attribute The attribute to load the objects by.
* @param string $value The value of the attribute to load the objects by.
* @param int $start The start of the SQL LIMIT clause, useful for pagination.
* @param int $limit The amount (limit) of objects to load, useful for pagination.
* @param string $orderBy The name of the field to sort the objects by.
* @param string $order The order to sort the objects by.
* @param bool $ignoreClassType Default is false, set to true if you want to load from overloaded tables and ignore the class type.
* @param string[] $constructorArgs An optional array of contructor arguements to pass to the records that will be generated and returned. Supports a maximum of 5 arguements.
*
* @return array An array containing objects of this type of business object.
*
* @since 1.1
*
* @throws \Alpha\Exception\RecordFoundException
* @throws \Alpha\Exception\IllegalArguementException
*/
public function loadAllByAttribute($attribute, $value, $start = 0, $limit = 0, $orderBy = 'ID', $order = 'ASC', $ignoreClassType = false, $constructorArgs = array());
/**
* Loads all of the record objects of this class by the specified attributes into an array which is returned.
*
* @param array $attributes The attributes to load the records by.
* @param array $values The values of the attributes to load the records by.
* @param int $start The start of the SQL LIMIT clause, useful for pagination.
* @param int $limit The amount (limit) of records to load, useful for pagination.
* @param string $orderBy The name of the field to sort the records by.
* @param string $order The order to sort the records by.
* @param bool $ignoreClassType Default is false, set to true if you want to load from overloaded tables and ignore the class type
* @param string[] $constructorArgs An optional array of contructor arguements to pass to the records that will be generated and returned. Supports a maximum of 5 arguements.
*
* @return array An array containing objects of this type of record object.
*
* @since 1.1
*
* @throws \Alpha\Exception\RecordFoundException
* @throws \Alpha\Exception\IllegalArguementException
*/
public function loadAllByAttributes($attributes = array(), $values = array(), $start = 0, $limit = 0, $orderBy = 'ID', $order = 'ASC', $ignoreClassType = false, $constructorArgs = array());
/**
* Loads all of the record objects of this class that where updated (updated_ts value) on the date indicated.
*
* @param string $date The date for which to load the records updated on, in the format 'YYYY-MM-DD'.
* @param int $start The start of the SQL LIMIT clause, useful for pagination.
* @param int $limit The amount (limit) of records to load, useful for pagination.
* @param string $orderBy The name of the field to sort the records by.
* @param string $order The order to sort the records by.
* @param bool $ignoreClassType Default is false, set to true if you want to load from overloaded tables and ignore the class type
*
* @return array An array containing objects of this type of record object.
*
* @since 1.1
*
* @throws \Alpha\Exception\RecordFoundException
*/
public function loadAllByDayUpdated($date, $start = 0, $limit = 0, $orderBy = 'ID', $order = 'ASC', $ignoreClassType = false);
/**
* Loads all of the specified attribute values of this class by the specified attribute into an
* array which is returned.
*
* @param string $attribute The attribute name to load the field values by.
* @param string $value The value of the attribute to load the field values by.
* @param string $returnAttribute The name of the attribute to return.
* @param string $order The order to sort the records by.
* @param bool $ignoreClassType Default is false, set to true if you want to load from overloaded tables and ignore the class type.
*
* @return array An array of field values.
*
* @since 1.1
*
* @throws \Alpha\Exception\RecordFoundException
*/
public function loadAllFieldValuesByAttribute($attribute, $value, $returnAttribute, $order = 'ASC', $ignoreClassType = false);
/**
* Saves the record. If $this->ID is empty or null it will INSERT, otherwise UPDATE.
*
* @since 1.1
*
* @throws \Alpha\Exception\FailedSaveException
* @throws \Alpha\Exception\LockingException
* @throws \Alpha\Exception\ValidationException
* @return void
*/
public function save();
/**
* Saves the field specified with the value supplied. Only works for persistent records. Note that no Alpha type
* validation is performed with this method!
*
* @param string $attribute The name of the attribute to save.
* @param mixed $value The value of the attribute to save.
*
* @since 1.1
*
* @throws \Alpha\Exception\IllegalArguementException
* @throws \Alpha\Exception\FailedSaveException
* @throws \Alpha\Exception\LockingException
* @return void
*/
public function saveAttribute($attribute, $value);
/**
* Saves the object history to the [tablename]_history table. It always does an INSERT.
*
* @since 1.2
*
* @throws \Alpha\Exception\FailedSaveException
* @return void
*/
public function saveHistory();
/**
* Deletes the current object from the database.
*
* @since 1.1
*
* @throws \Alpha\Exception\FailedDeleteException
* @return void
*/
public function delete();
/**
* Gets the version_num of the object from the database (returns 0 if the Record is not saved yet).
*
* @return int
*
* @since 1.1
*
* @throws \Alpha\Exception\RecordFoundException
*/
public function getVersion();
/**
* Builds a new database table for the Record class.
*
* @since 1.1
*
* @param bool $checkIndexes Set to false if you do not want to check for any additional required indexes while creating the table (default is true).
*
* @throws \Alpha\Exception\AlphaException
* @return void
*/
public function makeTable($checkIndexes = true);
/**
* Builds a new database table for the Record class to store it's history.
*
* @since 1.2
*
* @throws \AlphaException
* @return void
*/
public function makeHistoryTable();
/**
* Re-builds the table if the model requirements have changed. All data is lost!
*
* @since 1.1
*
* @throws \Alpha\Exception\AlphaException
* @return void
*/
public function rebuildTable();
/**
* Drops the table if the model requirements have changed. All data is lost!
*
* @since 1.1
*
* @param string $tableName Optional table name, leave blank for the defined table for this class to be dropped
*
* @throws \Alpha\Exception\AlphaException
* @return void
*/
public function dropTable($tableName = null);
/**
* Adds in a new class property without loosing existing data (does an ALTER TABLE query on the
* database).
*
* @param string $propName The name of the new field to add to the database table.
*
* @since 1.1
*
* @throws \Alpha\Exception\AlphaException
* @return void
*/
public function addProperty($propName);
/**
* Gets the maximum ID value from the database for this class type.
*
* @return int The maximum ID value in the class table.
*
* @since 1.1
*
* @throws \Alpha\Exception\AlphaException
*/
public function getMAX();
/**
* Gets the count from the database for the amount of objects of this class.
*
* @param array $attributes The attributes to count the objects by (optional).
* @param array $values The values of the attributes to count the objects by (optional).
*
* @return int
*
* @since 1.1
*
* @throws \Alpha\Exception\AlphaException
*/
public function getCount($attributes = array(), $values = array());
/**
* Gets the count from the database for the amount of entries in the [tableName]_history table for this business object. Only call
* this method on classes where maintainHistory = true, otherwise an exception will be thrown.
*
* @return int
*
* @since 1.2
*
* @throws \Alpha\Exception\AlphaException
*/
public function getHistoryCount();
/**
* Populate all of the enum options for this object from the database.
*
* @since 1.1
*
* @throws \Alpha\Exception\AlphaException
* @return void
*/
public function setEnumOptions();
/**
* Checks to see if the table exists in the database for the current business class.
*
* @param bool $checkHistoryTable Set to true if you want to check for the existance of the _history table for this DAO.
*
* @return bool
*
* @since 1.1
*
* @throws \Alpha\Exception\AlphaException
*/
public function checkTableExists($checkHistoryTable = false);
/**
* Static method to check the database and see if the table for the indicated Record class name
* exists (assumes table name will be $RecordClassName less "Object").
*
* @param string $RecordClassName The name of the business object class we are checking.
* @param bool $checkHistoryTable Set to true if you want to check for the existance of the _history table for this DAO.
*
* @return bool
*
* @since 1.1
*
* @throws \Alpha\Exception\AlphaException
* @throws \Alpha\Exception\IllegalArguementException
*/
public static function checkRecordTableExists($RecordClassName, $checkHistoryTable = false);
/**
* Checks to see if the table in the database matches (for fields) the business class definition, i.e. if the
* database table is in sync with the class definition.
*
* @return bool
*
* @since 1.1
*
* @throws \Alpha\Exception\AlphaException
*/
public function checkTableNeedsUpdate();
/**
* Returns an array containing any properties on the class which have not been created on the database
* table yet.
*
* @return array An array of missing fields in the database table.
*
* @since 1.1
*
* @throws \Alpha\Exception\AlphaException
*/
public function findMissingFields();
/**
* Gets an array of all of the names of the active database indexes for this class.
*
* @return array An array of database indexes on this table.
*
* @since 1.1
*
* @throws \Alpha\Exception\AlphaException
*/
public function getIndexes();
/**
* Creates a foreign key constraint (index) in the database on the given attribute.
*
* @param string $attributeName The name of the attribute to apply the index on.
* @param string $relatedClass The fully-qualified name of the related class.
* @param string $relatedClassAttribute The name of the field to relate to on the related class.
* @param string $indexName The optional name for the index, will calculate if not provided.
*
* @since 1.1
*
* @throws \Alpha\Exception\FailedIndexCreateException
* @return void
*/
public function createForeignIndex($attributeName, $relatedClass, $relatedClassAttribute, $indexName = null);
/**
* Creates a unique index in the database on the given attribute(s).
*
* @param string $attribute1Name The first attribute to mark unique in the database.
* @param string $attribute2Name The second attribute to mark unique in the databse (optional, use only for composite keys).
* @param string $attribute3Name The third attribute to mark unique in the databse (optional, use only for composite keys).
*
* @since 1.1
*
* @throws \Alpha\Exception\FailedIndexCreateException
* @return void
*/
public function createUniqueIndex($attribute1Name, $attribute2Name = '', $attribute3Name = '');
/**
* Reloads the object from the database, overwritting any attribute values in memory.
*
* @since 1.1
*
* @throws \Alpha\Exception\AlphaException
* @return void
*/
public function reload();
/**
* Checks that a record exists for the Record in the database.
*
* @param int $ID The Object ID of the object we want to see whether it exists or not.
*
* @return bool
*
* @since 1.1
*
* @throws \Alpha\Exception\AlphaException
*/
public function checkRecordExists($ID);
/**
* Checks to see if the table name matches the classname, and if not if the table
* name matches the classname name of another record, i.e. the table is used to store
* multiple types of records.
*
* @return bool
*
* @since 1.1
*
* @throws \Alpha\Exception\BadTableNameException
*/
public function isTableOverloaded();
/**
* Starts a new database transaction.
*
* @since 1.1
*
* @throws \Alpha\Exception\AlphaException
* @return void
*/
public static function begin();
/**
* Commits the current database transaction.
*
* @since 1.1
*
* @throws \Alpha\Exception\FailedSaveException
* @return void
*/
public static function commit();
/**
* Aborts the current database transaction.
*
* @since 1.1
*
* @throws \Alpha\Exception\AlphaException
* @return void
*/
public static function rollback();
/**
* Provide the Record that we are going to map the data to from this provider.
*
* @param \Alpha\Model\ActiveRecord $Record
*
* @since 1.1
* @return void
*/
public function setRecord($Record);
/**
* Returns a 2d array, where each element in the array is another array
* representing a database row.
*
* @param string $sqlQuery
*
* @throws \Alpha\Exception\CustomQueryException
*
* @return array
*
* @since 1.1
*/
public function query($sqlQuery);
/**
* Check to see if the configured database exists.
*
* @return bool
*
* @since 2.0
*/
public static function checkDatabaseExists();
/**
* Creates the configured database.
*
* @throws \Alpha\Exception\AlphaException
*
* @since 2.0
* @return void
*/
public static function createDatabase();
/**
* Drops the configured database.
*
* @throws \Alpha\Exception\AlphaException
*
* @since 2.0
* @return void
*/
public static function dropDatabase();
}