README

Laravel wrapper for Prestashop Web Service Library

Installation

Require this package with composer using the following command:

composer require dansmaculotte/laravel-prestashop-webservice

Finally publish the configuration file using the artisan command

php artisan vendor:publish --provider="DansMaCulotte\PrestashopWebService\PrestashopWebServiceProvider"

Configuration

Open the published configuration file at config/prestashop-webservice.php:

return [
    'url' => 'http://domain.com',
    'token' => '',
    'debug' => env('APP_DEBUG', false)
];

Then populate the url field with the root url of the targeted Prestashop installation and token field with the API token obtained from Prestashop control panel in Web Service section. If debug is true Prestashop will return debug information when responding to API requests.

Usage

You may use the Prestashop Web Service wrapper in two ways:

Using the dependency or method injection

...
use DansMaCulotte\PrestashopWebService\PrestashopWebService;

class FooController extends Controller
{
    private $prestashop;
    
    public function __construct(PrestashopWebService $prestashop)
    {
        $this->prestashop = $prestashop;
    }
    
    public function bar()
    {
        $opt['resource'] = 'customers';
        $xml = $this->prestashop->get($opt);
    }
}

Using the Facade

...
use Prestashop;

...

public function bar()
{   
    $opt['resource'] = 'customers';
    $xml = Prestashop::get($opt);
}

Prestashop Underlying library usage

You may find complete documentation and tutorials regarding Prestashop Web Service Library in the Prestashop Documentation.

Helper methods

I've added some helper methods to reduce development time:

Retrieving resource schema and filling data for posting

You may call getSchema() method to retrieve the requested resource schema. You may then fill the schema with an associative array of data with fillSchema() method.

$xmlSchema = Prestashop::getSchema('categories'); //returns a SimpleXMLElement instance with the desired schema

$data = [
    'name' => 'Clothes',
    'link_rewrite' => 'clothes',
    'active' => true,
];

$postXml = Prestashop::fillSchema($xmlSchema, $data); 

//The xml is now ready for being sent back to the web service to create a new category

$response = Prestashop::add(['resource' => 'categories', 'postXml' => $postXml->asXml()]);

Preserving not filled nodes from removal

The default behaviour for the fillSchema method is to remove the nodes that are not filled. If you want to preserve those nodes (typical update situation) put the third parameter as false

$putXml = Prestashop::fillSchema($xmlSchema, $data, false);

Removing specific nodes

When preserving unfilled nodes from removal you may specify some nodes to be removed as the fourth argument (this may be useful when updating a resource with some readonly nodes that would trigger error 400):

$putXml = Prestashop::fillSchema($xmlSchema, $data, false, ['manufacturer_name', 'quantity']);
//manufacturer_name and quantity only will be removed from the XML

Handling language values

If the node has a language child you may use a simple string for the value if your shop has only one language installed.

/*
    xml node with one language child example
    ...
    <name>
    <language id="1"/>
    </name>
    ...
*/
$data = ['name' => 'Clothes'];

If your shops has more than one language installed you may pass the node value as an array where the key is the language ID.

/*
    xml node with n language children example 
    ...
    <name>
    <language id="1"/>
    <language id="2"/>
    </name>
    ... 
*/
$data = [
    'name' => [
        1 => 'Clothes',
        2 => 'Abbigliamento',
    ],
];

Please note that if you don't provide an array of values keyed by the language ID all language values will have the same value.

Handling associations with several siblings

Provided you got a node with several associations like category association for products or similar as from this extract of product schema:

...
<associations>
<categories>
<category>
<id/>
</category>
</categories>
<product_features>
<product_feature>
<id/>
<id_feature_value/>
</product_feature>
</product_features>
...

You can prepare the array data map for the fillSchema method in this way:

$data => [
    ...
    'associations' => [
        'categories' => [
            [ 'category' => ['id' => 4] ],
            [ 'category' => ['id' => 5] ],
            [ 'category' => ['id' => 11] ],
        ],
        'product_features' => [
            [
                'product_feature' => [
                    'id' => 5,
                    'id_feature_value' => 94,
                ],
            ],
            [
                'product_feature' => [
                    'id' => 1,
                    'id_feature_value' => 2,
                ],
            ],
        ],
    ],
];

The result will be this as expected:

...
<associations>
    <categories>
        <category>
            <id>4</id>
        </category>
        <category>
            <id>5</id>
        </category>
        <category>
            <id>11</id>
        </category>
    </categories>
    <product_features>
        <product_feature>
            <id>5</id>
            <id_feature_value>94</id_feature_value>
        </product_feature>
        <product_feature>
            <id>1</id>
            <id_feature_value>2</id_feature_value>
        </product_feature>
    </product_features>
...

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

License

The MIT License (MIT). Please see License File for more information.

dansmaculotte / laravel-prestashop-webservice

Maintainers

Details