BlueSpice MediaWiki master
 All Classes Namespaces Files Functions Variables Groups Pages
EmbedVideo\AudioHandler Class Reference
Inheritance diagram for EmbedVideo\AudioHandler:
Collaboration diagram for EmbedVideo\AudioHandler:

Public Member Functions

 getParamMap ()
 
 validateParam ($name, $value)
 
 parseTimeString ($time)
 
 makeParamString ($parameters)
 
 parseParamString ($string)
 
 normaliseParams ($file, &$parameters)
 
 getImageSize ($file, $path)
 
 doTransform ($file, $dstPath, $dstUrl, $parameters, $flags=0)
 
 getDimensionsString ($file)
 
 getShortDesc ($file)
 
 getLongDesc ($file)
 
- Public Member Functions inherited from MediaHandler
 getParamMap ()
 
 validateParam ($name, $value)
 
 makeParamString ($params)
 
 parseParamString ($str)
 
 normaliseParams ($image, &$params)
 
 getImageSize ($image, $path)
 
 getMetadata ($image, $path)
 
 convertMetadataVersion ($metadata, $version=1)
 
 getMetadataType ($image)
 
 isMetadataValid ($image, $metadata)
 
 getCommonMetaArray (File $file)
 
 getScriptedTransform ($image, $script, $params)
 
 getTransform ($image, $dstPath, $dstUrl, $params)
 
 doTransform ($image, $dstPath, $dstUrl, $params, $flags=0)
 
 getThumbType ($ext, $mime, $params=null)
 
 getStreamHeaders ($metadata)
 
 canRender ($file)
 
 mustRender ($file)
 
 isMultiPage ($file)
 
 pageCount (File $file)
 
 isVectorized ($file)
 
 isAnimatedImage ($file)
 
 canAnimateThumbnail ($file)
 
 isEnabled ()
 
 getPageDimensions (File $image, $page)
 
 getPageText (File $image, $page)
 
 getEntireText (File $file)
 
 formatMetadata ($image, $context=false)
 
 formatMetadataHelper ($metadataArray, $context=false)
 
 getShortDesc ($file)
 
 getLongDesc ($file)
 
 getDimensionsString ($file)
 
 parserTransformHook ($parser, $file)
 
 verifyUpload ($fileName)
 
 removeBadFile ($dstPath, $retval=0)
 
 filterThumbnailPurgeList (&$files, $options)
 
 canRotate ()
 
 getRotation ($file)
 
 getAvailableLanguages (File $file)
 
 getDefaultRenderLanguage (File $file)
 
 getLength ($file)
 
 isExpensiveToThumbnail ($file)
 
 supportsBucketing ()
 
 sanitizeParamsForBucketing ($params)
 
 getWarningConfig ($file)
 
 getContentHeaders ($metadata)
 

Additional Inherited Members

- Static Public Member Functions inherited from MediaHandler
static getHandler ($type)
 
static getMetadataVersion ()
 
static getGeneralShortDesc ($file)
 
static getGeneralLongDesc ($file)
 
static fitBoxWidth ($boxWidth, $boxHeight, $maxHeight)
 
static getPageRangesByDimensions ($pagesByDimensions)
 
- Public Attributes inherited from MediaHandler
const TRANSFORM_LATER = 1
 
const METADATA_GOOD = true
 
const METADATA_BAD = false
 
const METADATA_COMPATIBLE = 2
 
const MAX_ERR_LOG_SIZE = 65535
 
- Protected Member Functions inherited from MediaHandler
 visibleMetadataFields ()
 
 logErrorForExternalProcess ($retval, $err, $cmd)
 
- Static Protected Member Functions inherited from MediaHandler
static addMeta (&$array, $visibility, $type, $id, $value, $param=false)
 

Member Function Documentation

EmbedVideo\AudioHandler::doTransform (   $file,
  $dstPath,
  $dstUrl,
  $parameters,
  $flags = 0 
)

Get a MediaTransformOutput object representing the transformed output. Does the transform unless $flags contains self::TRANSFORM_LATER.

Parameters
File$imageThe image object
string$dstPathFilesystem destination path
string$dstUrlDestination URL to use in output HTML
array$paramsArbitrary set of parameters validated by $this->validateParam() Note: These parameters have not gone through $this->normaliseParams()
integer$flagsA bitfield, may contain self::TRANSFORM_LATER
Returns
MediaTransformOutput
EmbedVideo\AudioHandler::getDimensionsString (   $file)

Shown in file history box on image description page.

public

Parameters
File$file
Returns
string Dimensions
EmbedVideo\AudioHandler::getImageSize (   $file,
  $path 
)

Get an image size array like that returned by getimagesize(), or false if it can't be determined.

This function is used for determining the width, height and bitdepth directly from an image. The results are stored in the database in the img_width, img_height, img_bits fields.

Note
If this is a multipage file, return the width and height of the first page.

public

Parameters
File$imageThe image object, or false if there isn't one
string$pathThe filename
Returns
mixed An array following the format of PHP getimagesize() internal function or false if not supported.
EmbedVideo\AudioHandler::getLongDesc (   $file)

Long description. Shown under image on image description page surounded by ().

public

Parameters
File$file
Returns
string
EmbedVideo\AudioHandler::getParamMap ( )

Get an associative array mapping magic word IDs to parameter names. Will be used by the parser to identify parameters.

EmbedVideo\AudioHandler::getShortDesc (   $file)

Short description. Shown on Special:Search results.

public

Parameters
File$file
Returns
string
EmbedVideo\AudioHandler::makeParamString (   $parameters)

Merge a parameter array into a string appropriate for inclusion in filenames

public

Parameters
arrayArray of parameters that have been through normaliseParams.
Returns
string
EmbedVideo\AudioHandler::normaliseParams (   $file,
$parameters 
)

Changes the parameter array as necessary, ready for transformation. Should be idempotent. Returns false if the parameters are unacceptable and the transform should fail

public

Parameters
objectFile
arrayParameters
Returns
boolean Success
EmbedVideo\AudioHandler::parseParamString (   $string)

Parse a param string made with makeParamString back into an array

public

Parameters
stringThe parameter string without file name (e.g. 122px)
Returns
mixed Array of parameters or false on failure.
EmbedVideo\AudioHandler::parseTimeString (   $time)

Parse a time string into seconds. strtotime() will not handle this nicely since 1:30 could be one minute and thirty seconds OR one hour and thirty minutes.

public

Parameters
stringTime formatted as one of: ss, :ss, mm:ss, hh:mm:ss, or dd:hh:mm:ss
Returns
mixed Integer seconds or false for a bad format.
EmbedVideo\AudioHandler::validateParam (   $name,
  $value 
)

Validate a thumbnail parameter at parse time. Return true to accept the parameter, and false to reject it. If you return false, the parser will do something quiet and forgiving.

public

Parameters
string$name
mixed$value

The documentation for this class was generated from the following file: