[ Index ]

PHP Cross Reference of phpBB-3.3.14-deutsch

title

Body

[close]

/phpbb/db/migration/ -> migration_interface.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: 70 lines (2 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

migration_interface:: (6 methods):
  depends_on()
  effectively_installed()
  update_schema()
  revert_schema()
  update_data()
  revert_data()


Interface: migration_interface  - X-Ref

Base class interface for database migrations

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



Generated: Mon Nov 25 19:05:08 2024 Cross-referenced by PHPXref 0.7.1