---------------
CRUDlex\\Entity
---------------

.. php:namespace: CRUDlex

.. php:class:: Entity

    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.

    .. php:attr:: definition

        protected EntityDefinition

        The definition how this entity looks like.

    .. php:attr:: entity

        protected array

        Holds the key value data of the entity.

    .. php:method:: toType($value, $type)

        Converts a given value to the given type.

        :type $value: mixed
        :param $value: the value to convert
        :type $type: string
        :param $type: the type to convert to like 'integer' or 'float'
        :returns: mixed the converted value

    .. php:method:: __construct(EntityDefinition $definition)

        Constructor.

        :type $definition: EntityDefinition
        :param $definition: the definition how this entity looks

    .. php:method:: set($field, $value)

        Sets a field value pair of this entity.

        :type $field: string
        :param $field: the field
        :type $value: mixed
        :param $value: the value

    .. php:method:: getRaw($field)

        Gets the raw value of a field no matter what type it is.
        This is usefull for input validation for example.

        :type $field: string
        :param $field: the field
        :returns: mixed null on invalid field or else the raw value

    .. php:method:: get($field)

        Gets the value of a field in its specific type.

        :type $field: string
        :param $field: the field
        :returns: 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

    .. php:method:: getDefinition()

        Gets the entity definition.

        :returns: EntityDefinition the definition

    .. php:method:: populateViaRequest(Request $request)

        Populates the entities fields from the requests parameters.

        :type $request: Request
        :param $request: the request to take the field data from