PrestaShop 1.6

https://docs.prestashop-project.org/1-6-documentation/
Admin
PrestaShop 1.6 is an open-source e-commerce platform that enables businesses to create and manage...
Tokens:117,012
Snippets:790
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Basic PrestaShop Module Install Method

Source: https://docs.prestashop-project.org/1-6-documentation/english-documentation/developer-guide/creating-a-prestashop-module/creating-a-first-module

This is the most basic implementation of the install() method for a PrestaShop module. It ensures the parent class's install method is called and returns true if successful. This method is fundamental for performing initial setup tasks for a module.

```php
public function install()
{
  if (!parent::install()) {
    return false;
  }

  return true;
}
```

--------------------------------

### PrestaShop User Guide Structure (Markdown)

Source: https://context7.com/context7/prestashop-project-1-6-documentation/llms.txt

Illustrates the hierarchical structure of the PrestaShop 1.6 user guide, specifically focusing on the main administration topics and an example of navigating to product management within the catalog section. This outlines the organization of administrative documentation.

```markdown
# Main user guide sections from english-documentation/user-guide.md:

## Core Administration Topics:
- Training
- Customizing your shop
- Connecting to the PrestaShop back office
- Discovering the Administration Area
- Getting on board of PrestaShop
- First steps with PrestaShop 1.6
- Managing the Catalog
- Managing Orders
- Managing Customers
- Creating Price Rules and Vouchers
- Managing Modules and Themes
- Making the Native Modules Work
- Managing Shipping
- Understanding Local Settings
- Understanding the Preferences
- Understanding the Advanced Parameters
- Administering the back office
- Understanding Statistics
- Advanced Stock Management
- Managing Multiple Shops
- Complying with the GDPR

# Example navigation to specific topic:
english-documentation/user-guide/managing-the-catalog/
├── artikel-verwalten.md (product management)
├── kategorien.md (categories)
├── artikelvarianten.md (product variations)
├── hersteller.md (manufacturers)
└── artikeleigenschaften.md (product attributes)
```

--------------------------------

### PHP: Fetch All Customers with Error Handling

Source: https://docs.prestashop-project.org/1-6-documentation/english-documentation/developer-guide/developer-tutorials/using-the-prestashop-web-service/web-service-tutorial/chapter-3-first-steps-accessing-the-web-service-and-listing-customers

An example of how to fetch all customers using the PrestaShop webservice library within a try-catch block for robust error handling. It instantiates the service and calls the 'get' method for the 'customers' resource.

```php
try {
	// creating web service access
	$webService = new PrestaShopWebservice('http://example.com/', 'ZR92FNY5UFRERNI3O9Z5QDHWKTP3YIIT', false);

	// call to retrieve all customers
	$xml = $webService->get(array('resource' => 'customers'));
}
catch (PrestaShopWebserviceException $ex) {
	// Shows a message related to the error
	echo 'Other error: <br />' . $ex->getMessage(); 
}
```

--------------------------------

### PrestaShop CLI Installation with Arguments

Source: https://docs.prestashop-project.org/1-6-documentation/english-documentation/getting-started/installing-prestashop-using-the-command-line-script

This command demonstrates how to perform a PrestaShop installation using the CLI script with all necessary arguments. It includes domain, database server, database name, database user, and database password. Optionally, an email address can be provided to receive a recap email upon completion.

```shell
$ php index_cli.php --domain=example.com --db_server=sql.example.com --db_name=prestashop --db_user=root --db_password=123456789
```

--------------------------------

### Installer PrestaShop avec paramètres CLI

Source: https://docs.prestashop-project.org/1-6-documentation/documentation-francaise/guide-de-demarrage/installer-prestashop-en-ligne-de-commande

Exemple de commande pour installer PrestaShop en ligne de commande en fournissant directement les paramètres nécessaires comme le domaine, les informations de la base de données et les identifiants administrateur.

```bash
php install_cli.php --domain=example.com --db_server=sql.example.com --db_name=prestashop --db_user=root --db_password=123456789
```

--------------------------------

### Resource Endpoint Example (Customers)

Source: https://docs.prestashop-project.org/1-6-documentation/english-documentation/developer-guide/developer-tutorials/using-the-prestashop-web-service/web-service-tutorial/chapter-2-discovery-testing-your-access-to-the-web-service-with-the-browser

This example demonstrates the structure of a resource endpoint, using 'customers' as an illustration. It shows how to retrieve customer data and provides links to schemas for creating and describing customer resources.

```APIDOC
## GET /api/customers

### Description
Accesses the customer resource. Allows for retrieving, creating, updating, and deleting customer data. Provides links to resource schemas.

### Method
GET, PUT, POST, DELETE, HEAD

### Endpoint
/api/customers

### Parameters
#### Query Parameters
- **schema** (string) - Optional - Specifies the schema type ('blank' for creation, 'synopsis' for description).

#### Request Body
(Not applicable for GET requests. For POST/PUT, refer to the blank schema.)

### Request Example
(For GET requests, no request body is needed. For POST/PUT, refer to the blank schema example.)

### Response
#### Success Response (200)
- **XML representation of customer data** (XML) - Description of the customer data structure.

#### Response Example
```xml
<customers xlink:href="http://example.com/api/customers" get="true" put="true" post="true" delete="true" head="true">
  <description xlink:href="http://example.com/api/customers" get="true" put="true" post="true" delete="true" head="true">The e-shop's customers</description>
  <schema xlink:href="http://example.com/api/customers?schema=blank" type="blank"/>
  <schema xlink:href="http://example.com/api/customers?schema=synopsis" type="synopsis"/>
</customers>
```
```

--------------------------------

### Basic PrestaShop Module Install Method

