SchemaAttribute::type() - Code Metrics - Inspection of "Merge branch 'main' of github.com:HexMakina/Crudit..." - HexMakina/Crudites - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 303b6c...b49db2 )

by Sammy

created 2024-12-02 23:29 UTC

SchemaAttribute::type() A

↳ Parent: SchemaAttribute

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php

namespace HexMakina\Crudites\Schema;

use HexMakina\BlackBox\Database\{SchemaInterface, SchemaAttributeInterface};
filter:
    dependency_paths: ["lib/*"]

class SchemaAttribute implements SchemaAttributeInterface
{
    private array $column;

    /** 
     * @param SchemaInterface $schema The schema to which the column belongs.
     * @param string $table The table to which the column belongs.
     * @param string $column The column name.
     * 
     * @throws \InvalidArgumentException If the column does not exist.
     */
    public function __construct(SchemaInterface $schema, string $table, string $column)
    {
        $this->column = $schema->column($table, $column);
    }

    /**
     * @return bool True if the column is nullable, false otherwise.
     */
    public function nullable(): bool
    {
        return !empty($this->column['nullable']);
    }

    /**
     * @return mixed The default value of the column, or null if no default is set.
     */
    public function default()
    {
        return $this->column['default'] ?? null;
    }

    /**
     * @return array<string> The possible values of the column, or an empty array if the column is not an enum.
     */
    public function enums(): array
    {
        $ret = [];

        $rx = '/enum\(\'(.+)\'\)/i';
        $column_type = $this->column['column_type'];

        $m = [];
        if (preg_match($rx, $column_type, $m) === 1) {
            $ret = explode("','", $m[1]);
        }

        return $ret;
    }

    /**
     * @return The SchemaInterface type of the column.
filter:
    dependency_paths: ["lib/*"]
     * 
     * @see https://dev.mysql.com/doc/refman/8.0/en/data-types.html
     */
    public function type(): ?string
    {

        return $this->column['type'];
    }

    /**
     * @return int The length of the column, or -1 if the column is not a string.
     * 
     * @see https://dev.mysql.com/doc/refman/8.0/en/char.html
     */
    public function length(): ?int
    {
        return $this->column['length'] ?? null;
    }

    /**
     * @return int The precision of the column, or -1 if the column is not numeric.
     * 
     * @see https://dev.mysql.com/doc/refman/8.0/en/precision-math-decimal-characteristics.html
     */
    public function precision(): ?int
    {
        return $this->column['precision'] ?? null;
    }

    /**
     * @return int The scale of the column, or nullif the column is not numeric.
     * 
     * @see https://dev.mysql.com/doc/refman/8.0/en/precision-math-decimal-characteristics.html
     */
    public function scale(): ?int
    {
        return $this->column['scale'] ?? null;
    }

    /**
     * @return bool True if the column is auto-incremented, false otherwise.
     * 
     * @see https://dev.mysql.com/doc/refman/8.0/en/example-auto-increment.html
     */
    public function isAuto(): bool
    {
        return !empty($this->column['auto_increment']);
    }

    public function validateValue($value = null): ?string
    {
        if ($value !== null) {
            $error = $this->validateValueWithType($value);
            if (!empty($error)) {
                return $error;
            }
        } else if (!$this->nullable() && $this->default() === null) {
            return 'ERR_REQUIRED_VALUE';
        }

        return null;
    }

    public function validateValueWithType($value = null): ?string
    {
        switch ($this->type()) {
            case SchemaAttributeInterface::TYPE_DATE:
            case SchemaAttributeInterface::TYPE_TIME:
            case SchemaAttributeInterface::TYPE_TIMESTAMP:
            case SchemaAttributeInterface::TYPE_DATETIME:
                if (date_create($value) === false) {
                    return 'ERR_DATETIME_FORMAT';
                }
                break;

            case SchemaAttributeInterface::TYPE_YEAR:
                if (preg_match('#^\d{4}$#', $value) !== 1) {
                    return 'ERR_YEAR_FORMAT';
                }
                break;

            case SchemaAttributeInterface::TYPE_INTEGER:
            case SchemaAttributeInterface::TYPE_FLOAT:
            case SchemaAttributeInterface::TYPE_DECIMAL:
                if (!is_numeric($value)) {
                    return 'ERR_NUMERIC_FORMAT';
                }
                break;

            case SchemaAttributeInterface::TYPE_STRING:
            case SchemaAttributeInterface::TYPE_TEXT:
                if (strlen($value) > $this->length()) {
                    return 'ERR_TEXT_TOO_LONG';
                }
                break;

            case SchemaAttributeInterface::TYPE_ENUM:
                if (!in_array($value, $this->enums())) {
                    return 'ERR_INVALID_ENUM_VALUE';
                }
                break;

            default:
                return null;
        }
    }
}


1			<?php
2
3			namespace HexMakina\Crudites\Schema;
4
5			use HexMakina\BlackBox\Database\{SchemaInterface, SchemaAttributeInterface};
			0 ignored issues – show Bug introduced 2024-11-25 21:22 UTC by Report Bug Copy Issue Report The type `HexMakina\BlackBox\Database\SchemaInterface` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history... Bug introduced 2024-11-25 21:22 UTC by Report Bug Copy Issue Report The type `HexMakina\BlackBox\Datab...chemaAttributeInterface` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
