mothership-ec/cog-mothership-returns

This package is abandoned and no longer maintained. No replacement package was suggested.

Cog module for order returns in Mothership

5.4.0 2016-05-09 15:09 UTC

Requires

• php: >=5.4.0
• mothership-ec/cog: ~4.10
• mothership-ec/cog-mothership-commerce: ~5.0
• mothership-ec/cog-mothership-ecommerce: ~3.7
• mothership-ec/cog-mothership-reports: ~2.1

GPL-3.0+

• The Mothership Development Team

• products
• orders
• order
• money
• commerce
• cog
• mothership
• returns

README

description

Installation

Add "message/cog-mothership-returns": "1.1.*" to your composer.json.

Assembling a new return

The assembler helps you build a new return ready for passing to the create decorator.

This service is available via:

$assembler = $this->get('return.assembler');

If you have an existing return you can pass this into the assembler with:

$assembler->setReturn($return);

And retrieve the assembled return once you are finished building it:

$return = $assembler->getReturn();

If your return has no associated order, i.e. is standalone, you should set the currency. This defaults to 'GBP':

$assembler->setCurrency('EUR');

You can set the return item from either a instance of Commerce\Order\Entity\Item\Item or Commerce\Product\Unit\Unit.

// Standard
$orderItem = $this->get('order.item.loader')->getByID(1);
$assembler->setReturnItem($orderItem);

// Standalone
$productUnit = $this->get('product.unit.loader')->getByID(1);
$assembler->setReturnItem($productUnit);

Notes

Namespaces and classes are called OrderReturn due to PHP having return as a reserved word.