Added file for FA framework changes documentation.

diff --git a/doc/api_changes.txt b/doc/api_changes.txt
new file mode 100644 (file)
index 0000000..6af93f4
--- /dev/null
+++ b/doc/api_changes.txt
@@ -0,0 +1,63 @@
+Changes in framework API introduced in FrontAccounting 2.4
+----------------------------------------------------------
+The list does not contain changes made in user interface files.
+
+Changed functions:
+ company_db_inc: 
+       update_company_prefs($params)
+       get_company_pref($prefs = null)
+       get_company_prefs()
+ maintenance_db.inc:
+       db_backup($conn, $ext='no', $comm='', $path=null)
+       db_export($conn, $filename, $zip='no', $comment='', $no_default=false)
+       save_to_file($path, $zip, $fileData)
+
+
+Before 2.4:
+       update_company_prefs( $params, $pref = TB_PREF )
+Now:
+       update_company_prefs($params)
+Description:
+       $pref parameter has been removed. All calls should be done after switch to selected company database with 
+       set_global_connection($company).
+
+Before 2.4:
+       get_company_pref($prefs = null, $tbpref = null)
+Now:
+       get_company_pref($prefs = null)
+Description:
+       $tbpref parameter has been removed. All calls should be done after switch to selected company database with 
+       set_global_connection($company).
+
+Before 2.4:
+       get_company_prefs($tbpref = TB_PREF)
+Now:
+       get_company_prefs()
+Description:
+       $tbpref parameter has been removed. All calls should be done after switch to selected company database with 
+       set_global_connection($company).
+
+Before 2.4:
+       db_backup($conn, $ext='no', $comm='', $tbpref = TB_PREF)
+Now:
+       db_backup($conn, $ext='no', $comm='', $path=null)
+Description: 
+       $tbpref parameter has been removed. Calls should be done after switch to selected company database with 
+       set_global_connection($company).
+       $path parameter has been added: path to storage directory for generated backup file. If not set defaults to BACKUP_PATH.
+
+Before 2.4:
+       db_export($conn, $filename, $zip='no', $comment='', $tbpref = TB_PREF, $no_default=false)
+Now:
+       db_export($conn, $filename, $zip='no', $comment='', $no_default=false)
+Description:
+       $tbpref parameter has been removed. Calls should be done after switch to selected company database with 
+       set_global_connection($company).
+       $filename now have to contain full path to target directory.
+
+Before 2.4:
+       save_to_file($backupfile, $zip, $fileData)
+Now:
+       save_to_file($path, $zip, $fileData)
+Description:
+       $path parameter have to contain full path to file, no assumptions to target folder is done inside function.