Class Zend_Service_Simpy

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

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


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

Base URI to which API methods and parameters will be appended

  • access: protected
Zend_Service_Rest $_rest (line 90)

Zend_Service_Rest object

  • access: protected
Methods
Constructor __construct (line 99)

Constructs a new Simpy (free) REST API Client

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

Deletes a given link.

void deleteLink (string $href)
  • string $href: URL of the bookmark to delete
getLinks (line 257)

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 368)

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 165)

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 346)

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 333)

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

mergeTags (line 218)

Merges two tags into a new tag.

void 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 182)

Removes a tag.

void removeTag (string $tag)
  • string $tag: Tag to be removed
renameTag (line 199)

Renames a tag.

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

Saves a given link.

void 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 389)

Saves a new note.

void saveNote (string $title, [mixed $tags = null], [string $description = 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)
splitTag (line 238)

Splits a single tag into two separate tags.

void 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 126)

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

  • return: Parsed XML response
  • access: protected
  • throws: Zend_Service_Exception
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 Thu, 18 Jan 2007 10:01:17 -0800 by phpDocumentor 1.3.1