Lagdo\DbAdmin\DbAdmin\TableQueryAdmin

Complexity

Total Complexity

27

Size/Duplication

Total Lines	220
Duplicated Lines	0 %

Importance

Changes	6
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	insertItem()	0	20	6
A	getQueryData()	0	57	5
B	getFieldInput()	0	26	7
A	getQueryEntries()	0	13	4
A	updateItem()	0	23	4
A	deleteItem()	0	15	1

<?php

namespace Lagdo\DbAdmin\DbAdmin;

use Lagdo\DbAdmin\DbAdmin\Traits\QueryInputTrait;
use Lagdo\DbAdmin\DbAdmin\Traits\TableQueryTrait;

This use statement conflicts with another class in this namespace, Lagdo\DbAdmin\DbAdmin\TableQueryTrait. Consider defining an alias.

use Lagdo\DbAdmin\Driver\Entity\TableFieldEntity;

use function compact;
use function is_array;
use function count;
use function preg_match;

/**
 * Admin table query functions
 */
class TableQueryAdmin extends AbstractAdmin
{
    use QueryInputTrait;

The trait Lagdo\DbAdmin\DbAdmin\Traits\QueryInputTrait requires some properties which are not provided by Lagdo\DbAdmin\DbAdmin\TableQueryAdmin: $fullType, $null, $unsigned, $length, $type

    use TableQueryTrait;

The trait Lagdo\DbAdmin\DbAdmin\Traits\TableQueryTrait requires some properties which are not provided by Lagdo\DbAdmin\DbAdmin\TableQueryAdmin: $privileges, $onUpdate, $default, $generated, $type, $autoIncrement

    /**
     * Get data for an input field
     *
     * @param TableFieldEntity $field
     * @param mixed $value
     * @param string|null $function
     * @param array $options
     *
     * @return array
     */
    protected function getFieldInput(TableFieldEntity $field, $value, $function, array $options): array
    {
        // From functions.inc.php (function input($field, $value, $function))
        $name = $this->util->html($this->util->bracketEscape($field->name));
        $save = $options["save"];
        $reset = ($this->driver->jush() == "mssql" && $field->autoIncrement);
        if (is_array($value) && !$function) {
            $value = json_encode($value, JSON_PRETTY_PRINT);
            $function = "json";
        }
        if ($reset && !$save) {
            $function = null;
        }
        $functions = [];
        if ($reset) {
            $functions["orig"] = $this->trans->lang('original');
        }
        $functions += $this->util->editFunctions($field);
        return [
            'type' => $this->util->html($field->fullType),
            'name' => $name,
            'field' => [
                'type' => $field->type,
            ],
            'functions' => $this->getEntryFunctions($field, $name, $function, $functions),
            'input' => $this->getEntryInput($field, $name, $value, $function, $functions, $options),
        ];
    }

    /**
     * @param array $fields
     * @param array|null $row
     * @param string $update
     * @param array $queryOptions
     *
     * @return array
     */
    private function getQueryEntries(array $fields, $row, string $update, array $queryOptions): array
    {
        $entries = [];
        foreach ($fields as $name => $field) {
            $value = $this->getRowFieldValue($field, $name, $row, $update, $queryOptions);
            $function = $this->getRowFieldFunction($field, $name, $value, $update, $queryOptions);
            if (preg_match("~time~", $field->type) && preg_match('~^CURRENT_TIMESTAMP~i', $value)) {

It seems like $value can also be of type false; however, parameter $subject of preg_match() does only seem to accept string, maybe add an additional type check?

                $value = "";
                $function = "now";
            }
            $entries[$name] = $this->getFieldInput($field, $value, $function, $queryOptions);
        }
        return $entries;
    }

