Kunstmaan / KunstmaanBundlesCMS

src/Kunstmaan/FormBundle/Entity/FormSubmission.php

<?php

namespace Kunstmaan\FormBundle\Entity;

use DateTime;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\ORM\Mapping as ORM;
use Kunstmaan\AdminBundle\Entity\EntityInterface;
use Kunstmaan\NodeBundle\Entity\Node;

/**
 * The form submission
 *
 * @ORM\Entity
 * @ORM\Table(name="kuma_form_submissions")
 * @ORM\HasLifecycleCallbacks()
 */
class FormSubmission implements EntityInterface
{
    /**
     * This id of the form submission
     *
     * @ORM\Id
     * @ORM\Column(type="bigint")
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    protected $id;

    /**
     * The ip address which created this form submission
     *
     * @ORM\Column(type="string", name="ip_address")
     */
    protected $ipAddress;

    /**
     * Link to the node of the form which created this form submission
     *
     * @ORM\ManyToOne(targetEntity="Kunstmaan\NodeBundle\Entity\Node")
     * @ORM\JoinColumn(name="node_id", referencedColumnName="id")
     */
    protected $node;

    /**
     * The language of the form submission
     *
     * @ORM\Column(type="string")
     */
    protected $lang;

    /**
     * The date when the form submission was created
     *
     * @ORM\Column(type="datetime")
     */
    protected $created;

    /**
     * The extra fields with their value, which where configured on the form which created this submission
     *
     * @ORM\OneToMany(targetEntity="FormSubmissionField", mappedBy="formSubmission", cascade={"persist", "remove"})
     * @ORM\OrderBy({"sequence" = "ASC"})
     */
    protected $fields;

    /**
     * Constructor
     */
    public function __construct()
    {
        $this->fields = new ArrayCollection();
        $this->setCreated(new DateTime());
    }

    /**
     * Get id
     *
     * @return int

Should the return type not be string?

     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * Set id
     *
     * @param string $id
     *
     * @return FormSubmission
     */
    public function setId($id)
    {
        $this->id = $id;

        return $this;
    }

    /**
     * Get the ip address which submitted this form submission
     *
     * @return string
     */
    public function getIpAddress()
    {
        return $this->ipAddress;
    }

    /**
     * Set the ip address
     *
     * @param string $ipAddress
     *
     * @return FormSubmission
     */
    public function setIpAddress($ipAddress)
    {
        $this->ipAddress = $ipAddress;

        return $this;
    }

    /**
     * Get the node of the form which created this form submission
     *
     * @return Node
     */
    public function getNode()
    {
        return $this->node;
    }

    /**
     * Set the node of the form which created this form submission
     *
     * @param Node $node
     *
     * @return FormSubmission
     */
    public function setNode($node)
    {
        $this->node = $node;

        return $this;
    }

    /**
     * Sets the language of this form submission
     *
     * @param string $lang
     *
     * @return FormSubmission
     */
    public function setLang($lang)
    {
        $this->lang = $lang;

        return $this;
    }

    /**
     * Get the language of this form submission
     *
     * @return string
     */
    public function getLang()
    {
        return $this->lang;
    }

    /**
     * Set the date when the form submission was created
     *
     * @param datetime $created
     *
     * @return FormSubmission
     */
    public function setCreated($created)
    {
        $this->created = $created;

        return $this;
    }

    /**
     * Get the date when this form submission was created
     *
     * @return datetime
     */
    public function getCreated()
    {
        return $this->created;
    }

    /**
     * Returns the list of fields with their values
     *
     * @return FormSubmissionField[];
     */
    public function getFields()
    {
        return $this->fields;
    }

    /**
     * A string representation of this form submission
     *
     * @return string;

The doc-type string; could not be parsed: Expected "|" or "end of type", but got ";" at position 6. (view supported doc-types)

     */
    public function __toString()
    {
        return 'FormSubmission';
    }
}