phpDocumentor contextvoice
Main
[ class tree: contextvoice ] [ index: contextvoice ] [ all elements ]

Class: contextvoice

Source Location: /contextvoice.php

Class contextvoice

Class Overview
Method Summary
contextvoice   __construct()   Default constructor
cv_Response   addUrl()   Submit a single url to contextvoice for tracking
cv_Response   addUrls()   Submit a number of urls to contextvoice for tracking.
cv_Response   getUrlInfo()   Get info about a single url from contextvoice.
cv_Response   getUrlReactions()   Get a set of reactions about a single url from contextvoice.

[ Top ]
Methods
Constructor __construct  [line 48]

  contextvoice __construct( [string $apikey = false]  )

Default constructor

You can use the service anonymously by not specifying an API key but you will be limited to only using the getUrlReactions method, and a call rate limit of 500 calls per day.

Instantiate as $myvar = new contextvoice('[my api key]'); or $myvar = new contextvoice(); //anonymous access

Parameters:
string   $apikey: 

API Tags:
Access:  public


[ Top ]
addUrl  [line 59]

  cv_Response addUrl( string $url  )

Submit a single url to contextvoice for tracking

Parameters:
string   $url:  Must be a fully qualified url e.g. http://www.example.com/page.htm


[ Top ]
addUrls  [line 77]

  cv_Response addUrls( mixed $urls  )

Submit a number of urls to contextvoice for tracking.

$urls can be either a comma delimited list or an array. each URL must be a fully qualified url e.g. http://www.example.com/page.htm

Parameters:
mixed   $urls:  This must be either a comma-separated list(string) or an array of urls


[ Top ]
getUrlInfo  [line 99]

  cv_Response getUrlInfo( string $url  )

Get info about a single url from contextvoice.

The url must have first been registered via the addUrl or addUrls methods.

Parameters:
string   $url:  Must be a fully qualified url e.g. http://www.example.com/page.htm


[ Top ]
getUrlReactions  [line 130]

  cv_Response getUrlReactions( string $url, [string $since = false], [string $include = false], [string $exclude = false], [bool $filter = false], [string $order = false], [int $page = false], [int $perpage = false], [bool $threaded = false]  )

Get a set of reactions about a single url from contextvoice.

The url must have first been registered via the addUrl or addUrls methods.

Parameters:
string   $url:  Must be a fully qualified url e.g. http://www.example.com/page.htm
string   $since:  [optional] Any php parseable date string e.g. "15 May 2009"
string   $include:  [optional] Comma-separated list of sources e.g. "twitter,digg,friendfeed"
string   $exclude:  [optional] Comma-separated list of sources e.g. "flickr,hackernews,slashdot"
bool   $filter:  [optional] if true, attempts to remove "retweets" from the results.
string   $order:  [optional] "asc" or "desc" orders the results by the date that they were added to the contextvoice indexes
int   $page:  [optional] the page of results to return defaults to 1
int   $perpage:  [optional] the number of results to return per page, defaults to 25
bool   $threaded:  [optional] return the threaded conversation (retwitts will be treated as children of the original twitt), defaults to false


[ Top ]

Documentation generated on Fri, 21 Aug 2009 12:54:26 +0100 by phpDocumentor 1.4.1