core/Updater/Migration.php


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

<?php
/**
 * Piwik - free/libre analytics platform
 *
 * @link https://matomo.org
 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 */
namespace Piwik\Updater;

use Piwik\Db;
use Exception;

/**
 * Base class for migrations. Any migration must extend this class.
 *
 * @api
 */
abstract class Migration
{
    /**
     * Executes the migration.
     * @return void
     */
    abstract public function exec();

    /**
     * Get a description of what the migration actually does. For example "Activate plugin $plugin" or
     * "SELECT * FROM table".
     *
     * @return string
     */
    abstract public function __toString();

    /**
     * Decides whether an error should be ignored or not.
     * @param Exception $exception
     * @return bool
     */
    public function shouldIgnoreError($exception)
    {
        return false;
    }
}