Function DatabaseDriver->add_table_field__sql
Definitions
sources/database.php
- Get SQL for adding a field to an existing table.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: string
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $table_name | ID_TEXT | No | No | required parameter | N/A | N/A | The table name |
| $name | ID_TEXT | No | No | required parameter | N/A | N/A | The field name |
| $type | ID_TEXT | No | No | required parameter | N/A | N/A | The field type |
| $default | ?mixed | No | No | required parameter | N/A | N/A | The default value; for a translatable field should still be a string value (null: null default) |
Returns
- SQL query to run
- Type: string
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Get SQL for adding a field to an existing table.
*
* @param ID_TEXT $table_name The table name
* @param ID_TEXT $name The field name
* @param ID_TEXT $type The field type
* @param ?mixed $default The default value; for a translatable field should still be a string value (null: null default)
* @return string SQL query to run
*/
public function add_table_field__sql(string $table_name, string $name, string $type, $default) : string
* Get SQL for adding a field to an existing table.
*
* @param ID_TEXT $table_name The table name
* @param ID_TEXT $name The field name
* @param ID_TEXT $type The field type
* @param ?mixed $default The default value; for a translatable field should still be a string value (null: null default)
* @return string SQL query to run
*/
public function add_table_field__sql(string $table_name, string $name, string $type, $default) : string