dmBridge PHP API
DMDataStore Interface Reference
Inheritance diagram for DMDataStore:

Public Member Functions


Detailed Description


Member Function Documentation

DMDataStore::addObjectComment ( DMObject obj,
DMComment comment 
)

Ascribes the given comment to the given object and persists the relationship to the data store.

Parameters:
DMObjectobj
DMCommentcomment
Returns:
void
DMDataStore::addObjectRating ( DMObject o,
DMRating r 
)

Appends the given rating to the given object and persists the relationship to the data store.

Parameters:
DMObjecto
DMRatingr
DMDataStore::addObjectTag ( DMObject o,
DMTag t 
)

Ascribes the given tag to the given object and persists the relationship to the data store.

Parameters:
DMObjecto
DMTagt
Returns:
void
DMDataStore::createTables ( )
DMDataStore::deleteAllTagsWithValue ( value)

Deletes all tags with the given value.

Parameters:
stringvalue
Returns:
int The number of tags deleted
Deprecated:
DMDataStore::deleteComment ( DMComment comment)
Parameters:
DMCommentcomment
DMDataStore::deleteTag ( DMTag tag)

Deletes the given tag from the data store.

Parameters:
DMTagtag
DMDataStore::getAllRatingsForObject ( DMObject o)
Parameters:
DMObjecto
Returns:
array Array of all ratings for the given object, as DMRating objects
Deprecated:
DMDataStore::getCommentsForQuery ( DMCommentQuery query,
count 
)
Parameters:
DMCommentQueryquery
boolcount Whether to return the result count, or the results
Returns:
Array of DMComment objects
Deprecated:
DMDataStore::getMeanNumCommentsPerObjectInCollection ( DMCollection col)
Parameters:
DMCollectioncol
Returns:
float
Deprecated:
DMDataStore::getMeanNumRatingsPerObjectInCollection ( DMCollection col)
Parameters:
DMCollectioncol
Returns:
float
Deprecated:
DMDataStore::getMeanNumTagsPerObjectInCollection ( DMCollection col)
Parameters:
DMCollectioncol
Returns:
float
Deprecated:
DMDataStore::getMedianNumCommentsPerObjectInCollection ( DMCollection col)
Parameters:
DMCollectioncol
Returns:
int
Deprecated:
DMDataStore::getMedianNumRatingsPerObjectInCollection ( DMCollection col)
Parameters:
DMCollectioncol
Returns:
int
Deprecated:
DMDataStore::getMedianNumTagsPerObjectInCollection ( DMCollection col)
Parameters:
DMCollectioncol
Returns:
int
Deprecated:
DMDataStore::getNumObjectsWithApprovedComments ( )
Returns:
int The number of objects with approved comments.
Deprecated:
DMDataStore::getNumObjectsWithApprovedTags ( )
Returns:
int The number of objects with approved tags.
Deprecated:
DMDataStore::getNumObjectsWithRatings ( )
Returns:
int The number of objects that have been rated.
Deprecated:
DMDataStore::getNumRatings ( )
Returns:
int The number of ratings in the data store.
Deprecated:
DMDataStore::getNumRatingsForObject ( DMObject o)
Parameters:
DMObjecto
Returns:
int The number of ratings for the given object.
Deprecated:
DMDataStore::getNumRatingsInCollection ( DMCollection c)
Parameters:
DMCollectionc
Returns:
int The number of ratings in the given collection.
Deprecated:
DMDataStore::getObjectsWithHighestRatings ( limit)
Parameters:
intlimit
Returns:
array Array of DMObjects
Deprecated:
DMDataStore::getObjectsWithLowestRatings ( limit)
Parameters:
intlimit
Returns:
array Array of DMObjects
Deprecated:
DMDataStore::getObjectsWithMostComments ( limit)
Parameters:
intlimit
Returns:
array Array of DMObjects in descending order by comment count, up to $limit
Deprecated:
DMDataStore::getObjectsWithMostRatings ( limit)
Parameters:
intlimit
Returns:
array Array of DMObjects
Deprecated:
DMDataStore::getObjectsWithMostTags ( limit)
Parameters:
intlimit
Returns:
array Array of DMObjects with the most tags in descending order up to $limit.
Deprecated:
DMDataStore::getRatingForObject ( DMObject o)
Parameters:
DMObjecto
Returns:
float
Deprecated:
DMDataStore::getTagsForQueryAsCounts ( DMTagQuery query,
count 
)
Parameters:
DMTagQueryquery
boolcount Whether to return the result count, or the results
Returns:
Associative array of tag value => count pairs
Deprecated:
DMDataStore::getTagsForQueryAsObjects ( DMTagQuery query,
count 
)
Parameters:
DMTagQueryquery
boolcount Whether to return the result count, or the results
Returns:
Array of DMTag objects
Deprecated:
DMDataStore::getType ( )
Returns:
int One of the DMDataStoreType constants

Implemented in DMMySQLDataStore, and DMSQLiteDataStore.

DMDataStore::loadComment ( id)
Parameters:
intid
Returns:
DMComment
Exceptions:
DMUnavailableModelException
DMDataStore::loadTag ( id)
Parameters:
intid
Returns:
DMTag
Exceptions:
DMUnavailableModelException
DMDataStore::saveComment ( DMComment c)

Persists the supplied comment to the data store.

Parameters:
DMCommentc
Returns:
void
DMDataStore::saveTag ( DMTag tag)

Saves the given tag to the data store.

Parameters:
DMTagtag The tag to save
Returns:
void

The documentation for this interface was generated from the following file:
 All Data Structures Functions Variables