|
Moodle
2.2.1
http://www.collinsharper.com
|
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 | |
| __construct | ( | $ | username, |
| $ | password | ||
| ) |
| _makeRequest | ( | $ | op, |
| $ | query = null |
||
| ) | [protected] |
Sends a request to the REST API service and does initial processing on the response.
| string | $op | Name of the operation for the request |
| array | $query | Query data for the request (optional) |
| Zend_Service_Exception |
Definition at line 86 of file Simpy.php.

| deleteLink | ( | $ | href | ) |
Deletes a given link.
| string | $href | URL of the bookmark to delete Zend_Service_Simpy Provides a fluent interface |
Definition at line 306 of file Simpy.php.

| deleteNote | ( | $ | noteId | ) |
Deletes a given note.
| int | $noteId | ID of the note to delete Zend_Service_Simpy Provides a fluent interface |
Definition at line 423 of file Simpy.php.

| getHttpClient | ( | ) |
Returns the HTTP client currently in use by this class for REST API calls, intended mainly for testing.
| getLinks | ( | Zend_Service_Simpy_LinkQuery $ | q = null | ) |
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)
| Zend_Service_Simpy_LinkQuery | $q | Query object to use (optional) |
Definition at line 240 of file Simpy.php.

| getNotes | ( | $ | q = null, |
| $ | limit = null |
||
| ) |
Returns all notes in reverse chronological order by add date or by rank.
| string | $q | Query string formatted using Simpy search syntax and search fields (optional) |
| int | $limit | Limits 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 |
Definition at line 369 of file Simpy.php.

| getTags | ( | $ | limit = null | ) |
Returns a list of all tags and their counts, ordered by count in decreasing order
| int | $limit | Limits the number of tags returned (optional) Zend_Service_Exception Zend_Service_Simpy_TagSet |
Definition at line 135 of file Simpy.php.

| getWatchlist | ( | $ | watchlistId | ) |
Returns the meta-data for a given watchlist.
| int | $watchlistId | ID of the watchlist to retrieve Zend_Service_Simpy_Watchlist |
Definition at line 342 of file Simpy.php.

| getWatchlists | ( | ) |
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
Definition at line 324 of file Simpy.php.

| mergeTags | ( | $ | fromTag1, |
| $ | fromTag2, | ||
| $ | toTag | ||
| ) |
Merges two tags into a new tag.
| string | $fromTag1 | First tag to merge. |
| string | $fromTag2 | Second tag to merge. |
| string | $toTag | Tag to merge the two tags into. Zend_Service_Simpy Provides a fluent interface |
Definition at line 197 of file Simpy.php.

| removeTag | ( | $ | tag | ) |
Removes a tag.
| string | $tag | Tag to be removed Zend_Service_Simpy Provides a fluent interface |
Definition at line 157 of file Simpy.php.

| renameTag | ( | $ | fromTag, |
| $ | toTag | ||
| ) |
Renames a tag.
| string | $fromTag | Tag to be renamed |
| string | $toTag | New tag name Zend_Service_Simpy Provides a fluent interface |
Definition at line 176 of file Simpy.php.

| saveLink | ( | $ | title, |
| $ | href, | ||
| $ | accessType, | ||
| $ | tags = null, |
||
| $ | urlNickname = null, |
||
| $ | note = null |
||
| ) |
Saves a given link.
| string | $title | Title of the page to save |
| string | $href | URL of the page to save |
| int | $accessType | ACCESSTYPE_PUBLIC or ACCESSTYPE_PRIVATE |
| mixed | $tags | String containing a comma-separated list of tags or array of strings containing tags (optional) |
| string | $urlNickname | Alternative custom title (optional) |
| string | $note | Free 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.

| saveNote | ( | $ | title, |
| $ | tags = null, |
||
| $ | description = null, |
||
| $ | noteId = null |
||
| ) |
Saves a note.
| string | $title | Title of the note |
| mixed | $tags | String containing a comma-separated list of tags or array of strings containing tags (optional) |
| string | $description | Free-text note (optional) |
| int | $noteId | Unique identifier for an existing note to update (optional) Zend_Service_Simpy Provides a fluent interface |
Definition at line 398 of file Simpy.php.

| splitTag | ( | $ | tag, |
| $ | toTag1, | ||
| $ | toTag2 | ||
| ) |
Splits a single tag into two separate tags.
| string | $tag | Tag to split |
| string | $toTag1 | First tag to split into |
| string | $toTag2 | Second tag to split into Zend_Service_Simpy Provides a fluent interface |
Definition at line 219 of file Simpy.php.
