MangoPayConstants::isEventTypeOk() - Code Metrics - Inspection of "Handling merge" - PartFire/MangoPayBundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( b0e1d7...34bc8c )

unknown

created 2017-01-21 11:02 UTC

MangoPayConstants::isEventTypeOk() A

↳ Parent: MangoPayConstants

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	1

<?php
/**
 * Created by Graham Owens ([email protected])
 * Company: PartFire Ltd (www.partfire.co.uk)
 * Console: Discovery
 *
 * User:    gra
 * Date:    31/12/16
 * Time:    00:53
 * Project: PartFire MangoPay Bundle
 * File:    MangoPayConstants.php
 *
 **/

namespace PartFire\MangoPayBundle;


class MangoPayConstants
{
    const       NATURAL_PERSON_TYPE                 = 'NATURAL';
    const       LEGAL_PERSON_TYPE                   = 'LEGAL';

    //  https://docs.mangopay.com/endpoints/v2.01/users#e259_create-a-legal-user

    //  May also help https://www.gov.uk/business-legal-structures/overview

    const       LEGAL_PERSON_TYPE_SOLETRADER        = 'SOLETRADER';
    const       LEGAL_PERSON_TYPE_ORGANISATION      = 'ORGANIZATION';
    const       LEGAL_PERSON_TYPE_BUSINESS          = 'BUSINESS';

    //  https://docs.mangopay.com/endpoints/v2.01/users#e253_the-user-object

    const       KYC_LEVEL_LIGHT                     = 'LIGHT';
    const       KYC_LEVEL_REGULAR                   = 'REGULAR';

    // https://docs.mangopay.com/endpoints/v2/users#e254_the-natural-user-object

    // KYC Doc types = https://docs.mangopay.com/endpoints/v2.01/kyc-documents#e205_create-a-kyc-document
    const       IDENTITY_PROOF                      = 'IDENTITY_PROOF';
    const       REGISTRATION_PROOF                  = 'REGISTRATION_PROOF';
    const       ARTICLES_OF_ASSOCIATION             = 'ARTICLES_OF_ASSOCIATION';
    const       SHAREHOLDER_DECLARATION             = 'SHAREHOLDER_DECLARATION';
    const       ADDRESS_PROOF                       = 'ADDRESS_PROOF';

    // KYC Doc Refusal reasons

    const       DOCUMENT_UNREADABLE                 = 'DOCUMENT_UNREADABLE';
    const       DOCUMENT_NOT_ACCEPTED               = 'DOCUMENT_NOT_ACCEPTED';
    const       DOCUMENT_HAS_EXPIRED                = 'DOCUMENT_HAS_EXPIRED';
    const       DOCUMENT_INCOMPLETE                 = 'DOCUMENT_INCOMPLETE';
    const       DOCUMENT_MISSING                    = 'DOCUMENT_MISSING';
    const       DOCUMENT_DO_NOT_MATCH_USER_DATA     = 'DOCUMENT_DO_NOT_MATCH_USER_DATA';
    const       DOCUMENT_DO_NOT_MATCH_ACCOUNT_DATA  = 'DOCUMENT_DO_NOT_MATCH_ACCOUNT_DATA';
    const       SPECIFIC_CASE                       = 'SPECIFIC_CASE';
    const       DOCUMENT_FALSIFIED                  = 'DOCUMENT_FALSIFIED';
    const       UNDERAGE_PERSON                     = 'UNDERAGE_PERSON';
    const       OTHER                               = 'OTHER';
    const       TRIGGER_PEPS                        = 'TRIGGER_PEPS';
    const       TRIGGER_SANCTIONS_LISTS             = 'TRIGGER_SANCTIONS_LISTS';
    const       TRIGGER_INTERPOL                    = 'TRIGGER_INTERPOL';

    // KYC Doc Status

    const       CREATED                             = 'CREATED';
    const       VALIDATION_ASKED                    = 'VALIDATION_ASKED';
    const       VALIDATED                           = 'VALIDATED';
    const       REFUSED                             = 'REFUSED';

    // Hook Status
    const       HOOK_NEW                            = "HOOK_NEW";
    const       HOOK_ACTIONED                       = "HOOK_ACTIONED";

    public static function getKYCRefusalArray() : array
    {
        return [
            self::DOCUMENT_UNREADABLE,
            self::DOCUMENT_NOT_ACCEPTED,
            self::DOCUMENT_HAS_EXPIRED,
            self::DOCUMENT_INCOMPLETE,
            self::DOCUMENT_MISSING,
            self::DOCUMENT_DO_NOT_MATCH_USER_DATA,
            self::DOCUMENT_DO_NOT_MATCH_ACCOUNT_DATA,
            self::SPECIFIC_CASE,
            self::DOCUMENT_FALSIFIED,
            self::UNDERAGE_PERSON,
            self::OTHER,
            self::TRIGGER_PEPS,
            self::TRIGGER_SANCTIONS_LISTS,
            self::TRIGGER_INTERPOL
        ];
    }