6
7			class SchemaAttribute implements SchemaAttributeInterface
8			{
9			private array $column;
10
11			/**
12			* @param SchemaInterface $schema The schema to which the column belongs.
13			* @param string $table The table to which the column belongs.
14			* @param string $column The column name.
15			*
16			* @throws \InvalidArgumentException If the column does not exist.
17			*/
18			public function __construct(SchemaInterface $schema, string $table, string $column)
19			{
20			$this->column = $schema->column($table, $column);
21			}
22
23			/**
24			* @return bool True if the column is nullable, false otherwise.
25			*/
26			public function nullable(): bool
27			{
28			return !empty($this->column['nullable']);
29			}
30
31			/**
32			* @return mixed The default value of the column, or null if no default is set.
33			*/
34			public function default()
35			{
36			return $this->column['default'] ?? null;
37			}
38
39			/**
40			* @return array<string> The possible values of the column, or an empty array if the column is not an enum.
41			*/
42			public function enums(): array
43			{
44			$ret = [];
45
46			$rx = '/enum\(\'(.+)\'\)/i';
47			$column_type = $this->column['column_type'];
48
49			$m = [];
50			if (preg_match($rx, $column_type, $m) === 1) {
51			$ret = explode("','", $m[1]);
52			}
53
54			return $ret;
55			}
56
57			/**
58			* @return The SchemaInterface type of the column.
			0 ignored issues – show Bug introduced 2024-12-02 23:31 UTC by Report Bug Copy Issue Report The type `HexMakina\Crudites\Schema\The` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
59			*
60			* @see https://dev.mysql.com/doc/refman/8.0/en/data-types.html
61			*/
62			public function type(): ?string
63			{
64
65			return $this->column['type'];
66			}
67
68			/**
69			* @return int The length of the column, or -1 if the column is not a string.
70			*
71			* @see https://dev.mysql.com/doc/refman/8.0/en/char.html
72			*/
73			public function length(): ?int
74			{
75			return $this->column['length'] ?? null;
76			}
77
78			/**
79			* @return int The precision of the column, or -1 if the column is not numeric.
80			*
81			* @see https://dev.mysql.com/doc/refman/8.0/en/precision-math-decimal-characteristics.html
82			*/
83			public function precision(): ?int
84			{
85			return $this->column['precision'] ?? null;
86			}
87
88			/**
89			* @return int The scale of the column, or nullif the column is not numeric.
90			*
91			* @see https://dev.mysql.com/doc/refman/8.0/en/precision-math-decimal-characteristics.html
92			*/
93			public function scale(): ?int
94			{
95			return $this->column['scale'] ?? null;
96			}
97
98			/**
99			* @return bool True if the column is auto-incremented, false otherwise.
100			*
101			* @see https://dev.mysql.com/doc/refman/8.0/en/example-auto-increment.html
102			*/
103			public function isAuto(): bool
104			{
105			return !empty($this->column['auto_increment']);
106			}
107
108			public function validateValue($value = null): ?string
109			{
110			if ($value !== null) {
111			$error = $this->validateValueWithType($value);
112			if (!empty($error)) {
113			return $error;
114			}
115			} else if (!$this->nullable() && $this->default() === null) {
116			return 'ERR_REQUIRED_VALUE';
117			}
118
119			return null;
120			}
121
122			public function validateValueWithType($value = null): ?string
123			{
124			switch ($this->type()) {
125			case SchemaAttributeInterface::TYPE_DATE:
126			case SchemaAttributeInterface::TYPE_TIME:
127			case SchemaAttributeInterface::TYPE_TIMESTAMP:
128			case SchemaAttributeInterface::TYPE_DATETIME:
129			if (date_create($value) === false) {
130			return 'ERR_DATETIME_FORMAT';
131			}
132			break;
133
134			case SchemaAttributeInterface::TYPE_YEAR:
135			if (preg_match('#^\d{4}$#', $value) !== 1) {
136			return 'ERR_YEAR_FORMAT';
137			}
138			break;
139
140			case SchemaAttributeInterface::TYPE_INTEGER:
141			case SchemaAttributeInterface::TYPE_FLOAT:
142			case SchemaAttributeInterface::TYPE_DECIMAL:
143			if (!is_numeric($value)) {
144			return 'ERR_NUMERIC_FORMAT';
145			}
146			break;
147
148			case SchemaAttributeInterface::TYPE_STRING:
149			case SchemaAttributeInterface::TYPE_TEXT:
150			if (strlen($value) > $this->length()) {
151			return 'ERR_TEXT_TOO_LONG';
152			}
153			break;
154
155			case SchemaAttributeInterface::TYPE_ENUM:
156			if (!in_array($value, $this->enums())) {
157			return 'ERR_INVALID_ENUM_VALUE';
158			}
159			break;
160
161			default:
162			return null;
163			}
164			}
165			}
166

HexMakina / Crudites

Push — main ( 303b6c...b49db2 )

SchemaAttribute::type() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like