diff options
Diffstat (limited to 'phpBB/phpbb/db/migration/migration.php')
| -rw-r--r-- | phpBB/phpbb/db/migration/migration.php | 40 | 
1 files changed, 10 insertions, 30 deletions
| diff --git a/phpBB/phpbb/db/migration/migration.php b/phpBB/phpbb/db/migration/migration.php index 5f120333e1..4e218344f4 100644 --- a/phpBB/phpbb/db/migration/migration.php +++ b/phpBB/phpbb/db/migration/migration.php @@ -20,7 +20,7 @@ namespace phpbb\db\migration;  * in a subclass. This class provides various utility methods to simplify editing  * a phpBB.  */ -abstract class migration +abstract class migration implements migration_interface  {  	/** @var \phpbb\config\config */  	protected $config; @@ -28,7 +28,7 @@ abstract class migration  	/** @var \phpbb\db\driver\driver_interface */  	protected $db; -	/** @var \phpbb\db\tools */ +	/** @var \phpbb\db\tools\tools_interface */  	protected $db_tools;  	/** @var string */ @@ -51,12 +51,12 @@ abstract class migration  	*  	* @param \phpbb\config\config $config  	* @param \phpbb\db\driver\driver_interface $db -	* @param \phpbb\db\tools $db_tools +	* @param \phpbb\db\tools\tools_interface $db_tools  	* @param string $phpbb_root_path  	* @param string $php_ext  	* @param string $table_prefix  	*/ -	public function __construct(\phpbb\config\config $config, \phpbb\db\driver\driver_interface $db, \phpbb\db\tools $db_tools, $phpbb_root_path, $php_ext, $table_prefix) +	public function __construct(\phpbb\config\config $config, \phpbb\db\driver\driver_interface $db, \phpbb\db\tools\tools_interface $db_tools, $phpbb_root_path, $php_ext, $table_prefix)  	{  		$this->config = $config;  		$this->db = $db; @@ -70,9 +70,7 @@ abstract class migration  	}  	/** -	* Defines other migrations to be applied first -	* -	* @return array An array of migration class names +	* {@inheritdoc}  	*/  	static public function depends_on()  	{ @@ -80,14 +78,7 @@ abstract class migration  	}  	/** -	* 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) +	* {@inheritdoc}  	*/  	public function effectively_installed()  	{ @@ -95,9 +86,7 @@ abstract class migration  	}  	/** -	* Updates the database schema by providing a set of change instructions -	* -	* @return array Array of schema changes (compatible with db_tools->perform_schema_changes()) +	* {@inheritdoc}  	*/  	public function update_schema()  	{ @@ -105,9 +94,7 @@ abstract class migration  	}  	/** -	* Reverts the database schema by providing a set of change instructions -	* -	* @return array Array of schema changes (compatible with db_tools->perform_schema_changes()) +	* {@inheritdoc}  	*/  	public function revert_schema()  	{ @@ -115,9 +102,7 @@ abstract class migration  	}  	/** -	* Updates data by returning a list of instructions to be executed -	* -	* @return array Array of data update instructions +	* {@inheritdoc}  	*/  	public function update_data()  	{ @@ -125,12 +110,7 @@ abstract class migration  	}  	/** -	* Reverts data by returning a list of instructions to be executed -	* -	* @return 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) +	* {@inheritdoc}  	*/  	public function revert_data()  	{ | 
