Added documentation

1 files changed, 71 insertions, 0 deletions

diff --git a/docs/files/constants.class.php.txt b/docs/files/constants.class.php.txt
new file mode 100644
index 0000000..83ae246
--- /dev/null
+++ b/docs/files/constants.class.php.txt
@@ -0,0 +1,71 @@
+<?php
+/**
+ * Some constants that can be used on other locations
+ * 
+ * @author Camil Staps
+ * 
+ * BusinessAdmin: administrative software for small companies
+ * Copyright (C) 2015 Camil Staps (ViviSoft)
+ * 
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+/**
+ * A class for some constants
+ */
+class constants {
+	/** @const db_prefix 				A prefix to add to the tables in the database (leave empty for none) */
+	const db_prefix						= '';
+
+	/** @const files_folder				The folder to store all files (appendices, invoices, etc.) in; with a trailing slash */
+	const files_folder					= '/var/www/localhost/BusinessAdmin/files/';
+	/** @const files_folder_external 	The external URI to this folder; with a trailing slash */
+	const files_folder_external			= 'http://localhost/BusinessAdmin/files/';
+	/** @const files_folder_trash		The folder inside files_folder to use a trash, without any trailing slashes */
+	const files_folder_trash			= 'trash';
+
+	/** @const url_external				The external URI to this folder; with a trailing slash */
+	const url_external					= 'http://localhost/BusinessAdmin/';
+	/** @const url_internal				The URI without the domain name; with a slash at the beginning but not at the end */
+	const url_internal					= '/BusinessAdmin';
+
+	/** @const my_name					Name of this control panel */
+	const my_name						= 'BusinessAdmin';
+
+	/**
+	 * @const invoice_name				Your name or the name of your business
+	 * @const invoice_address_1			First address line
+	 * @const invoice_address_2			Second address line
+	 * @const invoice_address_3			Third address line
+	 * @const invoice_tax_nr			Your tax number
+	 * @const invoice_iban				Your IBAN number
+	 * @const invoice_bic				The BIC code of your bank
+	 * @const invoice_tel_nr			Your telephone number
+	 * @const invoice_email				Your email address
+	 * @const invoice_valuta			The valuta symbol (will be placed in front of amounts). You can use a symbol like $ or a code like USD
+	 */
+	const invoice_name					= 'BusinessAdmin';
+	const invoice_address_1				= 'My Street 1';
+	const invoice_address_2				= '12345 My City';
+	const invoice_address_3				= 'My Country';
+	const invoice_tax_nr				= 'XX123456789A00';
+	const invoice_iban					= 'XX00 ABCD 1234 5678 90';
+	const invoice_bic					= 'XXXX XXXX';
+	const invoice_tel_nr				= '+31 6 1234 5678';
+	const invoice_email					= 'my-email@domain.tld';
+	const invoice_valuta				= '$'; // chr(128) for euro
+
+	/** @const version					Version of BusinessAdmin. Don't change this yourself! */
+	const version						= '0.1';
+}