Service/ShortUrl/BitLy.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 license@zend.com 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_ShortUrl  
Version
$Id$  

\Zend_Service_ShortUrl_BitLy

Package: Zend_Service_ShortUrl
Bit.ly API implementation
Parent(s)
\Zend_Service_ShortUrl_AbstractShortener < \Zend_Service_Abstract
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedstring $_apiKey
user API key or application access token
Details
Type
string
>VPropertyprotectedstring $_apiUri = 'http://api.bitly.com'
Base URI of the service
Default value'http://api.bitly.com'Details
Type
string
>VPropertyprotectedstring $_loginName
user login name
Details
Type
string

Methods

methodpublic__construct(string $login, null | string $apiKey = null) : void

Parameters
NameTypeDescription
$loginstring

user login name or application access token

$apiKeynull | string

user API key

methodprotected_processRequest() : string

handle bit.ly response

Returns
TypeDescription
string
Throws
ExceptionDescription
\Zend_Service_ShortUrl_Exception
methodprotected_setAccessParameter() : void

prepare http client

methodpublicsetApiLogin( $login,  $apiKey) : \Zend_Service_ShortUrl_BitLy

set login credentials

Parameters
NameTypeDescription
$login
$apiKey
Returns
TypeDescription
\Zend_Service_ShortUrl_BitLy
methodpublicsetOAuthAccessToken( $accessToken) : \Zend_Service_ShortUrl_BitLy

set OAuth credentials

Parameters
NameTypeDescription
$accessToken
Returns
TypeDescription
\Zend_Service_ShortUrl_BitLy
methodpublicshorten(string $url) : string

This function shortens long url

Parameters
NameTypeDescription
$urlstring

URL to Shorten

Returns
TypeDescription
stringShortened Url
Throws
ExceptionDescription
\Zend_Service_ShortUrl_Exceptionif bit.ly reports an error
methodpublicunshorten(string $shortenedUrl) : string

Reveals target for short URL

Parameters
NameTypeDescription
$shortenedUrlstring

URL to reveal target of

Returns
TypeDescription
stringUnshortened Url
Throws
ExceptionDescription
\Zend_Service_ShortUrl_Exceptionif bit.ly reports an error
Documentation was generated by phpDocumentor 2.2.0 .