PHPXRef 0.7.1 : moodle-2.8 : Detail view of Technorati.php

Class: Zend_Service_Technorati - X-Ref

Zend_Service_Technorati provides an easy, intuitive and object-oriented interface
for using the Technorati API.

It provides access to all available Technorati API queries
and returns the original XML response as a friendly PHP object.

__construct($apiKey) X-Ref

Constructs a new Zend_Service_Technorati instance
and setup character encoding.

param: string $apiKey Your Technorati API key

cosmos($url, $options = null) X-Ref

Cosmos query lets you see what blogs are linking to a given URL.

On the Technorati site, you can enter a URL in the searchbox and
it will return a list of blogs linking to it.
The API version allows more features and gives you a way
to use the cosmos on your own site.

Query options include:

'type'       => (link|weblog)
optional - A value of link returns the freshest links referencing your target URL.
A value of weblog returns the last set of unique weblogs referencing your target URL.
'limit'      => (int)
optional - adjust the size of your result from the default value of 20
to between 1 and 100 results.
'start'      => (int)
optional - adjust the range of your result set.
Set this number to larger than zero and you will receive
the portion of Technorati's total result set ranging from start to start+limit.
The default start value is 1.
'current'    => (true|false)
optional - the default setting of true
Technorati returns links that are currently on a weblog's homepage.
Set this parameter to false if you would like to receive all links
to the given URL regardless of their current placement on the source blog.
Internally the value is converted in (yes|no).
'claim'      => (true|false)
optional - the default setting of FALSE returns no user information
about each weblog included in the result set when available.
Set this parameter to FALSE to include Technorati member data
in the result set when a weblog in your result set
has been successfully claimed by a member of Technorati.
Internally the value is converted in (int).
'highlight'  => (true|false)
optional - the default setting of TRUE
highlights the citation of the given URL within the weblog excerpt.
Set this parameter to FALSE to apply no special markup to the blog excerpt.
Internally the value is converted in (int).

param: string $url     the URL you are searching for. Prefixes http:// and www. are optional.
param: array $options  additional parameters to refine your query
return: Zend_Service_Technorati_CosmosResultSet

search($query, $options = null) X-Ref

Search lets you see what blogs contain a given search string.

Query options include:

'language'   => (string)
optional - a ISO 639-1 two character language code
to retrieve results specific to that language.
This feature is currently beta and may not work for all languages.
'authority'  => (n|a1|a4|a7)
optional - filter results to those from blogs with at least
the Technorati Authority specified.
Technorati calculates a blog's authority by how many people link to it.
Filtering by authority is a good way to refine your search results.
There are four settings:
- n  => Any authority: All results.
- a1 => A little authority: Results from blogs with at least one link.
- a4 => Some authority: Results from blogs with a handful of links.
- a7 => A lot of authority: Results from blogs with hundreds of links.
'limit'      => (int)
optional - adjust the size of your result from the default value of 20
to between 1 and 100 results.
'start'      => (int)
optional - adjust the range of your result set.
Set this number to larger than zero and you will receive
the portion of Technorati's total result set ranging from start to start+limit.
The default start value is 1.
'claim'      => (true|false)
optional - the default setting of FALSE returns no user information
about each weblog included in the result set when available.
Set this parameter to FALSE to include Technorati member data
in the result set when a weblog in your result set
has been successfully claimed by a member of Technorati.
Internally the value is converted in (int).

param: string $query   the words you are searching for.
param: array $options  additional parameters to refine your query
return: Zend_Service_Technorati_SearchResultSet

tag($tag, $options = null) X-Ref

Tag lets you see what posts are associated with a given tag.

Query options include:

'limit'          => (int)
optional - adjust the size of your result from the default value of 20
to between 1 and 100 results.
'start'          => (int)
optional - adjust the range of your result set.
Set this number to larger than zero and you will receive
the portion of Technorati's total result set ranging from start to start+limit.
The default start value is 1.
'excerptsize'    => (int)
optional - number of word characters to include in the post excerpts.
By default 100 word characters are returned.
'topexcerptsize' => (int)
optional - number of word characters to include in the first post excerpt.
By default 150 word characters are returned.

param: string $tag     the tag term you are searching posts for.
param: array $options  additional parameters to refine your query
return: Zend_Service_Technorati_TagResultSet

dailyCounts($query, $options = null) X-Ref

TopTags provides daily counts of posts containing the queried keyword.

Query options include:

'days'       => (int)
optional - Used to specify the number of days in the past
to request daily count data for.
Can be any integer between 1 and 180, default is 180

param: string $q       the keyword query
param: array $options  additional parameters to refine your query
return: Zend_Service_Technorati_DailyCountsResultSet

topTags($options = null) X-Ref

TopTags provides information on top tags indexed by Technorati.

Query options include:

'limit'      => (int)
optional - adjust the size of your result from the default value of 20
to between 1 and 100 results.
'start'      => (int)
optional - adjust the range of your result set.
Set this number to larger than zero and you will receive
the portion of Technorati's total result set ranging from start to start+limit.
The default start value is 1.

param: array $options  additional parameters to refine your query
return: Zend_Service_Technorati_TagsResultSet

blogInfo($url, $options = null) X-Ref

BlogInfo provides information on what blog, if any, is associated with a given URL.

