Référence de la classe MediaHelper

Fonctions membres publiques
	canUpload ($file, $component='com_media', $allowedExecutables=array())
	countFiles ($dir)
	toBytes ($val)

Fonctions membres publiques statiques
static	isImage ($fileName)
static	getTypeIcon ($fileName)
static	getMimeType ($file, $isImage=false)
static	checkFileExtension ($extension, $component='com_media', $allowedExecutables=array())
static	imageResize ($width, $height, $target)
static	isValidLocalDirectory ($directory)
static	getCleanMediaFieldValue ($value)

Champs de données
const	EXECUTABLES

Fonctions membres privées
	checkMimeType ($mime, $component='com_media')

Description détaillée

Media helper class

Depuis

3.2

Documentation des fonctions membres

canUpload()

canUpload	(		$file,
			$component = 'com_media',
			$allowedExecutables = array()
	)

Checks if the file can be uploaded

Paramètres

array	$file	File information
string	$component	The option name for the component storing the parameters
string	$allowedExecutables	Array of executable file types that shall be whitelisted

Renvoie

boolean

Depuis

3.2

Références $app, $check, $component, $i, $maxSize, $params, $result, $sanitizer, Text\_(), elseif, InputFilter\FORBIDDEN_FILE_EXTENSIONS, Factory\getApplication(), ComponentHelper\getParams(), Factory\getUser(), File\makeSafe(), et Text\sprintf().

checkFileExtension()

static checkFileExtension (   $extension,   $component = 'com_media',   $allowedExecutables = array()  )

static

Checks the file extension

Paramètres

string	$extension	The extension to be checked
string	$component	The optional name for the component storing the parameters

Renvoie

boolean true if it passes the checks else false

Depuis

4.0.0

Références $component, $extension, $params, InputFilter\FORBIDDEN_FILE_EXTENSIONS, et ComponentHelper\getParams().

Référencé par LocalAdapter\moveFile().

checkMimeType()

checkMimeType (   $mime,   $component = 'com_media'  )

private

Checks the Mime type

Paramètres

string	$mime	The mime to be checked
string	$component	The optional name for the component storing the parameters

Renvoie

boolean true if mime type checking is disabled or it passes the checks else false

Depuis

3.7

Références $component, $params, et ComponentHelper\getParams().

countFiles()

countFiles

(

$dir

)

Counts the files and directories in a directory that are not php or html files.

Paramètres

string

$dir

Directory name

Renvoie

array The number of media files and directories in the given directory

Depuis

3.2

Références $dir.

getCleanMediaFieldValue()

static getCleanMediaFieldValue (   $value )

static

Helper method get clean data for value stores in a Media form field by removing adapter information from the value if available (in this case, the value will have this format: images/headers/blue-flower.jpg#joomlaImage://local-images/headers/blue-flower.jpg?width=700&height=180)

Paramètres

string

$value

Renvoie

string

Depuis

4.0.0

Références $value.

getMimeType()

static getMimeType (   $file,   $isImage = false  )

static

Get the Mime type

Paramètres

string	$file	The link to the file to be checked
boolean	$isImage	True if the passed file is an image else false

Renvoie

mixed the mime type detected false on error

Depuis

3.7.2

Références elseif.

Référencé par LocalAdapter\getPathInformation().

getTypeIcon()

static getTypeIcon (   $fileName )

static

Gets the file extension for purposed of using an icon

Paramètres

string

$fileName

The filename

Renvoie

string File extension to determine icon

Depuis

3.2

imageResize()

static imageResize (   $width,   $height,   $target  )

static

Calculate the size of a resized image

Paramètres

integer	$width	Image width
integer	$height	Image height
integer	$target	Target size

Renvoie

array The new width and height

Depuis

3.2

Références $height, $target, et $width.

isImage()

static isImage (   $fileName )

static

Checks if the file is an image

Paramètres

string

$fileName

The filename

Renvoie

boolean

Depuis

3.2

Référencé par LocalAdapter\getPathInformation().

isValidLocalDirectory()

static isValidLocalDirectory (   $directory )

static

Method to check if the given directory is a directory configured in FileSystem - Local plugin

Paramètres

string

$directory

Renvoie

boolean

Depuis

4.0.0

Références $params, et PluginHelper\getPlugin().

Référencé par MediaField\getLayoutData().

toBytes()

toBytes

(

$val

)

Small helper function that properly converts any configuration options to their byte representation.

Paramètres

string | integer

$val

The value to be converted to bytes.

Renvoie

integer The calculated bytes value from the input.

Depuis

3.3

Références $val.

Documentation des champs

EXECUTABLES

const EXECUTABLES

Valeur initiale :

= array(
        'js', 'exe', 'dll', 'go', 'ade', 'adp', 'bat', 'chm', 'cmd', 'com', 'cpl', 'hta',
        'ins', 'isp', 'jse', 'lib', 'mde', 'msc', 'msp', 'mst', 'pif', 'scr', 'sct', 'shb',
        'sys', 'vb', 'vbe', 'vbs', 'vxd', 'wsc', 'wsf', 'wsh', 'html', 'htm', 'msi'
    )

---

La documentation de cette classe a été générée à partir du fichier suivant :

• MediaHelper.php