Entity::toArray() - Code Metrics - Inspection of "Se agrega Entity::toArray()" - derafu/derafu-lib-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( d7b36e...d1a0c2 )

by Esteban De La Fuente
created 2025-01-09 15:12 UTC
Entity::toArray() A

↳ Parent: Entity
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	2
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	3
ccs	0
cts	2
cp	0
crap	2
rs	10
<?php

declare(strict_types=1);

/**
 * Derafu: Biblioteca PHP (Núcleo).
 * Copyright (C) Derafu <https://www.derafu.org>
 *
 * Este programa es software libre: usted puede redistribuirlo y/o modificarlo
 * bajo los términos de la Licencia Pública General Affero de GNU publicada por
 * la Fundación para el Software Libre, ya sea la versión 3 de la Licencia, o
 * (a su elección) cualquier versión posterior de la misma.
 *
 * Este programa se distribuye con la esperanza de que sea útil, pero SIN
 * GARANTÍA ALGUNA; ni siquiera la garantía implícita MERCANTIL o de APTITUD
 * PARA UN PROPÓSITO DETERMINADO. Consulte los detalles de la Licencia Pública
 * General Affero de GNU para obtener una información más detallada.
 *
 * Debería haber recibido una copia de la Licencia Pública General Affero de GNU
 * junto a este programa.
 *
 * En caso contrario, consulte <http://www.gnu.org/licenses/agpl.html>.
 */

namespace Derafu\Lib\Core\Package\Prime\Component\Entity\Entity;

use Derafu\Lib\Core\Package\Prime\Component\Entity\Contract\EntityInterface;
use LogicException;

/**
 * Clase genérica para el manejo de entidades de repositorios.
 *
 * Esta clase es útil cuando no se desea crear explícitamente cada clase de cada
 * entidad. Sin embargo, es desaconsejado su uso y se recomienda crear clases
 * para cada entidad que se requiera.
 */
class Entity implements EntityInterface
{
    /**
     * Atributos de la entidad.
     *
     * @var array
     */
    private array $attributes = [];

    /**
     * {@inheritdoc}
     */
    public function __toString(): string
    {
        return static::class . '@' . spl_object_id($this);
    }

    /**
     * {@inheritdoc}
     */
    public function toArray(): array
    {
        return $this->attributes;
    }

    /**
     * {@inheritdoc}
     */
    public function setAttribute(string $name, int|float|string|bool|null $value): static
    {
        $this->attributes[$name] = $value;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function getAttribute(string $name): int|float|string|bool|null
    {
        if (!$this->hasAttribute($name)) {
            throw new LogicException(sprintf(
                'No existe el atributo %s en la entidad %s.',
                $name,
                static::class
            ));
        }

        return $this->attributes[$name];
    }

    /**
     * {@inheritdoc}
     */
    public function hasAttribute(string $name): bool
    {
        return array_key_exists($name, $this->attributes);
    }

    /**
     * {@inheritdoc}
     */
    public function unsetAttribute(string $name): void
    {
        unset($this->attributes[$name]);
    }

    /**
     * Método mágico para asignar el valor de un atributo como si estuviese
     * definido en la clase.
     *
     * Se ejecuta al escribir datos sobre propiedades inaccesibles (protegidas
     * o privadas) o inexistentes.
     *
     * @param string $name
     * @param int|float|string|bool|null $value
     * @return void
     */
    public function __set(string $name, int|float|string|bool|null $value): void
    {
        $this->setAttribute($name, $value);
    }

    /**
     * Método mágico para obtener el valor de un atributo como si estuviese
     * definido en la clase.
     *
     * Se utiliza para consultar datos a partir de propiedades inaccesibles
     * (protegidas o privadas) o inexistentes.
     *
     * @param string $name
     * @return int|float|string|bool|null
     */
    public function __get(string $name): int|float|string|bool|null
    {
        return $this->getAttribute($name);
    }

    /**
     * Método mágico para saber si un atributo existe, y tiene valor, como si
     * estuviese definido en la clase.
     *
     * Se lanza al llamar a isset() o a empty() sobre propiedades inaccesibles
     * (protegidas o privadas) o inexistentes.
     *
     * @param string $name
     * @return boolean
     */
    public function __isset(string $name): bool
    {
        return $this->hasAttribute($name);
    }

    /**
     * Método mágico para desasignar el valor de un atributo como si estuviese
     * definido en la clase.
     *
     * Se invoca cuando se usa unset() sobre propiedades inaccesibles
     * (protegidas o privadas) o inexistentes.
     *
     * @param string $name
     * @return void
     */
    public function __unset(string $name): void
    {
        $this->setAttribute($name, null);
    }

    /**
     * Es lanzado al invocar un método inaccesible en un contexto de objeto.
     *
     * Específicamente procesa las llamadas a los "accessors" ("getters") y
     * "mutators" ("setters").
     *
     * @param string $name
     * @param array $arguments
     * @return mixed
     */
    public function __call(string $name, array $arguments)
    {
        // Si es un "accessor" getXyz() se procesa.
        $pattern = '/^get([A-Z][a-zA-Z0-9]*)$/';
        if (preg_match($pattern, $name, $matches)) {
            return $this->getAttribute(lcfirst($matches[1]));
        }

        // Si es un "mutator" setXyz() se procesa.
        $pattern = '/^set([A-Z][a-zA-Z0-9]*)$/';
        if (preg_match($pattern, $name, $matches)) {
            return $this->setAttribute(lcfirst($matches[1]), ...$arguments);
            return $this->setAttribute(lcfirst($matches[1]), /** @scrutinizer ignore-type */ ...$arguments);
        }

        // Si el método no existe se genera una excepción.
        throw new LogicException(sprintf(
            'El método %s::%s() no existe.',
            get_debug_type($this),
            $name,
        ));
    }

    /**
     * Es lanzado al invocar un método inaccesible en un contexto estático.
     *
     * @param string $name
     * @param array $arguments
     * @return mixed
     */
    public static function __callStatic(string $name, array $arguments)
    {
        // Si el método no existe se genera una excepción.
        throw new LogicException(sprintf(
            'El método %s::%s() no existe.',
            static::class,
            $name,
        ));
    }
}

derafu / derafu-lib-core

Push — master ( d7b36e...d1a0c2 )

Entity::toArray() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
