API Documentation

Zend/Service/Technorati/KeyInfoResult.php

Show: inherited
Table of Contents

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.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Service  
Subpackage
Technorati  
Version
$Id: KeyInfoResult.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Service_Technorati_KeyInfoResult

Package: Zend\Service\Technorati

Represents a single Technorati KeyInfo query result object.

It provides information about your Technorati API Key daily usage.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedstring  $_apiKey= ''

Technorati API key

Details
Type
string
Access
protected  
Propertyprotectedint  $_apiQueries= ''

Number of queries used today

Details
Type
int
Access
protected  
Propertyprotectedint  $_maxQueries= ''

Total number of available queries per day

Details
Type
int
Access
protected  

Methods

methodpublic__construct( \DomElement $dom, string $apiKey = null ) : void

Constructs a new object from DOM Element.

Parses given Key element from $dom and sets API key string.

Parameters
Name Type Description
$dom \DomElement

the ReST fragment for this object

$apiKey string

the API Key string

methodpublicgetApiKey( ) : string

Returns API Key string.

Returns
Type Description
string API Key string
methodpublicgetApiQueries( ) : int

Returns the number of queries sent today.

Returns
Type Description
int number of queries sent today
methodpublicgetMaxQueries( ) : int

Returns Key's daily query limit.

Returns
Type Description
int maximum number of available queries per day
methodpublicsetApiKey( string $apiKey ) : \Zend_Service_Technorati_KeyInfoResult

Sets API Key string.

Parameters
Name Type Description
$apiKey string

the API Key

Returns
Type Description
\Zend_Service_Technorati_KeyInfoResult $this instance
Documentation was generated by DocBlox 0.15.1.