Service/ShortUrl/BitLy.php
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_ShortUrl
- Version
- $Id$
\Zend_Service_ShortUrl_BitLy
- Parent(s)
- \Zend_Service_ShortUrl_AbstractShortener < \Zend_Service_Abstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties


string $_apiUri = 'http://api.bitly.com'
'http://api.bitly.com'
Details- Type
- string


string $_baseUri = null
null
Details- Type
- string
- Inherited_from
- \Zend_Service_ShortUrl_AbstractShortener::$$_baseUri


\Zend_Http_Client $_httpClient = null
null
Details- Type
- \Zend_Http_Client
- Inherited_from
- \Zend_Service_Abstract::$$_httpClient
- Inherited_from
- \Zend_Service_ShortUrl_AbstractShortener::$$_httpClient
Methods


__construct(string $login, null | string $apiKey = null) : void
Name | Type | Description |
---|---|---|
$login | string | user login name or application access token |
$apiKey | null | string | user API key |


_processRequest() : string
handle bit.ly response
Type | Description |
---|---|
string |
Exception | Description |
---|---|
\Zend_Service_ShortUrl_Exception |


_validateUri(string $url) : void
Checks whether URL to be shortened is valid
Inherited from: \Zend_Service_ShortUrl_AbstractShortener::_validateUri()Name | Type | Description |
---|---|---|
$url | string |
Exception | Description |
---|---|
\Zend_Service_ShortUrl_Exception | When URL is not valid |


_verifyBaseUri(string $shortenedUrl) : void
Verifies that the URL has been shortened by this service
Inherited from: \Zend_Service_ShortUrl_AbstractShortener::_verifyBaseUri()Name | Type | Description |
---|---|---|
$shortenedUrl | string |
Exception | Description |
---|---|
\Zend_Service_ShortUrl_Exception | If the URL hasn't been shortened by this service |


getHttpClient() : \Zend_Http_Client
Gets the HTTP client object.
Inherited from: \Zend_Service_Abstract::getHttpClient()\Zend_Service_ShortUrl_AbstractShortener::getHttpClient()Type | Description |
---|---|
\Zend_Http_Client |


setApiLogin( $login, $apiKey) : \Zend_Service_ShortUrl_BitLy
set login credentials
Name | Type | Description |
---|---|---|
$login | ||
$apiKey |
Type | Description |
---|---|
\Zend_Service_ShortUrl_BitLy |


setHttpClient(\Zend_Http_Client $httpClient) : void
Sets the HTTP client object to use for retrieving the feeds.
Inherited from: \Zend_Service_Abstract::setHttpClient()\Zend_Service_ShortUrl_AbstractShortener::setHttpClient()If none is set, the default Zend_Http_Client will be used.
Name | Type | Description |
---|---|---|
$httpClient | \Zend_Http_Client |


setOAuthAccessToken( $accessToken) : \Zend_Service_ShortUrl_BitLy
set OAuth credentials
Name | Type | Description |
---|---|---|
$accessToken |
Type | Description |
---|---|
\Zend_Service_ShortUrl_BitLy |


shorten(string $url) : string
This function shortens long url
Name | Type | Description |
---|---|---|
$url | string | URL to Shorten |
Type | Description |
---|---|
string | Shortened Url |
Exception | Description |
---|---|
\Zend_Service_ShortUrl_Exception | if bit.ly reports an error |


unshorten(string $shortenedUrl) : string
Reveals target for short URL
Name | Type | Description |
---|---|---|
$shortenedUrl | string | URL to reveal target of |
Type | Description |
---|---|
string | Unshortened Url |
Exception | Description |
---|---|
\Zend_Service_ShortUrl_Exception | if bit.ly reports an error |