Docs For Class Services

$options = array()

[line 50]

Global options for services

Most short URL services have APIs that do not require anything special to interface with. Others, however, require API keys, usernames, etc. This is a global variable that can store those options to reduce repetitiveness.

Var: Service options
See: Services_ShortURL::setServiceOptions()
Access: protected

Type:

array

[ Top ]

$services = array(
        'bit.ly'      => 'Bitly',
        'is.gd'       => 'Isgd',
        'tinyurl.com' => 'TinyURL',
        'digg.com'    => 'Digg',
        'tr.im'       => 'Trim',
        'goo.gl'      => 'Googl',
        'short.ie'    => 'Shortie'
    )

[line 57]

List of supported services

Var: Map of services to drivers
Access: protected

Type:

array

[ Top ]

addService [line 175]

void addService(
string
$host, string
$driver)

Add a service driver

You can easily create your own drivers and enable them globally using this method. Please submit your drivers if you're able to do so. We appreciate the help!

Access: public

Parameters:

string	`$host`	—	The hostname used by the shortening service
string	`$driver`	—	The name of the driver to be used

[ Top ]

detect [line 118]

object Instance detect(
string
$url)

Detect service from a short URL

Takes a URL and inpects it to see if there is a service driver that can be used to expand it.

Return: of Services_ShortURL_Interface
Access: public

Parameters:

string $url — The short URL to inspect

[ Top ]

extract [line 143]

array extract(
string
$string)

Extract all short URLs and expand them from a string

This exception will take a given string (e.g. a blog post or a tweet), inspect it for supported short URLs and expand each of them. It then returns an array with the short URL as the key and the expanded URL as the value.

Return: An array keyed by short URL with expanded URL as value
Throws: Services_ShortURL_Exception_CouldNotExpand
Access: public

Parameters:

string $string — The string to inspect for short URLs

[ Top ]

factory [line 76]

object Instance factory(
string
$service, [array
$options = array()])

Create an instance of a service driver

Return: of Services_ShortURL_Interface
Throws: Services_ShortURL_Exception
Access: public

Parameters:

string	`$service`	—	Name of service driver
array	`$options`	—	Options for the given service

[ Top ]

setServiceOptions [line 193]

void setServiceOptions(
string
$service, array
$options)

Set global service options

To easily use the extract feature or not have to worry about setting options for everything you can globally set a service's options using this method. Services_ShortURL::factory() will then use options set by this method.

Access: public

Parameters:

string	`$service`	—	Service to set options for
array	`$options`	—	The options for the service

[ Top ]

Class: Services_ShortURL

Class Overview

Author(s):

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$options = array()

$services = array(
        'bit.ly'      => 'Bitly',
        'is.gd'       => 'Isgd',
        'tinyurl.com' => 'TinyURL',
        'digg.com'    => 'Digg',
        'tr.im'       => 'Trim',
        'goo.gl'      => 'Googl',
        'short.ie'    => 'Shortie'
    )

Method Detail

addService [line 175]

Parameters:

detect [line 118]

Parameters:

extract [line 143]

Parameters:

factory [line 76]

Parameters:

setServiceOptions [line 193]

Parameters:

Class: Services_ShortURL

Class Overview

Author(s):

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$options = array()

$services = array( 'bit.ly' => 'Bitly', 'is.gd' => 'Isgd', 'tinyurl.com' => 'TinyURL', 'digg.com' => 'Digg', 'tr.im' => 'Trim', 'goo.gl' => 'Googl', 'short.ie' => 'Shortie' )

Method Detail

addService [line 175]

Parameters:

detect [line 118]

Parameters:

extract [line 143]

Parameters:

factory [line 76]

Parameters:

setServiceOptions [line 193]

Parameters:

$services = array(
'bit.ly' => 'Bitly',
'is.gd' => 'Isgd',
'tinyurl.com' => 'TinyURL',
'digg.com' => 'Digg',
'tr.im' => 'Trim',
'goo.gl' => 'Googl',
'short.ie' => 'Shortie'
)