Class: Services_oEmbed

Source Location: /Services_oEmbed-0.2.1/Services/oEmbed.php

Class Overview

Base class for consuming oEmbed objects

Author(s):

Joe Stump <joe at joestump.net>

Version:

Release: @version@

Copyright:

2008 Digg.com, Inc.

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

[line 87]
Base class for consuming oEmbed objects

 <?php

 
 require_once 'Services/oEmbed.php';
 
 // The URL that we'd like to find out more information about.
 $url = 'http://flickr.com/photos/joestump/2848795611/';
 
 // The oEmbed API URI. Not all providers support discovery yet so we're
 // explicitly providing one here. If one is not provided Services_oEmbed
 // attempts to discover it. If none is found an exception is thrown.
 $oEmbed = new Services_oEmbed($url, array(
     Services_oEmbed::OPTION_API => 'http://www.flickr.com/services/oembed/'
 ));
 $object = $oEmbed->getObject();
 
 // All of the objects have somewhat sane __toString() methods that allow
 // you to output them directly.
 echo (string)$object;
 
 ?>

Author: Joe Stump <joe@joestump.net>
Version: Release: @version@
Copyright: 2008 Digg.com, Inc.
Link: http://code.google.com/p/digg
Link: http://oembed.com
License: New BSD License

[ Top ]

Class Variables

$options = array(
        self::OPTION_TIMEOUT    => 3,
        self::OPTION_API        => null,
        self::OPTION_USER_AGENT => 'Services_oEmbed @package-version@'
    )

[line 126]

Options for oEmbed requests

Var: The options for making requests
Access: protected

Type:

array

[ Top ]

$url = null

[line 137]

URL of object to get embed information for

Var: Net_URL2 instance of URL of object
Access: protected

Type:

object

[ Top ]

Method Detail

discover [line 300]

string discover(
string
$url)

Discover an oEmbed API

Return: The oEmbed API endpoint discovered
Throws: Services_oEmbed_Exception if the $url is invalid
Access: protected

Parameters:

string $url — The URL to attempt to discover oEmbed for

[ Top ]

getObject [line 231]

object The getObject(
[array
$params = array()])

Get the oEmbed response

Return: oEmbed response as an object
Throws: Services_oEmbed_Exception on cURL errors
Throws: Services_oEmbed_Exception on HTTP errors
Throws: Services_oEmbed_Exception when result is not parsable
Access: public

Parameters:

array $params — Optional parameters for

[ Top ]

__construct (Constructor) [line 149]

void __construct(
string
$url, [array
$options = array()])

Constructor

Throws: Services_oEmbed_Exception when no valid API is found
Throws: Services_oEmbed_Exception if the $url is invalid
Access: public

Parameters:

string	`$url`	—	The URL to fetch an oEmbed for
array	`$options`	—	A list of options for the oEmbed lookup

[ Top ]

setOption [line 180]

void setOption(
mixed
$option, mixed
$value)

Set an option for the oEmbed request

See: Services_oEmbed::OPTION_API, Services_oEmbed::OPTION_TIMEOUT
Throws: Services_oEmbed_Exception on invalid option
Access: public

Parameters:

mixed	`$option`	—	The option name
mixed	`$value`	—	The option value

[ Top ]

_set_oembed_api [line 209]

string _set_oembed_api(
string
$value)

Set the API option

See: Validate::uri()
Throws: Services_oEmbed_Exception on invalid API URI
Access: protected

Parameters:

string $value — The API's URI

[ Top ]

Class: Services_oEmbed

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$options = array( self::OPTION_TIMEOUT => 3, self::OPTION_API => null, self::OPTION_USER_AGENT => 'Services_oEmbed @package-version@' )

$url = null

Method Detail

discover [line 300]

Parameters:

getObject [line 231]

Parameters:

__construct (Constructor) [line 149]

Parameters:

setOption [line 180]

Parameters:

_set_oembed_api [line 209]

Parameters:

$options = array(
self::OPTION_TIMEOUT => 3,
self::OPTION_API => null,
self::OPTION_USER_AGENT => 'Services_oEmbed @package-version@'
)