Class Venue

Description

Represents a venue.

Located in /src/Venue.php (line 9)


	
			
Method Summary
static Venue fromSimpleXMLElement ( $xml)
static array getEvents ( $event, string $venue)
static PaginatedResult getPastEvents (string $venue, [integer $limit = null], [integer $page = null])
static PaginatedResult search (string $venue, [integer $limit = null], [integer $page = null], [string $country = null])
Venue __construct (string $name, Location $location, string $url)
string getName ()
string getUrl ()
Methods
static method fromSimpleXMLElement (line 176)

Create a Venue object from a SimpleXMLElement.

  • return: A Venue object.
  • access: public
static Venue fromSimpleXMLElement ( $xml)
  • SimpleXMLElement $xml: A SimpleXMLElement.
static method getEvents (line 81)

Get a list of upcoming events at this venue.

  • return: An array of Event objects.
  • throws: Error
  • access: public
static array getEvents ( $event, string $venue)
  • string $venue: The venue id to fetch the events for. (Required)
  • $event
static method getPastEvents (line 107)

Get a paginated list of all the events held at this venue in the past.

  • return: A PaginatedResult object.
  • see: PaginatedResult
  • throws: Error
  • access: public
static PaginatedResult getPastEvents (string $venue, [integer $limit = null], [integer $page = null])
  • string $venue: The id for the venue you would like to fetch event listings for. (Required)
  • integer $limit: The maximum number of results to return. (Optional)
  • integer $page: The page of results to return. (Optional)
static method search (line 143)

Search for a venue by venue name .

  • return: A PaginatedResult object.
  • see: PaginatedResult
  • throws: Error
  • access: public
static PaginatedResult search (string $venue, [integer $limit = null], [integer $page = null], [string $country = null])
  • string $venue: The venue name you would like to search for. (Required)
  • integer $limit: The number of results to fetch per page. Defaults to 50. (Optional)
  • integer $page: The results page you would like to fetch. (Optional)
  • string $country: Filter your results by country. Expressed as an ISO 3166-2 code. (Optional)
Constructor __construct (line 39)

Create a Venue object.

  • access: public
Venue __construct (string $name, Location $location, string $url)
  • string $name: A venue name.
  • Location $location: A venue location.
  • string $url: A venue URL.
getLocation (line 59)

Returns the venues location.

  • return: A venue location.
  • access: public
Location getLocation ()
getName (line 50)

Returns the venues name.

  • return: A venue name.
  • access: public
string getName ()
getUrl (line 68)

Returns the venues URL.

  • return: A venue URL.
  • access: public
string getUrl ()

Documentation generated on Mon, 22 Dec 2008 16:57:52 +0100 by phpDocumentor 1.4.1