generateList() - Code Metrics - Inspection of "Added some docs." - Mistralys/mailcode - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( d91b12...474736 )

by Sebastian

created 2021-04-02 15:06 UTC

generateList() A

↳ Parent: Project

Complexity

Conditions	4
Paths	4

Size

Total Lines	33
Code Lines	20

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	4
eloc	20
c	1
b	0
f	0
nc	4
nop	0
dl	0
loc	33
rs	9.6

<?php
/**
 * Utility script to extract supported countries for the showphone
 * command, meant to be opened in a browser.
 *
 * @package Mailcode
 * @subpackage Tools
 * @author Sebastian Mordziol <[email protected]>
 *
 * @see https://countrycode.org/countryCode/downloadCountryCodes
 */

declare(strict_types=1);

use AppUtils\CSVHelper;
use AppUtils\FileHelper;
use libphonenumber\PhoneNumberFormat;
use libphonenumber\PhoneNumberUtil;

require_once 'prepend.php';

$outputFile = '../src/Mailcode/Commands/Command/ShowPhone/numbers.json';
$countries = generateList();

FileHelper::saveAsJSON($countries, $outputFile, true);

?><!DOCTYPE html>
<html lang="en">
    <head>
        <meta charset="utf-8">
        <meta http-equiv="X-UA-Compatible" content="IE=edge">
        <meta name="viewport" content="width=device-width, initial-scale=1">
        <title>Mailcode - Phone format countries</title>
        <link href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-BmbxuPwQa2lc/FVzBcNJ7UAyJxM6wuqIj61tLrc4wSX0szH/Ev+nYRRuWlolflfl" crossorigin="anonymous">
        <style>
            BODY{
                padding:2em 0;
            }
            TEXTAREA{
                font-family: monospace;
            }
        </style>
    </head>
    <body>
        <div class="container">
            <h1>Phone number countries extraction</h1>
            <p>
                This uses Google's <a href="https://github.com/google/libphonenumber">libphonenumber</a>
                library (via its PHP port
                <a href="https://github.com/giggsey/libphonenumber-for-php">giggsey/libphonenumber-for-php</a>).
                It generates a list of all supported countries for use in the <code>{showphone}</code>
                command class, to validate the source country phone format parameter.
            </p>
            <p>
                Target class: <code>Mailcode_Commands_Command_ShowPhone</code><br>
                Target data file: <code><?php echo str_replace('../', '/', $outputFile) ?></code>
            </p>
            <p>
                The command reads the file to access the countries.
            </p>
            <p>
                <strong>Extracted JSON data:</strong>
            </p>
            <textarea rows="20" class="form-control"><?php echo json_encode($countries, JSON_PRETTY_PRINT) ?></textarea>
        </div>
    </body>
</html>

<?php

function generateList() : array
{
    $labels = extractLabels();
    $phoneNumberUtil = PhoneNumberUtil::getInstance();
    $regions = $phoneNumberUtil->getSupportedRegions();

    $data = array();
    foreach ($regions as $code)
    {
        $meta = $phoneNumberUtil->getMetadataForRegion($code);
        if (!$meta) {
            die('No metadata for ' . $code);
interface ReturnsInt {
    public function returnsIntHinted(): int;
}

class MyClass implements ReturnsInt {
    public function returnsIntHinted(): int
    {
        if (foo()) {
            return 123;
        }
        // here: null is implicitly returned
    }
}
        }

        $exampleNumber = $phoneNumberUtil->getExampleNumber($code);
        $local = $phoneNumberUtil->formatInOriginalFormat($exampleNumber, $code);
        $international = $phoneNumberUtil->format($exampleNumber, PhoneNumberFormat::INTERNATIONAL);

        $label = $code;
        if (isset($labels[$code])) {
            $label = $labels[$code];
        }

        $data[$code] = array(
            'label' => $label,
            'local' => $local,
            'international' => $international
        );
    }

    ksort($data);

    return $data;
}

function extractLabels() : array
{
    $lines = CSVHelper::parseFile('countrycodes.csv');

    $result = array();

    foreach ($lines as $line) {
        $result[$line['ISO2']] = $line['Country Name'];
    }

    return $result;
}