Source: https://docs.prestashop-project.org/1-6-documentation/polska-dokumentacja/przewodnik-dewelopera/creating-a-prestashop-module/creating-a-first-module

This PHP method provides the minimal implementation for a PrestaShop module's install() method. It ensures the parent class's install method is called and returns true on success, false on failure. It serves as a foundation for more complex installation routines.

```php
public function install()
{
  if (!parent::install())
    return false;
  return true;
}
```

--------------------------------

### Navigate to Installation Documentation (Bash)

Source: https://context7.com/context7/prestashop-project-1-6-documentation/llms.txt

Navigates the file system to the 'getting-started' directory within the English documentation. This action is typically a precursor to accessing installation-related files and understanding system requirements.

```bash
# Navigate to installation documentation
cd english-documentation/getting-started/

# Key files available:
# - what-you-need-to-get-started.md
# - installing-prestashop.md
# - installing-prestashop-on-your-computer.md
# - installing-prestashop-using-the-command-line-script.md
# - updating-and-uninstalling-prestashop.md

# System Requirements:
# - PHP 5.2 or later
# - MySQL 5.0 or later
# - Apache Web Server 1.3+ (or nginx 1.0+)
# - Required PHP extensions: PDO_MySQL, cURL, SimpleXML, mcrypt, GD, OpenSSL, DOM, SOAP, Zip
# - Minimum 64MB RAM dedicated to PHP
# - FTP access for file uploads
# - Domain name and web hosting

# Installation steps:
# 1. Download PrestaShop from prestashop.com/download
# 2. Extract archive to local directory
# 3. Upload files via FTP to web server
# 4. Create MySQL database via phpMyAdmin or hosting control panel
# 5. Access installation URL (http://yourdomain.com/install)
# 6. Complete 6-step web installer
# 7. Delete /install folder for security
# 8. Rename /admin folder to custom name
```

--------------------------------

### Install Compass using Ruby Gem

Source: https://docs.prestashop-project.org/1-6-documentation/english-documentation/designer-guide/bootstrap-sass-and-compass-in-prestashop-1.6/using-compass

Command to install the Compass framework using RubyGems. This command should be run in your Ruby command line after Ruby has been successfully installed.

```shell
gem install compass
```

--------------------------------

### Example .htpasswd File Content

Source: https://docs.prestashop-project.org/1-6-documentation/documentation-francaise/guide-de-ladministrateur-systeme/rendre-votre-installation-de-prestashop-plus-sure

This is an example of the content for a .htpasswd file, which stores usernames and their corresponding password hashes. Each line represents a user with their credentials.

```plaintext
login1:$apr1$/wJeliK8$e9OzgRaVL8J8wSsFBXjor1
login2:$apr1$yV65Kqqz$cFt3sV2.Q7hhLRRUJDo5a/
```

--------------------------------

### Complete Nginx Server Block for PrestaShop

Source: https://docs.prestashop-project.org/1-6-documentation/english-documentation/system-administrator-guide

This is a comprehensive example of an Nginx server block configuration for hosting a PrestaShop website. It includes basic settings like listen port, server name, root directory, log file paths, and index file priorities. It also includes a location block for favicon.ico to handle requests for the site's icon.

```nginx
server {
    listen 80;
    #listen [::]:80;            # Uncomment this line if you also want to enable IPv6 support
    server_name example.com www.example.com;
    root /var/www/example;
    access_log /var/log/nginx/example.access.log;
    error_log /var/log/nginx/example.error.log;

    index index.php index.html; # Letting nginx know which files to try when requesting a folder


    location = /favicon.ico {
        log_not_found off;      # PrestaShop by default does not provide a favicon.ico

```

--------------------------------

### Advanced PrestaShop Module Install Method with Checks

Source: https://docs.prestashop-project.org/1-6-documentation/english-documentation/developer-guide/creating-a-prestashop-module/creating-a-first-module

An expanded install() method for PrestaShop modules that includes several essential checks and actions. It verifies Multistore status, parent installation, hook registration, and creates a configuration value. If any check fails, the installation process aborts.

```php
public function install()
{
  if (Shop::isFeatureActive()) {
    Shop::setContext(Shop::CONTEXT_ALL);
  }

  if (!parent::install() ||
    !$this->registerHook('leftColumn') ||
    !$this->registerHook('header') ||
    !Configuration::updateValue('MYMODULE_NAME', 'my friend')
  ) {
    return false;
  }

  return true;
}
```

--------------------------------

### Nginx Root Installation Friendly URLs Configuration

Source: https://docs.prestashop-project.org/1-6-documentation/english-documentation/system-administrator-guide

This Nginx configuration enables friendly URLs for a PrestaShop installation located at the root of the server. It simplifies the rewrite rules by removing the folder prefix. The `try_files` directive ensures that requests are correctly handled, falling back to index.php when necessary.

