API Documentation
\
Copilot
Client

\Copilot\ClientEvent

An event contains information about the real world event (either concert or event).

Summary

Methods
Properties
Constants
getId()
getDescription()
getDateOfEvent()
getEntranceTime()
getStartTime()
getTicketUrl()
getTicketPhone()
isSoldOut()
getTourName()
getTourDescription()
getLocation()
getMainAct()
getEventImageLink()
getSupportActs()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

getId()

getId() : string

Returns the id of the event

Returns

string —

The events id

getDescription()

getDescription() : string

Returns the descriptional text of the event

Returns

string —

The events description

getDateOfEvent()

getDateOfEvent(string  $format = "d.m.Y") : string

Returns the date of the event in the desired date format.

Note that this is really just a date and does not include time information

Parameters

string $format

The format of the date.

Returns

string —

The date in the given format, or in the original format if the date could not be parsed or an empty string if no date is available

getEntranceTime()

getEntranceTime(string  $format = "H:i") : string

Returns the entrance time for the event (does not contain date information)

Parameters

string $format

The format in which to display the entrance time

Returns

string —

The entrance time in the given format or in the original format if the time could not be parsed or an empty string if the time is not available

getStartTime()

getStartTime(string  $format = "H:i") : string

Returns the start time of the event (does not contain date information)

Parameters

string $format

The format in which to display the start time

Returns

string —

The start time in the given format or in the original format if the time could not be parsed or an empty string if the time is not available

getTicketUrl()

getTicketUrl() : string|NULL

Returns an URL pointing to a resource from where to buy tickets for the event

Returns

string|NULL —

The URL to the webpage or NULL if the information is not available

getTicketPhone()

getTicketPhone() : string|NULL

Returns a string containing a phone number from where to buy tickets for the event

Returns

string|NULL —

The phone number or NULL if the information is not available

isSoldOut()

isSoldOut() : boolean|NULL

Returns whether or not the event is sold out (no more tickets available execpt for box office)

Returns

boolean|NULL —

True when the event is sold out, false if not. Might return NULL if the information is not available

getTourName()

getTourName() : string

Returns the name of the tour the event belongs to

Returns

string —

The tour name or NULL if the event does not have a tour.

getTourDescription()

getTourDescription() : string

Returns the descriptional information of the tour the event belongs to

Returns

string —

The description of the tour or NULL if the event does not have a tour.

getLocation()

getLocation() : \Copilot\Client\Location

Returns the location the event will take place at

Returns

\Copilot\Client\Location —

The location of the event or NULL if that information is not available

getMainAct()

getMainAct() : \Copilot\Client\Artist|NULL

Returns the main act of the event.

Returns

\Copilot\Client\Artist|NULL —

The mainact of the event or NULL if the information is not available

getEventImageLink()

getEventImageLink(integer  $width) : string

Returns an URL to a suitable image for the event.

The image returned depends on the available data. The image will be resolved in the following order 1) The artists main image or 2) the artists band logo or 3) the artists press image

Parameters

integer $width

The width of the image to be returned

Returns

string —

The images URL or NULL if no image can be found

getSupportActs()

getSupportActs() : array<mixed,\Copilot\Client\Artist>

Returns all support acts in the given event

Returns

array<mixed,\Copilot\Client\Artist> —

An array of Artist's that appear as support acts