CS-Cart Developer Documentation

This web resource is aimed at those who want to improve or complement CS-Cart functionality. It covers different aspects of programming and gives a clear idea of architecture peculiarities and standards. The provided material will be of great help to you in customizing CS-Cart or developing new addons. All the documents are grouped into thematic units, so that it will be easy to find the desired information. General programming and formatting rules are also given here.

Introduction

• CS-Cart Architecture and API Overview - A brief introduction into CS-Cart architecture and application programming interface
• Technologies Used - Overview of the technologies behind CS-Cart

General Methodology

• API - CS-Cart API overview and usage
  • Supported Objects - Objects that can be manipulated with the API
  • Extending API with Add-ons - Guide to extending the API with add-ons
• Initialization - Initialization steps description
• Controllers - Controller structure and functioning details
  • Precontrollers and Postcontrollers - Pre- and postcontrollers concept and usage
• Database - Placeholders used in database requests
  • Connect Additional Databases - How to connect and use external databases
• Hooks - General hooking information and examples
• Microformats - Description of a microformat and its structure
• Special classes - A list of special classes used to minimize a CSS file size
• AJAX - A reference with examples for creating AJAX requests
• Notifications - Information on notification pop-ups
• What is new in CS-Cart 4 - Changes in software architecture introduced in CS-Cart 4

Add-ons

• Add-on Folder Structure - structure of an addon directory
• Add-on Scheme - add-on scheme described
• Add-on Connection - explains how to connect an addon with the help of hooks
• Adapting Add-on From 2.x to 3 - CS-Cart 3 add-on migrating guide
• Adapting Add-on From 3 to 4 - CS-Cart 3 add-on migrating guide
• Tutorials
  • Basic CS-Cart Add-on - learn how to write basic CS-Cart add-ons
  • Advanced CS-Cart Add-on - advanced CS-Cart add-on: PHP hooks, TPL hooks, postcontrollers
  • Add-on Licensing - add-on licensing explained
  • Storefront-Based Add-on Licensing in Ultimate Edition - separate add-on licensing for storefronts in CS-Cart Ultimate

Design and Layout

• Block Manager - Block scheme and block types description
• My Changes Add-on - Usage of the My Changes add-on
• Layouting Example - Brief example of creating an Amazon.com-like page layout
• Design changes - Basic knowledge about the CS-Cart design system and minor design changes guide
• Storefront design template scheme - General idea of the storefront template scheme

Appendix

• Coding Standards
  • Programming standards - Basic CS-Cart programming standards
  • Object selection standards - Search form standards
  • Heading and text formats - General hints on heading and text formatting
• addon.xml - addon.xml file fully commented example
• Hook base - The complete CS-Cart hook list
• List of Microformats - CS-Cart microformats with descriptions
• List of Special Classes - CS-Cart special classes with descriptions
• Examples of Design Changes - Most frequently requested design changes
  • Store Background
  • Link Color
  • Buttons
  • Form Fields
  • Top Menu
  • Storefront Width
• Tools and Information Sources
  • HTML Basics
  • CSS Basics
  • Smarty Basics
  • Smarty Debug Console