```nginx
location / {
  index /index.php;

  rewrite ^/api/?(.*)$ /webservice/dispatcher.php?url=$1 last;
  rewrite ^/([0-9])(-[_a-zA-Z0-9-]*)?(-[0-9]+)?/.+\.jpg$ /img/p/$1/$1$2.jpg last;
  rewrite ^/([0-9])([0-9])(-[_a-zA-Z0-9-]*)?(-[0-9]+)?/.+\.jpg$ /img/p/$1/$2/$1$2$3.jpg last;
  rewrite ^/([0-9])([0-9])([0-9])(-[_a-zA-Z0-9-]*)?(-[0-9]+)?/.+\.jpg$ /img/p/$1/$2/$3/$1$2$3$4.jpg last;
  rewrite ^/([0-9])([0-9])([0-9])([0-9])(-[_a-zA-Z0-9-]*)?(-[0-9]+)?/.+\.jpg$ /img/p/$1/$2/$3/$4/$1$2$3$4$5.jpg last;
  rewrite ^/([0-9])([0-9])([0-9])([0-9])([0-9])(-[_a-zA-Z0-9-]*)?(-[0-9]+)?/.+\.jpg$ /img/p/$1/$2/$3/$4/$5/$1$2$3$4$5$6.jpg last;
  rewrite ^/([0-9])([0-9])([0-9])([0-9])([0-9])([0-9])(-[_a-zA-Z0-9-]*)?(-[0-9]+)?/.+\.jpg$ /img/p/$1/$2/$3/$4/$5/$6/$1$2$3$4$5$6$7.jpg last;
  rewrite ^/([0-9])([0-9])([0-9])([0-9])([0-9])([0-9])([0-9])(-[_a-zA-Z0-9-]*)?(-[0-9]+)?/.+\.jpg$ /img/p/$1/$2/$3/$4/$5/$6/$7/$1$2$3$4$5$6$7$8.jpg last;
  rewrite ^/([0-9])([0-9])([0-9])([0-9])([0-9])([0-9])([0-9])([0-9])(-[_a-zA-Z0-9-]*)?(-[0-9]+)?/.+\.jpg$ /img/p/$1/$2/$3/$4/$5/$6/$7/$8/$1$2$3$4$5$6$7$8$9.jpg last;
  rewrite ^/c/([0-9]+)(-[_a-zA-Z0-9-]*)(-[0-9]+)?/.+\.jpg$ /img/c/$1$2.jpg last;
  rewrite ^/c/([a-zA-Z-]+)(-[0-9]+)?/.+\.jpg$ /img/c/$1.jpg last;
  rewrite ^/([0-9]+)(-[_a-zA-Z0-9-]*)(-[0-9]+)?/.+\.jpg$ /img/c/$1$2.jpg last;
  try_files $uri $uri/ /index.php?$args;
}
```

--------------------------------

### PHP PSR-2 Coding Style Example

Source: https://docs.prestashop-project.org/1-6-documentation/english-documentation/developer-guide/coding-standards/php-coding-standards

An example demonstrating adherence to the PSR-2 coding style guide, including namespace declaration, use statements, class and method brace placement, visibility declarations, and control structure syntax.

```php
<?php 
namespace Vendor\Package; 

use FooInterface;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;
 
class Foo extends Bar implements FooInterface
{
    public function sampleFunction($a, $b = null)
    {
        if ($a === $b) {
            bar();
        } elseif ($a > $b) {
            $foo->bar($arg1);
        } else {
            BazClass::bar($arg2, $arg3);
        }
    }
 
    final public static function bar()
    {
        // method body
    }
}

```

--------------------------------

### PHP Configuration Settings for PrestaShop

Source: https://docs.prestashop-project.org/1-6-documentation/english-documentation/system-administrator-guide

Specifies recommended PHP configuration directives for PrestaShop installations. These settings are crucial for security and functionality, particularly disabling directives that can pose security risks.

```ini
register_globals = Off
magic_quotes_gpc = Off
allow_url_include = Off
safe_mode = Off
safe_mode_gid = Off
```

--------------------------------

### PrestaShop Commit Message Examples

Source: https://docs.prestashop-project.org/1-6-documentation/english-documentation/developer-guide/contributing-to-prestashop/how-to-write-a-commit-message

Provides practical examples of commit messages following the PrestaShop convention. These examples illustrate how to use different categories (BO, FO, MO) and concisely describe the changes made in a commit.

```text
BO: Fixed bug while updating images in AdminProduct
FO: You can now buy products without TVA
MO: New RSS Feed module
```

--------------------------------

### MySQL User Creation Command Line

Source: https://docs.prestashop-project.org/1-6-documentation/english-documentation/system-administrator-guide

Demonstrates how to create a new MySQL user via the command line. This is a fundamental step in securing database access by adhering to the principle of least privilege.

```shell
mysql -u USERNAME -p PASSWORD
```

--------------------------------

### PrestaShop Theme Structure and Smarty Template Example

Source: https://context7.com/context7/prestashop-project-1-6-documentation/llms.txt

Illustrates the typical directory structure of a PrestaShop theme and provides an example of a Smarty template (header.tpl) used for rendering the website header. It shows how to include CSS and JavaScript files, display shop information, and integrate hooks.

```smarty
{* Example theme template structure *}
{* From designer-guide/theme-templates-and-smarty/ *}

{* Main theme directory structure: *}
{* themes/mytheme/ *}
{*   ├── css/ *}
{*   ├── js/ *}
{*   ├── img/ *}
{*   ├── lang/ *}
{*   ├── modules/ (module template overrides) *}
{*   ├── pdf/ *}
{*   ├── sass/ *}
{*   ├── cache/ *}
{*   ├── header.tpl *}
{*   ├── footer.tpl *}
{*   ├── product.tpl *}
{*   ├── category.tpl *}
{*   ├── index.tpl *}
{*   └── config.xml *}

{* Example header.tpl *}
<!DOCTYPE html>
<html lang="{$language_code}">
<head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>{$meta_title|escape:'html':'UTF-8'}</title>
    <meta name="description" content="{$meta_description|escape:'html':'UTF-8'}">
    <meta name="keywords" content="{$meta_keywords|escape:'html':'UTF-8'}">

    {if isset($css_files)}
        {foreach from=$css_files key=$css_uri item=$media}
            <link rel="stylesheet" href="{$css_uri}" type="text/css" media="{$media}">
        {/foreach}
    {/if}

    {if isset($js_files)}
        {foreach from=$js_files item=$js_uri}
            <script type="text/javascript" src="{$js_uri}"></script>
        {/foreach}
    {/if}
</head>
<body id="{$page_name}">
    <div id="page">
        <header id="header">
            <div class="container">
                <div class="row">
                    <div class="col-sm-4">
                        <a href="{$base_dir}" title="{$shop_name|escape:'html':'UTF-8'}">
                            <img src="{$logo_url}" alt="{$shop_name|escape:'html':'UTF-8'}">
                        </a>
                    </div>
                    <div class="col-sm-8">
                        {$HOOK_TOP}
                    </div>
                </div>
            </div>
        </header>

```