param: string $url the URL you are searching for. Prefixes http:// and www. are optional.
param: array $options additional parameters to refine your query
return: Zend_Service_Technorati_BlogInfoResult

blogPostTags($url, $options = null) X-Ref

BlogPostTags provides information on the top tags used by a specific blog.

Query options include:

'limit'      => (int)
optional - adjust the size of your result from the default value of 20
to between 1 and 100 results.
'start'      => (int)
optional - adjust the range of your result set.
Set this number to larger than zero and you will receive
the portion of Technorati's total result set ranging from start to start+limit.
The default start value is 1.
Note. This property is not documented.

param: string $url     the URL you are searching for. Prefixes http:// and www. are optional.
param: array $options  additional parameters to refine your query
return: Zend_Service_Technorati_TagsResultSet

getInfo($username, $options = null) X-Ref

GetInfo query tells you things that Technorati knows about a member.

The returned info is broken up into two sections:
The first part describes some information that the user wants
to allow people to know about him- or herself.
The second part of the document is a listing of the weblogs
that the user has successfully claimed and the information
that Technorati knows about these weblogs.

param: string $username the Technorati user name you are searching for
param: array $options additional parameters to refine your query
return: Zend_Service_Technorati_GetInfoResult

keyInfo() X-Ref

KeyInfo query provides information on daily usage of an API key.
Key Info Queries do not count against a key's daily query limit.

A day is defined as 00:00-23:59 Pacific time.

return: Zend_Service_Technorati_KeyInfoResult

getApiKey() X-Ref

Returns Technorati API key.

return: string Technorati API key

getRestClient() X-Ref

Returns a reference to the REST client object in use.

If the reference hasn't being inizialized yet,
then a new Zend_Rest_Client instance is created.

return: Zend_Rest_Client

setApiKey($key) X-Ref

Sets Technorati API key.

Be aware that this function doesn't validate the key.
The key is validated as soon as the first API request is sent.
If the key is invalid, the API request method will throw
a Zend_Service_Technorati_Exception exception with Invalid Key message.

param: string $key Technorati API Key
return: void

_validateCosmos(array $options) X-Ref

Validates Cosmos query options.

param: array $options
return: void

_validateSearch(array $options) X-Ref

Validates Search query options.

param: array $options
return: void

_validateTag(array $options) X-Ref

Validates Tag query options.

param: array $options
return: void

_validateDailyCounts(array $options) X-Ref

Validates DailyCounts query options.

param: array $options
return: void

_validateGetInfo(array $options) X-Ref

Validates GetInfo query options.

param: array $options
return: void

_validateTopTags(array $options) X-Ref

Validates TopTags query options.

param: array $options
return: void

_validateBlogInfo(array $options) X-Ref

Validates BlogInfo query options.

param: array $options
return: void

_validateBlogPostTags(array $options) X-Ref

Validates TopTags query options.

param: array $options
return: void

_validateInArrayOption($name, $options, array $array) X-Ref

Checks whether an option is in a given array.

param: string $name option name
param: array $options
param: array $array array of valid options
return: void

_validateMandatoryOption($name, $options) X-Ref

Checks whether mandatory $name option exists and it's valid.

param: array $options
return: void

_validateIntegerOption($name, $options) X-Ref

Checks whether $name option is a valid integer and casts it.

param: array $options
return: void

_makeRequest($path, $options = array() X-Ref

Makes and HTTP GET request to given $path with $options.
HTTP Response is first validated, then returned.

param: string $path
param: array $options
return: Zend_Http_Response

_validateOptionClaim(array $options) X-Ref

Checks whether 'claim' option value is valid.

param: array $options
return: void

_validateOptionFormat(array $options) X-Ref

Checks whether 'format' option value is valid.
Be aware that Zend_Service_Technorati supports only XML as format value.

param: array $options
return: void

_validateOptionLimit(array $options) X-Ref

Checks whether 'limit' option value is valid.
Value must be an integer greater than PARAM_LIMIT_MIN_VALUE
and lower than PARAM_LIMIT_MAX_VALUE.

param: array $options
return: void

_validateOptionStart(array $options) X-Ref

Checks whether 'start' option value is valid.
Value must be an integer greater than 0.

param: array $options
return: void

_validateOptionUrl(array $options) X-Ref

Checks whether 'url' option value exists and is valid.
'url' must be a valid HTTP(s) URL.

param: array $options
return: void

_checkErrors(DomDocument $dom) X-Ref

Checks XML response content for errors.

param: DomDocument $dom the XML response as a DOM document
return: void

_convertResponseAndCheckContent(Zend_Http_Response $response) X-Ref

Converts $response body to a DOM object and checks it.

param: Zend_Http_Response $response
return: DOMDocument

_checkResponse(Zend_Http_Response $response) X-Ref

Checks ReST response for errors.

param: Zend_Http_Response $response the ReST response
return: void

_compareOptions(array $options, array $validOptions) X-Ref

Checks whether user given options are valid.

param: array $options user options
param: array $validOptions valid options
return: void

_prepareOptions($options, array $defaultOptions) X-Ref

Prepares options for the request

param: array $options user options
param: array $defaultOptions default options
return: array Merged array of user and default/required options.

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:	1028 lines (38 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

PHP Cross Reference of moodle-2.8

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

Defines 1 class