sminnee /
silverstripe-framework
| Total Complexity | 83 |
| Total Lines | 738 |
| Duplicated Lines | 0 % |
| Changes | 0 | ||
Complex classes like DB often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use DB, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 24 | class DB |
||
| 25 | { |
||
| 26 | |||
| 27 | /** |
||
| 28 | * This constant was added in SilverStripe 2.4 to indicate that SQL-queries |
||
| 29 | * should now use ANSI-compatible syntax. The most notable affect of this |
||
| 30 | * change is that table and field names should be escaped with double quotes |
||
| 31 | * and not backticks |
||
| 32 | */ |
||
| 33 | const USE_ANSI_SQL = true; |
||
| 34 | |||
| 35 | /** |
||
| 36 | * Session key for alternative database name |
||
| 37 | */ |
||
| 38 | const ALT_DB_KEY = 'alternativeDatabaseName'; |
||
| 39 | |||
| 40 | /** |
||
| 41 | * Allow alternative DB to be disabled. |
||
| 42 | * Necessary for DB backed session store to work. |
||
| 43 | * |
||
| 44 | * @config |
||
| 45 | * @var bool |
||
| 46 | */ |
||
| 47 | private static $alternative_database_enabled = true; |
||
|
introduced
by
|
|||
| 48 | |||
| 49 | /** |
||
| 50 | * The global database connection. |
||
| 51 | * |
||
| 52 | * @var Database |
||
| 53 | */ |
||
| 54 | protected static $connections = []; |
||
| 55 | |||
| 56 | /** |
||
| 57 | * List of configurations for each connection |
||
| 58 | * |
||
| 59 | * @var array List of configs each in the $databaseConfig format |
||
| 60 | */ |
||
| 61 | protected static $configs = []; |
||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | /** |
||
| 66 | * The last SQL query run. |
||
| 67 | * @var string |
||
| 68 | */ |
||
| 69 | public static $lastQuery; |
||
| 70 | |||
| 71 | /** |
||
| 72 | * Internal flag to keep track of when db connection was attempted. |
||
| 73 | */ |
||
| 74 | private static $connection_attempted = false; |
||
| 75 | |||
| 76 | /** |
||
| 77 | * Set the global database connection. |
||
| 78 | * Pass an object that's a subclass of SS_Database. This object will be used when {@link DB::query()} |
||
| 79 | * is called. |
||
| 80 | * |
||
| 81 | * @param Database $connection The connecton object to set as the connection. |
||
| 82 | * @param string $name The name to give to this connection. If you omit this argument, the connection |
||
| 83 | * will be the default one used by the ORM. However, you can store other named connections to |
||
| 84 | * be accessed through DB::get_conn($name). This is useful when you have an application that |
||
| 85 | * needs to connect to more than one database. |
||
| 86 | */ |
||
| 87 | public static function set_conn(Database $connection, $name = 'default') |
||
| 88 | { |
||
| 89 | self::$connections[$name] = $connection; |
||
| 90 | } |
||
| 91 | |||
| 92 | /** |
||
| 93 | * Get the global database connection. |
||
| 94 | * |
||
| 95 | * @param string $name An optional name given to a connection in the DB::setConn() call. If omitted, |
||
| 96 | * the default connection is returned. |
||
| 97 | * @return Database |
||
| 98 | */ |
||
| 99 | public static function get_conn($name = 'default') |
||
| 100 | { |
||
| 101 | if (isset(self::$connections[$name])) { |
||
| 102 | return self::$connections[$name]; |
||
| 103 | } |
||
| 104 | |||
| 105 | // lazy connect |
||
| 106 | $config = static::getConfig($name); |
||
| 107 | if ($config) { |
||
| 108 | return static::connect($config, $name); |
||
| 109 | } |
||
| 110 | |||
| 111 | return null; |
||
| 112 | } |
||
| 113 | |||
| 114 | /** |
||
| 115 | * @deprecated since version 4.0 Use DB::get_conn instead |
||
| 116 | * @todo PSR-2 standardisation will probably un-deprecate this |
||
| 117 | */ |
||
| 118 | public static function getConn($name = 'default') |
||
| 119 | { |
||
| 120 | Deprecation::notice('4.0', 'Use DB::get_conn instead'); |
||
| 121 | return self::get_conn($name); |
||
| 122 | } |
||
| 123 | |||
| 124 | /** |
||
| 125 | * Retrieves the schema manager for the current database |
||
| 126 | * |
||
| 127 | * @param string $name An optional name given to a connection in the DB::setConn() call. If omitted, |
||
| 128 | * the default connection is returned. |
||
| 129 | * @return DBSchemaManager |
||
| 130 | */ |
||
| 131 | public static function get_schema($name = 'default') |
||
| 132 | { |
||
| 133 | $connection = self::get_conn($name); |
||
| 134 | if ($connection) { |
||
| 135 | return $connection->getSchemaManager(); |
||
| 136 | } |
||
| 137 | return null; |
||
| 138 | } |
||
| 139 | |||
| 140 | /** |
||
| 141 | * Builds a sql query with the specified connection |
||
| 142 | * |
||
| 143 | * @param SQLExpression $expression The expression object to build from |
||
| 144 | * @param array $parameters Out parameter for the resulting query parameters |
||
| 145 | * @param string $name An optional name given to a connection in the DB::setConn() call. If omitted, |
||
| 146 | * the default connection is returned. |
||
| 147 | * @return string The resulting SQL as a string |
||
| 148 | */ |
||
| 149 | public static function build_sql(SQLExpression $expression, &$parameters, $name = 'default') |
||
| 150 | { |
||
| 151 | $connection = self::get_conn($name); |
||
| 152 | if ($connection) { |
||
| 153 | return $connection->getQueryBuilder()->buildSQL($expression, $parameters); |
||
| 154 | } else { |
||
| 155 | $parameters = array(); |
||
| 156 | return null; |
||
| 157 | } |
||
| 158 | } |
||
| 159 | |||
| 160 | /** |
||
| 161 | * Retrieves the connector object for the current database |
||
| 162 | * |
||
| 163 | * @param string $name An optional name given to a connection in the DB::setConn() call. If omitted, |
||
| 164 | * the default connection is returned. |
||
| 165 | * @return DBConnector |
||
| 166 | */ |
||
| 167 | public static function get_connector($name = 'default') |
||
| 168 | { |
||
| 169 | $connection = self::get_conn($name); |
||
| 170 | if ($connection) { |
||
| 171 | return $connection->getConnector(); |
||
| 172 | } |
||
| 173 | return null; |
||
| 174 | } |
||
| 175 | |||
| 176 | /** |
||
| 177 | * Set an alternative database in a browser cookie, |
||
| 178 | * with the cookie lifetime set to the browser session. |
||
| 179 | * This is useful for integration testing on temporary databases. |
||
| 180 | * |
||
| 181 | * There is a strict naming convention for temporary databases to avoid abuse: |
||
| 182 | * <prefix> (default: 'ss_') + tmpdb + <7 digits> |
||
| 183 | * As an additional security measure, temporary databases will |
||
| 184 | * be ignored in "live" mode. |
||
| 185 | * |
||
| 186 | * Note that the database will be set on the next request. |
||
| 187 | * Set it to null to revert to the main database. |
||
| 188 | * |
||
| 189 | * @param string $name |
||
| 190 | */ |
||
| 191 | public static function set_alternative_database_name($name = null) |
||
| 192 | { |
||
| 193 | // Ignore if disabled |
||
| 194 | if (!Config::inst()->get(static::class, 'alternative_database_enabled')) { |
||
| 195 | return; |
||
| 196 | } |
||
| 197 | // Skip if CLI |
||
| 198 | if (Director::is_cli()) { |
||
| 199 | return; |
||
| 200 | } |
||
| 201 | // Validate name |
||
| 202 | if ($name && !self::valid_alternative_database_name($name)) { |
||
| 203 | throw new InvalidArgumentException(sprintf( |
||
| 204 | 'Invalid alternative database name: "%s"', |
||
| 205 | $name |
||
| 206 | )); |
||
| 207 | } |
||
| 208 | |||
| 209 | // Set against session |
||
| 210 | if (!Injector::inst()->has(HTTPRequest::class)) { |
||
| 211 | return; |
||
| 212 | } |
||
| 213 | /** @var HTTPRequest $request */ |
||
| 214 | $request = Injector::inst()->get(HTTPRequest::class); |
||
| 215 | if ($name) { |
||
| 216 | $request->getSession()->set(self::ALT_DB_KEY, $name); |
||
| 217 | } else { |
||
| 218 | $request->getSession()->clear(self::ALT_DB_KEY); |
||
| 219 | } |
||
| 220 | } |
||
| 221 | |||
| 222 | /** |
||
| 223 | * Get the name of the database in use |
||
| 224 | * |
||
| 225 | * @return string|false Name of temp database, or false if not set |
||
| 226 | */ |
||
| 227 | public static function get_alternative_database_name() |
||
| 228 | { |
||
| 229 | // Ignore if disabled |
||
| 230 | if (!Config::inst()->get(static::class, 'alternative_database_enabled')) { |
||
| 231 | return false; |
||
| 232 | } |
||
| 233 | // Skip if CLI |
||
| 234 | if (Director::is_cli()) { |
||
| 235 | return false; |
||
| 236 | } |
||
| 237 | // Skip if there's no request object yet |
||
| 238 | if (!Injector::inst()->has(HTTPRequest::class)) { |
||
| 239 | return null; |
||
| 240 | } |
||
| 241 | /** @var HTTPRequest $request */ |
||
| 242 | $request = Injector::inst()->get(HTTPRequest::class); |
||
| 243 | // Skip if the session hasn't been started |
||
| 244 | if (!$request->getSession()->isStarted()) { |
||
| 245 | return null; |
||
| 246 | } |
||
| 247 | |||
| 248 | $name = $request->getSession()->get(self::ALT_DB_KEY); |
||
| 249 | if (self::valid_alternative_database_name($name)) { |
||
| 250 | return $name; |
||
| 251 | } |
||
| 252 | |||
| 253 | return false; |
||
| 254 | } |
||
| 255 | |||
| 256 | /** |
||
| 257 | * Determines if the name is valid, as a security |
||
| 258 | * measure against setting arbitrary databases. |
||
| 259 | * |
||
| 260 | * @param string $name |
||
| 261 | * @return bool |
||
| 262 | */ |
||
| 263 | public static function valid_alternative_database_name($name) |
||
| 264 | { |
||
| 265 | if (Director::isLive() || empty($name)) { |
||
| 266 | return false; |
||
| 267 | } |
||
| 268 | |||
| 269 | $prefix = Environment::getEnv('SS_DATABASE_PREFIX') ?: 'ss_'; |
||
| 270 | $pattern = strtolower(sprintf('/^%stmpdb\d{7}$/', $prefix)); |
||
| 271 | return (bool)preg_match($pattern, $name); |
||
| 272 | } |
||
| 273 | |||
| 274 | /** |
||
| 275 | * Specify connection to a database |
||
| 276 | * |
||
| 277 | * Given the database configuration, this method will create the correct |
||
| 278 | * subclass of {@link SS_Database}. |
||
| 279 | * |
||
| 280 | * @param array $databaseConfig A map of options. The 'type' is the name of the |
||
| 281 | * subclass of SS_Database to use. For the rest of the options, see the specific class. |
||
| 282 | * @param string $label identifier for the connection |
||
| 283 | * @return Database |
||
| 284 | */ |
||
| 285 | public static function connect($databaseConfig, $label = 'default') |
||
| 286 | { |
||
| 287 | // This is used by the "testsession" module to test up a test session using an alternative name |
||
| 288 | if ($name = self::get_alternative_database_name()) { |
||
| 289 | $databaseConfig['database'] = $name; |
||
| 290 | } |
||
| 291 | |||
| 292 | if (!isset($databaseConfig['type']) || empty($databaseConfig['type'])) { |
||
| 293 | throw new InvalidArgumentException("DB::connect: Not passed a valid database config"); |
||
| 294 | } |
||
| 295 | |||
| 296 | self::$connection_attempted = true; |
||
| 297 | |||
| 298 | $dbClass = $databaseConfig['type']; |
||
| 299 | |||
| 300 | // Using Injector->create allows us to use registered configurations |
||
| 301 | // which may or may not map to explicit objects |
||
| 302 | $conn = Injector::inst()->create($dbClass); |
||
| 303 | self::set_conn($conn, $label); |
||
| 304 | $conn->connect($databaseConfig); |
||
| 305 | |||
| 306 | return $conn; |
||
| 307 | } |
||
| 308 | |||
| 309 | /** |
||
| 310 | * Set config for a lazy-connected database |
||
| 311 | * |
||
| 312 | * @param array $databaseConfig |
||
| 313 | * @param string $name |
||
| 314 | */ |
||
| 315 | public static function setConfig($databaseConfig, $name = 'default') |
||
| 316 | { |
||
| 317 | static::$configs[$name] = $databaseConfig; |
||
| 318 | } |
||
| 319 | |||
| 320 | /** |
||
| 321 | * Get the named connection config |
||
| 322 | * |
||
| 323 | * @param string $name |
||
| 324 | * @return mixed |
||
| 325 | */ |
||
| 326 | public static function getConfig($name = 'default') |
||
| 330 | } |
||
| 331 | } |
||
| 332 | |||
| 333 | /** |
||
| 334 | * Returns true if a database connection has been attempted. |
||
| 335 | * In particular, it lets the caller know if we're still so early in the execution pipeline that |
||
| 336 | * we haven't even tried to connect to the database yet. |
||
| 337 | */ |
||
| 338 | public static function connection_attempted() |
||
| 341 | } |
||
| 342 | |||
| 343 | /** |
||
| 344 | * Execute the given SQL query. |
||
| 345 | * @param string $sql The SQL query to execute |
||
| 346 | * @param int $errorLevel The level of error reporting to enable for the query |
||
| 347 | * @return Query |
||
| 348 | */ |
||
| 349 | public static function query($sql, $errorLevel = E_USER_ERROR) |
||
| 350 | { |
||
| 351 | self::$lastQuery = $sql; |
||
| 352 | |||
| 353 | return self::get_conn()->query($sql, $errorLevel); |
||
| 354 | } |
||
| 355 | |||
| 356 | /** |
||
| 357 | * Helper function for generating a list of parameter placeholders for the |
||
| 358 | * given argument(s) |
||
| 359 | * |
||
| 360 | * @param array|integer $input An array of items needing placeholders, or a |
||
| 361 | * number to specify the number of placeholders |
||
| 362 | * @param string $join The string to join each placeholder together with |
||
| 363 | * @return string|null Either a list of placeholders, or null |
||
| 364 | */ |
||
| 365 | public static function placeholders($input, $join = ', ') |
||
| 378 | } |
||
| 379 | |||
| 380 | /** |
||
| 381 | * @param string $sql The parameterised query |
||
| 382 | * @param array $parameters The parameters to inject into the query |
||
| 383 | * |
||
| 384 | * @return string |
||
| 385 | */ |
||
| 386 | public static function inline_parameters($sql, $parameters) |
||
| 431 | } |
||
| 432 | |||
| 433 | /** |
||
| 434 | * Replace a single parameter with the given value. |
||
| 435 | * For example, you can use this to replace a parameter with a column name instead of a literal |
||
| 436 | * @param string $sql Parameterised query |
||
| 437 | * @param int $paramIdx Zero-based position of the parameter |
||
| 438 | * @param mixed $replacement Value to insert into the query |
||
| 439 | * @param bool $skipEscaping Set to true to insert the value as-is, with no escaping. Use with caution! |
||
| 440 | * |
||
| 441 | * @return string |
||
| 442 | */ |
||
| 443 | public static function replace_parameter($sql, $paramIdx, $replacement, $skipEscaping = false) |
||
| 444 | { |
||
| 445 | $segments = preg_split('/\?/', $sql); |
||
| 446 | $joined = ''; |
||
| 447 | $inString = false; |
||
| 448 | $numSegments = count($segments); |
||
| 449 | $currentParamIdx = 0; |
||
| 450 | |||
| 451 | for ($i = 0; $i < $numSegments; $i++) { |
||
| 452 | $input = $segments[$i]; |
||
| 453 | // Append next segment |
||
| 454 | $joined .= $segments[$i]; |
||
| 455 | // Don't add placeholder after last segment |
||
| 456 | if ($i === $numSegments - 1) { |
||
| 457 | break; |
||
| 458 | } |
||
| 459 | // check string escape on previous fragment |
||
| 460 | // Remove escaped backslashes, count them! |
||
| 461 | $input = preg_replace('/\\\\\\\\/', '', $input); |
||
| 462 | // Count quotes |
||
| 463 | $totalQuotes = substr_count($input, "'"); // Includes double quote escaped quotes |
||
| 464 | $escapedQuotes = substr_count($input, "\\'"); |
||
| 465 | if ((($totalQuotes - $escapedQuotes) % 2) !== 0) { |
||
| 466 | $inString = !$inString; |
||
| 467 | } |
||
| 468 | |||
| 469 | // Append placeholder replacement |
||
| 470 | if ($inString) { |
||
| 471 | // Literal question mark |
||
| 472 | $joined .= '?'; |
||
| 473 | continue; |
||
| 474 | } |
||
| 475 | |||
| 476 | // If we've found the right parameter, replace it |
||
| 477 | if ($currentParamIdx == $paramIdx) { |
||
| 478 | if ($skipEscaping) { |
||
| 479 | $value = $replacement; |
||
| 480 | } elseif (is_bool($replacement)) { |
||
| 481 | $value = $replacement ? '1' : '0'; |
||
| 482 | } elseif (is_int($replacement)) { |
||
| 483 | $value = $replacement; |
||
| 484 | } else { |
||
| 485 | $value = (DB::get_conn() !== null) ? Convert::raw2sql($replacement, true) : $replacement; |
||
| 486 | } |
||
| 487 | $joined .= $value; |
||
| 488 | } elseif ($i < $numSegments -1) { |
||
| 489 | $joined .= '?'; |
||
| 490 | } |
||
| 491 | |||
| 492 | $currentParamIdx++; |
||
| 493 | } |
||
| 494 | return $joined; |
||
| 495 | } |
||
| 496 | |||
| 497 | /** |
||
| 498 | * Execute the given SQL parameterised query with the specified arguments |
||
| 499 | * |
||
| 500 | * @param string $sql The SQL query to execute. The ? character will denote parameters. |
||
| 501 | * @param array $parameters An ordered list of arguments. |
||
| 502 | * @param int $errorLevel The level of error reporting to enable for the query |
||
| 503 | * @return Query |
||
| 504 | */ |
||
| 505 | public static function prepared_query($sql, $parameters, $errorLevel = E_USER_ERROR) |
||
| 506 | { |
||
| 507 | self::$lastQuery = $sql; |
||
| 508 | |||
| 509 | return self::get_conn()->preparedQuery($sql, $parameters, $errorLevel); |
||
| 510 | } |
||
| 511 | |||
| 512 | /** |
||
| 513 | * Execute a complex manipulation on the database. |
||
| 514 | * A manipulation is an array of insert / or update sequences. The keys of the array are table names, |
||
| 515 | * and the values are map containing 'command' and 'fields'. Command should be 'insert' or 'update', |
||
| 516 | * and fields should be a map of field names to field values, including quotes. The field value can |
||
| 517 | * also be a SQL function or similar. |
||
| 518 | * |
||
| 519 | * Example: |
||
| 520 | * <code> |
||
| 521 | * array( |
||
| 522 | * // Command: insert |
||
| 523 | * "table name" => array( |
||
| 524 | * "command" => "insert", |
||
| 525 | * "fields" => array( |
||
| 526 | * "ClassName" => "'MyClass'", // if you're setting a literal, you need to escape and provide quotes |
||
| 527 | * "Created" => "now()", // alternatively, you can call DB functions |
||
| 528 | * "ID" => 234, |
||
| 529 | * ), |
||
| 530 | * "id" => 234 // an alternative to providing ID in the fields list |
||
| 531 | * ), |
||
| 532 | * |
||
| 533 | * // Command: update |
||
| 534 | * "other table" => array( |
||
| 535 | * "command" => "update", |
||
| 536 | * "fields" => array( |
||
| 537 | * "ClassName" => "'MyClass'", |
||
| 538 | * "LastEdited" => "now()", |
||
| 539 | * ), |
||
| 540 | * "where" => "ID = 234", |
||
| 541 | * "id" => 234 // an alternative to providing a where clause |
||
| 542 | * ), |
||
| 543 | * ) |
||
| 544 | * </code> |
||
| 545 | * |
||
| 546 | * You'll note that only one command on a given table can be called. |
||
| 547 | * That's a limitation of the system that's due to it being written for {@link DataObject::write()}, |
||
| 548 | * which needs to do a single write on a number of different tables. |
||
| 549 | * |
||
| 550 | * @todo Update this to support paramaterised queries |
||
| 551 | * |
||
| 552 | * @param array $manipulation |
||
| 553 | */ |
||
| 554 | public static function manipulate($manipulation) |
||
| 555 | { |
||
| 556 | self::$lastQuery = $manipulation; |
||
| 557 | self::get_conn()->manipulate($manipulation); |
||
| 558 | } |
||
| 559 | |||
| 560 | /** |
||
| 561 | * Get the autogenerated ID from the previous INSERT query. |
||
| 562 | * |
||
| 563 | * @param string $table |
||
| 564 | * @return int |
||
| 565 | */ |
||
| 566 | public static function get_generated_id($table) |
||
| 567 | { |
||
| 568 | return self::get_conn()->getGeneratedID($table); |
||
| 569 | } |
||
| 570 | |||
| 571 | /** |
||
| 572 | * Check if the connection to the database is active. |
||
| 573 | * |
||
| 574 | * @return boolean |
||
| 575 | */ |
||
| 576 | public static function is_active() |
||
| 579 | } |
||
| 580 | |||
| 581 | /** |
||
| 582 | * Create the database and connect to it. This can be called if the |
||
| 583 | * initial database connection is not successful because the database |
||
| 584 | * does not exist. |
||
| 585 | * |
||
| 586 | * @param string $database Name of database to create |
||
| 587 | * @return boolean Returns true if successful |
||
| 588 | */ |
||
| 589 | public static function create_database($database) |
||
| 590 | { |
||
| 591 | return self::get_conn()->selectDatabase($database, true); |
||
| 592 | } |
||
| 593 | |||
| 594 | /** |
||
| 595 | * Create a new table. |
||
| 596 | * @param string $table The name of the table |
||
| 597 | * @param array$fields A map of field names to field types |
||
| 598 | * @param array $indexes A map of indexes |
||
| 599 | * @param array $options An map of additional options. The available keys are as follows: |
||
| 600 | * - 'MSSQLDatabase'/'MySQLDatabase'/'PostgreSQLDatabase' - database-specific options such as "engine" |
||
| 601 | * for MySQL. |
||
| 602 | * - 'temporary' - If true, then a temporary table will be created |
||
| 603 | * @param array $advancedOptions Advanced creation options |
||
| 604 | * @return string The table name generated. This may be different from the table name, for example with |
||
| 605 | * temporary tables. |
||
| 606 | */ |
||
| 607 | public static function create_table( |
||
| 608 | $table, |
||
| 609 | $fields = null, |
||
| 610 | $indexes = null, |
||
| 611 | $options = null, |
||
| 612 | $advancedOptions = null |
||
| 613 | ) { |
||
| 614 | return self::get_schema()->createTable($table, $fields, $indexes, $options, $advancedOptions); |
||
| 615 | } |
||
| 616 | |||
| 617 | /** |
||
| 618 | * Create a new field on a table. |
||
| 619 | * @param string $table Name of the table. |
||
| 620 | * @param string $field Name of the field to add. |
||
| 621 | * @param string $spec The field specification, eg 'INTEGER NOT NULL' |
||
| 622 | */ |
||
| 623 | public static function create_field($table, $field, $spec) |
||
| 624 | { |
||
| 625 | return self::get_schema()->createField($table, $field, $spec); |
||
| 626 | } |
||
| 627 | |||
| 628 | /** |
||
| 629 | * Generate the following table in the database, modifying whatever already exists |
||
| 630 | * as necessary. |
||
| 631 | * |
||
| 632 | * @param string $table The name of the table |
||
| 633 | * @param string $fieldSchema A list of the fields to create, in the same form as DataObject::$db |
||
| 634 | * @param string $indexSchema A list of indexes to create. The keys of the array are the names of the index. |
||
| 635 | * The values of the array can be one of: |
||
| 636 | * - true: Create a single column index on the field named the same as the index. |
||
| 637 | * - array('fields' => array('A','B','C'), 'type' => 'index/unique/fulltext'): This gives you full |
||
| 638 | * control over the index. |
||
| 639 | * @param boolean $hasAutoIncPK A flag indicating that the primary key on this table is an autoincrement type |
||
| 640 | * @param string $options SQL statement to append to the CREATE TABLE call. |
||
| 641 | * @param array $extensions List of extensions |
||
| 642 | */ |
||
| 643 | public static function require_table( |
||
| 644 | $table, |
||
| 645 | $fieldSchema = null, |
||
| 646 | $indexSchema = null, |
||
| 647 | $hasAutoIncPK = true, |
||
| 648 | $options = null, |
||
| 649 | $extensions = null |
||
| 650 | ) { |
||
| 651 | self::get_schema()->requireTable($table, $fieldSchema, $indexSchema, $hasAutoIncPK, $options, $extensions); |
||
| 652 | } |
||
| 653 | |||
| 654 | /** |
||
| 655 | * Generate the given field on the table, modifying whatever already exists as necessary. |
||
| 656 | * |
||
| 657 | * @param string $table The table name. |
||
| 658 | * @param string $field The field name. |
||
| 659 | * @param string $spec The field specification. |
||
| 660 | */ |
||
| 661 | public static function require_field($table, $field, $spec) |
||
| 662 | { |
||
| 663 | self::get_schema()->requireField($table, $field, $spec); |
||
| 664 | } |
||
| 665 | |||
| 666 | /** |
||
| 667 | * Generate the given index in the database, modifying whatever already exists as necessary. |
||
| 668 | * |
||
| 669 | * @param string $table The table name. |
||
| 670 | * @param string $index The index name. |
||
| 671 | * @param string|boolean $spec The specification of the index. See requireTable() for more information. |
||
| 672 | */ |
||
| 673 | public static function require_index($table, $index, $spec) |
||
| 674 | { |
||
| 675 | self::get_schema()->requireIndex($table, $index, $spec); |
||
| 676 | } |
||
| 677 | |||
| 678 | /** |
||
| 679 | * If the given table exists, move it out of the way by renaming it to _obsolete_(tablename). |
||
| 680 | * |
||
| 681 | * @param string $table The table name. |
||
| 682 | */ |
||
| 683 | public static function dont_require_table($table) |
||
| 684 | { |
||
| 685 | self::get_schema()->dontRequireTable($table); |
||
| 686 | } |
||
| 687 | |||
| 688 | /** |
||
| 689 | * See {@link SS_Database->dontRequireField()}. |
||
| 690 | * |
||
| 691 | * @param string $table The table name. |
||
| 692 | * @param string $fieldName The field name not to require |
||
| 693 | */ |
||
| 694 | public static function dont_require_field($table, $fieldName) |
||
| 695 | { |
||
| 696 | self::get_schema()->dontRequireField($table, $fieldName); |
||
| 697 | } |
||
| 698 | |||
| 699 | /** |
||
| 700 | * Checks a table's integrity and repairs it if necessary. |
||
| 701 | * |
||
| 702 | * @param string $table The name of the table. |
||
| 703 | * @return boolean Return true if the table has integrity after the method is complete. |
||
| 704 | */ |
||
| 705 | public static function check_and_repair_table($table) |
||
| 706 | { |
||
| 707 | return self::get_schema()->checkAndRepairTable($table); |
||
| 708 | } |
||
| 709 | |||
| 710 | /** |
||
| 711 | * Return the number of rows affected by the previous operation. |
||
| 712 | * |
||
| 713 | * @return integer The number of affected rows |
||
| 714 | */ |
||
| 715 | public static function affected_rows() |
||
| 716 | { |
||
| 717 | return self::get_conn()->affectedRows(); |
||
| 718 | } |
||
| 719 | |||
| 720 | /** |
||
| 721 | * Returns a list of all tables in the database. |
||
| 722 | * The table names will be in lower case. |
||
| 723 | * |
||
| 724 | * @return array The list of tables |
||
| 725 | */ |
||
| 726 | public static function table_list() |
||
| 727 | { |
||
| 728 | return self::get_schema()->tableList(); |
||
| 729 | } |
||
| 730 | |||
| 731 | /** |
||
| 732 | * Get a list of all the fields for the given table. |
||
| 733 | * Returns a map of field name => field spec. |
||
| 734 | * |
||
| 735 | * @param string $table The table name. |
||
| 736 | * @return array The list of fields |
||
| 737 | */ |
||
| 738 | public static function field_list($table) |
||
| 739 | { |
||
| 740 | return self::get_schema()->fieldList($table); |
||
| 741 | } |
||
| 742 | |||
| 743 | /** |
||
| 744 | * Enable supression of database messages. |
||
| 745 | * |
||
| 746 | * @param bool $quiet |
||
| 747 | */ |
||
| 748 | public static function quiet($quiet = true) |
||
| 751 | } |
||
| 752 | |||
| 753 | /** |
||
| 754 | * Show a message about database alteration |
||
| 755 | * |
||
| 756 | * @param string $message to display |
||
| 757 | * @param string $type one of [created|changed|repaired|obsolete|deleted|error] |
||
| 758 | */ |
||
| 759 | public static function alteration_message($message, $type = "") |
||
| 762 | } |
||
| 763 | } |
||
| 764 |
Loading history...