    /**
     * Get data for insert/update on a table
     *
     * @param string $table         The table name
     * @param array  $queryOptions  The query options
     *
     * @return array
     */
    public function getQueryData(string $table, array $queryOptions = []): array
    {
        $isInsert = (count($queryOptions) === 0); // True only on insert.
        // Default options
        $queryOptions['clone'] = false;
        $queryOptions['save'] = false;

        list($fields, $where, $update) = $this->getFields($table, $queryOptions);
        $row = $this->getQueryFirstRow($table, $where, $fields, $queryOptions);

        /* TODO: Activate this code when a driver without table support will be supported */
        /*if (!$this->driver->support("table") && empty($fields)) {
            $primary = ''; // $this->driver->primaryIdName();
            if (!$where) {
                // insert
                $statement = $this->driver->select($table, ["*"], [$where], ["*"]);
                $row = ($statement ? $statement->fetchAssoc() : false);
                if (!$row) {
                    $row = [$primary => ""];
                }
            }
            if ($row) {
                foreach ($row as $key => $val) {
                    if (!$where) {
                        $row[$key] = null;
                    }
                    $fields[$key] = [
                        "name" => $key,
                        "null" => ($key !== $primary),
                        "autoIncrement" => ($key === $primary)
                    ];
                }
            }
        }*/

        // From functions.inc.php (function edit_form($table, $fields, $row, $update))
        $entries = [];
        $tableName = $this->util->tableName($this->driver->tableStatusOrName($table, true));
        $error = null;
        if (($where) && $row === null) { // No row found to edit.
            $error = $this->trans->lang('No rows.');
        } elseif (empty($fields)) {
            $error = $this->trans->lang('You have no privileges to update this table.');
        } else {
            $entries = $this->getQueryEntries($fields, $row, $update, $queryOptions);
        }

        $mainActions = [
            'query-back' => $this->trans->lang('Back'),
            'query-save' => $this->trans->lang('Save'),
        ];
        if ($isInsert) {
            $mainActions['query-save-select'] = $this->trans->lang('Save and select');
        }

        $fields = $entries;
        return compact('mainActions', 'tableName', 'error', 'fields');
    }

    /**
     * Insert a new item in a table
     *
     * @param string $table         The table name
     * @param array  $queryOptions  The query options
     *
     * @return array
     */
    public function insertItem(string $table, array $queryOptions): array
    {
        list($fields, ,) = $this->getFields($table, $queryOptions);

        // From edit.inc.php
        $values = [];
        foreach ($fields as $name => $field) {
            $val = $this->util->processInput($field, $queryOptions);
            if ($val !== false && $val !== null) {
                $values[$this->driver->escapeId($name)] = $val;
            }
        }

        $result = $this->driver->insert($table, $values);
        $lastId = ($result ? $this->driver->lastAutoIncrementId() : 0);
        $message = $this->trans->lang('Item%s has been inserted.', ($lastId ? " $lastId" : ""));

        $error = $this->driver->error();

        return compact('result', 'message', 'error');
    }

    /**
     * Update one or more items in a table
     *
     * @param string $table         The table name
     * @param array  $queryOptions  The query options
     *
     * @return array
     */
    public function updateItem(string $table, array $queryOptions): array
    {
        list($fields, $where, $update) = $this->getFields($table, $queryOptions);

        // From edit.inc.php
        $indexes = $this->driver->indexes($table);
        $uniqueIds = $this->util->uniqueIds($queryOptions["where"], $indexes);
        $queryWhere = "\nWHERE $where";

        $values = [];
        foreach ($fields as $name => $field) {
            $val = $this->util->processInput($field, $queryOptions);
            if ($val !== false && $val !== null) {
                $values[$this->driver->escapeId($name)] = $val;
            }
        }

        $result = $this->driver->update($table, $values, $queryWhere, count($uniqueIds));
        $message = $this->trans->lang('Item has been updated.');

        $error = $this->driver->error();

        return compact('result', 'message', 'error');
    }

    /**
     * Delete one or more items in a table
     *
     * @param string $table         The table name
     * @param array  $queryOptions  The query options
     *
     * @return array
     */
    public function deleteItem(string $table, array $queryOptions): array
    {
        list($fields, $where, $update) = $this->getFields($table, $queryOptions);

        // From edit.inc.php
        $indexes = $this->driver->indexes($table);
        $uniqueIds = $this->util->uniqueIds($queryOptions["where"], $indexes);
        $queryWhere = "\nWHERE $where";

        $result = $this->driver->delete($table, $queryWhere, count($uniqueIds));
        $message = $this->trans->lang('Item has been deleted.');

        $error = $this->driver->error();

        return compact('result', 'message', 'error');
    }
}