easy-invoice / includes / Migration / Src / MigrationInterface.php

MigrationInterface.php in Easy Invoice – Invoice Generator, PDF Quotes & Payments 2.3.7, at includes/Migration/Src/MigrationInterface.php

53 lines 922 B

Raw Download Zip

1	<?php
2	/**
3	* Migration Interface for Easy Invoice
4	*
5	* @package EasyInvoice
6	* @subpackage Migration
7	* @since 2.0.0
8	*/
9
10	namespace EasyInvoice\Migration\Src;
11
12	/**
13	* Migration interface.
14	*
15	* All migration classes must implement this interface.
16	*
17	* @since 2.0.0
18	*/
19	interface MigrationInterface {
20
21	/**
22	* Run the migration.
23	*
24	* @since 2.0.0
25	* @return array Migration result with 'success' and 'message' keys.
26	*/
27	public function migrate(): array;
28
29	/**
30	* Check if migration is needed.
31	*
32	* @since 2.0.0
33	* @return bool
34	*/
35	public function is_needed(): bool;
36
37	/**
38	* Get migration description.
39	*
40	* @since 2.0.0
41	* @return string
42	*/
43	public function get_description(): string;
44
45	/**
46	* Get migration version.
47	*
48	* @since 2.0.0
49	* @return string
50	*/
51	public function get_version(): string;
52	}
53