Complaint::create() - Code Metrics - Inspection of "Fixed typo in namespace (#330)" - mailgun/mailgun-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1fa199...f73445 )

by Tobias

created 2017-04-07 19:32 UTC

Complaint::create() A

↳ Parent: Complaint

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	11
ccs	0
cts	6
cp	0
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	6
nc	1
nop	5
crap	2

<?php

/*
 * Copyright (C) 2013-2016 Mailgun
 *
 * This software may be modified and distributed under the terms
 * of the MIT license. See the LICENSE file for details.
 */

namespace Mailgun\Api\Suppression;

use Mailgun\Api\HttpApi;
use Mailgun\Api\Pagination;
use Mailgun\Assert;
use Mailgun\Model\Suppression\Complaint\CreateResponse;
use Mailgun\Model\Suppression\Complaint\DeleteResponse;
use Mailgun\Model\Suppression\Complaint\IndexResponse;
use Mailgun\Model\Suppression\Complaint\ShowResponse;

/**
 * @see https://documentation.mailgun.com/api-suppressions.html#complaints
 *
 * @author Sean Johnson <[email protected]>
 */
class Complaint extends HttpApi
{
    use Pagination;

    /**
     * @param string $domain Domain to get complaints for
     * @param int    $limit  optional
     *
     * @return IndexResponse
     */
    public function index($domain, $limit = 100)
    {
        Assert::stringNotEmpty($domain);
        Assert::range($limit, 1, 10000, 'Limit parameter must be between 1 and 10000');

        $params = [
            'limit' => $limit,
        ];

        $response = $this->httpGet(sprintf('/v3/%s/complaints', $domain), $params);

        return $this->hydrateResponse($response, IndexResponse::class);
    }

    /**
     * @param string $domain  Domain to show complaint for
     * @param string $address Complaint address
     *
     * @return ShowResponse
     */
    public function show($domain, $address)
    {
        Assert::stringNotEmpty($domain);
        Assert::stringNotEmpty($address);
        $response = $this->httpGet(sprintf('/v3/%s/complaints/%s', $domain, $address));

        return $this->hydrateResponse($response, ShowResponse::class);
    }

    /**
     * @param string $domain  Domain to create complaint for
     * @param string $address Complaint address
     * @param array  $params  optional
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     *
     * @return CreateResponse
     */
    public function create($domain, $address, $code = null, $error = null, $createdAt = null)

    {
        Assert::stringNotEmpty($domain);
        Assert::stringNotEmpty($address);

        $params['address'] = $address;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

        $response = $this->httpPost(sprintf('/v3/%s/complaints', $domain), $params);

        return $this->hydrateResponse($response, CreateResponse::class);
    }

    /**
     * @param string $domain  Domain to delete complaint for
     * @param string $address Complaint address
     *
     * @return DeleteResponse
     */
    public function delete($domain, $address)
    {
        Assert::stringNotEmpty($domain);
        Assert::stringNotEmpty($address);

        $response = $this->httpDelete(sprintf('/v3/%s/complaints/%s', $domain, $address));

        return $this->hydrateResponse($response, DeleteResponse::class);
    }

    /**
     * @param string $domain Domain to delete all bounces for
     *
     * @return DeleteResponse
     */
    public function deleteAll($domain)
    {
        Assert::stringNotEmpty($domain);

        $response = $this->httpDelete(sprintf('/v3/%s/complaints', $domain));

        return $this->hydrateResponse($response, DeleteResponse::class);
    }
}


1			<?php
2
3			/*
4			* Copyright (C) 2013-2016 Mailgun
5			*
6			* This software may be modified and distributed under the terms
7			* of the MIT license. See the LICENSE file for details.
8			*/
9
10			namespace Mailgun\Api\Suppression;
11
12			use Mailgun\Api\HttpApi;
13			use Mailgun\Api\Pagination;
14			use Mailgun\Assert;
15			use Mailgun\Model\Suppression\Complaint\CreateResponse;
16			use Mailgun\Model\Suppression\Complaint\DeleteResponse;
17			use Mailgun\Model\Suppression\Complaint\IndexResponse;
18			use Mailgun\Model\Suppression\Complaint\ShowResponse;
19
20			/**
21			* @see https://documentation.mailgun.com/api-suppressions.html#complaints
22			*
23			* @author Sean Johnson <[email protected]>
24			*/
25			class Complaint extends HttpApi
26			{
27			use Pagination;
28
29			/**
30			* @param string $domain Domain to get complaints for
31			* @param int $limit optional
32			*
33			* @return IndexResponse
34			*/
35			public function index($domain, $limit = 100)
36			{
37			Assert::stringNotEmpty($domain);
38			Assert::range($limit, 1, 10000, 'Limit parameter must be between 1 and 10000');
39
40			$params = [
41			'limit' => $limit,
42			];
43
44			$response = $this->httpGet(sprintf('/v3/%s/complaints', $domain), $params);
45
46			return $this->hydrateResponse($response, IndexResponse::class);
47			}
48
49			/**
50			* @param string $domain Domain to show complaint for
51			* @param string $address Complaint address
52			*
53			* @return ShowResponse
54			*/
55			public function show($domain, $address)
56			{
57			Assert::stringNotEmpty($domain);
58			Assert::stringNotEmpty($address);
59			$response = $this->httpGet(sprintf('/v3/%s/complaints/%s', $domain, $address));
60
61			return $this->hydrateResponse($response, ShowResponse::class);
62			}
63
64			/**
65			* @param string $domain Domain to create complaint for
66			* @param string $address Complaint address
67			* @param array $params optional
			0 ignored issues – show Bug introduced 2017-02-20 20:01 UTC by Report Bug Copy Issue Report There is no parameter named `$params`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
68			*
69			* @return CreateResponse
70			*/
71			public function create($domain, $address, $code = null, $error = null, $createdAt = null)
			0 ignored issues – show Unused Code introduced 2017-02-20 20:01 UTC by Report Bug Copy Issue Report The parameter `$code` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2017-02-20 20:01 UTC by Report Bug Copy Issue Report The parameter `$error` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2017-02-20 20:01 UTC by Report Bug Copy Issue Report The parameter `$createdAt` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
72			{
73			Assert::stringNotEmpty($domain);
74			Assert::stringNotEmpty($address);
75
76			$params['address'] = $address;
			0 ignored issues – show Coding Style Comprehensibility introduced 2017-02-20 20:01 UTC by Report Bug Copy Issue Report `$params` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$params = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
77
78			$response = $this->httpPost(sprintf('/v3/%s/complaints', $domain), $params);
79
80			return $this->hydrateResponse($response, CreateResponse::class);
81			}
82
83			/**
84			* @param string $domain Domain to delete complaint for
85			* @param string $address Complaint address
86			*
87			* @return DeleteResponse
88			*/
89			public function delete($domain, $address)
90			{
91			Assert::stringNotEmpty($domain);
92			Assert::stringNotEmpty($address);
93
94			$response = $this->httpDelete(sprintf('/v3/%s/complaints/%s', $domain, $address));
95
96			return $this->hydrateResponse($response, DeleteResponse::class);
97			}
98
99			/**
100			* @param string $domain Domain to delete all bounces for
101			*
102			* @return DeleteResponse
103			*/
104			public function deleteAll($domain)
105			{
106			Assert::stringNotEmpty($domain);
107
108			$response = $this->httpDelete(sprintf('/v3/%s/complaints', $domain));
109
110			return $this->hydrateResponse($response, DeleteResponse::class);
111			}
112			}
113

mailgun / mailgun-php

Push — master ( 1fa199...f73445 )

Complaint::create() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like