Class WMSFacebookApplication

Description
Description | Vars | Methods (details)

Represents a Facebook application.

Represents a Facebook application. This class contains functionality that is application-specific. Typically the functionality is centred around the URL for the application.

Located in /WMSFacebookApplication.php (line 18) 

WMSFacebookObject
   |
   --WMSFacebookApplication
Method Summary
Description | Vars | Methods (details)
WMSFacebookApplication WMSFacebookApplication (Facebook $facebook, string $url)
string getImagePath ()
array getUsers ()
void image (string $filename, string $alt)
bool isAdded ()
void redirect (string $url)
void setImagePath (string $imagePath)
Variables
Description | Vars (details) | Methods (details)

Inherited Variables

Inherited from WMSFacebookObject

WMSFacebookObject::$ASSOCATION_TYPE_ASYMMETRIC
 WMSFacebookObject::$ASSOCATION_TYPE_DIRECTED
 WMSFacebookObject::$ASSOCATION_TYPE_SYMMETRIC
 WMSFacebookObject::$ERROR_OBJECT_EXISTS
 WMSFacebookObject::$ERROR_OBJECT_NOT_FOUND
 WMSFacebookObject::$OBJECT_TYPE_BINARY
 WMSFacebookObject::$OBJECT_TYPE_INTEGER
 WMSFacebookObject::$OBJECT_TYPE_STRING
Methods
Description | Vars Methods (details)
Constructor WMSFacebookApplication (line 28)

Used to instantiate a new WMSFacebookApplication instance.

Used to instantiate a new WMSFacebookApplication instance.

  • access: public
WMSFacebookApplication WMSFacebookApplication (Facebook $facebook, string $url)
  • Facebook $facebook: Valid Facebook instance.
  • string $url: Application's fully qualified website address.
getImagePath (line 113)

Returns the subdirectory in which the images for the application can be found. subclasses should be programmed to provide the proper behaviour.

Returns the subdirectory in which the images for the application can be found. If the image subdirectory structure is more complicated, then subclasses should be programmed to provide the proper behaviour. The default value is "images/".

  • return: Subdirectory name with trailing, but no leading slash.
  • access: protected
string getImagePath ()
getUsers (line 70)

Returns a list of users that have this application installed.

Returns a list of users that have this application installed.

  • return: List of WMSFacebookFriend instances.
  • access: public
array getUsers ()
image (line 123)

Echos an <img> tag to the document; includes width and height tags.

Echos an <img> tag to the document; includes width and height tags.

  • access: public
void image (string $filename, string $alt)
  • string $filename: Name of the image file to embed in the web page.
  • string $alt: Short description of the image.
isAdded (line 90)

Indicates whether the current user has added this application.

Indicates whether the current user has added this application.

  • return: true - application is in the user's list.
  • access: public
bool isAdded ()
redirect (line 57)

Asks Facebook to redirect the user's browser to the given address.

Asks Facebook to redirect the user's browser to the given address.

  • access: public
void redirect (string $url)
  • string $url: New URL for the browser to visit and render.
setImagePath (line 100)

Sets the subdirectory in which images for the application can be found.

Sets the subdirectory in which images for the application can be found.

  • access: public
void setImagePath (string $imagePath)
  • string $imagePath: Subdirectory name with trailing slash, without leading slash.

Inherited Methods

Inherited From WMSFacebookObject

WMSFacebookObject::WMSFacebookObject()
WMSFacebookObject::getFacebook()
WMSFacebookObject::getFacebookAPI()

Documentation generated on Mon, 17 Dec 2007 20:10:41 -0800 by phpDocumentor 1.4.0