[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/lib/zend/Zend/Service/ -> Simpy.php (summary)

Zend Framework LICENSE

Copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
License: http://framework.zend.com/license/new-bsd New BSD License
Version: $Id$
File Size: 433 lines (13 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Zend_Service_Simpy:: (16 methods):
  __construct()
  getHttpClient()
  _makeRequest()
  getTags()
  removeTag()
  renameTag()
  mergeTags()
  splitTag()
  getLinks()
  saveLink()
  deleteLink()
  getWatchlists()
  getWatchlist()
  getNotes()
  saveNote()
  deleteNote()


Class: Zend_Service_Simpy  - X-Ref


__construct($username, $password)   X-Ref
Constructs a new Simpy (free) REST API Client

param: string $username Username for the Simpy user account
param: string $password Password for the Simpy user account
return: void

getHttpClient()   X-Ref
Returns the HTTP client currently in use by this class for REST API
calls, intended mainly for testing.

return: Zend_Http_Client

_makeRequest($op, $query = null)   X-Ref
Sends a request to the REST API service and does initial processing
on the response.

param: string $op    Name of the operation for the request
param: array  $query Query data for the request (optional)
return: DOMDocument Parsed XML response

getTags($limit = null)   X-Ref
Returns a list of all tags and their counts, ordered by count in
decreasing order

param: int $limit Limits the number of tags returned (optional)
return: Zend_Service_Simpy_TagSet

removeTag($tag)   X-Ref
Removes a tag.

param: string $tag Tag to be removed
return: Zend_Service_Simpy Provides a fluent interface

renameTag($fromTag, $toTag)   X-Ref
Renames a tag.

param: string $fromTag Tag to be renamed
param: string $toTag   New tag name
return: Zend_Service_Simpy Provides a fluent interface

mergeTags($fromTag1, $fromTag2, $toTag)   X-Ref
Merges two tags into a new tag.

param: string $fromTag1 First tag to merge.
param: string $fromTag2 Second tag to merge.
param: string $toTag    Tag to merge the two tags into.
return: Zend_Service_Simpy Provides a fluent interface

splitTag($tag, $toTag1, $toTag2)   X-Ref
Splits a single tag into two separate tags.

param: string $tag    Tag to split
param: string $toTag1 First tag to split into
param: string $toTag2 Second tag to split into
return: Zend_Service_Simpy Provides a fluent interface

getLinks(Zend_Service_Simpy_LinkQuery $q = null)   X-Ref
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)

param: Zend_Service_Simpy_LinkQuery $q Query object to use (optional)
return: Zend_Service_Simpy_LinkSet

saveLink($title, $href, $accessType, $tags = null, $urlNickname = null, $note = null)   X-Ref
Saves a given link.

param: string $title       Title of the page to save
param: string $href        URL of the page to save
param: int    $accessType  ACCESSTYPE_PUBLIC or ACCESSTYPE_PRIVATE
param: mixed  $tags        String containing a comma-separated list of
param: string $urlNickname Alternative custom title (optional)
param: string $note        Free text note (optional)
return: Zend_Service_Simpy Provides a fluent interface

deleteLink($href)   X-Ref
Deletes a given link.

param: string $href URL of the bookmark to delete
return: Zend_Service_Simpy Provides a fluent interface

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

return: Zend_Service_Simpy_WatchlistSet

getWatchlist($watchlistId)   X-Ref
Returns the meta-data for a given watchlist.

param: int $watchlistId ID of the watchlist to retrieve
return: Zend_Service_Simpy_Watchlist

getNotes($q = null, $limit = null)   X-Ref
Returns all notes in reverse chronological order by add date or by
rank.

param: string $q     Query string formatted using Simpy search syntax
param: int    $limit Limits the number notes returned (optional)
return: Zend_Service_Simpy_NoteSet

saveNote($title, $tags = null, $description = null, $noteId = null)   X-Ref
Saves a note.

param: string $title       Title of the note
param: mixed  $tags        String containing a comma-separated list of
param: string $description Free-text note (optional)
param: int    $noteId      Unique identifier for an existing note to
return: Zend_Service_Simpy Provides a fluent interface

deleteNote($noteId)   X-Ref
Deletes a given note.

param: int $noteId ID of the note to delete
return: Zend_Service_Simpy Provides a fluent interface



Generated: Fri Nov 28 20:29:05 2014 Cross-referenced by PHPXref 0.7.1