--------------------------------

### Listing Customers

Source: https://docs.prestashop-project.org/1-6-documentation/english-documentation/developer-guide/developer-tutorials/using-the-prestashop-web-service/web-service-tutorial/chapter-3-first-steps-accessing-the-web-service-and-listing-customers

This snippet shows how to retrieve a list of all customers from the PrestaShop store using the `get()` method of the `PrestaShopWebservice` object. It includes basic error handling using a try-catch block.

```APIDOC
## GET /customers

### Description
Retrieves a list of all customers from the PrestaShop store.

### Method
GET

### Endpoint
`/api/customers` (This is a conceptual endpoint; the actual call uses the `get()` method with the `resource` parameter)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```php
try {
    // creating web service access
    $webService = new PrestaShopWebservice('http://example.com/', 'ZR92FNY5UFRERNI3O9Z5QDHWKTP3YIIT', false);

    // call to retrieve all customers
    $xml = $webService->get(array('resource' => 'customers'));

    // Process the $xml response here
}
catch (PrestaShopWebserviceException $ex) {
    // Shows a message related to the error
    echo 'Other error: <br />' . $ex->getMessage(); 
}
```

### Response
#### Success Response (200)
Returns an XML structure containing customer data.

#### Response Example
```xml
<prestashop xmlns:xlink="http://www.w3.org/1999/xlink">
    <customers>
        <customer id="1" xlink:href="http://example.com/api/customers/1">
            <id><![CDATA[1]]></id>
            <firstname><![CDATA[John]]></firstname>
            <lastname><![CDATA[Doe]]></lastname>
            <email><![CDATA[john.doe@example.com]]></email>
            <!-- ... other customer fields ... -->
        </customer>
        <!-- ... more customer elements ... -->
    </customers>
</prestashop>
```
```

--------------------------------

### PHP 'while' and 'do while' Control Structures

Source: https://docs.prestashop-project.org/1-6-documentation/documentacion-espanola/guia-del-desarrollador/estandares-de-codificacion

Provides examples of the correct syntax and formatting for while and do-while loops in PHP, focusing on consistent spacing and brace placement.

```php
<?php 
while ($expr) {
    // structure body
}

```

```php
<?php 
do {
    // structure body;
} while ($expr);

```

--------------------------------

### Advanced PrestaShop Module Install Method with Checks

Source: https://docs.prestashop-project.org/1-6-documentation/polska-dokumentacja/przewodnik-dewelopera/creating-a-prestashop-module/creating-a-first-module

This PHP install() method includes several checks before proceeding with module installation. It verifies if Multistore is active, if the parent class is installed, and if the module can be hooked to 'leftColumn' and 'header'. It also sets a configuration value 'MYMODULE_NAME'. If any check fails, installation is aborted.

```php
public function install()
{
  if (Shop::isFeatureActive())
    Shop::setContext(Shop::CONTEXT_ALL);

  if (!parent::install() ||
    !$this->registerHook('leftColumn') ||
    !$this->registerHook('header') ||
    !Configuration::updateValue('MYMODULE_NAME', 'my friend')
  )
    return false;

  return true;
}
```

--------------------------------

### Get Resource Schema with HTTP GET Request

Source: https://docs.prestashop-project.org/1-6-documentation/english-documentation/developer-guide/developer-tutorials/using-the-prestashop-web-service/web-service-one-page-documentation

Retrieves a blank XML document or a synopsis with tag descriptions for a specified resource using an HTTP GET request. This is useful for understanding the structure required for creating new entries.

```http
http://UCCLLQ9N2ARSHWCXLT74KUKSSK34BFKX@example.com/api/manufacturers?schema=blank
```

```http
http://UCCLLQ9N2ARSHWCXLT74KUKSSK34BFKX@example.com/api/manufacturers?schema=synopsis
```

--------------------------------

### Resource Endpoint Example: /api/customers

Source: https://docs.prestashop-project.org/1-6-documentation/english-documentation/developer-guide/developer-tutorials/using-the-prestashop-web-service/web-service-one-page-documentation

Accessing a specific resource like '/api/customers' provides details about the resource, including supported HTTP methods and links to schemas for creating or understanding data.

```APIDOC
## GET /api/customers

### Description
Provides information about the customers resource, including supported operations and links to schemas.

### Method
GET

### Endpoint
/api/customers

### Parameters
#### Query Parameters
- **schema** (string) - Optional. Can be 'blank' to get an empty schema for creating a new customer, or 'synopsis' for a schema with detailed field descriptions.

### Request Example
`GET /api/customers`
`GET /api/customers?schema=blank`
`GET /api/customers?schema=synopsis`

### Response
#### Success Response (200)
- **customers** (xml) - Root element for the customers resource.
  - **xlink:href** (string) - URL for the customers resource.
  - **get** (boolean) - Indicates if GET requests are supported.
  - **put** (boolean) - Indicates if PUT requests are supported.
  - **post** (boolean) - Indicates if POST requests are supported.
  - **delete** (boolean) - Indicates if DELETE requests are supported.
  - **head** (boolean) - Indicates if HEAD requests are supported.
  - **description** (xml) - A human-readable description of the customers resource.
  - **schema** (xml) - Links to the schemas (blank or synopsis).

#### Response Example (for a general resource request)
```xml
<customers xlink:href="http://example.com/api/customers" get="true" put="true" post="true" delete="true" head="true">
  <description xlink:href="http://example.com/api/customers" get="true" put="true" post="true" delete="true" head="true">The e-shop's customers</description>
  <schema xlink:href="http://example.com/api/customers?schema=blank" type="blank"/>
  <schema xlink:href="http://example.com/api/customers?schema=synopsis" type="synopsis"/>
