gyro/modules/systemupdate/start.inc.php

Go to the documentation of this file.
00001 <?php
00002 /**
00003  * @defgroup SystemUpdate
00004  * @ingroup Modules
00005  * 
00006  * Executes updates and installs new modules.
00007  * 
00008  * @section Usage
00009  * 
00010  * Systemupdate executes PHP and SQL scripts in folders app/install and app/install/updates.
00011  * 
00012  * If a module is enabled the first time or an app is new, Ssystemupdate will look for files name
00013  * 
00014  * - app/install/install.sql and
00015  * - app/install/install.php
00016  * 
00017  * Later must provide a function called "[module name|app]_install", e.g. "app_install" or "coolmodule_install".
00018  * 
00019  * Later updates are read from folder app/install/updates. Update files can be either SQL or PHP files and must be named
00020  * 
00021  * [VERSION]_explaination.[EXTENSION]
00022  * 
00023  * Version must boil down to a positive integer, may contain leading zeros. Valid filenames would be:
00024  * 
00025  * - 0001_keys_added_to_post_table.sql
00026  * - 2_convert_content_row.php
00027  * 
00028  * PHP files must contain a function called "[module name|app]_update_[version]", where version is version of file, but
00029  * may not contain leading zeros.
00030  */