Spatie\QueryBuilder\ColumnNameSanitizer

Complexity

Total Complexity

4

Size/Duplication

Total Lines	31
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	sanitize()	0	12	3
A	sanitizeArray()	0	4	1

<?php

namespace Spatie\QueryBuilder;

use Spatie\QueryBuilder\Exceptions\InvalidColumnName;

class ColumnNameSanitizer
{
    /**
     * Based on maximum column name length.
     */
    public const MAX_COLUMN_NAME_LENGTH = 64;

    /**
     * Column names are alphanumeric strings that can contain
     * underscores (`_`) but can't start with a number.
     */
    private const VALID_COLUMN_NAME_REGEX = "/^(?![0-9])[A-Za-z0-9_-]*$/";

    public static function sanitize(string $column): string
    {
        if (strlen($column) > self::MAX_COLUMN_NAME_LENGTH) {
            throw InvalidColumnName::columnNameTooLong($column, self::MAX_COLUMN_NAME_LENGTH);
        }

        if (! preg_match(self::VALID_COLUMN_NAME_REGEX, $column)) {
            throw InvalidColumnName::invalidCharacters($column);
        }

        return $column;
    }

    public static function sanitizeArray(array $columns): array
    {
        return array_map([self::class, 'sanitize'], $columns);
    }
}