MediaHelper
媒体助手类
| 自版本 |
3.2 |
|---|---|
| 包 |
Joomla CMS |
方法
canUpload
检查文件是否可以上传
canUpload(mixed||string|int file, component = 'com_media', string||string|int allowedExecutables = []) :
| 自版本 |
3.2 |
|---|
参数
- 文件
array<string|int, mixed>文件信息- 组件
string存储参数的组件选项名称- 允许的可执行文件
array<string|int, string>应列入白名单的可执行文件类型数组
返回值
bool
checkFileExtension
检查文件扩展名
checkFileExtension( extension, component = 'com_media', allowedExecutables = []) :
| 自版本 |
4.0.0 |
|---|
参数
- 扩展名
string要检查的扩展名- 组件
string存储参数的组件的可选名称- 允许的可执行文件
混合
返回值
bool如果通过检查则为 true，否则为 false
checkMimeType
检查 Mime 类型
checkMimeType( mime, component = 'com_media') :
| 自版本 |
3.7 |
|---|
参数
- mime
string要检查的 mime- 组件
string存储参数的组件的可选名称
返回值
bool如果禁用 mime 类型检查或通过检查则为 true，否则为 false
countFiles
计算目录中不是 php 或 html 文件的文件和目录数量。
countFiles( dir) : mixed||string|int
| 自版本 |
3.2 |
|---|
参数
- 目录
string目录名称
返回值
array<string|int, mixed>给定目录中媒体文件和目录的数量
getCleanMediaFieldValue
辅助方法获取存储在媒体表单字段中的值的干净数据，如果可用，则从值中删除适配器信息（在这种情况下，值将具有此格式：images/headers/blue-flower.jpg#joomlaImage://local-images/headers/blue-flower.jpg?width=700&height=180）
getCleanMediaFieldValue( value) :
| 自版本 |
4.0.0 |
|---|
参数
- 值
string
返回值
string
getMimeType
获取 Mime 类型
getMimeType( file, isImage = false) :
| 自版本 |
3.7.2 |
|---|
参数
- 文件
string要检查的文件的链接- isImage
bool如果传递的文件是图像则为 true，否则为 false
返回值
mixed检测到的 mime 类型，错误时为 false
getTypeIcon
获取用于使用图标的文件扩展名
getTypeIcon( fileName) :
| 自版本 |
3.2 |
|---|
参数
- 文件名
string文件名
返回值
string用于确定图标的文件扩展名
imageResize
计算调整大小的图像的大小
imageResize( width, height, target) : mixed||string|int
| 自版本 |
3.2 |
|---|
参数
- 宽度
int图像宽度- 高度
int图像高度- 目标
int目标大小
返回值
array<string|int, mixed>新的宽度和高度
isImage
检查文件是否为图像
isImage( fileName) :
| 自版本 |
3.2 |
|---|
参数
- 文件名
string文件名
返回值
bool
isValidLocalDirectory
用于检查给定目录是否为 FileSystem - Local 插件中配置的目录的方法
isValidLocalDirectory( directory) :
| 自版本 |
4.0.0 |
|---|
参数
- 目录
string
返回值
bool
isValidSvg
检查文件是否为有效的 SVG
isValidSvg( file, shouldLogErrors = true) :
| 自版本 |
4.3.0 |
|---|
参数
- 文件
string- shouldLogErrors
bool
返回值
bool
toBytes
一个小型的辅助函数，它可以将任何配置选项正确地转换为它们的字节表示形式。
toBytes(string|int val) :
| 自版本 |
3.3 |
|---|
参数
- 值
string|int要转换为字节的值。
返回值
int从输入计算出的字节值。
常量
EXECUTABLES
一个特殊的被阻止的可执行文件扩展名列表，跳过通常在 Web 服务器上下文中可执行的可执行文件，因为这些文件是从 Joomla\CMS\Filter\InputFilter 中获取的
| 值 | ['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'] |
|---|---|
| 自版本 |
4.0.0 |
类型
array<string|int, string>