LibPhoneNumberValidator::make() - Code Metrics - davidianbonner/cli-phone-number-validator - Measure and Improve Code Quality continuously with Scrutinizer

LibPhoneNumberValidator::make() A
last analyzed 2017-11-17 17:18 UTC

↳ Parent: LibPhoneNumberValidator

Complexity

Conditions	2
Paths	2

Size

Total Lines	9
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Importance

Changes

Metric	Value
cc	2
eloc	4
nc	2
nop	2
dl	0
loc	9
ccs	4
cts	4
cp	1
crap	2
rs	9.6666
c	0
b	0
f	0

<?php

namespace App;

use Exception;
use libphonenumber\PhoneNumber;
use libphonenumber\PhoneNumberType;
use libphonenumber\PhoneNumberUtil;
use libphonenumber\PhoneNumberFormat;
use libphonenumber\PhoneNumberToCarrierMapper;

class LibPhoneNumberValidator implements PhoneNumberValidator
{
    /**
     * @var libphonenumber\PhoneNumberUtil

     */
    protected $util;

    /**
     * @var libphonenumber\PhoneNumberToCarrierMapper

     */
    protected $carrierMapper;

    /**
     * Number to validate.
     * @var libphonenumber\PhoneNumber

     */
    protected $number;

    /**
     * @var bool
     */
    protected $isValid = false;

    /**
     * Instantiate the class and get an instance
     * of the libphonenumber util.
     */
    public function __construct(PhoneNumberUtil $util, PhoneNumberToCarrierMapper $carrierMapper)
    {
        $this->util = $util;

        $this->carrierMapper = $carrierMapper;


        // Default the phone number to prevent exceptions and allow control flow
        // to be handled by the developer with the 'isValid...' methods
        $this->number = new PhoneNumber;

    }

    /**
     * Validate the given number.
     *
     * @param  mixed        $number
     * @param  null|string  $countryCode
     * @return App\PhoneNumberValidator

     */
    public function make($number, string $countryCode = null): PhoneNumberValidator
    {
        try {
            $this->number = $this->util->parse($number, $countryCode);
        } catch (Exception $e) {
            // Let the 'isValid' methods handle the control-flow.
        }

        return $this;
    }

    /**
     * Is the number valid for the given country code.
     *
     * @param  mixed  $countryCode
     * @return bool
     */
    public function isValidForCountry($countryCode): bool
    {
        foreach (array_wrap($countryCode) as $code) {
            if ($this->util->isValidNumberForRegion($this->number, mb_strtoupper($code))) {
                return true;
            }
        }

        return false;
    }

    /**
     * Is the number a valid mobile.
     *
     * @return bool
     */
    public function isValidMobile(): bool
    {
        return $this->util->getNumberType($this->number) === PhoneNumberType::MOBILE;
    }

    /**
     * Is the number a valid landline/fixed-line.
     *
     * @return bool
     */
    public function isValidFixedLine(): bool
    {
        return $this->util->getNumberType($this->number) === PhoneNumberType::FIXED_LINE;
    }

    /**
     * Return the carrier name.
     *
     * @return string
     */
    public function getCarrierName(): string
    {
        return $this->carrierMapper->getNameForNumber($this->number, 'en');
    }

    /**
     * Return the phone number.
     *
     * @return string
     */
    public function getNumber(): string
    {
        return $this->util->format($this->number, PhoneNumberFormat::INTERNATIONAL);
    }

    /**
     * Get a new instance of the validator.
     *
     * @param libphonenumber\PhoneNumberToCarrierMapper $mapper
     */
    public static function getInstance()
    {
        return new static(PhoneNumberUtil::getInstance(), PhoneNumberToCarrierMapper::getInstance());
    }
}


