openrat-cms

Unnamed repository; edit this file 'description' to name the repository.
Log | Files | Refs | README

README.md (436B)

      1 # Updating
      2 
      3 This module is intended to upgrade a database schema.
      4 
      5 ## Usage
      6 
      7 
      8 The `isUpdateRequired()` method finds out the version of the actual db schema. If it is lower than the last known version, `true` is returned.
      9 
     10 The `update()` applys all necessary changes from the subdirectory `version` to the database. 
     11 
     12 ## Example
     13 
     14 ```
     15 $updater = new Update( $database );
     16 
     17 if   ( $updater->isUpdateRequired() )
     18     $updater->update();
     19 ```