TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\OnlineMediaHelperInterface Interface Reference

Inheritance diagram for TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\OnlineMediaHelperInterface:

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()

TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\OnlineMediaHelperInterface::__construct

(

$extension

)

Constructor

Parameters

string

$extension

file extension bind to the OnlineMedia helper

Implemented in TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\AbstractOnlineMediaHelper.

Member Function Documentation

getMetaData()

TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\OnlineMediaHelperInterface::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 TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\AbstractOEmbedHelper.

getOnlineMediaId()

TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\OnlineMediaHelperInterface::getOnlineMediaId

(

File

$file

)

Get Online Media item id

Parameters

File

$file

Returns

string

Implemented in TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\AbstractOnlineMediaHelper.

getPreviewImage()

TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\OnlineMediaHelperInterface::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 TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\VimeoHelper, and TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\YouTubeHelper.

getPublicUrl()

TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\OnlineMediaHelperInterface::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 TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\VimeoHelper, and TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\YouTubeHelper.

transformUrlToFile()

TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\OnlineMediaHelperInterface::transformUrlToFile	(		$url,
		Folder	$targetFolder
	)

Try to transform given URL to a File

Parameters

string	$url
Folder	$targetFolder

Returns

File|NULL

Implemented in TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\YouTubeHelper, and TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\VimeoHelper.