1			<?php
2			/**
3			* Utility script to extract supported countries for the showphone
4			* command, meant to be opened in a browser.
5			*
6			* @package Mailcode
7			* @subpackage Tools
8			* @author Sebastian Mordziol <[email protected]>
9			*
10			* @see https://countrycode.org/countryCode/downloadCountryCodes
11			*/
12
13			declare(strict_types=1);
14
15			use AppUtils\CSVHelper;
16			use AppUtils\FileHelper;
17			use libphonenumber\PhoneNumberFormat;
18			use libphonenumber\PhoneNumberUtil;
19
20			require_once 'prepend.php';
21
22			$outputFile = '../src/Mailcode/Commands/Command/ShowPhone/numbers.json';
23			$countries = generateList();
24
25			FileHelper::saveAsJSON($countries, $outputFile, true);
26
27			?><!DOCTYPE html>
28			<html lang="en">
29			<head>
30			<meta charset="utf-8">
31			<meta http-equiv="X-UA-Compatible" content="IE=edge">
32			<meta name="viewport" content="width=device-width, initial-scale=1">
33			<title>Mailcode - Phone format countries</title>
34			<link href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-BmbxuPwQa2lc/FVzBcNJ7UAyJxM6wuqIj61tLrc4wSX0szH/Ev+nYRRuWlolflfl" crossorigin="anonymous">
35			<style>
36			BODY{
37			padding:2em 0;
38			}
39			TEXTAREA{
40			font-family: monospace;
41			}
42			</style>
43			</head>
44			<body>
45			<div class="container">
46			<h1>Phone number countries extraction</h1>
47			<p>
48			This uses Google's <a href="https://github.com/google/libphonenumber">libphonenumber</a>
49			library (via its PHP port
50			<a href="https://github.com/giggsey/libphonenumber-for-php">giggsey/libphonenumber-for-php</a>).
51			It generates a list of all supported countries for use in the <code>{showphone}</code>
52			command class, to validate the source country phone format parameter.
53			</p>
54			<p>
55			Target class: <code>Mailcode_Commands_Command_ShowPhone</code><br>
56			Target data file: <code><?php echo str_replace('../', '/', $outputFile) ?></code>
57			</p>
58			<p>
59			The command reads the file to access the countries.
60			</p>
61			<p>
62			<strong>Extracted JSON data:</strong>
63			</p>
64			<textarea rows="20" class="form-control"><?php echo json_encode($countries, JSON_PRETTY_PRINT) ?></textarea>
65			</div>
66			</body>
67			</html>
68
69			<?php
70
71			function generateList() : array
72			{
73			$labels = extractLabels();
74			$phoneNumberUtil = PhoneNumberUtil::getInstance();
75			$regions = $phoneNumberUtil->getSupportedRegions();
76
77			$data = array();
78			foreach ($regions as $code)
79			{
80			$meta = $phoneNumberUtil->getMetadataForRegion($code);
81			if (!$meta) {
82			die('No metadata for ' . $code);
			0 ignored issues – show Bug Best Practice introduced 2021-04-02 15:10 UTC by Report Bug Copy Issue Report In this branch, the function will implicitly return `null` which is incompatible with the type-hinted return `array`. Consider adding a return statement or allowing `null` as return value. For hinted functions/methods where all return statements with the correct type are only reachable via conditions, ?null? gets implicitly returned which may be incompatible with the hinted type. Let?s take a look at an example: interface ReturnsInt { public function returnsIntHinted(): int; } class MyClass implements ReturnsInt { public function returnsIntHinted(): int { if (foo()) { return 123; } // here: null is implicitly returned } } Loading history... Best Practice introduced 2021-04-02 15:10 UTC by Report Bug Copy Issue Report Using `exit` here is not recommended. In general, usage of exit should be done with care and only when running in a scripting context like a CLI script. Loading history...
83			}
84
85			$exampleNumber = $phoneNumberUtil->getExampleNumber($code);
86			$local = $phoneNumberUtil->formatInOriginalFormat($exampleNumber, $code);
87			$international = $phoneNumberUtil->format($exampleNumber, PhoneNumberFormat::INTERNATIONAL);
88
89			$label = $code;
90			if (isset($labels[$code])) {
91			$label = $labels[$code];
92			}
93
94			$data[$code] = array(
95			'label' => $label,
96			'local' => $local,
97			'international' => $international
98			);
99			}
100
101			ksort($data);
102
103			return $data;
104			}
105
106			function extractLabels() : array
107			{
108			$lines = CSVHelper::parseFile('countrycodes.csv');
109
110			$result = array();
111
112			foreach ($lines as $line) {
113			$result[$line['ISO2']] = $line['Country Name'];
114			}
115
116			return $result;
117			}

Mistralys / mailcode

Push — master ( d91b12...474736 )

generateList() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like