MediaHelper
Media helper class
| since |
3.2 |
|---|
Methods
canUpload
Checks if the file can be uploaded
canUpload(array $file, string $component = 'com_media', string $allowedExecutables = array()) : boolean
| since |
3.2 |
|---|
Arguments
- $file
arrayFile information- $component
stringThe option name for the component storing the parameters- $allowedExecutables
stringArray of executable file types that shall be whitelisted
Response
boolean
checkMimeType
Checks the Mime type
checkMimeType(string $mime, string $component = 'com_media') : boolean
| since |
3.7 |
|---|
Arguments
- $mime
stringThe mime to be checked- $component
stringThe optional name for the component storing the parameters
Response
booleantrue if mime type checking is disabled or it passes the checks else false
countFiles
Counts the files and directories in a directory that are not php or html files.
countFiles(string $dir) : array
| since |
3.2 |
|---|
Arguments
- $dir
stringDirectory name
Response
arrayThe number of media files and directories in the given directory
getMimeType
Get the Mime type
getMimeType(string $file, boolean $isImage = false) : mixed
| since |
3.7.2 |
|---|
Arguments
- $file
stringThe link to the file to be checked- $isImage
booleanTrue if the passed file is an image else false
Response
mixedthe mime type detected false on error
getTypeIcon
Gets the file extension for purposed of using an icon
getTypeIcon(string $fileName) : string
| since |
3.2 |
|---|
Arguments
- $fileName
stringThe filename
Response
stringFile extension to determine icon
imageResize
Calculate the size of a resized image
imageResize(integer $width, integer $height, integer $target) : array
| since |
3.2 |
|---|
Arguments
- $width
integerImage width- $height
integerImage height- $target
integerTarget size
Response
arrayThe new width and height
isImage
Checks if the file is an image
isImage(string $fileName) : boolean
| since |
3.2 |
|---|
Arguments
- $fileName
stringThe filename
Response
boolean
toBytes
Small helper function that properly converts any configuration options to their byte representation.
toBytes(string|integer $val) : integer
| since |
3.3 |
|---|
Arguments
- $val
string|integerThe value to be converted to bytes.
Response
integerThe calculated bytes value from the input.