    public static function getIncomeRangeFromId(int $id) : string
    {
        switch ($id) {
            case 1:
                $range = "incomes <18K€";
                break;
            case 2:
                $range = "incomes between 18 and 30K€";
                break;
            case 3:
                $range = "incomes between 30 and 50K€";
                break;
            case 4:
                $range = "incomes between 50 and 80K€";
                break;
            case 5:
                $range = "incomes between 80 and 120K€";
                break;
            case 6:
                $range = "incomes>120K€";
                break;
            default:
                $range = "Unknown range";
        }

        return $range;
    }

    public static function isPersonTypeOk($personType)
    {
        return in_array($personType, self::getPersonTypeArray());
    }

    public static function getPersonTypeArray()
    {
        return [
            self::NATURAL_PERSON_TYPE,
            self::LEGAL_PERSON_TYPE
        ];
    }

    public static function isDocumentTypeOk($documentType)
    {
        return in_array($documentType, self::getDocumentTypeArray());
    }

    public static function getDocumentTypeArray()
    {
        return [
            self::IDENTITY_PROOF,
            self::REGISTRATION_PROOF,
            self::ARTICLES_OF_ASSOCIATION,
            self::SHAREHOLDER_DECLARATION,
            self::ADDRESS_PROOF
        ];
    }

    //  https://docs.mangopay.com/endpoints/v2.01/hooks#e246_the-hook-object
    // 16th Jan 2017

    public static function isEventTypeOk($eventType)
    {
        return in_array($eventType, self::getAllEventTypes());
    }

    public static function getAllEventTypes()
    {
        return [
            'PAYIN_NORMAL_CREATED',
            'PAYIN_NORMAL_SUCCEEDED',
            'PAYIN_NORMAL_FAILED',

            'PAYOUT_NORMAL_CREATED',
            'PAYOUT_NORMAL_SUCCEEDED',
            'PAYOUT_NORMAL_FAILED',

            'TRANSFER_NORMAL_CREATED',
            'TRANSFER_NORMAL_SUCCEEDED',
            'TRANSFER_NORMAL_FAILED',

            'PAYIN_REFUND_CREATED',
            'PAYIN_REFUND_SUCCEEDED',
            'PAYIN_REFUND_FAILED',

            'PAYOUT_REFUND_CREATED',
            'PAYOUT_REFUND_SUCCEEDED',
            'PAYOUT_REFUND_FAILED',

            'TRANSFER_REFUND_CREATED',
            'TRANSFER_REFUND_SUCCEEDED',
            'TRANSFER_REFUND_FAILED',

            'PAYIN_REPUDIATION_CREATED',
            'PAYIN_REPUDIATION_SUCCEEDED',
            'PAYIN_REPUDIATION_FAILED',

            'KYC_CREATED',
            'KYC_SUCCEEDED',
            'KYC_FAILED',
            'KYC_VALIDATION_ASKED',

            'DISPUTE_DOCUMENT_CREATED',
            'DISPUTE_DOCUMENT_VALIDATION_ASKED',
            'DISPUTE_DOCUMENT_SUCCEEDED',
            'DISPUTE_DOCUMENT_FAILED',

            'DISPUTE_CREATED',
            'DISPUTE_SUBMITTED',
            'DISPUTE_ACTION_REQUIRED',
            'DISPUTE_FURTHER_ACTION_REQUIRED',
            'DISPUTE_CLOSED',
            'DISPUTE_SENT_TO_BANK',

            'TRANSFER_SETTLEMENT_CREATED',
            'TRANSFER_SETTLEMENT_SUCCEEDED',
            'TRANSFER_SETTLEMENT_FAILED',

            'MANDATE_CREATED',
            'MANDATED_FAILED',
            'MANDATE_ACTIVATED',
            'MANDATE_SUBMITTED',

            'PREAUTHORIZATION_PAYMENT_WAITING',
            // (not currently available) 'PREAUTHORIZATION_PAYMENT_EXPIRED',

            'PREAUTHORIZATION_PAYMENT_CANCELED',
            'PREAUTHORIZATION_PAYMENT_VALIDATED',

        ];
    }
}

