AbstractOnlineMediaHelper Class Reference

Inheritance diagram for AbstractOnlineMediaHelper:

Public Member Functions
	__construct ($extension)
	getOnlineMediaId (File $file)
Public Member Functions inherited from 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 = array()
	$extension = ''

Detailed Description

Class AbstractOnlineMediaHelper

Definition at line 26 of file AbstractOnlineMediaHelper.php.

Constructor & Destructor Documentation

__construct

(

$extension

)

Constructor

Parameters

string

$extension

file extension bind to the OnlineMedia helper

Implements OnlineMediaHelperInterface.

Definition at line 47 of file AbstractOnlineMediaHelper.php.

References AbstractOnlineMediaHelper\$extension.

Member Function Documentation

createNewFile ( Folder  $targetFolder,   $fileName,   $onlineMediaId  )

protected

Create new OnlineMedia item container file

Parameters

Folder	$targetFolder
string	$fileName
string	$onlineMediaId

Returns

File

Definition at line 103 of file AbstractOnlineMediaHelper.php.

References Folder\addFile(), and GeneralUtility\tempnam().

Referenced by AbstractOEmbedHelper\transformMediaIdToFile().

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 75 of file AbstractOnlineMediaHelper.php.

References AbstractOnlineMediaHelper\getFileIndexRepository(), Folder\getHashedIdentifier(), AbstractOnlineMediaHelper\getResourceFactory(), and Folder\getStorage().

Referenced by AbstractOEmbedHelper\transformMediaIdToFile().

getFileIndexRepository ( )

protected

Returns an instance of the FileIndexRepository

Returns

FileIndexRepository

Definition at line 129 of file AbstractOnlineMediaHelper.php.

References FileIndexRepository\getInstance().

Referenced by AbstractOnlineMediaHelper\findExistingFileByOnlineMediaId().

getOnlineMediaId

(

File

$file

)

Get Online Media item id

Parameters

File

$file

Returns

string

Implements OnlineMediaHelperInterface.

Definition at line 58 of file AbstractOnlineMediaHelper.php.

References File\getContents(), and AbstractFile\getUid().

Referenced by AbstractOEmbedHelper\getMetaData(), YouTubeHelper\getPreviewImage(), VimeoHelper\getPreviewImage(), YouTubeHelper\getPublicUrl(), and VimeoHelper\getPublicUrl().

getResourceFactory ( )

protected

Returns the ResourceFactory

Returns

ResourceFactory

Definition at line 139 of file AbstractOnlineMediaHelper.php.

References ResourceFactory\getInstance().

Referenced by AbstractOnlineMediaHelper\findExistingFileByOnlineMediaId().

getTempFolderPath ( )

protected

Get temporary folder path to save preview images

Returns

string

Definition at line 115 of file AbstractOnlineMediaHelper.php.

References GeneralUtility\mkdir().

Referenced by YouTubeHelper\getPreviewImage(), and VimeoHelper\getPreviewImage().

Member Data Documentation

$extension = ''

protected

Definition at line 40 of file AbstractOnlineMediaHelper.php.

Referenced by AbstractOnlineMediaHelper\__construct().

$onlineMediaIdCache = array()

protected

Definition at line 33 of file AbstractOnlineMediaHelper.php.