abstract class profilefield_base_migration extends container_aware_migration

Properties

protected config $config from  migration
protected driver_interface $db from  migration
protected tools_interface $db_tools from  migration
protected string $table_prefix from  migration
protected array $tables from  migration
protected string $phpbb_root_path from  migration
protected string $php_ext from  migration
protected array $errors from  migration
protected array $queries from  migration
protected ContainerInterface $container from  container_aware_migration
protected $profilefield_name
protected $profilefield_database_type
protected $profilefield_data
protected $profilefield_language_data

Language data should be in array -> each language_data in separate key array( array( 'option_id' => value, 'field_type' => value, 'lang_value' => value, ), array( 'option_id' => value, 'field_type' => value, 'lang_value' => value, ), )

protected $user_column_name

Methods

__construct(config $config, driver_interface $db, tools_interface $db_tools, string $phpbb_root_path, string $php_ext, string $table_prefix, array $tables)

Constructor

static array
depends_on()

Defines other migrations to be applied first

bool
effectively_installed()

Allows you to check if the migration is effectively installed (entirely optional)

array
update_schema()

Updates the database schema by providing a set of change instructions

array
revert_schema()

Reverts the database schema by providing a set of change instructions

array
update_data()

Updates data by returning a list of instructions to be executed

array
revert_data()

Reverts data by returning a list of instructions to be executed

mixed
sql_query(string $sql)

Wrapper for running queries to generate user feedback on updates

array
get_queries()

Get the list of queries run

setContainer(ContainerInterface $container = null)

{@inheritdoc}

create_custom_field()

No description

create_language_entries()

Create Custom profile fields languguage entries

delete_custom_profile_field_data()

Clean database when reverting the migration

int
get_custom_profile_field_id()

Get custom profile field id

mixed
convert_user_field_to_custom_field(int $start)

No description

get_insert_sql_array()

No description

Details

in migration at line 63
__construct(config $config, driver_interface $db, tools_interface $db_tools, string $phpbb_root_path, string $php_ext, string $table_prefix, array $tables)

Constructor

Parameters

config $config
driver_interface $db
tools_interface $db_tools
string $phpbb_root_path
string $php_ext
string $table_prefix
array $tables

in migration at line 80
static array depends_on()

Defines other migrations to be applied first

Return Value

array

An array of migration class names

at line 43
bool effectively_installed()

Allows you to check if the migration is effectively installed (entirely optional)

This is checked when a migration is installed. If true is returned, the migration will be set as installed without performing the database changes. This function is intended to help moving to migrations from a previous database updater, where some migrations may have been installed already even though they are not yet listed in the migrations table.

Return Value

bool

True if this migration is installed, False if this migration is not installed (checked on install)

at line 48
array update_schema()

Updates the database schema by providing a set of change instructions

Return Value

array

Array of schema changes (compatible with db_tools->perform_schema_changes())

at line 59
array revert_schema()

Reverts the database schema by providing a set of change instructions

Return Value

array

Array of schema changes (compatible with db_tools->perform_schema_changes())

at line 70
array update_data()

Updates data by returning a list of instructions to be executed

Return Value

array

Array of data update instructions

at line 78
array revert_data()

Reverts data by returning a list of instructions to be executed

Return Value

array

Array of data instructions that will be performed on revert NOTE: calls to tools (such as config.add) are automatically reverted when possible, so you should not attempt to revert those, this is mostly for otherwise unrevertable calls (custom functions for example)

in migration at line 131
protected mixed sql_query(string $sql)

Wrapper for running queries to generate user feedback on updates

Parameters

string $sql

SQL query to run on the database

Return Value

mixed

Query result from db->sql_query()

in migration at line 167
array get_queries()

Get the list of queries run

Return Value

array

setContainer(ContainerInterface $container = null)

{@inheritdoc}

Parameters

ContainerInterface $container

at line 85
create_custom_field()

No description

at line 125
create_language_entries()

Create Custom profile fields languguage entries

at line 152
delete_custom_profile_field_data()

Clean database when reverting the migration

at line 173
int get_custom_profile_field_id()

Get custom profile field id

Return Value

int

custom profile filed id

at line 189
mixed convert_user_field_to_custom_field(int $start)

No description

Parameters

int $start

Start of staggering step

Return Value

mixed

int start of the next step, null if the end was reached

at line 235
protected get_insert_sql_array()

No description