Docs For Class WMSFacebookDataStore

Description

Represents a database built upon Facebook's Data Store API.

Represents a database built upon Facebook's Data Store API. This class facilitates the creation of objects (i.e., database tables) and association links. It also contains helper methods for data compression over HTTP (using bzip2 compression). Using compression can significantly increase the amount of data that can be packed into Facebook's per-column (of type BLOB) data limit.

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 /WMSFacebookDataStore.php (line 23)

WMSFacebookObject
   |
   --WMSFacebookDataStore

Method Summary

static void compress (string $data, [int $level = 9])

static void decompress (string $data)

WMSFacebookDataStore WMSFacebookDataStore (Facebook $facebook)

WMSFacebookDataStoreAssociationLink createAssociationLink (string $associationName, string $alias1, string $alias2)

WMSFacebookDataStoreObject createObjectType (string $objectName)

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

static method compress (line 82)

Compresses the given data and makes it suitable for transmission over HTTP-based protocols. been compiled into PHP.

Compresses the given data and makes it suitable for transmission over HTTP-based protocols. This uses bzip2 compression, which must have been compiled into PHP.

see: WMSFacebookDataStore::decompress()
access: public

static void compress (string $data, [int $level = 9])

string $data: Information to compress.
int $level: How well to compress (9 = best/slow, 1 = poor/fast).

static method decompress (line 94)

Decompresses the given data that was previously compressed with a call to compress.

see: WMSFacebookDataStore::compress()
access: public

static void decompress (string $data)

string $data: Information to decompress.

Constructor WMSFacebookDataStore (line 29)

Used to instantiate a new WMSFacebookDataStore instance.

access: public

WMSFacebookDataStore WMSFacebookDataStore (Facebook $facebook)

Facebook $facebook: Valid Facebook instance.

createAssociationLink (line 62)

Creates an association link of a given name, with respect to the two aliases. be an alias that represents the Facebook user's unique identifier.

Creates an association link of a given name, with respect to the two aliases. The aliases are names for the IDs. For example "user_id" would be an alias that represents the Facebook user's unique identifier.

access: public

WMSFacebookDataStoreAssociationLink createAssociationLink (string $associationName, string $alias1, string $alias2)

string $associationName: Name of the association link to create.
string $alias1: Name of the ID to associate with alias2.
string $alias2: Name of the ID to associate with alias1.

createObjectType (line 42)

Creates an object type with the given name. if the object creation failed because it already exists. the error will be thrown to the calling code.

Creates an object type with the given name. This will fail silently if the object creation failed because it already exists. Otherwise, the error will be thrown to the calling code.

access: public

WMSFacebookDataStoreObject createObjectType (string $objectName)

string $objectName: Name of the object type to create.

Inherited Methods

Inherited From WMSFacebookObject

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