Service/Simpy.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Service
subpackage: Simpy
version: $Id: Simpy.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Service_Simpy

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Service_Simpy
jump to top

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
link: http://www.simpy.com/doc/api/rest/
package: Zend_Service
subpackage: Simpy
Properties: $_baseUri; $_http
Methods: __construct; getHttpClient; _makeRequest; getTags; removeTag; renameTag; mergeTags; splitTag; getLinks; saveLink; deleteLink; getWatchlists; getWatchlist; getNotes; saveNote; deleteNote

Description

Properties

$_baseUri
jump to class

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

Base URI to which API methods and parameters will be appended

Details

$_baseUri: string
visibility: protected
default: http://simpy.com/simpy/api/rest/
final: false
static: false

$_http
jump to class

Zend_Http_Client $_http = ''

HTTP client for use in making web service calls

Details

$_http: Zend_Http_Client
visibility: protected
default
final: false
static: false

Methods

__construct
jump to class

__construct(
          string $username, string $password
          )
        
        :
        void

Constructs a new Simpy (free) REST API Client

Arguments

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

Details

visibility: public
final: false
static: false

_makeRequest
jump to class

_makeRequest(
          string $op, array $query
              =
              null
          )
        
        :
        DOMDocument

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

Arguments

$op: string
Name of the operation for the request
$query: array
Query data for the request (optional)

Output

DOMDocument: Parsed XML response

Details

visibility: protected
final: false
static: false
throws

deleteLink
jump to class

deleteLink(
          string $href
          )
        
        :
        Zend_Service_Simpy

Deletes a given link.

Arguments

$href: string
URL of the bookmark to delete

Output

Zend_Service_Simpy: Provides a fluent interface

Details

visibility: public
final: false
static: false
link: http://www.simpy.com/doc/api/rest/DeleteLink

deleteNote
jump to class

deleteNote(
          int $noteId
          )
        
        :
        Zend_Service_Simpy

Deletes a given note.

Arguments

$noteId: int
ID of the note to delete

Output

Zend_Service_Simpy: Provides a fluent interface

Details

visibility: public
final: false
static: false
link: http://www.simpy.com/doc/api/rest/DeleteNote

getHttpClient
jump to class

getHttpClient(
          
          )
        
        :
        Zend_Http_Client

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

Output

Zend_Http_Client

Details

visibility: public
final: false
static: false

getLinks
jump to class

getLinks(
          Zend_Service_Simpy_LinkQuery $q
              =
              null
          )
        
        :
        Zend_Service_Simpy_LinkSet

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)

Arguments

$q: Zend_Service_Simpy_LinkQuery
Query object to use (optional)

Output

Zend_Service_Simpy_LinkSet

Details

visibility: public
final: false
static: false

getNotes
jump to class

getNotes(
          string $q
              =
              null, int $limit
              =
              null
          )
        
        :
        Zend_Service_Simpy_NoteSet

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

Arguments

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

Output

Zend_Service_Simpy_NoteSet

Details

visibility: public
final: false
static: false
link: http://www.simpy.com/doc/api/rest/GetNotes
link: http://www.simpy.com/simpy/FAQ.do#searchSyntax
link: http://www.simpy.com/simpy/FAQ.do#searchFieldsLinks

getTags
jump to class

getTags(
          int $limit
              =
              null
          )
        
        :
        Zend_Service_Simpy_TagSet

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

Arguments

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

Output

Zend_Service_Simpy_TagSet

Details

visibility: public
final: false
static: false
link: http://www.simpy.com/doc/api/rest/GetTags
throws

getWatchlist
jump to class

getWatchlist(
          int $watchlistId
          )
        
        :
        Zend_Service_Simpy_Watchlist

Returns the meta-data for a given watchlist.

Arguments

$watchlistId: int
ID of the watchlist to retrieve

Output

Zend_Service_Simpy_Watchlist

Details

visibility: public
final: false
static: false
link: http://www.simpy.com/doc/api/rest/GetWatchlist

getWatchlists
jump to class

getWatchlists(
          
          )
        
        :
        Zend_Service_Simpy_WatchlistSet

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

Output

Zend_Service_Simpy_WatchlistSet

Details

visibility: public
final: false
static: false
link: http://www.simpy.com/doc/api/rest/GetWatchlists

mergeTags
jump to class

