Smalot\Magento\Order\OrderInvoice

Complexity

Total Complexity

6

Size/Duplication

Total Lines	82
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	4
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	addComment()	0	4	1
A	cancel()	0	4	1
A	capture()	0	4	1
A	create()	0	4	1
A	getInfo()	0	4	1
A	getList()	0	4	1

<?php

/**
 * @file
 *          Magento API Client (SOAP v1).
 *          Allows wrappers for each call, dependencies injections
 *          and code completion.
 *
 * @author  Sébastien MALOT <sebastien@malot.fr>
 * @license MIT
 * @url     <https://github.com/smalot/magento-client>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Smalot\Magento\Order;

use Smalot\Magento\ActionInterface;
use Smalot\Magento\MagentoModuleAbstract;

/**
 * Class OrderInvoice
 *
 * @package Smalot\Magento\Order
 */
class OrderInvoice extends MagentoModuleAbstract
{
    /**
     * Allows you to add a new comment to the order invoice.
     *
     * @param string $invoiceIncrementId
     * @param string $comment
     * @param int    $email
     * @param int    $includeComment
     *
     * @return ActionInterface
     */
    public function addComment($invoiceIncrementId, $comment = null, $email = null, $includeComment = null)

The parameter $invoiceIncrementId is not used and could be removed.

The parameter $comment is not used and could be removed.

The parameter $email is not used and could be removed.

The parameter $includeComment is not used and could be removed.

    {
        return $this->__createAction('order_invoice.addComment', func_get_args());
    }

    /**
     * Allows you to cancel the required invoice.
     * Note that not all order invoices can be canceled.
     * Only some payment methods support canceling the order invoice
     * (e.g., Google Checkout, PayPal Pro, PayPal Express Checkout).
     *
     * @param string $invoiceIncrementId
     *
     * @return ActionInterface
     */
    public function cancel($invoiceIncrementId)

The parameter $invoiceIncrementId is not used and could be removed.

    {
        return $this->__createAction('order_invoice.cancel', func_get_args());
    }

    /**
     * Allows you to capture the required invoice.
     * Note that not all order invoices can be captured.
     * Only some payment methods support capturing the order invoice (e.g., PayPal Pro).
     *
     * @param string $invoiceIncrementId
     *
     * @return ActionInterface
     */
    public function capture($invoiceIncrementId)

The parameter $invoiceIncrementId is not used and could be removed.

    {
        return $this->__createAction('order_invoice.capture', func_get_args());
    }

    /**
     * Allows you to create a new invoice for an order.
     *
     * @param string $orderIncrementId
     * @param array  $itemsQty
     * @param string $comment
     * @param string $email
     * @param string $includeComment
     *
     * @return ActionInterface
     */
    public function create($orderIncrementId, $itemsQty, $comment, $email, $includeComment)

The parameter $orderIncrementId is not used and could be removed.

The parameter $itemsQty is not used and could be removed.

The parameter $comment is not used and could be removed.

The parameter $email is not used and could be removed.

The parameter $includeComment is not used and could be removed.

    {
        return $this->__createAction('order_invoice.create', func_get_args());
    }

    /**
     * @param string $invoiceIncrementId
     *
     * @return ActionInterface
     */
    public function getInfo($invoiceIncrementId)

The parameter $invoiceIncrementId is not used and could be removed.

    {
        return $this->__createAction('order_invoice.info', func_get_args());
    }

    /**
     * @param array $filters
     *
     * @return ActionInterface
     */
    public function getList($filters = null)

The parameter $filters is not used and could be removed.

    {
        return $this->__createAction('order_invoice.list', func_get_args());
    }
}