Four Square Venue

Gives details about a venue, including location, mayorship, tags, tips, specials, and category.

Figure 1a. Instantiate Venue
$venue = eden('foursquare')->venue($_SESSION['oauth_token']);
Figure 1b. Usage: Returns a list of venues near the current location with the most people currently checked in.
$venue
	->setRadius('[INTEGER]')		//optional
    ->setLimit('[INTEGER]')			//optional
    ->getTrending('[LATITUDE]', '[LONGTITUDE]');
Figure 1c. Usage: Returns information about the current events at a place.
$venue->getVenueEventInfo('[VENUE_ID]');
Figure 1d. Usage: Add a Venue
$venue
	->setCrossStreet('NEAR STREET')					//optional
	->setCity('CITY')								//optional
	->setState('STATE')								//optional
	->setZip('ZIP CODE')							//optional
	->setPhone('PHONE NUMBER')						//optional
	->setTwitter('TWITTER ACCOUNT')					//optional
	->setPrimaryCategoryId('[CATEGORY_ID]')			//optional
	->setDescription('[YOUR VENUE DESCRIPTION]')	//optional
	->setUrl('http://www.yourdomain.com/')			//optional
    ->addVenue('[VENUE_NAME]','[LATITUDE]', '[LONGTITUDE]'');
Figure 1e. Venue Methods
Method Arguments Returns Description
$venue->setVenueName($venueName);
  1. string
Eden_Foursquare_Venue Set name of the venue
$venue->setText($text);
  1. string
Eden_Foursquare_Venue Set text of the tip
$venue->setVenueAddress($venueAddress);
  1. string
Eden_Foursquare_Venue Set address of the venue
$venue->setLocation($longtitude, $latitude);
  1. int|float
  2. int|float
Eden_Foursquare_Venue Set location by setting longtitide and latitude
$venue->setTwitter($twitter);
  1. string
Eden_Foursquare_Venue Set twitter account
$venue->setCategoryId($categoryId);
  1. string
Eden_Foursquare_Venue Set category id
$venue->setCrossStreet($crossStreet);
  1. string
Eden_Foursquare_Venue The nearest intersecting street or streets.
$venue->setCity($city);
  1. string
Eden_Foursquare_Venue The city name where this venue is.
$venue->setState($state);
  1. string
Eden_Foursquare_Venue The nearest state or province to the venue.
$venue->setZip($zip);
  1. string
Eden_Foursquare_Venue The zip or postal code for the venue.
$venue->setPhone($phone);
  1. string
Eden_Foursquare_Venue The phone number of the venue.
$venue->setPrimaryCategoryId($primaryCategoryId);
  1. string
Eden_Foursquare_Venue The ID of the category to which you want to assign this venue.
$venue->setDescription($description);
  1. string
Eden_Foursquare_Venue A freeform description of the venue, up to 300 characters.
$venue->setUrl($url);
  1. string
Eden_Foursquare_Venue The url of the homepage of the venue.
$venue->setLimit($limit);
  1. integer
Eden_Foursquare_Venue Number of results to return, up to 50.
$venue->setRadius($radius);
  1. integer
Eden_Foursquare_Venue Radius in meters, up to approximately 2000 meters.
$venue->setStartTime($startTime);
  1. integer|integer
Eden_Foursquare_Venue The start of the time range to retrieve stats for (seconds since epoch). If omitted, all-time stats will be returned.
$venue->setEndTime($endTime);
  1. integer|integer
Eden_Foursquare_Venue The end of the time range to retrieve stats for (seconds since epoch). If omitted, the current time is assumed.
$venue->setQuery($venueName);
  1. integer|integer
Eden_Foursquare_Venue A search term to be applied against venue names.
$venue->addVenue($venueName, $latitude, $longtitude);
  1. string
  2. string|integer|float
  3. string|integer|float
array Allows users to add a new venue.
$venue->getVenueCategories(); none array Returns a hierarchical list of categories applied to venues.
$venue->getManagedVenues(); none array Returns a list of venues the current user manages.
$venue->search($near = NULL, $latitude = NULL, $longtitude = NULL);
  1. string|null
  2. - Required unless longtitude and latitude is provided
  3. string|integer|float|null
  4. - Required unless near is provided
  5. string|integer|float|null
  6. - Required unless near is provided
array Returns a list of venues near the current location, optionally matching the search term.
$venue->getDailyVenueStats($startTime, $venueId);
  1. string|integer
  2. - The start of the time range to retrieve stats. Example: YYYY-MM-DD
  3. string
array Get daily venue stats for a list of venues over a time range.
$venue->getTrending($latitude, $longtitude);
  1. string|integer|float
  2. string|integer|float
array Returns a list of venues near the current location with the most people currently checked in.
$venue->getVenueEventInfo($venueId);
  1. string
  2. - The venue id for which events are being requested.
array Allows you to access information about the current events at a place.
$venue->getVenueList($venueId);
  1. string
  2. - Identity of a venue to get lists for.
array The lists that this venue appears on
$venue->getVenueMenu($venueId);
  1. string
  2. - The venue id for which menu is being requested.
array Returns menu information for a venue
$venue->getVenuePhoto($venueId, $group);
  1. string
  2. - The venue you want photos for.
  3. string
  4. - checkin or venue
array Returns menu information for a venue
$venue->getSimilarVenues($venueId);
  1. string
  2. - The venue you want similar venues for.
array Returns a list of venues similar to the specified venue.
$venue->getVenueStats($venueId);
  1. string
  2. - The venue you want similar venues for.
array Returns venue stats over a given time range.
$venue->getVenueTips($venueId);
  1. string
  2. - The venue you want tips for.
array Returns tips for a venue.
$venue->editVenue($venueId);
  1. string
  2. - The venue id to edit
array Make changes to a venue
$venue->flagVenue($venueId, $problem);
  1. string
  2. - The venue id for which an edit is being proposed
  3. string
  4. - One of mislocated, closed, duplicate, inappropriate, doesnt_exist, event_over
array Allows users to indicate a venue is incorrect in some way.
$venue->markVenue($venueId);
  1. string
  2. - The venue id for which an edit is being proposed
  3. string
  4. - One of mislocated, closed, duplicate, inappropriate, doesnt_exist, event_over
array Allows you to mark a venue to-do, with optional text.
$venue->proposeEdit($venueId);
  1. string
  2. - The venue id to edit
array Make changes to a venue

© 2012 Openovate Labs. All rights reserved.