Differences

This shows you the differences between two versions of the page.

--- merkalt:configure_file [2012/11/29 09:53] – created dmitriy
+++ merkalt:configure_file [2012/11/29 12:15] (current) – dmitriy
@@ Line 2: / Line 2: @@
 \\ ** common site instance settings **
+  * $DOMAIN_ABSOLUTE_PATH - define full real path to the main folder of sites location;
+  * $INSTANCE_RELATIVE_PATH - instance relative path define name of subfolder for instance location (empty for root instance);
+  * $MAIN_HOST_PATH - main host virtual path define virtual path for main (root) host (e.g. http://merkalt.no/fargenavnelapper/). Composed of previously defined domain URL and instance relative path;;
+Additional configuration options: **$config** array.
+  *  **general** - different instance settings;
+     *  menu delimiter (MENU_DELIMITER constant) define the symbol which will be used as menu options delimiter in main (top) and additional (bottom) menus;
+     *  "tell a friend" form using switcher (USE_TF_FORM constant) define if "Tell a friend" form will be used or not. If set to //true// makes "Tell a friend" form visible on sendmail page;
+     *  seed word (SEED_WORD constant) define additional string for MD5 encoding of passed payment data;
+     *  initial number of fields in ‘Tell a friend’ form (SENDMAIL_INIT_TF_FIELDS_AMT constant) define how much fields for friend’s e-mail addresses will appear on sendmail page loading;
+     *  maximal number of fields allowed in ‘Tell a friend’ form (SENDMAIL_MAX_TF_FIELDS_AMT constant) define the limitation for friend’s e-mail fields number on sendmail page, in ‘Tell a friend’ form;
+     *  invoice ID postfix (INVOICE_ID_POSTFIX constant) define the suffix string for invoice identifiers in order to make invoice id unique among all site instances. Therefore the value of this string must be unique for each instance. Currently this string contents three-digits code which will be added to order identifier in order to form unique invoice identifier. For more information see [[merkalt::order_id_format_changed]].
+  *  **globalDb** - global database settings;
+      *  **host** - the name of MySQL host to be accessed;
+      *  **username** - the name of user which has access rights to used DB;
+      *  **password** - password for the DB user;
+      *  **dbname** - the name of used DB;
+      *  **profiler** - the using of Zend profiler option;
+  *  **paths** - set of paths used;
+     *  includes absolute path (INCLUDES_ABSOLUTE_PATH constant) define path to included site-specific modules;
+     *  templates absolute path (TEMPLATES_ABSOLUTE_PATH constant) define path to templates set location;
+     *  payment modules templates absolute path (PAYMENT_TEMPLATES_ABSOLUTE_PATH constant) define path to payment-dependent forms which used for shipping data request. The folder, defined in PAYMENT_TEMPLATES_ABSOLUTE_PATH contents a set of folders, each one corresponds to one of allowed payment types. Currently it contents folders for "PayPal", "CC gateway" and "Invoice notification" modules;
+     *  affiliate programs templates location (AFFILIATES_TEMPLATES_ABSOLUTE_PATH constant) define the location of affiliate code templates which used by corresponding affiliate programs modules;
+     *  motifs folder absolute path (MOTIFS_ABSOLUTE_PATH constant) define absolute path to instance motifs folder;
+     *  motifs folder relative path (MOTIFS_RELATIONAL_PATH constant) define relative path to instance motifs folder;
+  *  **includePaths** - set of core paths used;
+     *  libraries absolute path (LIBRARIES_ABSOLUTE_PATH) define path to libraries modules;
+  *  **url** - list of urls used;
+  *  **notification** - e-mail notifications settings
+     *  name of e-mail sender (EMAIL_SENDER constant) define the name which will be shown as author (or origin) of e-mail (e.g. 'Merkalt.no');
+     *  address of e-mail sender (EMAIL_SENDER_ADDR constant) define e-mail address which will be shown as address of author (or origin) (e.g. 'post@merkalt.no');
+     *  subject of customer e-mail (EMAIL_CUSTOMER_SUBJECT constant) define subject string of customer e-mail (e.g. 'Ordrebekreftelse - Merkalt.no');
+     *  e-mail address of webmaster (EMAIL_WM_ADDR constant) define e-mail address of webmaster on which site e-mails will be sent (e.g. 'post@merkalt.no');
+     *  additional e-mail address(es) for webmaster order notification (EMAIL_ORDER_RECIPIENTS constant) define e-mail address(es) on which e-mails with orders content will be sent (e.g. 'bjorn.egil@merkalt.no');
+     *  subject of webmaster e-mail (EMAIL_WM_SUBJECT constant) define subject string for webmaster's e-mail (e.g. 'Bestilling - Merkalt.no');
+     * email_contact_recipients - recipients of contact messages
+  *  **payment_modules** - specific payment modules settings
+     * paypal - needed for PayPal PDT post-back data verification
+        *  PayPal PDT authentication token (PAYPAL_PDT_AUTH_TOKEN constant) define a string with PDT authentication token, which could be taken from PayPal merchant account settings, when PDT is turned ON;
+  *  **aWeber** - AWeber system settings;
+    *  **usage** - the flag of using of AWeber system. Could be //true// or //false//. If set to //true//, AWeber sign up check box will appear on main index page, above the order submit button;
+    *  **host** - AWeber system web host name ('www.aweber.com');
+    *  **path** - AWeber system web service relational script path ('/scripts/addlead.pl');
+    *  **unit** - the name of AWeber mailing list to be used for customer subscription;
+    *  **redirect** - the page to be used on customer subscription success. Doesn’t used with ‘hidden’ subscription;
+    *  **meta_message** - AWeber form parameter;
+    *  **meta_required** - the list of required form fields;
+    *  **meta_split_id** - AWeber form parameter;
+    *  **meta_adtracking** - AWeber form parameter;
+    *  **meta_web_form_id** - the identifier of used AWeber sign up form;
+    *  **meta_forward_vars** - AWeber form parameter;
+    *  **meta_redirect_onlist** - AWeber form parameter;
+    *  **logging_results** - the flag of using of AWeber system response logging (**debug aid**);
+----
   *  MySQL tables prefix (TABLES_PREFIX constant) define the prefix for all tables which used by site instance. Must be unique for each instance;
   *  MySQL coupons tables prefix (COUPONS_TABLES_PREFIX constant) define the prefix for all tables which used by site instance. To share coupon codes against all instances of single site, use the same coupons tables prefix for all site instances.
-  *  domain path (DOMAIN_ABSOLUTE_PATH constant) define full real path to the main folder of sites location;
-  *  instance relative path (INSTANCE_RELATIVE_PATH constant) define name of subfolder for instance location (empty for root instance);
-  *  server-side path (SITE_ABSOLUTE_PATH constant) define absolute path to instance subfolder (composed of domain path & instance relative path);
-  *  main host virtual path (MAIN_HOST_PATH constant) define virtual path for main (root) host (e.g. http://merkalt.no/ for all instances);
-  *  instance virtual path (HOST_PATH) define full instance virtual path (e.g. 'http://merkalt.no/bedrift/'). Composed of previously defined main host virtual path and instance relative path;
-  *  includes absolute path (INCLUDES_ABSOLUTE_PATH constant) define path to included site-specific modules;
-  *  templates absolute path (TEMPLATES_ABSOLUTE_PATH constant) define path to templates set location;
-  *  payment modules templates absolute path (PAYMENT_TEMPLATES_ABSOLUTE_PATH constant) define path to payment-dependent forms which used for shipping data request. The folder, defined in PAYMENT_TEMPLATES_ABSOLUTE_PATH contents a set of folders, each one corresponds to one of allowed payment types. Currently it contents folders for "PayPal", "CC gateway" and "Invoice notification" modules;
-  *  libraries absolute path (LIBRARIES_ABSOLUTE_PATH) define path to libraries modules;
-  *  affiliate programs modules location (AFFILIATES_MODULES_PATH constant) define relative path to affiliate programs modules location. Each affiliate program which used in system have own module realizing affiliate code functional. All these modules location is defined with a help of this setting;
-  *  affiliate programs templates location (AFFILIATES_TEMPLATES_ABSOLUTE_PATH constant) define the location of affiliate code templates which used by corresponding affiliate programs modules;
-  *  ajax scripts relative path (AJAX_RELATIVE_PATH constant) define path to ajax scripts in relation to instance subfolder;
-  *  javascript library relative path (JSLIB_RELATIVE_PATH constant) define path to javascripts library in relation to instance subfolder;
-  *  motifs folder absolute path (MOTIFS_ABSOLUTE_PATH constant) define absolute path to instance motifs folder;
-  *  motifs folder relative path (MOTIFS_RELATIONAL_PATH constant) define relative path to instance motifs folder;
-\\ ** e-mail settings **
-  *  name of e-mail sender (EMAIL_SENDER constant) define the name which will be shown as author (or origin) of e-mail (e.g. 'Merkalt.no');
-  *  address of e-mail sender (EMAIL_SENDER_ADDR constant) define e-mail address which will be shown as address of author (or origin) (e.g. 'post@merkalt.no');
-  *  subject of customer e-mail (EMAIL_CUSTOMER_SUBJECT constant) define subject string of customer e-mail (e.g. 'Ordrebekreftelse - Merkalt.no');
-  *  e-mail address of webmaster (EMAIL_WM_ADDR constant) define e-mail address of webmaster on which site e-mails will be sent (e.g. 'post@merkalt.no');
-  *  additional e-mail address(es) for webmaster order notification (EMAIL_ORDER_RECIPIENTS constant) define e-mail address(es) on which e-mails with orders content will be sent (e.g. 'bjorn.egil@merkalt.no');
-  *  subject of webmaster e-mail (EMAIL_WM_SUBJECT constant) define subject string for webmaster's e-mail (e.g. 'Bestilling - Merkalt.no');
-\\  ** PayPal data ** needed for PayPal PDT post-back data verification
-  *  PayPal PDT authentication token (PAYPAL_PDT_AUTH_TOKEN constant) define a string with PDT authentication token, which could be taken from PayPal merchant account settings, when PDT is turned ON;
 \\ ** other instance settings **
-  *  menu delimiter (MENU_DELIMITER constant) define the symbol which will be used as menu options delimiter in main (top) and additional (bottom) menus;
   *  discounts are used (USE_DISCOUNTS constant) define using of discounts code and data by site instance; it takes values true or false only;
   *  color selector is used (USE_COLORS constant) define using color selector for label colorization;
   *  discount coupons system using switcher (USE_COUPONS constant) define if discount coupons system will be used or not. If set to //true// makes coupon code field on main index page visible.
-  *  "tell a friend" form using switcher (USE_TF_FORM constant) define if "Tell a friend" form will be used or not. If set to //true// makes "Tell a friend" form visible on sendmail page;
   *  project (or instance) name (PROJECT_NAME constant) define alias for instance in order to change process logic (if required, e.g. like for idband);
   *  fractional prices are used (FRACTIONAL_PRICE constant) set to true if used prices are not integer (like for english version), false otherwise;
   *  maximal number of chars in text strings (MAX_TEXT_LENGTH constant) define a warning threshold (by number of characters entered) for text line if motif is added into design;
-  *  seed word (SEED_WORD constant) define additional string for MD5 encoding of passed payment data;
   *  order delivery method (ORDER_DELIVERY_METHOD constant) define the method of order notification delivery. It could take two values only: "log" (order data will be saved to textual log file) or "mail" (order data will be sent to customer and webmaster via e-mail);
-  *  initial number of fields in ‘Tell a friend’ form (SENDMAIL_INIT_TF_FIELDS_AMT constant) define how much fields for friend’s e-mail addresses will appear on sendmail page loading;
-  *  maximal number of fields allowed in ‘Tell a friend’ form (SENDMAIL_MAX_TF_FIELDS_AMT constant) define the limitation for friend’s e-mail fields number on sendmail page, in ‘Tell a friend’ form;
-  *  invoice ID postfix (INVOICE_ID_POSTFIX constant) define the suffix string for invoice identifiers in order to make invoice id unique among all site instances. Therefore the value of this string must be unique for each instance. Currently this string contents three-digits code which will be added to order identifier in order to form unique invoice identifier. For more information see [[merkalt::order_id_format_changed]].
-Additional configuration options: **$config** array.
-  *  **db** - database settings;
-    *  **adapter** – the name of DB adapter, used to DB tables access. It must be //PDO_MYSQL// for MySQL DB using;
-    *  **params** - DB credentials;
-      *  **host** - the name of MySQL host to be accessed;
-      *  **username** - the name of user which has access rights to used DB;
-      *  **password** - password for the DB user;
-      *  **dbname** - the name of used DB;
-      *  **prefix** - does not used currently;
-      *  **profiler** - the using of Zend profiler option;
   *  **affiliation** - affiliation programs settings;
     *  **post_affiliate_pro** PostAffiliate Pro system settings;
@@ Line 69: / Line 89: @@
       *  **cpid** - //cpid// parameter in tracking link;
       *  **sid** - //sid// parameter in tracking link;
-  *  **aWeber** - AWeber system settings;
-    *  **usage** - the flag of using of AWeber system. Could be //true// or //false//. If set to //true//, AWeber sign up check box will appear on main index page, above the order submit button;
-    *  **host** - AWeber system web host name ('www.aweber.com');
-    *  **path** - AWeber system web service relational script path ('/scripts/addlead.pl');
-    *  **unit** - the name of AWeber mailing list to be used for customer subscription;
-    *  **redirect** - the page to be used on customer subscription success. Doesn’t used with ‘hidden’ subscription;
-    *  **meta_message** - AWeber form parameter;
-    *  **meta_required** - the list of required form fields;
-    *  **meta_split_id** - AWeber form parameter;
-    *  **meta_adtracking** - AWeber form parameter;
-    *  **meta_web_form_id** - the identifier of used AWeber sign up form;
-    *  **meta_forward_vars** - AWeber form parameter;
-    *  **meta_redirect_onlist** - AWeber form parameter;
-    *  **logging_results** - the flag of using of AWeber system response logging (**debug aid**);