webgriffe/amp-magento

Magento REST Api wrapper to use with Amp PHP framework.

v3.0.0-ALPHA.3 2024-12-10 13:50 UTC

Requires

• php: ~7.3.0|~7.4.0|~8.0.0|~8.1.0|~8.2.0|~8.3.0
• ext-json: *
• ext-xml: *
• amphp/amp: ^2.1
• amphp/artax: ^3.0
• amphp/byte-stream: ^1.6
• amphp/file: ^0.3
• amphp/uri: ^0.1
• cweagans/composer-patches: ^1.7
• justinrainbow/json-schema: ^5.2
• nikic/fast-route: ^1.3
• phpunit/phpunit: ^9.0
• webmozart/assert: ^1.4

Requires (Dev)

• phpstan/extension-installer: ^1.0
• phpstan/phpstan: ^1.8
• phpstan/phpstan-webmozart-assert: ^1.2
• squizlabs/php_codesniffer: ^3.4

MIT

• Webgriffe SRL

README

Magento REST Api wrapper to use with Amp PHP framework.

Installation

Require this package using Composer:

composer require webgriffe/amp-magento

## Usage

ApiClient is the main class of this library: it contains methods that wrap Magento REST API.

<?php

use Amp\Artax\DefaultClient;
use Webgriffe\AmpMagento\ApiClient;

require_once __DIR__.'/vendor/autoload.php';

$client = new ApiClient(
    new DefaultClient(),
    [
        'baseUrl' => 'http://magento.base.url',
        'username' => 'magento-username',
        'password' => 'magento-password'
    ]
);

$order = \Amp\Promise\wait($client->getOrder(1));
var_dump($order);

In Memory Magento

The folder InMemoryMagento contains a fake Magento server and client to be used for automated testing. Unit tests in tests/ApiClientTest.php show how to use InMemoryMagento.

Contributing

To contribute simply fork this repository, do your changes and then propose a pull requests. You should run coding standards check and tests as well:

vendor/bin/phpcs --standard=PSR2 src
vendor/bin/phpunit

License

This library is under the MIT license. See the complete license in the LICENSE file.

Credits

Developed by Webgriffe®