Query::clause() - Code Metrics - HexMakina/Crudites - Measure and Improve Code Quality continuously with Scrutinizer

Query::clause() A
last analyzed 2025-03-10 00:20 UTC

↳ Parent: Query

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace HexMakina\Crudites\Grammar\Query;

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

abstract class Query implements QueryInterface
{
    protected array $bindings = [];
    
    protected string $table;
    protected ?string $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;
    }

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

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

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

    public function set(ClauseInterface $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->alias = $setter;
        }

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

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

        return array_merge($this->bindings, array_reduce($this->clauses, function ($carry, $clause) {
            return array_merge($carry, $clause->bindings());
        }, []));
    }
    
    public function addBinding($field, $value, $table_name = null, $bind_label = null): string
    {
        $bind_label ??= $this->bindLabel($field, $table_name);

        $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, $binding_label = null): array
    {
        $ret = [];
        
        $binding_label ??= $this->base();
        $index = count($this->bindings);
        
        foreach ($assoc_data as $column_name => $value) {
            $ret[$column_name] = $this->addBinding($column_name, $value, $this->table, $binding_label.'_'.$column_name.'_'.($index++));
        }
        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, ClauseInterface};
			0 ignored issues – show Bug introduced 2024-12-06 01:12 UTC by Report Bug Copy Issue Report The type `HexMakina\BlackBox\Database\ClauseInterface` 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			abstract class Query implements QueryInterface
8			{
9			protected array $bindings = [];
10
11			protected string $table;
12			protected ?string $alias = null;
13
14
15			protected array $clauses = [];
16
17			abstract public function statement(): string;
18
19			/**
20			* Provides debugging information about the object.
21			* This method returns an array of object properties and their values,
22			* excluding properties that are not set.
23			*/
24			public function __debugInfo(): array
25			{
26			$dbg = get_object_vars($this);
27
28			foreach (array_keys($dbg) as $k) {
29			if (!isset($dbg[$k])) {
30			unset($dbg[$k]);
31			}
32			}
33
34			$dbg['statement()'] = $this->statement();
35
36
37			if (empty($this->bindings)) {
38			unset($dbg['bindings']);
39			}
40			else{
41			$dbg['bindings'] = json_encode($dbg['bindings']);
42			}
43
44			return $dbg;
45			}
46
47			public function __toString()
48			{
49			return $this->statement();
50			}
51
52			public function table(): string
53			{
54			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...
55			}
56
57			public function alias(): ?string
58			{
59			return $this->alias;
60			}
61
62			public function base(): string
63			{
64			return $this->alias ?? $this->table;
65			}
66
67			public function clause(string $name): ?ClauseInterface
68			{
69			return $this->clauses[$name] ?? null;
70			}
71
72			public function add(ClauseInterface $clause): self
73			{
74			$this->clauses[$clause->name()] = $clause;
75			return $this;
76			}
77
78			public function set(ClauseInterface $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->alias = $setter;
94			}
95
96			return $this->alias ?? $this->table;
97			}
98
99			public function bindings(): array
100			{
101			if(empty($this->clauses)){
102			return $this->bindings;
103			}
104
105			return array_merge($this->bindings, array_reduce($this->clauses, function ($carry, $clause) {
106			return array_merge($carry, $clause->bindings());
107			}, []));
108			}
109
110			public function addBinding($field, $value, $table_name = null, $bind_label = null): string
111			{
112			$bind_label ??= $this->bindLabel($field, $table_name);
113
114			$this->bindings[$bind_label] = $value;
115
116			return $bind_label;
117			}
118
119			public function bindLabel($field, $table_name = null): string
120			{
121			return ':' . $this->tableLabel($table_name) . '_' . $field;
122			}
123
124			public function addBindings($assoc_data, $binding_label = null): array
125			{
126			$ret = [];
127
128			$binding_label ??= $this->base();
129			$index = count($this->bindings);
130
131			foreach ($assoc_data as $column_name => $value) {
132			$ret[$column_name] = $this->addBinding($column_name, $value, $this->table, $binding_label.'_'.$column_name.'_'.($index++));
133			}
134			return $ret;
135			}
136
137			public function compare($query)
138			{
139			if ($this->statement() !== $query->statement()) {
140			return 'statement';
141			}
142
143			if (!empty(array_diff($this->bindings(), $query->bindings()))) {
144			return 'bindings';
145			}
146			if (!empty(array_diff($query->bindings(), $this->bindings()))) {
147			return 'bindings';
148			}
149
150			return true;
151			}
152			}
153

HexMakina / Crudites

Query::clause() A last analyzed 2025-03-10 00:20 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Query::clause() A
last analyzed 2025-03-10 00:20 UTC