UpdateObserver.php
115 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 | /** |
| 11 | * UpdateObservers can be used to inject logic into the component updating process. Derive |
| 12 | * from this base class and add an instance of the derived class to a Updater instance. When |
| 13 | * Updater::update() is called, the methods in the added UpdateListeners will be executed |
| 14 | * accordingly. |
| 15 | */ |
| 16 | abstract class UpdateObserver |
| 17 | { |
| 18 | /** |
| 19 | * Executed when a component is about to be updated. At this point, no SQL queries or other |
| 20 | * updating logic has been executed. |
| 21 | * |
| 22 | * @param string $name The name of the component being updated. |
| 23 | */ |
| 24 | public function onComponentUpdateStarting($name) |
| 25 | { |
| 26 | // empty |
| 27 | } |
| 28 | |
| 29 | /** |
| 30 | * Executed after a component has been successfully updated. |
| 31 | * |
| 32 | * @param string $name The name of the component being updated. |
| 33 | * @param string $version The version of the component that was updated. |
| 34 | * @param string[] $warnings Any warnings that occurred during the component update process. |
| 35 | */ |
| 36 | public function onComponentUpdateFinished($name, $version, $warnings) |
| 37 | { |
| 38 | // empty |
| 39 | } |
| 40 | |
| 41 | /** |
| 42 | * Executed before the update method of an Updates class is executed. |
| 43 | * |
| 44 | * @param string $componentName The name of the component being updated. |
| 45 | * @param string $file The path to the Updates file being executed. |
| 46 | * @param string $updateClassName The name of the Update class that should exist within the Update file. |
| 47 | * @param string $version The version the Updates file belongs to. |
| 48 | */ |
| 49 | public function onComponentUpdateFileStarting($componentName, $file, $updateClassName, $version) |
| 50 | { |
| 51 | // empty |
| 52 | } |
| 53 | |
| 54 | /** |
| 55 | * Executed after the update method of an Updates class is successfully executed. |
| 56 | * |
| 57 | * @param string $componentName The name of the component being updated. |
| 58 | * @param string $file The path to the Updates file being executed. |
| 59 | * @param string $updateClassName The name of the Update class that should exist within the Update file. |
| 60 | * @param string $version The version the Updates file belongs to. |
| 61 | */ |
| 62 | public function onComponentUpdateFileFinished($componentName, $file, $updateClassName, $version) |
| 63 | { |
| 64 | // empty |
| 65 | } |
| 66 | |
| 67 | /** |
| 68 | * Executed before a migration is executed. |
| 69 | * |
| 70 | * @param string $updateFile The path to the Updates file being executed. |
| 71 | * @param Migration $migration The migration that is about to be executed. |
| 72 | */ |
| 73 | public function onStartExecutingMigration($updateFile, Migration $migration) |
| 74 | { |
| 75 | // empty |
| 76 | } |
| 77 | |
| 78 | /** |
| 79 | * Executed after a migration is executed. |
| 80 | * |
| 81 | * @param string $updateFile The path to the Updates file being executed. |
| 82 | * @param Migration $migration The migration that is about to be executed. |
| 83 | */ |
| 84 | public function onFinishedExecutingMigration($updateFile, Migration $migration) |
| 85 | { |
| 86 | // empty |
| 87 | } |
| 88 | |
| 89 | /** |
| 90 | * Executed when a warning occurs during the update process. A warning occurs when an Updates file |
| 91 | * throws an exception that is not a UpdaterErrorException. |
| 92 | * |
| 93 | * @param string $componentName The name of the component being updated. |
| 94 | * @param string $version The version of the Updates file during which the warning occurred. |
| 95 | * @param \Exception $exception The exception that generated the warning. |
| 96 | */ |
| 97 | public function onWarning($componentName, $version, \Exception $exception) |
| 98 | { |
| 99 | // empty |
| 100 | } |
| 101 | |
| 102 | /** |
| 103 | * Executed when an error occurs during the update process. An error occurs when an Updates file |
| 104 | * throws a UpdaterErrorException. |
| 105 | * |
| 106 | * @param string $componentName The name of the component being updated. |
| 107 | * @param string $version The version of the Updates file during which the error occurred. |
| 108 | * @param \Exception $exception The exception that generated the error. |
| 109 | */ |
| 110 | public function onError($componentName, $version, \Exception $exception) |
| 111 | { |
| 112 | // empty |
| 113 | } |
| 114 | } |
| 115 |