tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

DOC Document correct method signature for DB::require_table

Browse Source
This commit is contained in:
Maxime Rainville 2024-10-14 17:52:16 +13:00 committed by Maxime Rainville
parent ebbd6427b2
commit 9b8169ff6c
No known key found for this signature in database
2 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/ORM/Connect/DBSchemaManager.php
View File

@ -358,6 +358,7 @@ abstract class DBSchemaManager
* @param boolean $hasAutoIncPK A flag indicating that the primary key on this table is an autoincrement type * @param boolean $hasAutoIncPK A flag indicating that the primary key on this table is an autoincrement type
* @param array $options Create table options (ENGINE, etc.) * @param array $options Create table options (ENGINE, etc.)
* @param array|bool $extensions List of extensions * @param array|bool $extensions List of extensions
* @return void
*/ */
public function requireTable( public function requireTable(
$table, $table,

11
src/ORM/DB.php
View File

@ -550,15 +550,16 @@ class DB
* as necessary. * as necessary.
* *
* @param string $table The name of the table * @param string $table The name of the table
* @param string $fieldSchema A list of the fields to create, in the same form as DataObject::$db * @param array $fieldSchema|null A list of the fields to create, in the same form as DataObject::$db
* @param string $indexSchema A list of indexes to create. The keys of the array are the names of the index. * @param array $indexSchema|null A list of indexes to create. See {@link require_index()}
* The values of the array can be one of: * The values of the array can be one of:
* - true: Create a single column index on the field named the same as the index. * - true: Create a single column index on the field named the same as the index.
* - array('fields' => array('A','B','C'), 'type' => 'index/unique/fulltext'): This gives you full * - ['fields' => ['A','B','C'], 'type' => 'index/unique/fulltext']: This gives you full
* control over the index. * control over the index.
* @param boolean $hasAutoIncPK A flag indicating that the primary key on this table is an autoincrement type * @param boolean $hasAutoIncPK A flag indicating that the primary key on this table is an autoincrement type
* @param string $options SQL statement to append to the CREATE TABLE call. * @param array|null $options Create table options (ENGINE, etc.)
* @param array $extensions List of extensions * @param array|bool|null $extensions List of extensions
* @return void
*/ */
public static function require_table( public static function require_table(
$table, $table,