Class WMSFacebookDataStoreAssociationLink

Description
Description | Vars | Methods (details)

Represents a associative link between two IDs that will be associated.

Represents a associative link between two IDs that will be associated. Associations are allow an application to retrieve stored data. A common association is between the user's Facebook ID and an ID belonging to a "row" of data that has been added to the Facebook data store (i.e., the Facebook database).

Located in /WMSFacebookDataStoreAssociationLink.php (line 22) 

WMSFacebookObject
   |
   --WMSFacebookDataStoreAssociationLink
Method Summary
Description | Vars | Methods (details)
WMSFacebookDataStoreAssociationLink WMSFacebookDataStoreAssociationLink (Facebook $facebook, string $name)
WMSFacebookDataStoreAssociation associate (int|string $id1, int|string $id2, [string $data = null], [int $timestamp = null])
void create (string $alias1, string $alias2)
bool drop ()
WMSFacebookDataStoreRow getAssociatedObjects (int|string $id)
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 WMSFacebookDataStoreAssociationLink (line 32)

Creates a new instance of an association link with a given name.

Creates a new instance of an association link with a given name.

  • access: public
WMSFacebookDataStoreAssociationLink WMSFacebookDataStoreAssociationLink (Facebook $facebook, string $name)
  • Facebook $facebook: Valid Facebook instance.
  • string $name: Name of the association link.
associate (line 101)

Stores an association between two Facebook identifiers ($id1, $id2) in Facebook's Data Store. the current date and time if not explicitly set.

Stores an association between two Facebook identifiers ($id1, $id2) in Facebook's Data Store. The optional timestamp parameter will be set to the current date and time if not explicitly set.

WMSFacebookDataStoreAssociation associate (int|string $id1, int|string $id2, [string $data = null], [int $timestamp = null])
  • int|string $id1: Facebook ID to associate with id2.
  • int|string $id2: Facebook ID to associate with id1.
  • string $data: (Optional) Arbitrary data to describe the association.
  • int $timestamp: (Optional) Timestamp of the association.
create (line 44)

Defines a new association link.

Defines a new association link.

  • access: public
void create (string $alias1, string $alias2)
  • string $alias1: Name of the item to associate with alias2.
  • string $alias2: Name of the item to associate with alias1.
drop (line 71)

Removes this association link and all associations from the data store.

Removes this association link and all associations from the data store.

  • return: true - the association link was permanently deleted.
  • access: public
bool drop ()
getAssociatedObjects (line 130)

Given a Facebook ID ($id), this method returns all the IDs that have been associated with $id.

Given a Facebook ID ($id), this method returns all the IDs that have been associated with $id.

WMSFacebookDataStoreRow getAssociatedObjects (int|string $id)
  • int|string $id: Facebook ID associated with another ID.

Inherited Methods

Inherited From WMSFacebookObject

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

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