Real-time Vehicle Information Proxy
Back to top  

Incoming

Incoming Entity for receiving incoming GPS XML data from /api endpoints

package

App\Entity
ORM\Table

(name="incoming")
ORM\Entity

(repositoryClass="App\Repository\IncomingRepository")

Methods

Incoming constructor instantiates the Doctrine Array Collection class

__construct()

Add an Outgoing Target ID to the Collection of outgoings

addOutgoing(\App\Entity\Outgoing $outgoing) : \App\Entity\Incoming

Arguments

$outgoing

\App\Entity\Outgoing

Response

\App\Entity\Incoming

Doctrine PrePersist actions triggered when record row is requested

createdOnPrePersit()
ORM\PrePersist

Get Incoming GPS ID

getGpsId() : null|string

Response

null|string

Get Incoming Headers array

getHeaders() : array|null

Response

array|null

Get Incoming ID

getId() : integer|null

Response

integer|null

Get Incoming latency value

getLatency() : integer|null

Response

integer|null

Returns the Doctrine Array Collection of associated Outgoing payloads

getOutgoings() : \Doctrine\Common\Collections\Collection|array<mixed,\App\Entity\Outgoing>

Response

\Doctrine\Common\Collections\Collection|array<mixed,\App\Entity\Outgoing>

Get Incoming payload content

getPayload() : string

Response

string

Get Incoming Epoch Timestamp received

getReceived() : integer

Response

integer

Get the collection of Outgoings Targets

removeOutgoing(\App\Entity\Outgoing $outgoing) : \App\Entity\Incoming

Arguments

$outgoing

\App\Entity\Outgoing

Response

\App\Entity\Incoming

Sets the $created timestamp

setCreated(integer $created) : \App\Entity\Incoming

Arguments

$created

integer

Response

\App\Entity\Incoming

Set Incoming GPS ID

setGpsId(string $gpsId) : \App\Entity\Incoming

Arguments

$gpsId

string

Response

\App\Entity\Incoming

Set Incoming Headers array

setHeaders(array $headers) : \App\Entity\Incoming

Arguments

$headers

array

Response

\App\Entity\Incoming

Set Incoming latency value

setLatency(integer $latency) : \App\Entity\Incoming

Arguments

$latency

integer

Response

\App\Entity\Incoming

Set Incoming payload content

setPayload(string $payload) : \App\Entity\Incoming

Arguments

$payload

string

Response

\App\Entity\Incoming

Set Incoming Epoch Timestamp received

setReceived(integer $received) : \App\Entity\Incoming

Arguments

$received

integer

Response

\App\Entity\Incoming

Properties

Auto generated ID

id : integer
var
ORM\Column

(name="id", type="integer", nullable=false)
ORM\Id
ORM\GeneratedValue

(strategy="IDENTITY")

Type(s)

integer

GPS ID received from Incoming XML POST

gpsId : string
var
ORM\Column

(name="gps_id", type="string", length=32, nullable=false)
Assert\NotNull

()

Type(s)

string

Body content payload posted in Incoming XML POST

payload : string
var
ORM\Column

(name="payload", type="text", nullable=false)

Type(s)

string

Headers array in JSON format from Incoming XML POST

headers : array
var
ORM\Column

(name="headers", type="json", nullable=false)

Type(s)

array

Epoch Timestamp from Incoming XML POST

received : integer
var
ORM\Column

(name="received", type="integer", nullable=true)

Type(s)

integer

Calculated latency in seconds from $received until now()

latency : integer|null
var
ORM\Column

(name="latency", type="integer", nullable=true)

Type(s)

integer|null

UTC timestamp of when record was created

created : integer
var
Gedmo\Timestampable

(on="create")
ORM\Column

(type="integer", name="created", nullable=true)

Type(s)

integer

Doctrine Array Collection of associated Outgoing database records

outgoings : \Doctrine\Common\Collections\ArrayCollection
ORM\OneToMany

(targetEntity="App\Entity\Outgoing", mappedBy="incomingId", cascade={"remove"}, orphanRemoval=true)
var

Type(s)

\Doctrine\Common\Collections\ArrayCollection