PHP SDK Class Reference
Back to top  

ScanLog

Extends \NextEvent\PHPSDK\Model\Model

ScanLog model

A scan log holds entry information of an access code. Those information contain process time, gate which scanned the code and which device has done it. Furthermore it holds connection state information and the validation message. This model can be used to analyze the entrance checks.

package

NextEvent\PHPSDK\Model

Methods

Supports getX or hasX Methods for properties which are yet unknown.

__call(string $name, array $args) : mixed
inherited

If the source of your model contains, e.g. a property named 'my_property', you can call getMyProperty() to retrieve it's value.

Arguments

$name

string

$args

array

Response

mixed

Model constructor

__construct(array $source)
inherited

Parse source data.

Throws
\NextEvent\PHPSDK\Exception\InvalidModelDataException

Arguments

$source

array

The source data as received from the API

Get the value for the given variable.

get(string $var) : mixed
inherited

Should be used, if you expect the model to have custom properties which are not known/covered by the known getters

Arguments

$var

string

Response

mixed

Get the category id for this scan log

getCategoryId() : integer

Response

integer

Get the code, i.e barcode, for this scan log

getCode() : string

Response

string

Get the validation message for this scan log

getConnection() : integer
see \NextEvent\PHPSDK\Model\ScanLog::CONNECTION_ONLINE

For the online connection

\NextEvent\PHPSDK\Model\ScanLog::CONNECTION_OFFLINE

For the offline connection

Response

integer

Get the creation data of this scan log

getCreatedDate() : \NextEvent\PHPSDK\Model\DateTime|null

Response

\NextEvent\PHPSDK\Model\DateTime|null

Get the device id for this scan log

getDeviceId() : integer

Response

integer

Get the entry state for this scan log

getEntryState() : integer
see \NextEvent\PHPSDK\Model\AccessCode::ENTRY_IN

For the in state

\NextEvent\PHPSDK\Model\AccessCode::ENTRY_OUT

For the out state

Response

integer

Get the gate id for this scan log

getGateId() : integer

Response

integer

Get the unique identifier for this scan log

getId() : integer

Response

integer

Get the category id for this scan log

getPriceId() : integer|null

Response

integer|null

Get the processed time for this scan log

getProcessed() : \NextEvent\PHPSDK\Model\DateTime

Response

\NextEvent\PHPSDK\Model\DateTime

Get the validation message for this scan log

getValidation() : string

Response

string

Check model state if it is valid

isValid() : boolean
inherited abstract

Response

boolean

String representation of object

serialize() : string
inherited

Implements Serializable interface

Response

string

Convert model to an Array

toArray() : array
inherited

Response

array

Convert the model for logging

toLogContext() : array
inherited

Implements the LogContextInterface interface

Response

array

Represent the model as string

toString() : string
inherited

Response

string

Constructs the object from a string

unserialize( $serialized)
inherited

Implements Serializable interface

Arguments

$serialized

Constants

Constant for indicating an online connection.

CONNECTION_ONLINE
var

Constant for indicating an offline connection.

CONNECTION_OFFLINE
var