</customers>
```

#### Response Example (for `?schema=blank`)
```xml
<?xml version="1.0" encoding="UTF-8"?>
<prestashop xmlns:xlink="http://www.w3.org/1999/xlink">
  <customer>
    <id></id>
    <id_default_group></id_default_group>
    <id_lang></id_lang>
    <newsletter_date_add></newsletter_date_add>
    <ip_registration_newsletter></ip_registration_newsletter>
    <last_passwd_gen></last_passwd_gen>
    <secure_key></secure_key>
    <deleted></deleted>
    <passwd></passwd>
    <lastname></lastname>
    <firstname></firstname>
    <email></email>
    ...
  </customer>
</prestashop>
```

#### Response Example (for `?schema=synopsis`)
```xml
<?xml version="1.0" encoding="UTF-8"?>
<prestashop xmlns:xlink="http://www.w3.org/1999/xlink">
  <customer>
    <id_default_group></id_default_group>
    <id_lang format="isUnsignedId"></id_lang>
    <newsletter_date_add></newsletter_date_add>
    <ip_registration_newsletter></ip_registration_newsletter>
    <last_passwd_gen></last_passwd_gen>
    <secure_key format="isMd5"></secure_key>
    ...
  </customer>
</prestashop>
```
```

--------------------------------

### HTML Navigation Bar Example

Source: https://docs.prestashop-project.org/1-6-documentation/english-documentation/designer-guide/bootstrap-sass-and-compass-in-prestashop-1.6/using-bootstrap

Provides an example of a fixed navigation bar using Bootstrap classes in PrestaShop. It includes a brand link, a responsive toggle button for collapsing the menu on smaller screens, and a navigation list aligned to the right. This structure is common for site-wide navigation.

```html
<div class="navbar navbar-fixed-top">
  <div class="navbar-inner">
    <div class="container">
      <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
        <span class="icon-th-list"></span></a>
      <a href="#" class="brand">SiteTitle</a>
      <div class="nav-collapse collapse">
        <ul class="nav pull-right">
          <li class="active"><a href="#">Home</a></li>
          <li><a href="#">About Us</a></li>
          <li><a href="#">Contact Us</a></li>
        </ul>
      </div>
    </div>
  </div>
</div>
```

--------------------------------

### PrestaShop 1.6 Bootstrap Button and Link Examples

Source: https://docs.prestashop-project.org/1-6-documentation/english-documentation/designer-guide/bootstrap-sass-and-compass-in-prestashop-1.6/using-bootstrap

Demonstrates the application of Bootstrap button classes (`btn`, `btn-default`, `btn-primary`, etc.) and size modifiers (`btn-lg`, `btn-sm`) within PrestaShop HTML structures. Includes examples for add to cart buttons, view links, and submit buttons, showcasing the use of active and disabled states.

```html
<span class="button ajax_add_to_cart_button btn btn-default disabled">
  <span>{l s='Add to cart'}</span>
</span>
<a itemprop="url" class="button lnk_view btn btn-default" 
    href="{$product.link|escape:'html':'UTF-8'}" title="{l s='View}">
  <span>{l s='More'}</span>
</a>
<button type="submit" name="submitMessage" id="submitMessage" 
    class="button btn btn-default button-medium">
  <span>{l s='Send'}<i class="icon-chevron-right right"></i></span>
</button>
```

--------------------------------

### Create a New Compass Project

Source: https://docs.prestashop-project.org/1-6-documentation/english-documentation/designer-guide/bootstrap-sass-and-compass-in-prestashop-1.6/using-compass

Command to create a new Compass project within the `/themes` folder of your PrestaShop installation. This command will generate the necessary configuration files, including `config.rb`.

```shell
compass create
```

--------------------------------

### Sass SCSS Syntax Example

Source: https://docs.prestashop-project.org/1-6-documentation/english-documentation/designer-guide/bootstrap-sass-and-compass-in-prestashop-1.6/using-sass

Demonstrates the SCSS syntax for styling an H1 element. SCSS is the newer syntax used by PrestaShop and is a superset of CSS.

```scss
h1 {
  color: #000;
  background: #fff;
}
```

--------------------------------

### Viewing Data with PrestaShopWebservice

Source: https://docs.prestashop-project.org/1-6-documentation/english-documentation/developer-guide/developer-tutorials/using-the-prestashop-web-service/web-service-one-page-documentation

Demonstrates how to retrieve a list of customers using the PrestaShopWebservice's get() method.

```APIDOC
## Viewing Data with PrestaShopWebservice

### Description
This endpoint allows you to retrieve a list of resources, such as customers, from the PrestaShop API using the `PrestaShopWebservice` class.

### Method
GET

### Endpoint
`/api/customers/` (when using `$webService->get()` with resource parameter)

### Parameters
#### Query Parameters
- **resource** (string) - Required - The type of resource to retrieve (e.g., 'customers', 'carriers', 'countries').
- **id** (integer) - Optional - The ID of a specific resource to retrieve.

### Request Example
```php
// Instantiate PrestaShopWebservice (assuming $webService is already instantiated)
$opt = [];
$opt['resource'] = 'customers';
$xml = $webService->get($opt);
```

### Response
#### Success Response (200)
Returns an XML object containing the requested resource data.

#### Response Example
```xml
<?xml>
<prestashop>
  <customer id="1" xlink:href="http://example.com/api/customers/1"/>
  <customer id="2" xlink:href="http://example.com/api/customers/2"/>
  <customer id="3" xlink:href="http://example.com/api/customers/3"/>
  <customer id="4" xlink:href="http://example.com/api/customers/4"/>
