Docs For Class WMSFacebookDataStoreProperty

Description

Represents a property, which is similar to a database column.

Represents a property, which is similar to a database column. This class is responsible for the creation and deletion of a database column. It also contains a value that can be inserted into the column. When setting a value, it is possible to ask that the data be compressed. Compressing large amounts of data will speed up the application (presuming network bandwidth is a bottleneck, not CPU time) as well as allow more information to be packed within Facebook's data store 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 /WMSFacebookDataStoreProperty.php (line 22)

WMSFacebookObject
   |
   --WMSFacebookDataStoreProperty

Method Summary

WMSFacebookDataStoreProperty WMSFacebookDataStoreProperty (Facebook $facebook, WMSFacebookDataStoreObject $wmsFacebookDataStoreObject, string $propertyName, int $propertyType)

void append ( &$map, array $map)

bool create ()

bool drop ()

Object getValue ()

void setValue (string $propertyValue, [bool $compress = false])

string __toString ()

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 WMSFacebookDataStoreProperty (line 38)

Used to instantiate a new WMSFacebookDataStoreProperty instance.

access: public

WMSFacebookDataStoreProperty WMSFacebookDataStoreProperty (Facebook $facebook, WMSFacebookDataStoreObject $wmsFacebookDataStoreObject, string $propertyName, int $propertyType)

Facebook $facebook: Valid Facebook instance.
WMSFacebookDataStoreObject $wmsFacebookDataStoreObject: Object that will contain this property.
string $propertyName: Unique identifier for this property.
int $propertyType: Integer, String, or Binary.

append (line 168)

Appends the name and value of this property to the end of the given array.

access: public

void append ( &$map, array $map)

array $map: Array into which property's name and value are appended.
&$map

create (line 54)

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 was created, or already exists.
access: public

bool create ()

drop (line 79)

Asks Facebook to delete this property type. if the deletion failed because the property does not exist. the error will be thrown to the calling code.

Asks Facebook to delete this property type. This will fail silently if the deletion failed because the property does not exist. Otherwise, the error will be thrown to the calling code.

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

bool drop ()

getValue (line 148)

Returns the value associated with this property.

return: An integer, string, or binary content depending on the type of property this object represents.
access: public

Object getValue ()

setValue (line 134)

Changes the value associated with this property. property must be appropriate to the underlying data type. if this property was created as holding an integer value, then the parameter value must be of type integer. and binary data should match with binary content.

Changes the value associated with this property. The value of the property must be appropriate to the underlying data type. For example, if this property was created as holding an integer value, then the parameter value must be of type integer. Strings must match with strings and binary data should match with binary content. Eventually the data will make its way into the permanent data store on Facebook.

access: public

void setValue (string $propertyValue, [bool $compress = false])

string $propertyValue: Value to store in the database.
bool $compress: true - compress $propertyValue using bzip2.

__toString (line 179)

Returns a preformatted string containing the name and value of this property, separated by a full colon. so that empty values can be "seen".

Returns a preformatted string containing the name and value of this property, separated by a full colon. The value itself will be in quotes so that empty values can be "seen".

return: Name and value of this property.
access: public

string __toString ()

Inherited Methods

Inherited From WMSFacebookObject

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