HexMakina / Crudites

src/Row.php

<?php

namespace HexMakina\Crudites;

use HexMakina\BlackBox\Database\ConnectionInterface;
use HexMakina\BlackBox\Database\RowInterface;
use HexMakina\BlackBox\Database\ResultInterface;

The type HexMakina\BlackBox\Database\ResultInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use HexMakina\Crudites\CruditesException;

class Row implements RowInterface
{
    private string $table;

    private ConnectionInterface $connection;

    /** @var array<int|string,mixed>|null $load from database */
    private ?array $load = null;

    /** @var array<int|string,mixed> $fresh from the constructor */
    private array $fresh = [];

    /** @var array<int|string,mixed> $alterations during lifecycle */
    private array $alterations = [];

    /** @var ResultInterface|null $result the result from the last executed query */
    private ?ResultInterface $result = null;


    /** @param array<string,mixed> $datass */
    /**
     * Represents a row in a table.
     *
     * @param ConnectionInterface $connection The database connection.
     * @param string $table The table name.
     * @param array $fresh The fresh data for the row.
     */
    public function __construct(ConnectionInterface $connection, string $table, array $fresh = [])
    {
        $this->connection = $connection;
        $this->table = $table;
        $this->fresh = $fresh;
    }

    // property overloading
    public function __get($name)
    {
        return $this->alterations[$name]
            ?? $this->fresh[$name]
            ?? $this->load[$name]
            ?? null;
    }

    public function __isset($name)
    {
        return isset($this->alterations[$name])
            || isset($this->fresh[$name])
            || isset($this->load[$name]);
    }

    public function __set(string $name, $value = null)
    {
        if (
            $value === $this->$name
            || !$this->connection->schema()->hasColumn($this->table, $name)
        ) {
            return;
        }

        $attributes = $this->connection->schema()->attributes($this->table, $name);

        // skip auto_incremented columns
        if ($attributes->isAuto()) {
            return;
        }

        // Replace empty strings with null if the column is nullable
        if (trim((string)$value) === '' && $attributes->nullable()) {
            $value = null;
        }

        // checks for changes with loaded data. using == instead of === is risky but needed
        if ($this->isNew() || $this->load[$name] != $value) {
            $this->alterations[$name] = $value;
        }

    }

    public function __unset($name)
    {
        unset($this->alterations[$name]);
    }

    // output
    public function __toString()
    {
        return PHP_EOL . 'load: '
            . json_encode($this->load)
            . PHP_EOL . 'alterations: '
            . json_encode(array_keys($this->alterations));
    }

    public function __debugInfo()
    {
        return [
            'table' => $this->table,
            'load' => $this->load,
            'fresh' => $this->fresh,
            'alterations' => $this->alterations,
            'result' => $this->result,
        ];
    }

    public function import(array $dat_ass): RowInterface
    {
        foreach ($dat_ass as $k => $v) {
            $this->$k = $v;
        }

        return $this;
    }

    
    public function export(): array
    {
        return array_merge((array)$this->load, $this->fresh, $this->alterations);
    }



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

The expression return $this->table returns the type string which is incompatible with the return type mandated by HexMakina\BlackBox\Database\RowInterface::table() of HexMakina\BlackBox\Database\TableInterface.

    }

    public function isNew(): bool
    {
        return empty($this->load);
    }

    public function isAltered(): bool
    {
        return !empty($this->alterations);
    }

    public function load(?array $datass = null): Rowinterface
    {
        $unique_match = $this->connection->schema()->matchUniqueness($this->table, $datass ?? $this->export());
        if (empty($unique_match)) {
            return $this;
        }

        $query = $this->connection->schema()->select($this->table);
        $query->where()->andFields($unique_match, $this->table, '=');

        try{
            $this->result = $this->connection->result($query);
        }
        catch(\Throwable $t){

Consider adding a comment why this CATCH block is empty.

        }

        $res = $this->result->retOne(\PDO::FETCH_ASSOC);

The method retOne() does not exist on null.

        $this->load = $res === false ? null : $res;

        return $this;
    }

    /**
     * @return array<string,string> an array of errors, column name => message
     */
    public function save(): array
    {
        if (!$this->isNew() && !$this->isAltered()) { // existing record with no alterations
            return [];
        }

        if (!empty($errors = $this->validate())) { // Table level validation
            return $errors;
        }
        try {
            if ($this->isNew()) {
                $this->create($this->connection);

The call to HexMakina\Crudites\Row::create() has too many arguments starting with $this->connection.

            } else {
                $this->update($this->connection);

The call to HexMakina\Crudites\Row::update() has too many arguments starting with $this->connection.

            }
        } catch (CruditesException $cruditesException) {
            return [$this->table => $cruditesException->getMessage()];
        }

        return [];
    }


    /**
     * Deletes the current record from the database.
     * 
     * @return bool true if the record was deleted, false otherwise.
     * @throws CruditesException if a unique match is not found.
     */
    public function wipe(): bool
    {
        $datass = $this->load ?? $this->fresh ?? $this->alterations;

        // need The Primary key, then you can wipe at ease
        if (!empty($pk_match = $this->connection->schema()->matchPrimaryKeys($this->table, $datass))) {
            $query = $this->connection->schema()->delete($this->table, $pk_match);

            $this->result = $this->connection->result($query);
            return $this->result->ran();
        }

        return false;
    }


    /**
     * Creates a new record in the database.
     * Executes an insert query with the current data and updates the alterations tracker with the auto-incremented primary key value if applicable.
     */
    private function create(): void
    {
        $query = $this->connection->schema()->insert($this->table, $this->export());
        $this->result = $this->connection->result($query);

        // creation might lead to auto_incremented changes
        // recovering auto_incremented value and pushing it in alterations tracker
        $aipk = $this->connection->schema()->autoIncrementedPrimaryKey($this->table);
        if ($aipk !== null) {
            $this->$aipk = $this->result->lastInsertId();
        }
    }

    /**
     * Updates the existing record in the database with the current alterations.
     *
     * @throws CruditesException if a unique match is not found.
     */
    private function update(): void
    {
        $unique_match = $this->connection->schema()->matchUniqueness($this->table, $this->load);

        if (empty($unique_match)) {
            throw new CruditesException('NO_UNIQUE_MATCH_IN_LOAD_ARRAY');
        }

        $query = $this->connection->schema()->update($this->table, $this->alterations, $unique_match);
        $this->result = $this->connection->result($query);
    }


    //------------------------------------------------------------  type:data validation
    /**
     * @return array<mixed,string> containing all invalid data, indexed by field name, or empty if all valid
     */
    public function validate(): array
    {
        $errors = [];
        $datass = $this->export();

        foreach ($this->connection->schema()->columns($this->table) as $column_name) {

            $attribute = $this->connection->schema()->attributes($this->table, $column_name);
            $column_errors = $attribute->validateValue($datass[$column_name] ?? null);

            if (!empty($column_errors)) {
                $errors[$column_name] = $column_errors;
            }
        }

        return $errors;
    }
}