phpBB API Documentation
Class

phpbb\db\migration\profilefield_base_migration

abstract class profilefield_base_migration extends container_aware_migration

Methods

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

Constructor

 from migration
static array depends_on()

Defines other migrations to be applied first

 from migration
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
array get_queries()

Get the list of queries run

 from migration
setContainer(ContainerInterface $container = null)

{@inheritdoc}

 from container_aware_migration
create_custom_field()

create_language_entries()

Create Custom profile fields languguage entries
delete_custom_profile_field_data()

Clean database when reverting the migration
get_custom_profile_field_id()

Get custom profile field id
convert_user_field_to_custom_field(int $start)

Details

in migration at line 59
public __construct(config $config, driver_interface $db, tools_interface $db_tools, string $phpbb_root_path, string $php_ext, string $table_prefix)

Constructor

Parameters

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

in migration at line 75
static public array depends_on()

Defines other migrations to be applied first

Return Value

array An array of migration class names

at line 43
public 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
public array update_schema()

Updates the database schema by providing a set of change instructions

Return Value

array Array of schema changes (compatible with dbtools->performschema_changes())

at line 59
public array revert_schema()

Reverts the database schema by providing a set of change instructions

Return Value

array Array of schema changes (compatible with dbtools->performschema_changes())

at line 70
public 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
public 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 162
public array get_queries()

Get the list of queries run

Return Value

array

in container_aware_migration at line 32
public setContainer(ContainerInterface $container = null)

{@inheritdoc}

Parameters

ContainerInterface $container

at line 85
public create_custom_field()

at line 125
public create_language_entries()

Create Custom profile fields languguage entries

at line 152
public delete_custom_profile_field_data()

Clean database when reverting the migration

at line 173
public get_custom_profile_field_id()

Get custom profile field id

at line 189
public convert_user_field_to_custom_field(int $start)

Parameters

int $start Start of staggering step