Service/Technorati/KeyInfoResult.php

Show: PublicProtectedPrivateinherited
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 [email protected] so we can send you a copy immediately.
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Service  
Subpackage
Technorati  
Version
$Id$  

\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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedstring $_apiKey
Technorati API key
Details
Type
string
Access
protected  
>VPropertyprotectedint $_apiQueries
Number of queries used today
Details
Type
int
Access
protected  
>VPropertyprotectedint $_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
NameTypeDescription
$dom\DomElement

the ReST fragment for this object

$apiKeystring

the API Key string

methodpublicgetApiKey() : string

Returns API Key string.

Returns
TypeDescription
stringAPI Key string
methodpublicgetApiQueries() : int

Returns the number of queries sent today.

Returns
TypeDescription
intnumber of queries sent today
methodpublicgetMaxQueries() : int

Returns Key's daily query limit.

Returns
TypeDescription
intmaximum number of available queries per day
methodpublicsetApiKey(string $apiKey) : \Zend_Service_Technorati_KeyInfoResult

Sets API Key string.

Parameters
NameTypeDescription
$apiKeystring

the API Key

Returns
TypeDescription
\Zend_Service_Technorati_KeyInfoResult$this instance
Documentation was generated by phpDocumentor 2.2.0 .