Completed
Branch feature/issue-157 (4a7b0b)
by Mikaël
16:29
created

Utils::getContentFromUrl()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 9

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 7
CRAP Score 2

Importance

Changes 0
Metric Value
dl 0
loc 9
ccs 7
cts 7
cp 1
rs 9.9666
c 0
b 0
f 0
cc 2
nc 2
nop 8
crap 2

How to fix   Many Parameters   

Many Parameters

Methods with many parameters are not only hard to understand, but their parameters also often become inconsistent when you need more, or different data.

There are several approaches to avoid long parameter lists:

1
<?php
2
3
namespace WsdlToPhp\PackageGenerator\Generator;
4
5
use WsdlToPhp\PackageGenerator\ConfigurationReader\GeneratorOptions;
6
7
class Utils
8
{
9
    /**
10
     * Gets upper case word among a string from the end or from the beginning part
11
     * @param string $optionValue
12
     * @param string $string the string from which we can extract the part
13
     * @return string
14
     */
15 474
    public static function getPart($optionValue, $string)
16
    {
17 474
        $elementType = '';
18 474
        $string = str_replace('_', '', $string);
19 474
        $string = preg_replace('/([0-9])/', '', $string);
20 474
        if (!empty($string)) {
21 79
            switch ($optionValue) {
22 395
                case GeneratorOptions::VALUE_END:
23 30
                    $parts = preg_split('/[A-Z]/', ucfirst($string));
24 30
                    $partsCount = count($parts);
25 30
                    if (!empty($parts[$partsCount - 1])) {
26 24
                        $elementType = substr($string, strrpos($string, implode('', array_slice($parts, -1))) - 1);
27 12
                    } else {
28 6
                        for ($i = $partsCount - 1; $i >= 0; $i--) {
29 6
                            $part = trim($parts[$i]);
30 6
                            if (!empty($part)) {
31
                                break;
32
                            }
33 3
                        }
34 6
                        $elementType = substr($string, ((count($parts) - 2 - $i) + 1) * -1);
35
                    }
36 30
                    break;
37 370
                case GeneratorOptions::VALUE_START:
38 414
                    $parts = preg_split('/[A-Z]/', ucfirst($string));
39 414
                    $partsCount = count($parts);
40 414
                    if (empty($parts[0]) && !empty($parts[1])) {
41 414
                        $elementType = substr($string, 0, strlen($parts[1]) + 1);
42 207
                    } else {
43 18
                        for ($i = 0; $i < $partsCount; $i++) {
44 18
                            $part = trim($parts[$i]);
45 18
                            if (!empty($part)) {
46 18
                                break;
47
                            }
48 9
                        }
49 18
                        $elementType = substr($string, 0, $i);
50
                    }
51 414
                    break;
52 25
                case GeneratorOptions::VALUE_NONE:
53 24
                    $elementType = $string;
54 24
                    break;
55 3
                default:
56 6
                    break;
57 3
            }
58 237
        }
59 474
        return $elementType;
60
    }
61
    /**
62
     * Get content from url using a proxy or not
63
     * @param string $url
64
     * @param string $basicAuthLogin
65
     * @param string $basicAuthPassword
66
     * @param string $proxyHost
67
     * @param string $proxyPort
68
     * @param string $proxyLogin
69
     * @param string $proxyPassword
70
     * @param array $contextOptions
71
     * @return string
72
     */
73 12
    public static function getContentFromUrl($url, $basicAuthLogin = null, $basicAuthPassword = null, $proxyHost = null, $proxyPort = null, $proxyLogin = null, $proxyPassword = null, array $contextOptions = [])
74
    {
75 12
        $context = null;
76 12
        $options = self::getStreamContextOptions($basicAuthLogin, $basicAuthPassword, $proxyHost, $proxyPort, $proxyLogin, $proxyPassword, $contextOptions);
77 12
        if (!empty($options)) {
78 9
            $context = stream_context_create($options);
79 3
        }
80 12
        return file_get_contents($url, false, $context);
81
    }
82
    /**
83
     * @param string $basicAuthLogin
84
     * @param string $basicAuthPassword
85
     * @param string $proxyHost
86
     * @param string $proxyPort
87
     * @param string $proxyLogin
88
     * @param string $proxyPassword
89
     * @param array $contextOptions
90
     * @return string[]
91
     */
92 36
    public static function getStreamContextOptions($basicAuthLogin = null, $basicAuthPassword = null, $proxyHost = null, $proxyPort = null, $proxyLogin = null, $proxyPassword = null, array $contextOptions = [])
93
    {
94 36
        $proxyOptions = $basicAuthOptions = [];
95 36
        if (!empty($basicAuthLogin) && !empty($basicAuthPassword)) {
96
            $basicAuthOptions = [
97
                'http' => [
98
                    'header' => [
99 18
                        sprintf('Authorization: Basic %s', base64_encode(sprintf('%s:%s', $basicAuthLogin, $basicAuthPassword))),
100 9
                    ],
101 9
                ],
102 9
            ];
103 9
        }
104 36
        if (!empty($proxyHost)) {
105
            $proxyOptions = [
106
                'http' => [
107 18
                    'proxy' => sprintf('tcp://%s%s', $proxyHost, empty($proxyPort) ? '' : sprintf(':%s', $proxyPort)),
108
                    'header' => [
109 18
                        sprintf('Proxy-Authorization: Basic %s', base64_encode(sprintf('%s:%s', $proxyLogin, $proxyPassword))),
110 9
                    ],
111 9
                ],
112 9
            ];
113 9
        }
114 36
        return array_merge_recursive($contextOptions, $proxyOptions, $basicAuthOptions);
115
    }
116
    /**
117
     * Returns the value with good type
118
     * @param mixed $value the value
119
     * @param string $knownType the value
120
     * @return mixed
121
     */
122 216
    public static function getValueWithinItsType($value, $knownType = null)
123
    {
124 216
        if (is_int($value) || (!is_null($value) && in_array($knownType, [
125 108
            'time',
126 54
            'positiveInteger',
127 54
            'unsignedLong',
128 54
            'unsignedInt',
129 54
            'short',
130 54
            'long',
131 54
            'int',
132 54
            'integer',
133 216
        ], true))) {
134 18
            return intval($value);
135 216
        } elseif (is_float($value) || (!is_null($value) && in_array($knownType, [
136 108
            'float',
137 54
            'double',
138 54
            'decimal',
139 216
        ], true))) {
140 6
            return floatval($value);
141 216
        } elseif (is_bool($value) || (!is_null($value) && in_array($knownType, [
142 108
            'bool',
143 54
            'boolean',
144 216
        ], true))) {
145 18
            return ($value === 'true' || $value === true || $value === 1 || $value === '1');
146
        }
147 210
        return $value;
148
    }
149
    /**
150
     * @param string $origin
151
     * @param string $destination
152
     * @return string
153
     */
154 192
    public static function resolveCompletePath($origin, $destination)
155
    {
156 192
        $resolvedPath = $destination;
157 192
        if (!empty($destination) && strpos($destination, 'http://') === false && strpos($destination, 'https://') === false && !empty($origin)) {
158 192
            if (substr($destination, 0, 2) === './') {
159 12
                $destination = substr($destination, 2);
160 6
            }
161 192
            $destinationParts = explode('/', $destination);
162 192
            $fileParts = pathinfo($origin);
163 192
            $fileBasename = (is_array($fileParts) && array_key_exists('basename', $fileParts)) ? $fileParts['basename'] : '';
164 192
            $parts = parse_url(str_replace('/' . $fileBasename, '', $origin));
165 192
            $scheme = (is_array($parts) && array_key_exists('scheme', $parts)) ? $parts['scheme'] : '';
166 192
            $host = (is_array($parts) && array_key_exists('host', $parts)) ? $parts['host'] : '';
167 192
            $path = (is_array($parts) && array_key_exists('path', $parts)) ? $parts['path'] : '';
168 192
            $path = str_replace('/' . $fileBasename, '', $path);
169 192
            $pathParts = explode('/', $path);
170 192
            $finalPath = implode('/', $pathParts);
171 192
            foreach ($destinationParts as $locationPart) {
172 192
                if ($locationPart == '..') {
173 12
                    $finalPath = substr($finalPath, 0, strrpos($finalPath, '/', 0));
174 6
                } else {
175 192
                    $finalPath .= '/' . $locationPart;
176
                }
177 96
            }
178 192
            $port = (is_array($parts) && array_key_exists('port', $parts)) ? $parts['port'] : '';
179
            /**
180
             * Remote file
181
             */
182 192
            if (!empty($scheme) && !empty($host)) {
183 6
                $resolvedPath = str_replace('urn', 'http', $scheme) . '://' . $host . (!empty($port) ? ':' . $port : '') . str_replace('//', '/', $finalPath);
184 189
            } elseif (empty($scheme) && empty($host) && count($pathParts)) {
185
                /**
186
                 * Local file
187
                 */
188 186
                if (is_file($finalPath)) {
189 186
                    $resolvedPath = $finalPath;
190 93
                }
191 93
            }
192 96
        }
193 192
        return $resolvedPath;
194
    }
195
    /**
196
     * Clean comment
197
     * @param string $comment the comment to clean
198
     * @param string $glueSeparator ths string to use when gathering values
199
     * @param bool $uniqueValues indicates if comment values must be unique or not
200
     * @return string
201
     */
202 246
    public static function cleanComment($comment, $glueSeparator = ',', $uniqueValues = true)
203
    {
204 246
        if (!is_scalar($comment) && !is_array($comment)) {
205 6
            return '';
206
        }
207 240
        return trim(str_replace('*/', '*[:slash:]', is_scalar($comment) ? $comment : implode($glueSeparator, $uniqueValues ? array_unique($comment) : $comment)));
208
    }
209
    /**
210
     * Clean a string to make it valid as PHP variable
211
     * See more about the used regular expression at {@link http://www.regular-expressions.info/unicode.html}:
212
     * - \p{L} for any valid letter
213
     * - \p{N} for any valid number
214
     * - /u for supporting unicode
215
     * @param string $string the string to clean
216
     * @param bool $keepMultipleUnderscores optional, allows to keep the multiple consecutive underscores
217
     * @return string
218
     */
219 960
    public static function cleanString($string, $keepMultipleUnderscores = true)
220
    {
221 960
        $cleanedString = preg_replace('/[^\p{L}\p{N}_]/u', '_', $string);
222 960
        if (!$keepMultipleUnderscores) {
223 168
            $cleanedString = preg_replace('/[_]+/', '_', $cleanedString);
224 84
        }
225 960
        return $cleanedString;
226
    }
227
    /**
228
     * @param string $namespacedClassName
229
     * @return string
230
     */
231 342
    public static function removeNamespace($namespacedClassName)
232
    {
233 342
        $elements = explode('\\', $namespacedClassName);
234 342
        return (string) array_pop($elements);
235
    }
236
    /**
237
     * @param string $directory
238
     * @param int $permissions
239
     * @return bool
240
     */
241 390
    public static function createDirectory($directory, $permissions = 0775)
242
    {
243 390
        if (!is_dir($directory)) {
244 54
            mkdir($directory, $permissions, true);
245 27
        }
246 390
        return true;
247
    }
248
    /**
249
     * Save schemas to schemasFolder
250
     * Filename will be extracted from schemasUrl or default schema.wsdl will be used
251
     * @param string $destinationFolder
252
     * @param string $schemasFolder
253
     * @param string $schemasUrl
254
     * @param string $content
255
     * @return string
256
     */
257 12
    public static function saveSchemas($destinationFolder, $schemasFolder, $schemasUrl, $content)
258
    {
259 12
        if (($schemasFolder === null) || empty($schemasFolder)) {
260
            // if null or empty schemas folder was provided
261
            // default schemas folder will be wsdl
262 6
            $schemasFolder = 'wsdl';
263 3
        }
264 12
        $schemasPath = rtrim($destinationFolder, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR . rtrim($schemasFolder, DIRECTORY_SEPARATOR);
265
        // Here we must cover all possible variants
266 12
        if ((strpos(strtolower($schemasUrl), '.wsdl') !== false) || (strpos(strtolower($schemasUrl), '.xsd') !== false) || (strpos(strtolower($schemasUrl), '.xml') !== false)) {
267 12
            $filename = basename($schemasUrl);
268 6
        } else {
269
            // if $url is like http://example.com/index.php?WSDL default filename will be schema.wsdl
270 6
            $filename = 'schema.wsdl';
271
        }
272 12
        self::createDirectory($schemasPath);
273 12
        file_put_contents($schemasPath . DIRECTORY_SEPARATOR . $filename, $content);
274 12
        return $schemasPath . DIRECTORY_SEPARATOR . $filename;
275
    }
276
}
277