</prestashop>
```

### Additional Information
To access individual resources after retrieval, you can parse the XML response. For example, to get all customer children:

```php
$resources = $xml->customers->children();
foreach ($resources as $resource)
    echo $resource->attributes() . '<br />';
```
```

--------------------------------

### Registering Module Hooks in PrestaShop Install Method

Source: https://docs.prestashop-project.org/1-6-documentation/english-documentation/developer-guide/creating-a-prestashop-module/displaying-content-on-the-front-office

This PHP code snippet shows how to register hooks ('leftColumn', 'header') and set a configuration value during module installation in PrestaShop. It ensures the module can respond to specific front-office events. Dependencies include PrestaShop's `Shop` and `Configuration` classes.

```php
public function install()
{
  if (Shop::isFeatureActive())
    Shop::setContext(Shop::CONTEXT_ALL);

  return parent::install() &&
    $this->registerHook('leftColumn') &&
    $this->registerHook('header') &&
    Configuration::updateValue('MYMODULE_NAME', 'my friend');
}
```

--------------------------------

### PHP: Instantiate PrestaShop Webservice Client

Source: https://docs.prestashop-project.org/1-6-documentation/english-documentation/developer-guide/developer-tutorials/using-the-prestashop-web-service/web-service-tutorial/chapter-3-first-steps-accessing-the-web-service-and-listing-customers

Shows how to create an instance of the PrestaShopWebservice class. This requires the store's URL, an authentication key, and a boolean to enable/disable debug mode.

```php
$webService = new PrestaShopWebservice('http://example.com/', 'ZR92FNY5UFRERNI3O9Z5QDHWKTP3YIIT', false);
```

--------------------------------

### Multiline Implements List Formatting (PHP)

Source: https://docs.prestashop-project.org/1-6-documentation/documentacion-espanola/guia-del-desarrollador/estandares-de-codificacion

Illustrates how to split a list of 'implements' across multiple lines. Each interface should be on its own indented line, starting with the first item on the next line after 'implements'.

```PHP
<?php 
namespace Vendor\Package; 
 
use FooClass;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass; 
 
class ClassName extends ParentClass implements
    \ArrayAccess,
    \Countable,
    \Serializable
{
    // constants, properties, methods
}
```

--------------------------------

### PrestaShop Web Service Initialization

Source: https://docs.prestashop-project.org/1-6-documentation/english-documentation/developer-guide/developer-tutorials/using-the-prestashop-web-service/web-service-tutorial/chapter-3-first-steps-accessing-the-web-service-and-listing-customers

This snippet demonstrates how to create an instance of the PrestaShopWebservice object, which is the first step to interacting with the web service. It requires the store's root URL, an authentication key, and a boolean for debug mode.

```APIDOC
## Initialize PrestaShopWebservice

### Description
Creates an instance of the PrestaShopWebservice object to interact with the PrestaShop API.

### Method
Constructor

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Constructor Parameters
- **storeUrl** (string) - Required - The root URL of the PrestaShop store (e.g., 'http://example.com/').
- **apiKey** (string) - Required - The authentication key for the web service.
- **debugMode** (boolean) - Required - Set to `true` to enable debug mode, `false` otherwise.

### Request Example
```php
require_once('./PSWebServiceLibrary.php');

try {
    $webService = new PrestaShopWebservice('http://example.com/', 'ZR92FNY5UFRERNI3O9Z5QDHWKTP3YIPT', false);
    // ... further operations ...
}
catch (PrestaShopWebserviceException $ex) {
    echo 'Error creating webservice instance: ' . $ex->getMessage();
}
```

### Response
#### Success Response
An instance of the `PrestaShopWebservice` object is created.

#### Response Example
N/A (Constructor)
```

--------------------------------

### Available HTTP Methods

Source: https://docs.prestashop-project.org/1-6-documentation/english-documentation/developer-guide/developer-tutorials/using-the-prestashop-web-service/web-service-reference

Details the standard and exceptional HTTP methods (GET, POST, PUT, DELETE, HEAD) available for various API resources in PrestaShop 1.6.

```APIDOC
## Available HTTP Methods

### Description
This section lists the standard and resource-specific HTTP methods supported by the PrestaShop 1.6 API.

### Methods

**Standard Methods (GET, POST, PUT, DELETE, HEAD):** Most resources support these standard RESTful methods.

**Exceptional Methods:**
- `search`: Only `GET` and `HEAD` are supported.
- `stock_availables`: `GET`, `POST`, and `HEAD` are supported.
- `stock_movements`: Only `GET` and `HEAD` are supported.
- `stocks`: Only `GET` and `HEAD` are supported.
- `supply_order_details`: Only `GET` and `HEAD` are supported.
- `supply_order_histories`: Only `GET` and `HEAD` are supported.
- `supply_order_receipt_histories`: Only `GET` and `HEAD` are supported.
- `supply_order_states`: Only `GET` and `HEAD` are supported.
- `supply_orders`: Only `GET` and `HEAD` are supported.
- `warehouse_product_locations`: Only `GET` and `HEAD` are supported.
- `warehouses`: `GET`, `POST`, `PUT`, and `HEAD` are supported.
```

--------------------------------

### Advanced PrestaShop Module Uninstall Method

Source: https://docs.prestashop-project.org/1-6-documentation/english-documentation/developer-guide/creating-a-prestashop-module/creating-a-first-module

