S3ObjectSafeNameValidator::validate() - Code Metrics - matecat/simple-s3 - Measure and Improve Code Quality continuously with Scrutinizer

S3ObjectSafeNameValidator::validate() A
last analyzed 2025-10-29 18:23 UTC

↳ Parent: S3ObjectSafeNameValidator

Complexity

Conditions	3
Paths	4

Size

Total Lines	14
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	3

Importance

Changes

Metric	Value
eloc	6
dl	0
loc	14
ccs	7
cts	7
cp	1
rs	10
c	0
b	0
f	0
cc	3
nc	4
nop	1
crap	3

<?php
/**
 *  This file is part of the Simple S3 package.
 *
 * (c) Mauro Cassani<https://github.com/mauretto78>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 */

namespace Matecat\SimpleS3\Components\Validators;

/**
 * This class check if a string is a valid S3 object Name
 *
 * Amazon S3 object safe naming Requirements
 * -------------------------------------------------------------------------
 * You can use any UTF-8 character in an object key name. However, using certain characters in key names may cause problems with some applications and protocols.
 * The following guidelines help you maximize compliance with DNS, web-safe characters, XML parsers, and other APIs.
 *
 * Complete reference:
 *
 * https://docs.aws.amazon.com/en_us/AmazonS3/latest/dev/UsingMetadata.html
 *
 * @package SimpleS3
 */
final class S3ObjectSafeNameValidator extends S3NameValidator
{
    /**
     * @param string $string
     *
     * @return array
     */
    public static function validate(string $string): array
    {
        $errors = [];

        if (str_starts_with($string, '.')) {
            $errors[] = 'The string cannot starts with .';
        }

        // check for string length
        if (strlen(urlencode($string)) > 221) {
            $errors[] = 'The string is too long (max length of urlencoded string is 221 bytes)';
        }

        return $errors;
    }
}


1		<?php
2		/**
3		* This file is part of the Simple S3 package.
4		*
5		* (c) Mauro Cassani<https://github.com/mauretto78>
6		*
7		* For the full copyright and license information, please view the LICENSE
8		* file that was distributed with this source code.
9		*
10		*/
11
12		namespace Matecat\SimpleS3\Components\Validators;
13
14		/**
15		* This class check if a string is a valid S3 object Name
16		*
17		* Amazon S3 object safe naming Requirements
18		* -------------------------------------------------------------------------
19		* You can use any UTF-8 character in an object key name. However, using certain characters in key names may cause problems with some applications and protocols.
20		* The following guidelines help you maximize compliance with DNS, web-safe characters, XML parsers, and other APIs.
21		*
22		* Complete reference:
23		*
24		* https://docs.aws.amazon.com/en_us/AmazonS3/latest/dev/UsingMetadata.html
25		*
26		* @package SimpleS3
27		*/
28		final class S3ObjectSafeNameValidator extends S3NameValidator
29		{
30		/**
31		* @param string $string
32		*
33		* @return array
34		*/
35	13	public static function validate(string $string): array
36		{
37	13	$errors = [];
38
39	13	if (str_starts_with($string, '.')) {
40	1	$errors[] = 'The string cannot starts with .';
41		}
42
43		// check for string length
44	13	if (strlen(urlencode($string)) > 221) {
45	1	$errors[] = 'The string is too long (max length of urlencoded string is 221 bytes)';
46		}
47
48	13	return $errors;
49		}
50		}
51

matecat / simple-s3

S3ObjectSafeNameValidator::validate() A last analyzed 2025-10-29 18:23 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

S3ObjectSafeNameValidator::validate() A
last analyzed 2025-10-29 18:23 UTC