Smalot\Magento\Order\OrderCreditMemo

Complexity

Total Complexity

5

Size/Duplication

Total Lines	78
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	3
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	addComment()	0	4	1
A	cancel()	0	4	1
A	create()	0	10	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 OrderCreditMemo
 *
 * @package Smalot\Magento\Order
 */
class OrderCreditMemo extends MagentoModuleAbstract
{
    /**
     * Allows you to add a new comment to an existing credit memo.
     * Email notification can be sent to the user email.
     *
     * @param string $creditmemoIncrementId
     * @param string $comment
     * @param string $notifyCustomer
     * @param string $includeComment
     *
     * @return ActionInterface
     */
    public function addComment($creditmemoIncrementId, $comment = null, $notifyCustomer = null, $includeComment = null)

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

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

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

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

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

    /**
     * Allows you to cancel an existing credit memo.
     *
     * @param string $creditmemoIncrementId
     *
     * @return ActionInterface
     */
    public function cancel($creditmemoIncrementId)

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

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

    /**
     * Allows you to create a new credit memo for the invoiced order.
     * Comments can be added and an email notification can be sent to the user email.
     *
     * @param string $orderIncrementId
     * @param array  $creditmemoData
     * @param string $comment
     * @param int    $notifyCustomer
     * @param int    $includeComment
     * @param string $refundToStoreCreditAmount
     *
     * @return ActionInterface
     */
    public function create(
        $orderIncrementId,

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

        $creditmemoData = null,

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

        $comment = null,

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

        $notifyCustomer = null,

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

        $includeComment = null,

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

        $refundToStoreCreditAmount = null

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

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

    /**
     * Allows you to retrieve full information about the specified credit memo.
     *
     * @param string $creditmemoIncrementId
     *
     * @return ActionInterface
     */
    public function getInfo($creditmemoIncrementId)

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

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

    /**
     * Allows you to retrieve the list of credit memos by filters.
     *
     * @param array $filters
     *
     * @return ActionInterface
     */
    public function getList($filters)

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

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