An enhanced uninstall() method for PrestaShop modules designed to remove data added during installation. This example specifically demonstrates deleting a configuration value previously set by the install() method. It ensures that module data is properly cleaned from the database.

```php
public function uninstall()
{
  if (!parent::uninstall() ||
    !Configuration::deleteByName('MYMODULE_NAME')
  ) {
    return false;
  }

  return true;
}
```

--------------------------------

### PHP: Include PrestaShop Webservice Library

Source: https://docs.prestashop-project.org/1-6-documentation/english-documentation/developer-guide/developer-tutorials/using-the-prestashop-web-service/web-service-tutorial/chapter-3-first-steps-accessing-the-web-service-and-listing-customers

Demonstrates how to include the PrestaShop webservice library file in your PHP script. This file must be in the same directory as your script or accessible via the include path.

```php
require_once( './PSWebServiceLibrary.php' );
```

--------------------------------

### Enable PrestaShop Debug Profiling

Source: https://docs.prestashop-project.org/1-6-documentation/english-documentation/system-administrator-guide

This code enables PrestaShop's code profiling tool, which displays page loading performance information at the bottom of each page. It should be disabled in production environments.

```php
define('_PS_DEBUG_PROFILING_', false); // Set to true to enable profiling, false to disable.
```

--------------------------------

### Translate Simple String in display.tpl - PrestaShop Module

Source: https://docs.prestashop-project.org/1-6-documentation/polska-dokumentacja/przewodnik-dewelopera/creating-a-prestashop-module/module-translation

Example of translating a simple string in a `display.tpl` file for a PrestaShop module. The string 'Welcome to this page!' is enclosed in the `{l s='...' mod='mymodule'}` function.

```smarty
{l s='Welcome to this page!' mod='mymodule'}
```

--------------------------------

### Get Shop Protocol in PrestaShop

Source: https://docs.prestashop-project.org/1-6-documentation/english-documentation/developer-guide/prestashop-cloud-specific-development

This code snippet shows how to retrieve the correct shop protocol (HTTP or HTTPS) using the `Tools::getShopProtocol()` method in PrestaShop. This is essential for constructing URLs with the appropriate protocol.

```php
Tools::getShopProtocol();
```

--------------------------------

### Get specific product using curl with PrestaShop API

Source: https://context7.com/context7/prestashop-project-1-6-documentation/llms.txt

This example demonstrates how to retrieve a specific product from the PrestaShop API using curl. It requires the Web Service to be enabled and an API key with the appropriate permissions.

```bash
curl -X GET \
  'https://yourdomain.com/api/products/1?output_format=JSON' \
  -H 'Authorization: Basic BASE64_ENCODED_API_KEY'
```

--------------------------------

### API Root Endpoint

Source: https://docs.prestashop-project.org/1-6-documentation/english-documentation/developer-guide/developer-tutorials/using-the-prestashop-web-service/web-service-tutorial/chapter-2-discovery-testing-your-access-to-the-web-service-with-the-browser

The root `/api/` endpoint provides a list of all available resources within the PrestaShop installation. Each resource is linked, allowing navigation to specific resource endpoints.

```APIDOC
## GET /api

### Description
Retrieves a list of all available API resources for the web service.

### Method
GET

### Endpoint
/api/

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
An XML document listing available resources with their respective endpoints and supported HTTP methods.

#### Response Example
```xml
<prestashop xmlns:xlink="http://www.w3.org/1999/xlink">
  <api shop_name="MYSHOP">
    <addresses>...</addresses>
    <carriers>...</carriers>
    ...
  </api>
</prestashop>
```
```

--------------------------------

### Executar o script de instalação do PrestaShop via CLI

Source: https://docs.prestashop-project.org/1-6-documentation/documentacao-em-portugues/comecando-com-prestashop/instalando-o-prestashop-usando-scripts-de-linha-de-comando

Este comando inicia o instalador do PrestaShop pela linha de comando. Ao executá-lo sem argumentos, ele exibirá todas as opções disponíveis. Funciona em ambientes com PHP instalado e acesso ao terminal.

```bash
$ php index_cli.php
```

--------------------------------

### Get product list using curl with PrestaShop API

Source: https://context7.com/context7/prestashop-project-1-6-documentation/llms.txt

This example demonstrates how to retrieve a list of products from the PrestaShop API using curl.  It requires the Web Service to be enabled and an API key with the appropriate permissions.

```bash
curl -X GET \
  'https://yourdomain.com/api/products?output_format=JSON' \
  -H 'Authorization: Basic BASE64_ENCODED_API_KEY'
```

--------------------------------

### PHP: Configure cURL Extension

Source: https://docs.prestashop-project.org/1-6-documentation/english-documentation/developer-guide/developer-tutorials/using-the-prestashop-web-service/web-service-tutorial/chapter-3-first-steps-accessing-the-web-service-and-listing-customers

Instructions for enabling the cURL extension in PHP for Windows and Linux/Mac systems. This is a prerequisite for using the PrestaShop webservice library.

```php
extension=php_curl.dll
```

```bash
sudo apt-get install php5-curl
```

--------------------------------

### PrestaShop Web Service API (REST)

Source: https://context7.com/context7/prestashop-project-1-6-documentation/llms.txt

Guides users on accessing and manipulating PrestaShop data remotely via its RESTful Web Service API. Includes examples for enabling the service, generating API keys, and making requests using cURL and PHP.

```APIDOC
## Web Service API Access (REST)

### Description
Interact with PrestaShop data remotely using the RESTful Web Service API. This requires enabling the Web Service in PrestaShop's back office and generating an API key with appropriate permissions.

### Method
GET, POST, PUT, DELETE

### Endpoint
`https://yourdomain.com/api/[resource]`

