TYPO3  7.6
Public Member Functions | List of all members
OnlineMediaHelperInterface Interface Reference
Inheritance diagram for OnlineMediaHelperInterface:
AbstractOnlineMediaHelper AbstractOEmbedHelper VimeoHelper YouTubeHelper

Public Member Functions

 __construct ($extension)
 
 transformUrlToFile ($url, Folder $targetFolder)
 
 getOnlineMediaId (File $file)
 
 getPublicUrl (File $file, $relativeToCurrentScript=false)
 
 getPreviewImage (File $file)
 
 getMetaData (File $file)
 

Detailed Description

Interface OnlineMediaInterface

Definition at line 23 of file OnlineMediaHelperInterface.php.

Constructor & Destructor Documentation

__construct (   $extension)

Constructor

Parameters
string$extensionfile extension bind to the OnlineMedia helper

Implemented in AbstractOnlineMediaHelper.

Member Function Documentation

getMetaData ( File  $file)

Get meta data for OnlineMedia item

See $GLOBALS[TCA][sys_file_metadata][columns] for possible fields to fill/use

Parameters
File$file
Returns
array with metadata

Implemented in AbstractOEmbedHelper.

getOnlineMediaId ( File  $file)

Get Online Media item id

Parameters
File$file
Returns
string

Implemented in AbstractOnlineMediaHelper.

getPreviewImage ( File  $file)

Get local absolute file path to preview image

Return an empty string when no preview image is available

Parameters
File$file
Returns
string

Implemented in VimeoHelper, and YouTubeHelper.

getPublicUrl ( File  $file,
  $relativeToCurrentScript = false 
)

Get public url

Return NULL if you want to use core default behaviour

Parameters
File$file
bool$relativeToCurrentScript
Returns
string|NULL

Implemented in VimeoHelper, and YouTubeHelper.

transformUrlToFile (   $url,
Folder  $targetFolder 
)

Try to transform given URL to a File

Parameters
string$url
Folder$targetFolder
Returns
File|NULL

Implemented in YouTubeHelper, and VimeoHelper.