Migration.php
43 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Matomo - free/libre analytics platform |
| 4 | * |
| 5 | * @link https://matomo.org |
| 6 | * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later |
| 7 | */ |
| 8 | namespace Piwik\Updater; |
| 9 | |
| 10 | use Exception; |
| 11 | |
| 12 | /** |
| 13 | * Base class for migrations. Any migration must extend this class. |
| 14 | * |
| 15 | * @api |
| 16 | */ |
| 17 | abstract class Migration |
| 18 | { |
| 19 | /** |
| 20 | * Executes the migration. |
| 21 | * @return void |
| 22 | */ |
| 23 | abstract public function exec(); |
| 24 | |
| 25 | /** |
| 26 | * Get a description of what the migration actually does. For example "Activate plugin $plugin" or |
| 27 | * "SELECT * FROM table". |
| 28 | * |
| 29 | * @return string |
| 30 | */ |
| 31 | abstract public function __toString(); |
| 32 | |
| 33 | /** |
| 34 | * Decides whether an error should be ignored or not. |
| 35 | * @param Exception $exception |
| 36 | * @return bool |
| 37 | */ |
| 38 | public function shouldIgnoreError($exception) |
| 39 | { |
| 40 | return false; |
| 41 | } |
| 42 | } |
| 43 |