API Documentation

Service/ShortUrl/AbstractShortener.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Service_ShortUrl  
version
$Id: $  

\Zend_Service_ShortUrl_AbstractShortener

Extends from
\Zend_Service_Abstract
Implements
\Zend_Service_ShortUrl_Shortener
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Service_ShortUrl  

Properties

Propertyprotectedstring  $_baseUri= 'null'

Base URI of the service

Default valuenullDetails
Type
string

Methods

methodprotected_validateUri( string $url ) : void

Checks whether URL to be shortened is valid

Parameters
Name Type Description
$url string
Throws
Exception Description
\Zend_Service_ShortUrl_Exception When URL is not valid
methodprotected_verifyBaseUri( string $shortenedUrl ) : void

Verifies that the URL has been shortened by this service

Parameters
Name Type Description
$shortenedUrl string
Throws
Exception Description
\Zend_Service_ShortUrl_Exception If the URL hasn't been shortened by this service
methodpublicgetHttpClient( ) : \Zend_Http_Client
static

Gets the HTTP client object.

Inherited from: \Zend_Service_Abstract::getHttpClient()
Returns
Type Description
\Zend_Http_Client
methodpublicsetHttpClient( \Zend_Http_Client $httpClient ) : void
static

Sets the HTTP client object to use for retrieving the feeds. If none is set, the default Zend_Http_Client will be used.

Inherited from: \Zend_Service_Abstract::setHttpClient()
Parameters
Name Type Description
$httpClient \Zend_Http_Client
methodpublicshorten(  $shortenedUrl ) : string

This function shortens long url

Inherited from: \Zend_Service_ShortUrl_Shortener::shorten()
Parameters
Name Type Description
$shortenedUrl
Returns
Type Description
string Shortened Url
methodpublicunshorten( string $shortenedUrl ) : string

Reveals target for short URL

Inherited from: \Zend_Service_ShortUrl_Shortener::unshorten()
Parameters
Name Type Description
$shortenedUrl string URL to reveal target of
Returns
Type Description
string Unshortened Url
Documentation was generated by DocBlox 0.13.3.