PHP Interface Sulu\Bundle\MediaBundle\Media\FormatManager\FormatManagerInterface

Mostrar archivo Open project: sulu/sulu Interface Usage Examples

Public Methods

Method Description
clearCache ( ) Clears the format cache.
getFormatDefinition ( string $formatKey, string $locale = null, array $formatOptions = [] ) : array Returns a definition of a format with a given key. The returned formats contain the passed format options merged into them.
getFormatDefinitions ( string $locale = null, array $formatOptions = [] ) : array Returns all definitions of image formats. The returned formats contain the passed format-options merged into them.
getFormats ( integer $id, string $fileName, array $storageOptions, integer $version, integer $subVersion, string $mimeType ) : array
getMediaProperties ( string $url ) : array Return media id and format.
purge ( integer $idMedia, string $fileName, array $options ) : boolean Delete the image by the given parameters.
returnImage ( integer $id, string $formatName ) : Response Return the image by a given url.

Method Details

clearCache() public method

Clears the format cache.
public clearCache ( )

getFormatDefinition() public method

Returns a definition of a format with a given key. The returned formats contain the passed format options merged into them.
public getFormatDefinition ( string $formatKey, string $locale = null, array $formatOptions = [] ) : array
$formatKey string
$locale string
$formatOptions array
return array

getFormatDefinitions() public method

Returns all definitions of image formats. The returned formats contain the passed format-options merged into them.
public getFormatDefinitions ( string $locale = null, array $formatOptions = [] ) : array
$locale string
$formatOptions array
return array

getFormats() public method

public getFormats ( integer $id, string $fileName, array $storageOptions, integer $version, integer $subVersion, string $mimeType ) : array
$id integer
$fileName string
$storageOptions array
$version integer
$subVersion integer
$mimeType string
return array

getMediaProperties() public method

Return media id and format.
public getMediaProperties ( string $url ) : array
$url string
return array

purge() public method

Delete the image by the given parameters.
public purge ( integer $idMedia, string $fileName, array $options ) : boolean
$idMedia integer
$fileName string
$options array
return boolean

returnImage() public method

Return the image by a given url.
public returnImage ( integer $id, string $formatName ) : Response
$id integer
$formatName string
return Symfony\Component\HttpFoundation\Response