__construct()
__construct(string $baseurl)
Creates a new client for the given base url
Parameters
| string | $baseurl | The URL the client will retrieve it's information from |
This is the base class for usage by 3rd party developers.
This class provides methods to retrieve all public information from a co*pilot installation. This ranges from artists to events (and concerts) to newsfeed and newsletter subscription.
The client is constructed by providing the baseurl to the copilot installation the client should talk with. For information on the base url please contact us at support@copilot-office.de
getAgencyArtists(\Copilot\Client\Page $page = NULL) : array<mixed,\Copilot\Client\Artist>
Returns all artists that are managed by the agency
| \Copilot\Client\Page | $page | The page object to be used |
Array of artists managed by the agency
getExternalArtists(\Copilot\Client\Page $page = NULL) : array<mixed,\Copilot\Client\Artist>
Returns all artists that are not managed by the agency (artists booked for concerts)
| \Copilot\Client\Page | $page | The page object to be used |
Array of artists not managed by the agency
getArtistById(string $id) : \Copilot\Client\Artist
Returns a artists details for the given id
| string | $id | The id of the artist |
The artist to be returned
getVideos(\Copilot\Client\Artist $artist) : array<mixed,\Copilot\Client\Video>
Returns all videos for the given artist
| \Copilot\Client\Artist | $artist | The artist |
Array of videos for the given artist. Might be empty but never NULL
getFutureEvents(\Copilot\Client\Artist $artist, \Copilot\Client\Page $page = NULL) : array<mixed,\Copilot\Client\Event>
Returns an array of all upcoming events for the given artist
| \Copilot\Client\Artist | $artist | The artist for whom to retrieve future events |
| \Copilot\Client\Page | $page | The page object to be used |
The event for the given artist
getAllEvents(\Copilot\Client\Page $page = NULL) : array<mixed,\Copilot\Client\Event>
Returns all events from the past until the future
| \Copilot\Client\Page | $page | The page object to be used |
All events from the past to the future
getEventsFrom(string $from, \Copilot\Client\Page $page = NULL) : array<mixed,\Copilot\Client\Event>
Returns all events from the given date
| string | $from | The date in format "Y-m-d" |
| \Copilot\Client\Page | $page | The page object to be used |
The events in the given timerange
getEventById(string $id) : \Copilot\Client\Event
Returns a single event by it's id
| string | $id | The id of the event to be retrieved |
The event
getAllConcerts(\Copilot\Client\Page $page = NULL) : array<mixed,\Copilot\Client\Event>
Returns all concerts from the past to the future (use with care!)
| \Copilot\Client\Page | $page | The page object to be used |
The events
getConcertsFrom(string $from, \Copilot\Client\Page $page) : \Copilot\Client\Event[]:
Returns all concerts from a certain point in time to the future
| string | $from | The date in the format "Y-m-d" |
| \Copilot\Client\Page | $page | The page object to be used |
getConcertById(string $id) : \Copilot\Client\Event
Returns the concert for the given id
| string | $id | The id of the concert to be retrieved |
getNews(string $channels = NULL, \Copilot\Client\Page $page = NULL) : array<mixed,\Copilot\Client\News>
Returns the news for the given channels or all news if no channels are specified
| string | $channels | The channels to fetch news from |
| \Copilot\Client\Page | $page | The page object to be used |
Array of news entries
getNewsByArtist(\Copilot\Client\Artist $artist, \Copilot\Client\Page $page = NULL) : array<mixed,\Copilot\Client\News>
Returns all news for the given artist
| \Copilot\Client\Artist | $artist | The artist to return news for |
| \Copilot\Client\Page | $page | The page object to be used |
The page of news for the given artist. Might be empty.
getNewsById(string $id) : \Copilot\Client\News
Returns the news article for the given id
| string | $id | The id of the news article |
The news article