1			<?php
2			/**
3			* Created by Graham Owens ([email protected])
4			* Company: PartFire Ltd (www.partfire.co.uk)
5			* Console: Discovery
6			*
7			* User: gra
8			* Date: 31/12/16
9			* Time: 00:53
10			* Project: PartFire MangoPay Bundle
11			* File: MangoPayConstants.php
12			*
13			**/
14
15			namespace PartFire\MangoPayBundle;
16
17
18			class MangoPayConstants
19			{
20			const NATURAL_PERSON_TYPE = 'NATURAL';
21			const LEGAL_PERSON_TYPE = 'LEGAL';
22
23			// https://docs.mangopay.com/endpoints/v2.01/users#e259_create-a-legal-user
24
25			// May also help https://www.gov.uk/business-legal-structures/overview
26
27			const LEGAL_PERSON_TYPE_SOLETRADER = 'SOLETRADER';
28			const LEGAL_PERSON_TYPE_ORGANISATION = 'ORGANIZATION';
29			const LEGAL_PERSON_TYPE_BUSINESS = 'BUSINESS';
30
31			// https://docs.mangopay.com/endpoints/v2.01/users#e253_the-user-object
32
33			const KYC_LEVEL_LIGHT = 'LIGHT';
34			const KYC_LEVEL_REGULAR = 'REGULAR';
35
36			// https://docs.mangopay.com/endpoints/v2/users#e254_the-natural-user-object
37
38			// KYC Doc types = https://docs.mangopay.com/endpoints/v2.01/kyc-documents#e205_create-a-kyc-document
39			const IDENTITY_PROOF = 'IDENTITY_PROOF';
40			const REGISTRATION_PROOF = 'REGISTRATION_PROOF';
41			const ARTICLES_OF_ASSOCIATION = 'ARTICLES_OF_ASSOCIATION';
42			const SHAREHOLDER_DECLARATION = 'SHAREHOLDER_DECLARATION';
43			const ADDRESS_PROOF = 'ADDRESS_PROOF';
44
45			// KYC Doc Refusal reasons
46
47			const DOCUMENT_UNREADABLE = 'DOCUMENT_UNREADABLE';
48			const DOCUMENT_NOT_ACCEPTED = 'DOCUMENT_NOT_ACCEPTED';
49			const DOCUMENT_HAS_EXPIRED = 'DOCUMENT_HAS_EXPIRED';
50			const DOCUMENT_INCOMPLETE = 'DOCUMENT_INCOMPLETE';
51			const DOCUMENT_MISSING = 'DOCUMENT_MISSING';
52			const DOCUMENT_DO_NOT_MATCH_USER_DATA = 'DOCUMENT_DO_NOT_MATCH_USER_DATA';
53			const DOCUMENT_DO_NOT_MATCH_ACCOUNT_DATA = 'DOCUMENT_DO_NOT_MATCH_ACCOUNT_DATA';
54			const SPECIFIC_CASE = 'SPECIFIC_CASE';
55			const DOCUMENT_FALSIFIED = 'DOCUMENT_FALSIFIED';
56			const UNDERAGE_PERSON = 'UNDERAGE_PERSON';
57			const OTHER = 'OTHER';
58			const TRIGGER_PEPS = 'TRIGGER_PEPS';
59			const TRIGGER_SANCTIONS_LISTS = 'TRIGGER_SANCTIONS_LISTS';
60			const TRIGGER_INTERPOL = 'TRIGGER_INTERPOL';
61
62			// KYC Doc Status
63
64			const CREATED = 'CREATED';
65			const VALIDATION_ASKED = 'VALIDATION_ASKED';
66			const VALIDATED = 'VALIDATED';
67			const REFUSED = 'REFUSED';
68
69			// Hook Status
70			const HOOK_NEW = "HOOK_NEW";
71			const HOOK_ACTIONED = "HOOK_ACTIONED";
72
73			public static function getKYCRefusalArray() : array
74			{
75			return [
76			self::DOCUMENT_UNREADABLE,
77			self::DOCUMENT_NOT_ACCEPTED,
78			self::DOCUMENT_HAS_EXPIRED,
79			self::DOCUMENT_INCOMPLETE,
80			self::DOCUMENT_MISSING,
81			self::DOCUMENT_DO_NOT_MATCH_USER_DATA,
82			self::DOCUMENT_DO_NOT_MATCH_ACCOUNT_DATA,
83			self::SPECIFIC_CASE,
84			self::DOCUMENT_FALSIFIED,
85			self::UNDERAGE_PERSON,
86			self::OTHER,
87			self::TRIGGER_PEPS,
88			self::TRIGGER_SANCTIONS_LISTS,
89			self::TRIGGER_INTERPOL
90			];
91			}
92
93			public static function getIncomeRangeFromId(int $id) : string
94			{
95			switch ($id) {
96			case 1:
97			$range = "incomes <18K€";
98			break;
99			case 2:
100			$range = "incomes between 18 and 30K€";
101			break;
102			case 3:
103			$range = "incomes between 30 and 50K€";
104			break;
105			case 4:
106			$range = "incomes between 50 and 80K€";
107			break;
108			case 5:
109			$range = "incomes between 80 and 120K€";
110			break;
111			case 6:
112			$range = "incomes>120K€";
113			break;
114			default:
115			$range = "Unknown range";
116			}
117
118			return $range;
119			}
120
121			public static function isPersonTypeOk($personType)
122			{
123			return in_array($personType, self::getPersonTypeArray());
124			}
125
126			public static function getPersonTypeArray()
127			{
128			return [
129			self::NATURAL_PERSON_TYPE,
130			self::LEGAL_PERSON_TYPE
131			];
132			}
133
134			public static function isDocumentTypeOk($documentType)
135			{
136			return in_array($documentType, self::getDocumentTypeArray());
137			}
138
139			public static function getDocumentTypeArray()
140			{
141			return [
142			self::IDENTITY_PROOF,
143			self::REGISTRATION_PROOF,
144			self::ARTICLES_OF_ASSOCIATION,
145			self::SHAREHOLDER_DECLARATION,
146			self::ADDRESS_PROOF
147			];
148			}
149
150			// https://docs.mangopay.com/endpoints/v2.01/hooks#e246_the-hook-object
151			// 16th Jan 2017
152
153			public static function isEventTypeOk($eventType)
154			{
155			return in_array($eventType, self::getAllEventTypes());
156			}
157
158			public static function getAllEventTypes()
159			{
160			return [
161			'PAYIN_NORMAL_CREATED',
162			'PAYIN_NORMAL_SUCCEEDED',
163			'PAYIN_NORMAL_FAILED',
164
165			'PAYOUT_NORMAL_CREATED',
166			'PAYOUT_NORMAL_SUCCEEDED',
167			'PAYOUT_NORMAL_FAILED',
168
169			'TRANSFER_NORMAL_CREATED',
170			'TRANSFER_NORMAL_SUCCEEDED',
171			'TRANSFER_NORMAL_FAILED',
172
173			'PAYIN_REFUND_CREATED',
174			'PAYIN_REFUND_SUCCEEDED',
175			'PAYIN_REFUND_FAILED',
176
177			'PAYOUT_REFUND_CREATED',
178			'PAYOUT_REFUND_SUCCEEDED',
179			'PAYOUT_REFUND_FAILED',
180
181			'TRANSFER_REFUND_CREATED',
182			'TRANSFER_REFUND_SUCCEEDED',
183			'TRANSFER_REFUND_FAILED',
184
185			'PAYIN_REPUDIATION_CREATED',
186			'PAYIN_REPUDIATION_SUCCEEDED',
187			'PAYIN_REPUDIATION_FAILED',
188
189			'KYC_CREATED',
190			'KYC_SUCCEEDED',
191			'KYC_FAILED',
192			'KYC_VALIDATION_ASKED',
193
194			'DISPUTE_DOCUMENT_CREATED',
195			'DISPUTE_DOCUMENT_VALIDATION_ASKED',
196			'DISPUTE_DOCUMENT_SUCCEEDED',
197			'DISPUTE_DOCUMENT_FAILED',
198
199			'DISPUTE_CREATED',
200			'DISPUTE_SUBMITTED',
201			'DISPUTE_ACTION_REQUIRED',
202			'DISPUTE_FURTHER_ACTION_REQUIRED',
203			'DISPUTE_CLOSED',
204			'DISPUTE_SENT_TO_BANK',
205
206			'TRANSFER_SETTLEMENT_CREATED',
207			'TRANSFER_SETTLEMENT_SUCCEEDED',
208			'TRANSFER_SETTLEMENT_FAILED',
209
210			'MANDATE_CREATED',
211			'MANDATED_FAILED',
212			'MANDATE_ACTIVATED',
213			'MANDATE_SUBMITTED',
214
215			'PREAUTHORIZATION_PAYMENT_WAITING',
216			// (not currently available) 'PREAUTHORIZATION_PAYMENT_EXPIRED',
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-01-16 17:13 UTC by Report Bug Copy Issue Report `37%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
217			'PREAUTHORIZATION_PAYMENT_CANCELED',
218			'PREAUTHORIZATION_PAYMENT_VALIDATED',
219
220			];
221			}
222			}

PartFire / MangoPayBundle

Push — master ( b0e1d7...34bc8c )

MangoPayConstants::isEventTypeOk() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like