Docs For Class CMS

Description

Class CMS_oembed

Represent an oembed resource object

author: Sébastien Pauchet <sebastien.pauchet@ws-interactive.fr>

Located in /automne/classes/common/oembed.php (line 25)

CMS_grandFather
   |
   --CMS_oembed

Method Summary

static string _regDelimStripper (string $s)

static string _regImploder (array $r)

void __construct (string $url, [integer $maxwidth = ''], [integer $maxheight = ''], [ $embedlyKey = ''])

array getData ( $name)

array getDatas ()

string getHTML ([array $attributes = array()], [boolean $inframe = false])

string getProvider ()

string getProviderName ()

string getThumbnail ([array $attributes = array()])

string getTitle ()

boolean hasProvider ()

string _addWmode (string $html)

boolean _embedlySupported ()

string _getIframe (string $style, string $attr)

boolean _getProvider ()

boolean _retrieveDatas ()

Methods

static _regDelimStripper (line 250)

static string _regDelimStripper (string $s)

string $s

static _regImploder (line 242)

static string _regImploder (array $r)

array $r

Constructor __construct (line 103)

Constructor.

initialize object.

access: public

void __construct (string $url, [integer $maxwidth = ''], [integer $maxheight = ''], [ $embedlyKey = ''])

string $url: the url of the distant oembed resource to get
integer $maxwidth: the max width to apply to distant oembed resource (optional)
integer $maxheight: the max height to apply to distant oembed resource (optional)
$embedlyKey

getData (line 538)

Get datas for current media

return: the media datas
access: public

array getData ( $name)

$name

getDatas (line 379)

Get current media datas from provider

return: the medias datas returned by provider
access: public

array getDatas ()

getHTML (line 395)

Get HTML embed code for current media

return: the html embed code (framed if needed)
access: public

string getHTML ([array $attributes = array()], [boolean $inframe = false])

array $attributes: the html attributes to add to returned code
boolean $inframe: does the HTML should be returned into an iframe ? (default false)

getProvider (line 274)

Get current provider using media URL.

return: the provider API url
access: public

string getProvider ()

getProviderName (line 521)

Get provider name for current media

return: the media provider name
access: public

string getProviderName ()

getThumbnail (line 463)

Get thumbnial HTML code for current media

return: the html thumbnail code
access: public

string getThumbnail ([array $attributes = array()])

array $attributes: the html attributes to add to returned code

getTitle (line 507)

Get title for current media

return: the media title
access: public

string getTitle ()

hasProvider (line 260)

Does current oembed object has provider

access: public

boolean hasProvider ()

_addWmode (line 556)

Add wmode transparent to flash embed code

return: the html code transformed
access: protected

string _addWmode (string $html)

string $html: the html code to transform

_embedlySupported (line 179)

Use embed.ly regexp service to check URL

access: public

boolean _embedlySupported ()

_getIframe (line 575)

Get iframe code for current html embed code

return: the html code
access: protected

string _getIframe (string $style, string $attr)

string $style: the html style code to add
string $attr: the html attributes code to add

_getProvider (line 128)

Get current provider using media URL.

access: protected

boolean _getProvider ()

_retrieveDatas (line 288)

Retrieve current media datas from provider

access: protected

boolean _retrieveDatas ()

Inherited Methods

Inherited From CMS_grandFather

CMS_grandFather::autoload()
CMS_grandFather::hasError()
CMS_grandFather::log()
CMS_grandFather::PHPErrorHandler()
CMS_grandFather::raiseError()
CMS_grandFather::setDebug()
CMS_grandFather::setLog()
CMS_grandFather::_raiseError()
CMS_grandFather::__call()

Class Constants

Inherited Constants

Inherited from CMS_grandFather

CMS_grandFather::ERROR_LOG
CMS_grandFather::SYSTEM_LABEL