CRUDlex\Entity

Complexity

Total Complexity

23

Size/Duplication

Total Lines	157
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	set()	0	4	1
A	getRaw()	0	7	2
A	get()	0	14	3
A	getDefinition()	0	4	1
B	toType()	0	11	7
C	populateViaRequest()	0	29	8

<?php

/*
 * This file is part of the CRUDlex package.
 *
 * (c) Philip Lehmann-Böhm <philip@philiplb.de>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace CRUDlex;

use Symfony\Component\HttpFoundation\Request;

/**
 * Represents a single set of data in field value pairs like the row in a
 * database. Depends of course on the AbstractData implementation being used.
 * With this objects, the data is passed arround and validated.
 */
class Entity
{

    /**
     * The definition how this entity looks like.
     * @var EntityDefinition
     */
    protected $definition;

    /**
     * Holds the key value data of the entity.
     * @var array
     */
    protected $entity;


    /**
     * Converts a given value to the given type.
     *
     * @param mixed $value
     * the value to convert
     * @param string $type
     * the type to convert to like 'integer' or 'float'
     *
     * @return mixed
     * the converted value
     */
    protected function toType($value, $type)
    {
        if (in_array($type, ['integer', 'float']) && !in_array($value, ['', null], true)) {
            settype($value, $type);
        } else if ($type == 'boolean') {
            $value = (bool)$value;
        } else if ($type == 'many') {
            $value = $value ?: [];
        }
        return $value === '' ? null : $value;
    }


    /**
     * Constructor.
     *
     * @param EntityDefinition $definition
     * the definition how this entity looks
     */
    public function __construct(EntityDefinition $definition)
    {
        $this->definition = $definition;
        $this->entity     = [];
    }

    /**
     * Sets a field value pair of this entity.
     *
     * @param string $field
     * the field
     * @param mixed $value
     * the value
     */
    public function set($field, $value)
    {
        $this->entity[$field] = $value;
    }

    /**
     * Gets the raw value of a field no matter what type it is.
     * This is usefull for input validation for example.
     *
     * @param string $field
     * the field
     *
     * @return mixed
     * null on invalid field or else the raw value
     */
    public function getRaw($field)
    {
        if (!array_key_exists($field, $this->entity)) {
            return null;
        }
        return $this->entity[$field];
    }

    /**
     * Gets the value of a field in its specific type.
     *
     * @param string $field
     * the field
     *
     * @return mixed
     * null on invalid field, an integer if the definition says that the
     * type of the field is an integer, a boolean if the field is a boolean or
     * else the raw value
     */
    public function get($field)
    {
        if ($this->definition->getField($field, 'value') !== null) {
            return $this->definition->getField($field, 'value');
        }

        if (!array_key_exists($field, $this->entity)) {
            return null;
        }

        $type  = $this->definition->getType($field);
        $value = $this->toType($this->entity[$field], $type);
        return $value;
    }

    /**
     * Gets the entity definition.
     *
     * @return EntityDefinition
     * the definition
     */
    public function getDefinition()
    {
        return $this->definition;
    }

    /**
     * Populates the entities fields from the requests parameters.
     *
     * @param Request $request
     * the request to take the field data from
     */
    public function populateViaRequest(Request $request)
    {
        $fields = $this->definition->getEditableFieldNames();
        foreach ($fields as $field) {
            $type = $this->definition->getType($field);
            if ($type === 'file') {
                $file = $request->files->get($field);
                if ($file) {
                    $this->set($field, $file->getClientOriginalName());
                }
            } else if ($type === 'reference') {
                $value = $request->get($field);
                if ($value === '') {
                    $value = null;
                }
                $this->set($field, ['id' => $value]);
            } else if ($type === 'many') {
                $array = $request->get($field, []);
                if (is_array($array)) {
                    $many = array_map(function($id) {
                        return ['id' => $id];
                    }, $array);
                    $this->set($field, $many);
                }
            } else {
                $this->set($field, $request->get($field));
            }
        }
    }

}