Difference between revisions of "X-Cart:Code"

From X-Cart 4 Classic
Jump to: navigation, search
(Created page with '==Access points ===func.php=== ===home.php=== ===cart.php=== ===product.php=== ==Directory /admin/== ==Directory /catalog/== ==Directory /customer/== ==Directory /files/== ==Dire…')
 
m
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==Access points
+
==Overview ==
 +
 
 +
1. PHP scripts:
 +
* Customer related scripts are located in the ./ (root) directory.
 +
* Administrator related scripts are located in the ./admin directory.
 +
* Provider related scripts are located in the ./provider directory.
 +
* Common scripts are located in the ./include directory.
 +
* Modules related scripts are located in the ./modules directory.
 +
* Customer/Administrator/Provider related scripts location is configured in the ./top.inc.php script.
 +
 
 +
2. Smarty class scripts are located in ./include/lib/smarty directory.
 +
 
 +
3. CSS styles are described in ./skin/common_files/*.css file.
 +
 
 +
4. Smarty templates configuration can be found in ./skin/common_files/skin1.conf file.
 +
 
 +
5. Templates directory:
 +
* Common templates are located in the ./skin1 and ./skin/common_files/main directories.
 +
* Templates for the Customer area are located in the ./skin/common_files/customer directory.
 +
* Templates for the Admin area are located in the ./skin/common_files/admin directory.
 +
* Templates for the Provider area are located in the ./skin/common_files/provider directory.
 +
* Mail templates are located in the ./skin/common_files/mail directory.
 +
* Templates for X-Cart modules are located in the ./skin/common_files/modules directory.
 +
 
 +
6. Compiled templates (for cache and Smarty internal use): ./var/templates_c
 +
 
 +
7. Dump of MySQL database is in ./sql/*.sql file.
 +
 
 +
8. Images are located in ./skin/common_files/images directory.
 +
 
 +
9. Product images, category images, manufacturer images etc are located in the ./images directory.
 +
 
 +
10. Files related to integrated shipping modules are located in the ./shipping directory.
 +
 
 +
==Access points==
 +
===config.php===
 +
 
 +
See [[X-Cart:config.php]] page.
 +
 
 
===func.php===
 
===func.php===
 
===home.php===
 
===home.php===
 
===cart.php===
 
===cart.php===
 
===product.php===
 
===product.php===
 +
 
==Directory /admin/==
 
==Directory /admin/==
 
==Directory /catalog/==
 
==Directory /catalog/==
Line 19: Line 58:
 
==Directory /schemes/==
 
==Directory /schemes/==
 
==Directory /shipping/==
 
==Directory /shipping/==
==Directory /skin1/==
+
==Directory /skin/==
==Directory /skin1_original/==
+
 
 +
===CSS files===
 +
 
 +
CSS files for the Customer area are the following:
 +
 
 +
* skin/common_files/css/main.css - Main CSS file for the Customer area.
 +
* skin/common_files/css/main.FF.css - Browser-specific CSS for Mozilla FireFox, Customer area.
 +
* skin/common_files/css/main.IE6.css - Browser-specific CSS for Microsoft Internet Explorer 6, Customer area.
 +
* skin/common_files/css/main.IE7.css - Browser-specific CSS for Microsoft Internet Explorer 7, Customer area.
 +
* skin/common_files/css/main.popup.css - CSS for layer-based popups, Customer area.
 +
* skin/common_files/css/main.popup.IE6.css - Browser-specific CSS for layer-based popups in Microsoft Internet Explorer 6, Customer area.
  
This directory contain backup of default skin, JavaScripts, CSS and some images used by that skin.
+
CSS files for the store's back end  (Admin and Provider areas) are the following:
 +
 
 +
* skin/common_files/css/skin1_admin.css - Main CSS file for the Admin area.
 +
* skin/common_files/css/skin1_printable.css - CSS file for the printable version of the Admin area.
 +
 
 +
CSS files for modules are the following:
 +
 
 +
* skin/common_files/modules/Fast_Lane_Checkout/main.css - Main CSS file for the Customer area, Fast Lane Checkout module.
 +
* skin/common_files/modules/Gift_Certificates/template_sample_1.css - CSS file for template_sample_1.tpl, Gift certificates module.
 +
* skin/common_files/modules/Gift_Certificates/template_sample_2.css - CSS file for template_sample_2.tpl, Gift certificates module.
 +
* skin/common_files/modules/HTML_Editor/scripts/style/editor.css - CSS file for the WYSIWYG editor, Admin area, HTML Editor module (editing not recommended).
 +
* skin/common_files/modules/Subscriptions/calendar.css - CSS file for the calendar in the Admin area, Subscriptions module.
 +
* skin/common_files/modules/XAffiliate/main.css - Main CSS file for the Customer area, X-Affiliate add-on.
 +
* skin/common_files/modules/Product_Configurator/main.css - Main CSS file for the Customer area, X-Configurator add-on.
 +
* skin/common_files/modules/Fancy_Categories/main.css  - Main CSS file for the Customer area, X-FancyCategories add-on.
 +
* skin/common_files/modules/Feature_Comparison/main.css - Main CSS file for the Customer area, X-FeatureComparison add-on.
 +
* skin/common_files/modules/Feature_Comparison/main.IE6.css - Browser-specific CSS for Microsoft Internet Explorer 6, Customer area, X-FeatureComparison add-on.
 +
* skin/common_files/modules/Gift_Registry/main.css - Main CSS file for the Customer area, X-GiftRegistry add-on.
 +
* skin/common_files/modules/Magnifier/main.css - Main CSS file for the Customer area, X-Magnifier add-on.
 +
* skin/common_files/modules/RMA/main.css - Main CSS file for the Customer area, X-RMA add-on.
 +
* skin/common_files/modules/Special_Offers/main.css - Main CSS file for the Customer area, X-SpecialOffers add-on.
 +
* skin/common_files/modules/Survey/main.css - Main CSS file for the Customer area, X-Survey add-on.
  
 
==Directory /sql/==
 
==Directory /sql/==
 
==Directory /upgrade/==
 
==Directory /upgrade/==
 
==Directory /var/==
 
==Directory /var/==
 +
  
 
[[Category:X-Cart developer guide]]
 
[[Category:X-Cart developer guide]]

Latest revision as of 12:31, 30 November 2017

Overview

1. PHP scripts:

  • Customer related scripts are located in the ./ (root) directory.
  • Administrator related scripts are located in the ./admin directory.
  • Provider related scripts are located in the ./provider directory.
  • Common scripts are located in the ./include directory.
  • Modules related scripts are located in the ./modules directory.
  • Customer/Administrator/Provider related scripts location is configured in the ./top.inc.php script.

2. Smarty class scripts are located in ./include/lib/smarty directory.

3. CSS styles are described in ./skin/common_files/*.css file.

4. Smarty templates configuration can be found in ./skin/common_files/skin1.conf file.

5. Templates directory:

  • Common templates are located in the ./skin1 and ./skin/common_files/main directories.
  • Templates for the Customer area are located in the ./skin/common_files/customer directory.
  • Templates for the Admin area are located in the ./skin/common_files/admin directory.
  • Templates for the Provider area are located in the ./skin/common_files/provider directory.
  • Mail templates are located in the ./skin/common_files/mail directory.
  • Templates for X-Cart modules are located in the ./skin/common_files/modules directory.

6. Compiled templates (for cache and Smarty internal use): ./var/templates_c

7. Dump of MySQL database is in ./sql/*.sql file.

8. Images are located in ./skin/common_files/images directory.

9. Product images, category images, manufacturer images etc are located in the ./images directory.

10. Files related to integrated shipping modules are located in the ./shipping directory.

Access points

config.php

See X-Cart:config.php page.

func.php

home.php

cart.php

product.php

Directory /admin/

Directory /catalog/

Directory /customer/

Directory /files/

Directory /images/

Directory /include/

file1.php

file2.php

file3.php

Directory /mail/

Directory /modules/

Directory /payment/

Directory /provider/

Directory /schemes/

Directory /shipping/

Directory /skin/

CSS files

CSS files for the Customer area are the following:

  • skin/common_files/css/main.css - Main CSS file for the Customer area.
  • skin/common_files/css/main.FF.css - Browser-specific CSS for Mozilla FireFox, Customer area.
  • skin/common_files/css/main.IE6.css - Browser-specific CSS for Microsoft Internet Explorer 6, Customer area.
  • skin/common_files/css/main.IE7.css - Browser-specific CSS for Microsoft Internet Explorer 7, Customer area.
  • skin/common_files/css/main.popup.css - CSS for layer-based popups, Customer area.
  • skin/common_files/css/main.popup.IE6.css - Browser-specific CSS for layer-based popups in Microsoft Internet Explorer 6, Customer area.

CSS files for the store's back end (Admin and Provider areas) are the following:

  • skin/common_files/css/skin1_admin.css - Main CSS file for the Admin area.
  • skin/common_files/css/skin1_printable.css - CSS file for the printable version of the Admin area.

CSS files for modules are the following:

  • skin/common_files/modules/Fast_Lane_Checkout/main.css - Main CSS file for the Customer area, Fast Lane Checkout module.
  • skin/common_files/modules/Gift_Certificates/template_sample_1.css - CSS file for template_sample_1.tpl, Gift certificates module.
  • skin/common_files/modules/Gift_Certificates/template_sample_2.css - CSS file for template_sample_2.tpl, Gift certificates module.
  • skin/common_files/modules/HTML_Editor/scripts/style/editor.css - CSS file for the WYSIWYG editor, Admin area, HTML Editor module (editing not recommended).
  • skin/common_files/modules/Subscriptions/calendar.css - CSS file for the calendar in the Admin area, Subscriptions module.
  • skin/common_files/modules/XAffiliate/main.css - Main CSS file for the Customer area, X-Affiliate add-on.
  • skin/common_files/modules/Product_Configurator/main.css - Main CSS file for the Customer area, X-Configurator add-on.
  • skin/common_files/modules/Fancy_Categories/main.css - Main CSS file for the Customer area, X-FancyCategories add-on.
  • skin/common_files/modules/Feature_Comparison/main.css - Main CSS file for the Customer area, X-FeatureComparison add-on.
  • skin/common_files/modules/Feature_Comparison/main.IE6.css - Browser-specific CSS for Microsoft Internet Explorer 6, Customer area, X-FeatureComparison add-on.
  • skin/common_files/modules/Gift_Registry/main.css - Main CSS file for the Customer area, X-GiftRegistry add-on.
  • skin/common_files/modules/Magnifier/main.css - Main CSS file for the Customer area, X-Magnifier add-on.
  • skin/common_files/modules/RMA/main.css - Main CSS file for the Customer area, X-RMA add-on.
  • skin/common_files/modules/Special_Offers/main.css - Main CSS file for the Customer area, X-SpecialOffers add-on.
  • skin/common_files/modules/Survey/main.css - Main CSS file for the Customer area, X-Survey add-on.

Directory /sql/

Directory /upgrade/

Directory /var/