mergeTags(
          string $fromTag1, string $fromTag2, string $toTag
          )
        
        :
        Zend_Service_Simpy

Merges two tags into a new tag.

Arguments

$fromTag1: string
First tag to merge.
$fromTag2: string
Second tag to merge.
$toTag: string
Tag to merge the two tags into.

Output

Zend_Service_Simpy: Provides a fluent interface

Details

visibility: public
final: false
static: false
link: http://www.simpy.com/doc/api/rest/MergeTags

removeTag
jump to class

removeTag(
          string $tag
          )
        
        :
        Zend_Service_Simpy

Removes a tag.

Arguments

$tag: string
Tag to be removed

Output

Zend_Service_Simpy: Provides a fluent interface

Details

visibility: public
final: false
static: false
link: http://www.simpy.com/doc/api/rest/RemoveTag

renameTag
jump to class

renameTag(
          string $fromTag, string $toTag
          )
        
        :
        Zend_Service_Simpy

Renames a tag.

Arguments

$fromTag: string
Tag to be renamed
$toTag: string
New tag name

Output

Zend_Service_Simpy: Provides a fluent interface

Details

visibility: public
final: false
static: false
link: http://www.simpy.com/doc/api/rest/RenameTag

saveLink
jump to class

saveLink(
          string $title, string $href, int $accessType, mixed $tags
              =
              null, string $urlNickname
              =
              null, string $note
              =
              null
          )
        
        :
        Zend_Service_Simpy

Saves a given link.

Arguments

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

Output

Zend_Service_Simpy: Provides a fluent interface

Details

visibility: public
final: false
static: false
link: Zend_Service_Simpy::ACCESSTYPE_PUBLIC
link: Zend_Service_Simpy::ACCESSTYPE_PRIVATE
link: http://www.simpy.com/doc/api/rest/SaveLink

saveNote
jump to class

saveNote(
          string $title, mixed $tags
              =
              null, string $description
              =
              null, int $noteId
              =
              null
          )
        
        :
        Zend_Service_Simpy

Saves a note.

Arguments

$title: string
Title of the note
$tags: mixed
String containing a comma-separated list of tags or array of strings containing tags (optional)
$description: string
Free-text note (optional)
$noteId: int
Unique identifier for an existing note to update (optional)

Output

Zend_Service_Simpy: Provides a fluent interface

Details

visibility: public
final: false
static: false
link: http://www.simpy.com/doc/api/rest/SaveNote

splitTag
jump to class

splitTag(
          string $tag, string $toTag1, string $toTag2
          )
        
        :
        Zend_Service_Simpy

Splits a single tag into two separate tags.

Arguments

$tag: string
Tag to split
$toTag1: string
First tag to split into
$toTag2: string
Second tag to split into

Output

Zend_Service_Simpy: Provides a fluent interface

Details

visibility: public
final: false
static: false
link: http://www.simpy.com/doc/api/rest/SplitTag

API Documentation

Service/Simpy.php

Description

Zend_Service_Simpyjump to top

Description

Properties

$_baseUrijump to class

Details

$_httpjump to class

Details

Methods

__constructjump to class

Arguments

Details

_makeRequestjump to class

Arguments

Output

Details

deleteLinkjump to class

Arguments

Output

Details

deleteNotejump to class

Arguments

Output

Details

getHttpClientjump to class

Output

Details

getLinksjump to class

Arguments

Output

Details

getNotesjump to class

Arguments

Output

Details

getTagsjump to class

Arguments

Output

Details

getWatchlistjump to class

Arguments

Output

Details

getWatchlistsjump to class

Output

Details

mergeTagsjump to class

Arguments

Output

Details

removeTagjump to class

Arguments

Output

Details

renameTagjump to class

Arguments

Output

Details

saveLinkjump to class

Arguments

Output

Details

saveNotejump to class

Arguments

Output

Details

splitTagjump to class

Arguments

Output

Details

Zend_Service_Simpy
jump to top

$_baseUri
jump to class

$_http
jump to class

__construct
jump to class

_makeRequest
jump to class

deleteLink
jump to class

deleteNote
jump to class

getHttpClient
jump to class

getLinks
jump to class

getNotes
jump to class

getTags
jump to class

getWatchlist
jump to class

getWatchlists
jump to class

mergeTags
jump to class

removeTag
jump to class

renameTag
jump to class

saveLink
jump to class

saveNote
jump to class

splitTag
jump to class