arsengoian/commerce-ml

Easy-peasy CommerceML 2.10 PHP library

dev-master 2020-11-27 11:04 UTC

Requires

• php: >=7.1.0
• ext-dom: *
• ext-json: *

Requires (Dev)

• phpunit/phpunit: 6.5

Apache-2.0

• Arsen Goian

README

Simple and requirements-free SimpleXML-based CommerceML parser and builder.

Features

Usage:

 composer require arsengoian/commerce-ml

Parse CommerceML:

use CommerceML\Client;
/**
 * @var string $input
 */
$commercialInformation = Client::toCommerceML($input);

Build CommerceML string from CommerceML object:

use CommerceML\Client;
/**
 * @var CommerceML\Implementation\CommercialInformation $commercialInformation
 */
$output = Client::toString($commercialInformation);

Namespaces:

• CommerceML\Nodes - abstract classes representing nodes. May have a custom implementation, including database storage
• CommerceML\Implementation - simplest implementations storing variables in protected fields. This implementation will be returned while parsing. Nodes collecting arrays also implement ArrayAccess, IteratorAggregate and Countable.
• CommerceML\Constructors - implementations with constructors, extend those from CommerceML\Implementation. Use these while building a custom CommerceML tree.

Advanced:

To use custom classes while parsing, before calling Client::toString(), do:

use CommerceML\Node\Node

Node::overrideImplementations([
    ProductCustomImplementation::class, // Must inherit from CommerceML\Implementations\Product
]);

Contributions

Current implementation of the library doesn't cover all possible CommerceML nodes. E.g. product import nodes aren't covered.

Also complete test coverage would be welcomed.