Docs For Class WMSFacebookDataStoreObject

Description

Represents a Facebook Object to which properties may be added.

Represents a Facebook Object to which properties may be added. This class glues together Facebook Data Store properties with their corresponding Facebook Data Store object. Properties are name/value pairs. This class abstracts the creation and insertion of properties as well as the ability to drop the object entirely.

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 /WMSFacebookDataStoreObject.php (line 22)

WMSFacebookObject
   |
   --WMSFacebookDataStoreObject

Method Summary

WMSFacebookDataStoreObject WMSFacebookDataStoreObject (Facebook $facebook, string $objectName)

bool create ()

WMSFacebookDataStoreProperty createPropertyBinary (string $propertyName)

WMSFacebookDataStoreProperty createPropertyInteger (string $propertyName)

WMSFacebookDataStoreProperty createPropertyString (string $propertyName)

bool drop ()

void getObjectName ()

array getProperties ()

WMSFacebookDataStoreRow insertProperties ()

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 WMSFacebookDataStoreObject (line 34)

Used to instantiate a new WMSFacebookDataStoreObject instance.

access: public

WMSFacebookDataStoreObject WMSFacebookDataStoreObject (Facebook $facebook, string $objectName)

Facebook $facebook: Valid Facebook instance.
string $objectName: Name of a data store object (database table).

create (line 71)

Asks Facebook to create an object type based on the objectName for this instance.

Asks Facebook to create an object type based on the objectName for this instance. This will fail silently if the object already exists. Otherwise, the error will be thrown to the calling code.

return: true - object type was created or already exists.
access: public

bool create ()

createPropertyBinary (line 215)

Creates a data store property that contains a binary value. maximum length of the value is 64K.

Creates a data store property that contains a binary value. The maximum length of the value is 64K.

access: public

WMSFacebookDataStoreProperty createPropertyBinary (string $propertyName)

string $propertyName: Name of the object property to create.

createPropertyInteger (line 191)

Creates a data store property that contains an integer value.

access: public

WMSFacebookDataStoreProperty createPropertyInteger (string $propertyName)

string $propertyName: Name of the object property to create.

createPropertyString (line 203)

Creates a data store property that contains a string value. length of the string is 256 characters.

Creates a data store property that contains a string value. This maximum length of the string is 256 characters.

access: public

WMSFacebookDataStoreProperty createPropertyString (string $propertyName)

string $propertyName: Name of the object property to create.

drop (line 120)

Asks Facebook to delete an object type with the given name. fail silently if the object deletion failed because it does not exist.

Asks Facebook to delete an object type with the given name. This will fail silently if the object deletion failed because it does not exist. Otherwise, the error will be thrown to the calling code.

return: true - object type was deleted, or does not exist.
access: public

bool drop ()

getObjectName (line 223)

access: public

void getObjectName ()

getProperties (line 60)

Returns the list of properties belonging to this data store object.

return: WMSFacebookDataStoreProperty instances
see: addProperty
see: createProperty
access: public

array getProperties ()

insertProperties (line 94)

Creates a map of name/value pairs for insertion into the Facebook "table" associated with an instance of this class. an object that represents the row that was added.

Creates a map of name/value pairs for insertion into the Facebook "table" associated with an instance of this class. It will return an object that represents the row that was added.

access: public

WMSFacebookDataStoreRow insertProperties ()

Inherited Methods

Inherited From WMSFacebookObject

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