[ Index ]

PHP Cross Reference of phpBB-3.1.12-deutsch

title

Body

[close]

/phpbb/db/migration/ -> migration.php (summary)

This file is part of the phpBB Forum Software package.

Copyright: (c) phpBB Limited
License: GNU General Public License, version 2 (GPL-2.0)
File Size: 186 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 9 functions

  __construct()
  depends_on()
  effectively_installed()
  update_schema()
  revert_schema()
  update_data()
  revert_data()
  sql_query()
  get_queries()

Functions
Functions that are not part of a class:

__construct(\phpbb\config\config $config, \phpbb\db\driver\driver_interface $db, \phpbb\db\tools $db_tools, $phpbb_root_path, $php_ext, $table_prefix)   X-Ref
Constructor

param: \phpbb\config\config $config
param: \phpbb\db\driver\driver_interface $db
param: \phpbb\db\tools $db_tools
param: string $phpbb_root_path
param: string $php_ext
param: string $table_prefix

depends_on()   X-Ref
Defines other migrations to be applied first

return: array An array of migration class names

effectively_installed()   X-Ref
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: bool True if this migration is installed, False if this migration is not installed (checked on install)

update_schema()   X-Ref
Updates the database schema by providing a set of change instructions

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

revert_schema()   X-Ref
Reverts the database schema by providing a set of change instructions

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

update_data()   X-Ref
Updates data by returning a list of instructions to be executed

return: array Array of data update instructions

revert_data()   X-Ref
Reverts data by returning a list of instructions to be executed

return: array Array of data instructions that will be performed on revert

sql_query($sql)   X-Ref
Wrapper for running queries to generate user feedback on updates

param: string $sql SQL query to run on the database
return: mixed Query result from db->sql_query()

get_queries()   X-Ref
Get the list of queries run

return: array



Generated: Thu Jan 11 00:25:41 2018 Cross-referenced by PHPXref 0.7.1