Query::__debugInfo() - 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

Query::__debugInfo() A

↳ Parent: Query

Complexity

Conditions	4
Paths	6

Size

Total Lines	21
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	10
nc	6
nop	0
dl	0
loc	21
rs	9.9332
c	0
b	0
f	0

<?php

namespace HexMakina\Crudites\Grammar\Query;

use HexMakina\BlackBox\Database\QueryInterface;
use HexMakina\Crudites\Grammar\Clause\Clause;

abstract class Query implements QueryInterface
{

    
    protected array $bindings = [];
    protected array $binding_names = [];
    
    protected string $table;
    protected ?string $alias = null;
    
    protected $table_alias = null;
    
    protected array $clauses = [];
    
    abstract public function statement(): string;
    
    /**
     * Provides debugging information about the object.
     * This method returns an array of object properties and their values,
     * excluding properties that are not set.
     */
    public function __debugInfo(): array
    {
        $dbg = get_object_vars($this);

        foreach (array_keys($dbg) as $k) {
            if (!isset($dbg[$k])) {
                unset($dbg[$k]);
            }
        }

        $dbg['statement()'] = $this->statement();

        
        if (empty($this->bindings)) {
            unset($dbg['bindings']);
        }
        else{
            $dbg['bindings'] = json_encode($dbg['bindings']);
        }

        return $dbg;
    }

    public function __toString()
    {
        return $this->statement();
    }

    public function table(): string
    {
        return $this->table;
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
    }

    public function alias(): string
    {
        return $this->alias ?? $this->table;
    }

    public function clause(string $name): ?Clause
    {
        return $this->clauses[$name] ?? null;
    }

    public function add(Clause $clause): self
    {
        $this->clauses[$clause->name()] = $clause;
        return $this;
    }

    public function set(Clause $clause): self
    {
        unset($this->clauses[$clause->name()]);
        return $this->add($clause);
    }

    //------------------------------------------------------------  PREP::FIELDS
    public function tableLabel(string $force = null)
    {
        return $force ?? $this->tableAlias();
    }

    public function tableAlias($setter = null): string
    {
        if ($setter !== null) {
            $this->table_alias = $setter;
        }

        return $this->table_alias ?? $this->table;
    }

    public function bindings(): array
    {
        return $this->bindings;
    }

    public function getBindingNames(): array
    {
        return $this->binding_names;
    }

    public function addBinding($field, $value, $table_name = null, $bind_label = null): string
    {
        $table_label = $this->tableLabel($table_name);
        $bind_label ??= $this->bindLabel($field, $table_name);

        $this->binding_names[$table_label] ??= [];
        $this->binding_names[$table_label][$field] = $bind_label;
        $this->bindings[$bind_label] = $value;

        return $bind_label;
    }

    public function bindLabel($field, $table_name = null): string
    {
        return ':' . $this->tableLabel($table_name) . '_' . $field;
    }

    public function addBindings($assoc_data): array
    {
        $ret = [];
        foreach ($assoc_data as $column_name => $value) {
            $ret[$column_name] = $this->addBinding($column_name, $value, $this->table);
        }
        return $ret;
    }

    public function compare($query)
    {
        if ($this->statement() !== $query->statement()) {
            return 'statement';
        }

        if (!empty(array_diff($this->bindings(), $query->bindings()))) {
            return 'bindings';
        }
        if (!empty(array_diff($query->bindings(), $this->bindings()))) {
            return 'bindings';
        }

        return true;
    }
}


1			<?php
2
3			namespace HexMakina\Crudites\Grammar\Query;
4
5			use HexMakina\BlackBox\Database\QueryInterface;
6			use HexMakina\Crudites\Grammar\Clause\Clause;
7
8			abstract class Query implements QueryInterface
9			{
10
11
12			protected array $bindings = [];
13			protected array $binding_names = [];
14
15			protected string $table;
16			protected ?string $alias = null;
17
18			protected $table_alias = null;
19
20			protected array $clauses = [];
21
22			abstract public function statement(): string;
23
24			/**
25			* Provides debugging information about the object.
26			* This method returns an array of object properties and their values,
27			* excluding properties that are not set.
28			*/
29			public function __debugInfo(): array
30			{
31			$dbg = get_object_vars($this);
32
33			foreach (array_keys($dbg) as $k) {
34			if (!isset($dbg[$k])) {
35			unset($dbg[$k]);
36			}
37			}
38
39			$dbg['statement()'] = $this->statement();
40
41
42			if (empty($this->bindings)) {
43			unset($dbg['bindings']);
44			}
45			else{
46			$dbg['bindings'] = json_encode($dbg['bindings']);
47			}
48
49			return $dbg;
50			}
51
52			public function __toString()
53			{
54			return $this->statement();
55			}
56
57			public function table(): string
58			{
59			return $this->table;
			0 ignored issues – show Bug Best Practice introduced 2024-12-02 21:05 UTC by Report Bug Copy Issue Report The expression `return $this->table` returns the type `string` which is incompatible with the return type mandated by `HexMakina\BlackBox\Datab...QueryInterface::table()` of `HexMakina\BlackBox\Database\TableInterface`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
60			}
61
62			public function alias(): string
63			{
64			return $this->alias ?? $this->table;
65			}
66
67			public function clause(string $name): ?Clause
68			{
69			return $this->clauses[$name] ?? null;
70			}
71
72			public function add(Clause $clause): self
73			{
74			$this->clauses[$clause->name()] = $clause;
75			return $this;
76			}
77
78			public function set(Clause $clause): self
79			{
80			unset($this->clauses[$clause->name()]);
81			return $this->add($clause);
82			}
83
84			//------------------------------------------------------------ PREP::FIELDS
85			public function tableLabel(string $force = null)
86			{
87			return $force ?? $this->tableAlias();
88			}
89
90			public function tableAlias($setter = null): string
91			{
92			if ($setter !== null) {
93			$this->table_alias = $setter;
94			}
95
96			return $this->table_alias ?? $this->table;
97			}
98
99			public function bindings(): array
100			{
101			return $this->bindings;
102			}
103
104			public function getBindingNames(): array
105			{
106			return $this->binding_names;
107			}
108
109			public function addBinding($field, $value, $table_name = null, $bind_label = null): string
110			{
111			$table_label = $this->tableLabel($table_name);
112			$bind_label ??= $this->bindLabel($field, $table_name);
113
114			$this->binding_names[$table_label] ??= [];
115			$this->binding_names[$table_label][$field] = $bind_label;
116			$this->bindings[$bind_label] = $value;
117
118			return $bind_label;
119			}
120
121			public function bindLabel($field, $table_name = null): string
122			{
123			return ':' . $this->tableLabel($table_name) . '_' . $field;
124			}
125
126			public function addBindings($assoc_data): array
127			{
128			$ret = [];
129			foreach ($assoc_data as $column_name => $value) {
130			$ret[$column_name] = $this->addBinding($column_name, $value, $this->table);
131			}
132			return $ret;
133			}
134
135			public function compare($query)
136			{
137			if ($this->statement() !== $query->statement()) {
138			return 'statement';
139			}
140
141			if (!empty(array_diff($this->bindings(), $query->bindings()))) {
142			return 'bindings';
143			}
144			if (!empty(array_diff($query->bindings(), $this->bindings()))) {
145			return 'bindings';
146			}
147
148			return true;
149			}
150			}
151

HexMakina / Crudites

Push — main ( 303b6c...b49db2 )

Query::__debugInfo() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like