dmBridge PHP API
DMHTTPAPIRepresentationTransformer Interface Reference

Interface to be implemented by all "representation transformers," which are classes that transform input into a given HTTP representation. More...

Inheritance diagram for DMHTTPAPIRepresentationTransformer:

Public Member Functions


Detailed Description

Interface to be implemented by all "representation transformers," which are classes that transform input into a given HTTP representation.

Author:
Alex Dolski <alex.dolski@unlv.edu> http://www.opensource.org/licenses/mit-license.php

Definition at line 16 of file DMHTTPAPIRepresentationTransformer.php.


Member Function Documentation

DMHTTPAPIRepresentationTransformer::nullResponse ( )
Returns:
An empty representation; for example, a pair of empty XML tags, or perhaps no content at all.

Implemented in DMJSONRepresentationTransformerV1, and DMXMLRepresentationTransformerV1.

DMHTTPAPIRepresentationTransformer::transformCollection ( DMCollection col)
Parameters:
DMCollectioncol The DMCollection to transform
Returns:
string HTTP representation

Implemented in DMJSONRepresentationTransformerV1, and DMXMLRepresentationTransformerV1.

DMHTTPAPIRepresentationTransformer::transformCollections ( array $  collections)
Parameters:
arraycollections Array of DMCollections
Returns:
string HTTP representation

Implemented in DMJSONRepresentationTransformerV1, and DMXMLRepresentationTransformerV1.

DMHTTPAPIRepresentationTransformer::transformComment ( DMComment comment)
Parameters:
DMCommentcomment
Returns:
string HTTP representation

Implemented in DMJSONRepresentationTransformerV1, and DMXMLRepresentationTransformerV1.

DMHTTPAPIRepresentationTransformer::transformComments ( array $  comments,
page,
rpp,
total 
)
Parameters:
arraycomments Array of DMComments
intpage
intrpp Results per page
inttotal
Returns:
string HTTP representation

Implemented in DMJSONRepresentationTransformerV1, and DMXMLRepresentationTransformerV1.

DMHTTPAPIRepresentationTransformer::transformException ( Exception $  e)
Parameters:
Exceptione
Returns:
string HTTP representation

Implemented in DMJSONRepresentationTransformerV1, and DMXMLRepresentationTransformerV1.

DMHTTPAPIRepresentationTransformer::transformObject ( DMObject obj)
Parameters:
DMObjectobj The DMObject to transform
Returns:
string HTTP representation

Implemented in DMJSONRepresentationTransformerV1, and DMXMLRepresentationTransformerV1.

DMHTTPAPIRepresentationTransformer::transformObjectComments ( DMObject obj,
page,
rpp 
)
Parameters:
DMObjectobj The object whose comments should be transformed
intpage
intrpp
Returns:
string HTTP representation

Implemented in DMJSONRepresentationTransformerV1, and DMXMLRepresentationTransformerV1.

DMHTTPAPIRepresentationTransformer::transformObjectRating ( DMObject obj)
Parameters:
DMObjectobj The object whose tags should be transformed
Returns:
string HTTP representation

Implemented in DMJSONRepresentationTransformerV1, and DMXMLRepresentationTransformerV1.

DMHTTPAPIRepresentationTransformer::transformObjectTags ( DMObject obj)
Parameters:
DMObjectobj
Returns:
string HTTP representation

Implemented in DMJSONRepresentationTransformerV1, and DMXMLRepresentationTransformerV1.

DMHTTPAPIRepresentationTransformer::transformResults ( DMObjectQuery query)
Parameters:
DMObjectQueryquery A DMObjectQuery initialized to retrieve a result set
Returns:
string HTTP representation

Implemented in DMJSONRepresentationTransformerV1, and DMXMLRepresentationTransformerV1.

DMHTTPAPIRepresentationTransformer::transformStatus ( )
Returns:
HTTP API status information

Implemented in DMJSONRepresentationTransformerV1, and DMXMLRepresentationTransformerV1.

DMHTTPAPIRepresentationTransformer::transformTag ( DMTag tag)
Parameters:
DMTagtag The DMTag to be transformed
Returns:
string HTTP representation

Implemented in DMJSONRepresentationTransformerV1, and DMXMLRepresentationTransformerV1.

DMHTTPAPIRepresentationTransformer::transformTagCounts ( array $  tags,
page,
rpp,
total 
)
Parameters:
arraytags An array of DMTags to be transformed
intpage
intrpp Results per page
inttotal
Returns:
string HTTP representation

Implemented in DMJSONRepresentationTransformerV1, and DMXMLRepresentationTransformerV1.

DMHTTPAPIRepresentationTransformer::transformVocabularyFrequencies ( array $  freqs)
Parameters:
arrayfreqs Hash of term/count pairs
Returns:
string HTTP representation

Implemented in DMJSONRepresentationTransformerV1, and DMXMLRepresentationTransformerV1.

DMHTTPAPIRepresentationTransformer::transformVocabularySuggestions ( array $  words)
Parameters:
arraywords Indexed array of strings
Returns:
string HTTP representation

Implemented in DMJSONRepresentationTransformerV1, and DMXMLRepresentationTransformerV1.


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