Docs For Class WMSFacebookDataStoreAssociation

Description

Represents two IDs that have been associated.

Represents two IDs that have been associated. This class contains details about an association of two objects, which are represented by their IDs. Other details includes an arbitrary piece of data and a timestamp. The timestamp can be used for any purpose, but the most common is to track when the association was made.

author: Dave Jarvis
version: 0.0.1
copyright: Copyright (c) 2007 White Magic Software, Ltd.
link: http://www.davidjarvis.ca
example: Data Store Example
license: GNU LGPL Version 3

Located in /WMSFacebookDataStoreAssociation.php (line 20)

WMSFacebookObject
   |
   --WMSFacebookDataStoreAssociation

Method Summary

WMSFacebookDataStoreAssociation WMSFacebookDataStoreAssociation (Facebook $facebook, string $name)

boolean create ()

bool drop ()

void setData ( $dataValue)

void setId1 ( $id1)

void setId2 ( $id2)

void setTimestamp ( $timestamp)

Variables

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

Constructor WMSFacebookDataStoreAssociation (line 35)

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

access: public

WMSFacebookDataStoreAssociation WMSFacebookDataStoreAssociation (Facebook $facebook, string $name)

Facebook $facebook: Valid Facebook instance.
string $name: Name of the association.

create (line 73)

Inserts this association from the data store.

return: true - association was added.
see: getData
see: getTimestamp
access: public

boolean create ()

drop (line 47)

Removes this association from the data store. remain valid.

Removes this association from the data store. All other associations remain valid.

return: true - association was removed, or does not exist.
access: public

bool drop ()

setData (line 98)

access: public

void setData ( $dataValue)

$dataValue

setId1 (line 82)

access: public

void setId1 ( $id1)

$id1

setId2 (line 90)

access: public

void setId2 ( $id2)

$id2

setTimestamp (line 106)

access: public

void setTimestamp ( $timestamp)

$timestamp

Inherited Methods

Inherited From WMSFacebookObject

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