API Documentation
\
Copilot
Client

\Copilot\ClientArtist

This class contains the base data for a single Artist.

The class is suitable for showing an artists detail page however it does not contain any data to events the artist appears on.

Summary

Methods
Properties
Constants
getId()
getStageName()
getWebsite()
getFacebook()
getMyspace()
getShortBio()
getLongBio()
getImageLink()
getMainImageLinks()
getMainImages()
getPressImageLinks()
getPressImages()
getBiographyDocuments()
getPressTextDocuments()
getBandLogoLinks()
getBandLogos()
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 artist

Returns

string —

The id of the artist

getStageName()

getStageName() : string

Returns the artists stage name

Returns

string —

The Artists official stage name

getWebsite()

getWebsite() : string

Returns the domain to the artists website

Returns

string —

URL to the artists website

getFacebook()

getFacebook() : string

Returns a string where the artists facebook page is hosted

Returns

string —

The URL to the artists facebook page

getMyspace()

getMyspace() : string

Returns a string where the artists myspace page is hosted

Returns

string —

The URL to the artists myspace page

getShortBio()

getShortBio() : string

Returns the short biography text of the artist.

The string that is being returned is in plaintext and should not contain any HTML Tags.

Returns

string —

The artists short unformatted biography

getLongBio()

getLongBio() : string

Returns the full biography text of the artist.

The string that is being returned contains HTML tags.

Returns

string —

The artists long biography in HTML format

getImageLink()

getImageLink(  $width)

Parameters

$width

getMainImageLinks()

getMainImageLinks(integer  $width) : array

Returns hyperlinks to the artists main images.

Parameters

integer $width

The width the images should have

Returns

array —

An array containing URLs to the artists main images

getMainImages()

getMainImages() : array

Returns the assets that are tagged as main image

Returns

array —

An array of assets tagged as MAIN_IMAGE

getPressImageLinks()

getPressImageLinks(integer  $width) : array

Returns hyperlinks to the artists press images

Parameters

integer $width

The width the images should have

Returns

array —

An array containing URLs to the artists press images

getPressImages()

getPressImages() : array

Returns an array of assets that are tagged as ARTIST_PRESSIMAGE

Returns

array —

An array of assets with the artists press images

getBiographyDocuments()

getBiographyDocuments() : array

Returns an array of assets that are tagged as ARTIST_BIOGRAPHY

Returns

array —

An array of assets with the artists biography documents

getPressTextDocuments()

getPressTextDocuments() : array

Returns an array of assets that are tagged as ARTIST_PRESSTEXT

Returns

array —

An array of assets with the artists presstext documents

getBandLogoLinks()

getBandLogoLinks(integer  $width) : array

Returns an array of hyperlinks for assets that are tagged as ARTIST_BANDLOGO

Parameters

integer $width

The width the images should have

Returns

array —

Array of URLs of the artist bandlogo

getBandLogos()

getBandLogos() : array

Returns an array of assets that are tagged as ARTIST_BANDLOGO

Returns

array —

An array of assets containing the artists band logo