TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\AbstractOnlineMediaHelper Class Reference

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

Public Member Functions
	__construct ($extension)
	getOnlineMediaId (File $file)
Public Member Functions inherited from TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\OnlineMediaHelperInterface
	transformUrlToFile ($url, Folder $targetFolder)
	getPublicUrl (File $file, $relativeToCurrentScript=false)
	getPreviewImage (File $file)
	getMetaData (File $file)

Protected Member Functions
	findExistingFileByOnlineMediaId ($onlineMediaId, Folder $targetFolder, $fileExtension)
	createNewFile (Folder $targetFolder, $fileName, $onlineMediaId)
	getTempFolderPath ()
	getFileIndexRepository ()
	getResourceFactory ()

Protected Attributes
	$onlineMediaIdCache = []
	$extension = ''

Detailed Description

Class AbstractOnlineMediaHelper

Definition at line 26 of file AbstractOnlineMediaHelper.php.

Constructor & Destructor Documentation

__construct()

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

(

$extension

)

Constructor

Parameters

string

$extension

file extension bind to the OnlineMedia helper

Implements TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\OnlineMediaHelperInterface.

Definition at line 47 of file AbstractOnlineMediaHelper.php.

References TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\AbstractOnlineMediaHelper\$extension.

Member Function Documentation

createNewFile()

TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\AbstractOnlineMediaHelper::createNewFile ( Folder  $targetFolder,   $fileName,   $onlineMediaId  )

protected

Create new OnlineMedia item container file

Parameters

Folder	$targetFolder
string	$fileName
string	$onlineMediaId

Returns

File

Definition at line 107 of file AbstractOnlineMediaHelper.php.

References TYPO3\CMS\Core\Resource\Folder\addFile(), and TYPO3\CMS\Core\Utility\GeneralUtility\tempnam().

Referenced by TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\AbstractOEmbedHelper\transformMediaIdToFile().

findExistingFileByOnlineMediaId()

TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\AbstractOnlineMediaHelper::findExistingFileByOnlineMediaId (   $onlineMediaId, Folder  $targetFolder,   $fileExtension  )

protected

Search for files with same onlineMediaId by content hash in indexed storage

Parameters

string	$onlineMediaId
Folder	$targetFolder
string	$fileExtension

Returns

File|NULL

Definition at line 79 of file AbstractOnlineMediaHelper.php.

References TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\AbstractOnlineMediaHelper\getFileIndexRepository(), TYPO3\CMS\Core\Resource\Folder\getHashedIdentifier(), TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\AbstractOnlineMediaHelper\getResourceFactory(), and TYPO3\CMS\Core\Resource\Folder\getStorage().

Referenced by TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\AbstractOEmbedHelper\transformMediaIdToFile().

getFileIndexRepository()

TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\AbstractOnlineMediaHelper::getFileIndexRepository ( )

protected

Returns an instance of the FileIndexRepository

Returns

FileIndexRepository

Definition at line 133 of file AbstractOnlineMediaHelper.php.

References TYPO3\CMS\Core\Resource\Index\FileIndexRepository\getInstance().

Referenced by TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\AbstractOnlineMediaHelper\findExistingFileByOnlineMediaId().

getOnlineMediaId()

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

(

File

$file

)

Get Online Media item id

Parameters

File

$file

Returns

string

Implements TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\OnlineMediaHelperInterface.

Definition at line 58 of file AbstractOnlineMediaHelper.php.

References TYPO3\CMS\Core\Resource\File\getContents(), TYPO3\CMS\Core\Resource\AbstractFile\getSize(), and TYPO3\CMS\Core\Resource\AbstractFile\getUid().

Referenced by TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\AbstractOEmbedHelper\getMetaData(), TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\YouTubeHelper\getPreviewImage(), TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\VimeoHelper\getPreviewImage(), TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\YouTubeHelper\getPublicUrl(), and TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\VimeoHelper\getPublicUrl().

getResourceFactory()

TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\AbstractOnlineMediaHelper::getResourceFactory ( )

protected

Returns the ResourceFactory

Returns

ResourceFactory

Definition at line 143 of file AbstractOnlineMediaHelper.php.

References TYPO3\CMS\Core\Resource\ResourceFactory\getInstance().

Referenced by TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\AbstractOnlineMediaHelper\findExistingFileByOnlineMediaId().

getTempFolderPath()

TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\AbstractOnlineMediaHelper::getTempFolderPath ( )

protected

Get temporary folder path to save preview images

Returns

string

Definition at line 119 of file AbstractOnlineMediaHelper.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\mkdir().

Referenced by TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\YouTubeHelper\getPreviewImage(), and TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\VimeoHelper\getPreviewImage().

Member Data Documentation

$extension

TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\AbstractOnlineMediaHelper::$extension = ''

protected

Definition at line 40 of file AbstractOnlineMediaHelper.php.

Referenced by TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\AbstractOnlineMediaHelper\__construct().

$onlineMediaIdCache

TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\AbstractOnlineMediaHelper::$onlineMediaIdCache = []

protected

Definition at line 33 of file AbstractOnlineMediaHelper.php.