1		<?php
2
3		namespace App;
4
5		use Exception;
6		use libphonenumber\PhoneNumber;
7		use libphonenumber\PhoneNumberType;
8		use libphonenumber\PhoneNumberUtil;
9		use libphonenumber\PhoneNumberFormat;
10		use libphonenumber\PhoneNumberToCarrierMapper;
11
12		class LibPhoneNumberValidator implements PhoneNumberValidator
13		{
14		/**
15		* @var libphonenumber\PhoneNumberUtil
		0 ignored issues – show Bug introduced 2017-11-17 02:53 UTC by Report Bug Copy Issue Report The type `App\libphonenumber\PhoneNumberUtil` was not found. Did you mean `libphonenumber\PhoneNumberUtil`? If so, make sure to prefix the type with `\`. Loading history...
16		*/
17		protected $util;
18
19		/**
20		* @var libphonenumber\PhoneNumberToCarrierMapper
		0 ignored issues – show Bug introduced 2017-11-17 02:53 UTC by Report Bug Copy Issue Report The type `App\libphonenumber\PhoneNumberToCarrierMapper` was not found. Did you mean `libphonenumber\PhoneNumberToCarrierMapper`? If so, make sure to prefix the type with `\`. Loading history...
21		*/
22		protected $carrierMapper;
23
24		/**
25		* Number to validate.
26		* @var libphonenumber\PhoneNumber
		0 ignored issues – show Bug introduced 2017-11-17 02:53 UTC by Report Bug Copy Issue Report The type `App\libphonenumber\PhoneNumber` was not found. Did you mean `libphonenumber\PhoneNumber`? If so, make sure to prefix the type with `\`. Loading history...
27		*/
28		protected $number;
29
30		/**
31		* @var bool
32		*/
33		protected $isValid = false;
34
35		/**
36		* Instantiate the class and get an instance
37		* of the libphonenumber util.
38		*/
39	20	public function __construct(PhoneNumberUtil $util, PhoneNumberToCarrierMapper $carrierMapper)
40		{
41	20	$this->util = $util;
		0 ignored issues – show Documentation Bug introduced 2017-11-17 02:53 UTC by Report Bug Copy Issue Report It seems like `$util` of type `libphonenumber\PhoneNumberUtil` is incompatible with the declared type `App\libphonenumber\PhoneNumberUtil` of property `$util`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
42	20	$this->carrierMapper = $carrierMapper;
		0 ignored issues – show Documentation Bug introduced 2017-11-17 02:53 UTC by Report Bug Copy Issue Report It seems like `$carrierMapper` of type `libphonenumber\PhoneNumberToCarrierMapper` is incompatible with the declared type `App\libphonenumber\PhoneNumberToCarrierMapper` of property `$carrierMapper`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
43
44		// Default the phone number to prevent exceptions and allow control flow
45		// to be handled by the developer with the 'isValid...' methods
46	20	$this->number = new PhoneNumber;
		0 ignored issues – show Documentation Bug introduced 2017-11-17 02:53 UTC by Report Bug Copy Issue Report It seems like `new libphonenumber\PhoneNumber()` of type `libphonenumber\PhoneNumber` is incompatible with the declared type `App\libphonenumber\PhoneNumber` of property `$number`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
47	20	}
48
49		/**
50		* Validate the given number.
51		*
52		* @param mixed $number
53		* @param null\|string $countryCode
54		* @return App\PhoneNumberValidator
		0 ignored issues – show Bug introduced 2017-11-17 02:53 UTC by Report Bug Copy Issue Report The type `App\App\PhoneNumberValidator` was not found. Did you mean `App\PhoneNumberValidator`? If so, make sure to prefix the type with `\`. Loading history...
55		*/
56	19	public function make($number, string $countryCode = null): PhoneNumberValidator
57		{
58		try {
59	19	$this->number = $this->util->parse($number, $countryCode);
60	1	} catch (Exception $e) {
61		// Let the 'isValid' methods handle the control-flow.
62		}
63
64	19	return $this;
65		}
66
67		/**
68		* Is the number valid for the given country code.
69		*
70		* @param mixed $countryCode
71		* @return bool
72		*/
73	7	public function isValidForCountry($countryCode): bool
74		{
75	7	foreach (array_wrap($countryCode) as $code) {
76	7	if ($this->util->isValidNumberForRegion($this->number, mb_strtoupper($code))) {
77	7	return true;
78		}
79		}
80
81	2	return false;
82		}
83
84		/**
85		* Is the number a valid mobile.
86		*
87		* @return bool
88		*/
89	7	public function isValidMobile(): bool
90		{
91	7	return $this->util->getNumberType($this->number) === PhoneNumberType::MOBILE;
92		}
93
94		/**
95		* Is the number a valid landline/fixed-line.
96		*
97		* @return bool
98		*/
99	2	public function isValidFixedLine(): bool
100		{
101	2	return $this->util->getNumberType($this->number) === PhoneNumberType::FIXED_LINE;
102		}
103
104		/**
105		* Return the carrier name.
106		*
107		* @return string
108		*/
109	7	public function getCarrierName(): string
110		{
111	7	return $this->carrierMapper->getNameForNumber($this->number, 'en');
112		}
113
114		/**
115		* Return the phone number.
116		*
117		* @return string
118		*/
119	6	public function getNumber(): string
120		{
121	6	return $this->util->format($this->number, PhoneNumberFormat::INTERNATIONAL);
122		}
123
124		/**
125		* Get a new instance of the validator.
126		*
127		* @param libphonenumber\PhoneNumberToCarrierMapper $mapper
128		*/
129	20	public static function getInstance()
130		{
131	20	return new static(PhoneNumberUtil::getInstance(), PhoneNumberToCarrierMapper::getInstance());
132		}
133		}
134

davidianbonner / cli-phone-number-validator

LibPhoneNumberValidator::make() A last analyzed 2017-11-17 17:18 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

LibPhoneNumberValidator::make() A
last analyzed 2017-11-17 17:18 UTC