Classes, interfaces and traits
Spawnable¶
A class which implements the Spawnable interface can be used to define whether a Model can be created, without
having specific properties set, such as a unique identifier.
« More »
AccessCode¶
Access code model
An access code is used in the entrance check process.
Each access code owns a (bar)code, a category id and a state.
A [Gate](../classes/NextEvent.PHPSDK.Model.Gate.html) is responsible for invalidating,
i.e. modifying the `entry_state`, of such an access code.
« More »
AccessCodeCollection¶
The access code collection holds access code instances.
An instance of this collection can update the entry state of all access codes inside of it with one single API
request.
« More »
APIResponse¶
Class APIResponse
A wrapper class for responses returned by GuzzleHttp.
Adds utility functions used by the SDK
« More »
BaseCategory¶
BaseCategory model
Provides the structure for a base category record.
Base categories are categories which can not be booked and are never linked to an order item.
Base categories are internally used to create category records.
All values which are set for a base category will automatically be applied to
the related category records.
« More »
BasePrice¶
BasePrice model
Provides the structure for a base price record.
A base price is a price which applies it's data to actual price records.
A base price is never linked to a category record.
It rather links to a [BaseCategory](../classes/NextEvent.PHPSDK.Model.BaseCategory.html).
Just like a base category, a base price is never linked to an order item.
« More »
Basket¶
Basket model
Represents a basket model retrieved from the API
« More »
BasketItem¶
BasketItem model
Model class representing a single item (ticket) of a NextEvent basket
« More »
CancellationRequest¶
Cancellation request model
Represents a cancellation request for a given order.
Can be used to confirm cancellation in a second step.
« More »
Category¶
Category model
Struct for a category record assigned to an order/basket item.
« More »
Collection¶
A collection holds instances of models by converting them from raw data.
It has meta information about the total amount of items, pages and references to other pages.
Further more it allows to iterate over all total items, by simply fetching the next page if the bounds
of the current page have been reached.
If you want to fetch the next page manually, you can call [Collection::fetchNextPage()](../classes/NextEvent.PHPSDK.Model.Collection.html#method_fetchNextPage).
This will fetch the next page, if it is available and apply the content to this collection.
In order to fetch a specific page and apply it to the collection, you can fetch it with the rest client
and then apply it via [Collection::setData()](../classes/NextEvent.PHPSDK.Model.Collection.html#method_setData). Whether you want to reset the current data or not
can be controlled with the flag `reset`.
« More »
DateTime¶
Class DateTime
Extend the default DateTime class with a flag indicating that it
only represent a date and the time should be ignored.
« More »
Device¶
Device model
A device entity represents a real world device.
It holds information such as the device UUID, platform(os) and it's version and the device name.
A device can also tell on which gate it is logged in and when it has been logged in the last time.
« More »
DiscountCode¶
Discount code model
Struct for a discount code record assigned to an order/basket item or a DiscountGroup relation.
« More »
DiscountGroup¶
Discount group model
Struct for a discount group registered in the system.
« More »
Event¶
Event model
Model class for an event record registered in NextEvent.
Provides simplified access to event title, details, start/end dates, etc.
« More »
Gate¶
Gate model
A gate represents an entity which is responsible for invalidating access codes.
It can only invalidate those access codes whose category id matches one of the gate's category ids.
« More »
GeoCoordinates¶
GeoCoordinates model
Struct for a pair of geographic coordinates as defined
in the World Geodetic System (WGS 84).
« More »
Location¶
Location model
Represents a geographic place, like the location of an event.
« More »
Model¶
Base class for model classes
Data structures retrieved from the NextEvent API are wrapped
into dependants of this class in order to provide a well-defined
struct for accessing these informations.
With the Serializable interface implemented, all models
can easily be serialized and stored in session data.
« More »
MutableModel¶
A mutable model is a model whose source attributes can be changed.
An instance of a mutable model provides setters for any property.
This means you can call e.g. `$model->setFoo($val)` which will will store the value at the index `foo`
in the internal source array.
You can also override the whole source at once with the [MutableModel::setSource()](../classes/NextEvent.PHPSDK.Model.MutableModel.html#method_setSource).
« More »
Order¶
Order model
Represents an order record retrieved from the API.
« More »
OrderDocument¶
OrderDocument model
Represents a printable PDF document attached to an order
« More »
OrderItem¶
OrderItem model
Model class representing a single item of a NextEvent order
« More »
Organization¶
Organization model
Represents an organization entity
« More »
Payment¶
Payment model
Represents a payment authorization record issued by the API.
Can be used to process payment and finally settle orders.
« More »
PostalAddress¶
Class PostalAddress
Represents an postal address data structure
« More »
Price¶
Price model
Model class exposing price properties like title, price, currency
« More »
ScanLog¶
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.
« More »
Seat¶
Seat information model
Struct for seat information assigend an order/basket item.
« More »
Ticket¶
Ticket model
Model class representing a booked ticket
« More »
TicketDocument¶
TicketDocument model
Represents a printable PDF document attached to a ticket
« More »