### Parameters
#### Query Parameters
- **output_format** (string) - Optional - Specifies the desired response format (e.g., `JSON`, `XML`). Defaults to XML.
- **display** (string) - Optional - Used for specific display options, often related to associations.
- **filter[field]** (string) - Optional - Filters resources by a specific field.
- **sort[field]** (string) - Optional - Sorts resources by a specific field.
- **limit** (int) - Optional - Limits the number of returned resources.
- **page** (int) - Optional - Specifies the page number for paginated results.

#### Path Parameters
- **resource** (string) - Required - The name of the resource to access (e.g., `products`, `customers`).
- **id** (int) - Required - The ID of the specific resource.

#### Request Body
- **XML or JSON payload** - Required for POST and PUT requests, containing the data to be created or updated.

### Request Example
```bash
# Get product list
curl -X GET 'https://yourdomain.com/api/products?output_format=JSON' -H 'Authorization: Basic BASE64_ENCODED_API_KEY'

# Get specific product
curl -X GET 'https://yourdomain.com/api/products/1?output_format=JSON' -H 'Authorization: Basic BASE64_ENCODED_API_KEY'
```

### Request Example (PHP cURL for adding a product)
```php
<?php
$api_key = 'YOUR_API_KEY';
$shop_url = 'https://yourdomain.com';

$xml = '<?xml version="1.0" encoding="UTF-8"?>
<prestashop xmlns:xlink="http://www.w3.org/1999/xlink">
    <product>
        <price><![CDATA[29.99]]></price>
        <active>1</active>
        <name>
            <language id="1"><![CDATA[New Product Name]]></language>
        </name>
        <link_rewrite>
            <language id="1"><![CDATA[new-product-name]]></language>
        </link_rewrite>
        <description>
            <language id="1"><![CDATA[Product description here]]></language>
        </description>
    </product>
</prestashop>';

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $shop_url.'/api/products');
curl_setopt($ch, CURLOPT_USERPWD, $api_key.':');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $xml);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: text/xml'));
$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>
```

### Response
#### Success Response (200 OK)
- **XML or JSON** - The requested resource representation or status of the operation.

#### Response Example
```json
// Example for GET /api/products?output_format=JSON:
[
  {
    "id": "1",
    "link": "https://yourdomain.com/api/products/1"
  }
]

// Example for POST (creation):
<?xml version="1.0" encoding="UTF-8"?>
<prestashop xmlns:xlink="http://www.w3.org/1999/xlink">
    <product>
        <id>123</id>
    </product>
</prestashop>
```

#### Error Response
- **400 Bad Request**: Invalid request format or parameters.
- **401 Unauthorized**: Missing or invalid API key.
- **404 Not Found**: The requested resource does not exist.
- **500 Internal Server Error**: Server-side error.

#### Error Response Example
```xml
<?xml version="1.0" encoding="UTF-8"?>
<prestashop>
    <error>
        <code><![CDATA[401]]></code>
        <message><![CDATA[Invalid id or authentication key.]]></message>
    </error>
</prestashop>
```
```

--------------------------------

### JavaScript IIFE Example - Airbnb Style

Source: https://docs.prestashop-project.org/1-6-documentation/english-documentation/developer-guide/coding-standards/javascript-coding-standards

Demonstrates an Immediately Invoked Function Expression (IIFE) in JavaScript, adhering to the Airbnb style guide. This pattern is useful for creating a private scope and avoiding global scope pollution. It includes conditional logic within braces.

```javascript
(function () {
  if (test) {
    return false;
  }
}());
```

--------------------------------

### Instalar PrestaShop com parâmetros de linha de comando

Source: https://docs.prestashop-project.org/1-6-documentation/documentacao-em-portugues/comecando-com-prestashop/instalando-o-prestashop-usando-scripts-de-linha-de-comando

Exemplo de como executar o script de instalação do PrestaShop fornecendo todos os parâmetros necessários diretamente na linha de comando. Isso inclui detalhes do domínio, servidor de banco de dados, nome do banco de dados, usuário e senha. Um argumento opcional para email também pode ser incluído para receber uma notificação ao final da instalação.

```bash
$ php index_cli.php --domain=examplo.com --db_server=sql.examplo.com --db_name=prestashop --db_user=root --db_password=123456789
```

--------------------------------

### Accessing Smarty Super-Variable Properties

Source: https://docs.prestashop-project.org/1-6-documentation/english-documentation/designer-guide/theme-templates-and-smarty

Provides examples of accessing information through the `$smarty` super-variable. This includes retrieving capture values, GET and POST parameters, the current timestamp (with optional formatting), and PHP constants. It also touches on legacy Smarty 2 foreach syntax and the recommended Smarty 3 equivalent.

```smarty
{$smarty.capture.myVariable}
{$smarty.get.name}
{$smarty.post.name}
{$smarty.now}
{$smarty.now|date_format:'%d-%m-%Y %H:%M:%S'}
{$smarty.const.CONSTANT_NAME}
```

```smarty
{* Smarty 3 syntax: *}
{$varName@property}
```

--------------------------------

### Update Module Position in PrestaShop Hook Programmatically

Source: https://context7.com/context7/prestashop-project-1-6-documentation/llms.txt

This example demonstrates how to programmatically control the display order of a module within a specific hook. It uses `Module::getInstanceByName` to get the module instance and `updatePosition` to set its position relative to other modules in the specified hook. Lower numbers indicate earlier display.

```php
$module_instance = Module::getInstanceByName('mymodule');
$module_instance->updatePosition(
    Hook::getIdByName('displayLeftColumn'),  // hook id
    0,                                        // way (0 = down, 1 = up)
    1                                         // position
);
```
Tokens:
Raw