Moodle  2.2.1
http://www.collinsharper.com
Zend_Service_Simpy Class Reference

Public Member Functions

 __construct ($username, $password)
 getHttpClient ()
 getTags ($limit=null)
 removeTag ($tag)
 renameTag ($fromTag, $toTag)
 mergeTags ($fromTag1, $fromTag2, $toTag)
 splitTag ($tag, $toTag1, $toTag2)
 getLinks (Zend_Service_Simpy_LinkQuery $q=null)
 saveLink ($title, $href, $accessType, $tags=null, $urlNickname=null, $note=null)
 deleteLink ($href)
 getWatchlists ()
 getWatchlist ($watchlistId)
 getNotes ($q=null, $limit=null)
 saveNote ($title, $tags=null, $description=null, $noteId=null)
 deleteNote ($noteId)

Protected Member Functions

 _makeRequest ($op, $query=null)

Protected Attributes

 $_baseUri = 'http://simpy.com/simpy/api/rest/'
 $_http

Detailed Description

Definition at line 37 of file Simpy.php.


Constructor & Destructor Documentation

__construct ( username,
password 
)

Constructs a new Simpy (free) REST API Client

Parameters:
string$usernameUsername for the Simpy user account
string$passwordPassword for the Simpy user account
Returns:
void

Definition at line 60 of file Simpy.php.

Here is the call graph for this function:


Member Function Documentation

_makeRequest ( op,
query = null 
) [protected]

Sends a request to the REST API service and does initial processing on the response.

Parameters:
string$opName of the operation for the request
array$queryQuery data for the request (optional)
Exceptions:
Zend_Service_Exception
Returns:
DOMDocument Parsed XML response
See also:
Zend_Service_Exception
Zend_Service_Exception

Definition at line 86 of file Simpy.php.

Here is the caller graph for this function:

deleteLink ( href)

Deletes a given link.

Parameters:
string$hrefURL of the bookmark to delete Zend_Service_Simpy Provides a fluent interface

Definition at line 306 of file Simpy.php.

Here is the call graph for this function:

deleteNote ( noteId)

Deletes a given note.

Parameters:
int$noteIdID of the note to delete Zend_Service_Simpy Provides a fluent interface

Definition at line 423 of file Simpy.php.

Here is the call graph for this function:

Returns the HTTP client currently in use by this class for REST API calls, intended mainly for testing.

Returns:
Zend_Http_Client

Definition at line 72 of file Simpy.php.

Performs a query on existing links and returns the results or returns all links if no particular query is specified (which should be used sparingly to prevent overloading Simpy servers)

Parameters:
Zend_Service_Simpy_LinkQuery$qQuery object to use (optional)
Returns:
Zend_Service_Simpy_LinkSet
See also:
Zend_Service_Simpy_LinkSet

Definition at line 240 of file Simpy.php.

Here is the call graph for this function:

getNotes ( q = null,
limit = null 
)

Returns all notes in reverse chronological order by add date or by rank.

Parameters:
string$qQuery string formatted using Simpy search syntax and search fields (optional)
int$limitLimits the number notes returned (optional) http://www.simpy.com/simpy/FAQ.do#searchSyntax http://www.simpy.com/simpy/FAQ.do#searchFieldsLinks Zend_Service_Simpy_NoteSet
See also:
Zend_Service_Simpy_NoteSet

Definition at line 369 of file Simpy.php.

Here is the call graph for this function:

getTags ( limit = null)

Returns a list of all tags and their counts, ordered by count in decreasing order

Parameters:
int$limitLimits the number of tags returned (optional) Zend_Service_Exception Zend_Service_Simpy_TagSet
See also:
Zend_Service_Simpy_TagSet

Definition at line 135 of file Simpy.php.

Here is the call graph for this function:

getWatchlist ( watchlistId)

Returns the meta-data for a given watchlist.

Parameters:
int$watchlistIdID of the watchlist to retrieve Zend_Service_Simpy_Watchlist
See also:
Zend_Service_Simpy_Watchlist

Definition at line 342 of file Simpy.php.

Here is the call graph for this function:

Return a list of watchlists and their meta-data, including the number of new links added to each watchlist since last login.

Zend_Service_Simpy_WatchlistSet

See also:
Zend_Service_Simpy_WatchlistSet

Definition at line 324 of file Simpy.php.

Here is the call graph for this function:

mergeTags ( fromTag1,
fromTag2,
toTag 
)

Merges two tags into a new tag.

Parameters:
string$fromTag1First tag to merge.
string$fromTag2Second tag to merge.
string$toTagTag to merge the two tags into. Zend_Service_Simpy Provides a fluent interface

Definition at line 197 of file Simpy.php.

Here is the call graph for this function:

removeTag ( tag)

Removes a tag.

Parameters:
string$tagTag to be removed Zend_Service_Simpy Provides a fluent interface

Definition at line 157 of file Simpy.php.

Here is the call graph for this function:

renameTag ( fromTag,
toTag 
)

Renames a tag.

Parameters:
string$fromTagTag to be renamed
string$toTagNew tag name Zend_Service_Simpy Provides a fluent interface

Definition at line 176 of file Simpy.php.

Here is the call graph for this function:

saveLink ( title,
href,
accessType,
tags = null,
urlNickname = null,
note = null 
)

Saves a given link.

Parameters:
string$titleTitle of the page to save
string$hrefURL of the page to save
int$accessTypeACCESSTYPE_PUBLIC or ACCESSTYPE_PRIVATE
mixed$tagsString containing a comma-separated list of tags or array of strings containing tags (optional)
string$urlNicknameAlternative custom title (optional)
string$noteFree text note (optional) Zend_Service_Simpy::ACCESSTYPE_PRIVATE http://www.simpy.com/doc/api/rest/SaveLink Zend_Service_Simpy Provides a fluent interface

Definition at line 279 of file Simpy.php.

Here is the call graph for this function:

saveNote ( title,
tags = null,
description = null,
noteId = null 
)

Saves a note.

Parameters:
string$titleTitle of the note
mixed$tagsString containing a comma-separated list of tags or array of strings containing tags (optional)
string$descriptionFree-text note (optional)
int$noteIdUnique identifier for an existing note to update (optional) Zend_Service_Simpy Provides a fluent interface

Definition at line 398 of file Simpy.php.

Here is the call graph for this function:

splitTag ( tag,
toTag1,
toTag2 
)

Splits a single tag into two separate tags.

Parameters:
string$tagTag to split
string$toTag1First tag to split into
string$toTag2Second tag to split into Zend_Service_Simpy Provides a fluent interface

Definition at line 219 of file Simpy.php.

Here is the call graph for this function:


Field Documentation

$_baseUri = 'http://simpy.com/simpy/api/rest/' [protected]

Definition at line 44 of file Simpy.php.

$_http [protected]

Definition at line 51 of file Simpy.php.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations