Class Zend_Service_Simpy

Description
  • copyright: Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)
  • license: New BSD License

Located in /Service/Simpy.php (line 78)


	
			
Variable Summary
 string $_baseUri
 Zend_Service_Rest $_rest
Method Summary
 void __construct (string $username, string $password)
 Zend_Service_Simpy deleteLink (string $href)
 Zend_Service_Simpy_NoteSet getNotes ([string $q = null], [int $limit = null])
 Zend_Service_Simpy_TagSet getTags ([int $limit = null])
 Zend_Service_Simpy mergeTags (string $fromTag1, string $fromTag2, string $toTag)
 Zend_Service_Simpy removeTag (string $tag)
 Zend_Service_Simpy renameTag (string $fromTag, string $toTag)
 Zend_Service_Simpy saveLink (string $title, string $href, int $accessType, [mixed $tags = null], [string $urlNickname = null], [string $note = null])
 Zend_Service_Simpy saveNote (string $title, [mixed $tags = null], [string $description = null], [int $noteId = null])
 Zend_Service_Simpy splitTag (string $tag, string $toTag1, string $toTag2)
 DOMDocument _makeRequest (string $op, [string|array $query = null])
Variables
string $_baseUri = 'http://simpy.com' (line 85)

Base URI to which API methods and parameters will be appended

  • access: protected
Zend_Service_Rest $_rest (line 92)

Zend_Service_Rest object

  • access: protected
Methods
Constructor __construct (line 101)

Constructs a new Simpy (free) REST API Client

  • access: public
void __construct (string $username, string $password)
  • string $username: Username for the Simpy user account
  • string $password: Password for the Simpy user account
deleteLink (line 319)

Deletes a given link.

Zend_Service_Simpy deleteLink (string $href)
  • string $href: URL of the bookmark to delete
deleteNote (line 422)

Deletes a given note.

Zend_Service_Simpy deleteNote (int $noteId)
  • int $noteId: ID of the note to delete
getLinks (line 256)

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)

  • access: public
getNotes (line 372)

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

Zend_Service_Simpy_NoteSet getNotes ([string $q = null], [int $limit = null])
  • string $q: Query string formatted using Simpy search syntax and search fields (optional)
  • int $limit: Limits the number notes returned (optional)
getTags (line 156)

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

Zend_Service_Simpy_TagSet getTags ([int $limit = null])
  • int $limit: Limits the number of tags returned (optional)
getWatchlist (line 350)

Returns the meta-data for a given watchlist.

Zend_Service_Simpy_Watchlist getWatchlist (int $watchlistId)
  • int $watchlistId: ID of the watchlist to retrieve
getWatchlists (line 337)

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

mergeTags (line 213)

Merges two tags into a new tag.

Zend_Service_Simpy mergeTags (string $fromTag1, string $fromTag2, string $toTag)
  • string $fromTag1: First tag to merge.
  • string $fromTag2: Second tag to merge.
  • string $toTag: Tag to merge the two tags into.
removeTag (line 173)

Removes a tag.

Zend_Service_Simpy removeTag (string $tag)
  • string $tag: Tag to be removed
renameTag (line 192)

Renames a tag.

Zend_Service_Simpy renameTag (string $fromTag, string $toTag)
  • string $fromTag: Tag to be renamed
  • string $toTag: New tag name
saveLink (line 291)

Saves a given link.

Zend_Service_Simpy saveLink (string $title, string $href, int $accessType, [mixed $tags = null], [string $urlNickname = null], [string $note = null])
  • 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)
saveNote (line 396)

Saves a note.

Zend_Service_Simpy saveNote (string $title, [mixed $tags = null], [string $description = null], [int $noteId = null])
  • 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)
splitTag (line 235)

Splits a single tag into two separate tags.

Zend_Service_Simpy splitTag (string $tag, string $toTag1, string $toTag2)
  • string $tag: Tag to split
  • string $toTag1: First tag to split into
  • string $toTag2: Second tag to split into
_makeRequest (line 117)

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

  • return: Parsed XML response
  • throws: Zend_Service_Exception
  • access: protected
DOMDocument _makeRequest (string $op, [string|array $query = null])
  • string $op: Name of the operation for the request
  • string|array $query: Query data for the request (optional)

Documentation generated on Sun, 27 May 2007 23:27:36 -0700 by phpDocumentor 1.3.2