Joomla! API

下载
启动

Image

用于操作图像的类。

自版本

1.7.3
包

Joomla CMS

方法

__construct

类构造函数。

__construct( source = null) :
自版本

1.7.3
抛出

RuntimeException

参数

source

mixed源图像的文件路径或图像的 GD 资源句柄。

返回值

mixed

__destruct

在对象被取消设置时最后一次调用 destroy() 方法以释放任何内存的方法

__destruct() :
参见 Image::destroy()
自版本

2.5.0

返回值

mixed

createThumbnails

从当前图像创建缩略图并将其保存到磁盘的方法。它允许通过调整原始图像的大小或裁剪来创建。

createThumbnails( thumbSizes,  creationMethod = self::SCALE_INSIDE,  thumbsFolder = null,  useOriginalName = false) : mixed||string|int
自版本

4.3.0
抛出

LogicException

InvalidArgumentException

参数

thumbSizes

mixed字符串或字符串数组。示例：$thumbSizes = ['150x75','250x150'];

creationMethod

int1-3 调整大小 $scaleMethod | 4 创建裁剪

thumbsFolder

string目标缩略图文件夹。null 在图像文件夹中生成一个缩略图文件夹

useOriginalName

bool我们是否使用原始图像名称？默认为 false，{filename}_{width}x{height}.{ext}

返回值

array<string|int, mixed>

createThumbs

从当前图像创建缩略图并将其保存到磁盘的方法。它允许通过调整原始图像的大小或裁剪来创建。

createThumbs( thumbSizes,  creationMethod = self::SCALE_INSIDE,  thumbsFolder = null) : mixed||string|int
已弃用
自版本

2.5.0
抛出

LogicException

InvalidArgumentException
已弃用

4.0 将在 6.0 中删除 使用 \Joomla\CMS\Image\createThumbnails 代替

参数

thumbSizes

mixed字符串或字符串数组。示例：$thumbSizes = ['150x75','250x150'];

creationMethod

int1-3 调整大小 $scaleMethod | 4 创建裁剪

thumbsFolder

string目标缩略图文件夹。null 在图像文件夹中生成一个缩略图文件夹

返回值

array<string|int, mixed>

crop

裁剪当前图像的方法。

crop( width,  height,  left = null,  top = null,  createNew = true) : \Joomla\CMS\Image\Image
自版本

2.5.0
抛出

LogicException

参数

width

mixed要裁剪的图像部分的宽度（以像素或百分比表示）。

height

mixed要裁剪的图像部分的高度（以像素或百分比表示）。

left

int从左侧开始裁剪的像素数。

top

int从顶部开始裁剪的像素数。

createNew

bool如果为 true，则当前图像将被克隆、裁剪并返回；否则，当前图像将被裁剪并返回。

返回值

Image

cropResize

调整图像大小后裁剪图像以保持比例，而无需执行所有设置工作的方法。

cropResize( width,  height,  createNew = true) : \Joomla\CMS\Image\Image
自版本

2.5.0

参数

width

int图像所需的宽度（以像素或百分比表示）。

height

int图像所需的高度（以像素或百分比表示）。

createNew

bool如果为 true，则当前图像将被克隆、调整大小、裁剪并返回。

返回值

Image

destroy

销毁图像句柄并释放与句柄关联的内存的方法

destroy() :
自版本

2.5.0

返回值

bool成功时为 true，失败时或未加载图像时为 false

filter

按类型为图像应用滤镜的方法。两个示例是：灰度和素描。

filter( type, mixed||string|int options = []) : \Joomla\CMS\Image\Image
自版本

2.5.0
参见 Filter
抛出

LogicException

参数

type

string要应用的图像滤镜的名称。

options

array<string|int, mixed>滤镜的选项数组。

返回值

Image

flip

翻转当前图像的方法。

flip( mode,  createNew = true) : \Joomla\CMS\Image\Image
自版本

3.4.2
抛出

LogicException

参数

mode

int翻转图像的模式 {@link https://php.ac.cn/imageflip#refsect1-function.imageflip-parameters}

createNew

bool如果为 true，则当前图像将被克隆、翻转并返回；否则，当前图像将被翻转并返回。

返回值

Image

generateThumbs

从当前图像生成缩略图的方法。它允许通过调整原始图像的大小或裁剪来创建。

generateThumbs( thumbSizes,  creationMethod = self::SCALE_INSIDE) : mixed||string|int
自版本

2.5.0
抛出

LogicException

InvalidArgumentException

参数

thumbSizes

mixed字符串或字符串数组。示例：$thumbSizes = array('150x75','250x150');

creationMethod

int1-3 调整大小 $scaleMethod | 4 创建裁剪 | 5 调整大小然后裁剪

返回值

array<string|int, mixed>

getFilterInstance

获取指定类型的图像滤镜实例的方法。

getFilterInstance( type) : \Joomla\CMS\Image\ImageFilter
自版本

2.5.0
抛出

RuntimeException

参数

type

string要获取的图像滤镜类型。

返回值

ImageFilter

getHandle

获取图像资源句柄

getHandle() : \GdImage
自版本

3.8.0
抛出

LogicException如果图像未加载到实例中

返回值

GdImage

getHeight

获取图像高度（以像素为单位）的方法。

getHeight() :
自版本

2.5.0
抛出

LogicException

返回值

int

getImageFileProperties

根据文件系统路径返回图像属性对象的方法。

getImageFileProperties( path) : \stdClass
静态

结果对象包含图像宽度、高度、类型、属性、MIME 类型、位和通道的值。

自版本

2.5.0
抛出

InvalidArgumentException

RuntimeException

参数

path

string要获取属性的文件系统路径。

返回值

stdClass

getOrientation

检测图像方向是横向、纵向还是正方形的方法。

getOrientation() :

方向将作为字符串返回。

自版本

3.4.2

返回值

mixed方向字符串或 null。

getOrientationString

比较宽度和高度整数以确定图像方向。

getOrientationString( width,  height) :
静态
自版本

3.4.2

参数

width

int用于计算的宽度值

height

int用于计算的高度值

返回值

string方向字符串

getPath

返回路径的方法

getPath() :
自版本

2.5.0

返回值

string

getWidth

获取图像宽度（以像素为单位）的方法。

getWidth() :
自版本

2.5.0
抛出

LogicException

返回值

int

isLoaded

确定图像是否已加载到对象中的方法。

isLoaded() :
自版本

2.5.0

返回值

bool

isTransparent

确定图像是否具有透明度的函数。

isTransparent() :
自版本

2.5.0
抛出

LogicException

返回值

bool

loadFile

将文件加载到 Image 对象中作为资源的方法。

loadFile( path) :
自版本

2.5.0
抛出

InvalidArgumentException

RuntimeException

参数

path

string要加载为图像的文件系统路径。

返回值

void

prepareDimensions

获取调整大小的图像的新尺寸的方法。

prepareDimensions( width,  height,  scaleMethod) : \stdClass
自版本

2.5.0
抛出

InvalidArgumentException如果宽度、高度或两者都给出为零

参数

width

int调整大小的图像的宽度（以像素为单位）。

height

int调整大小的图像的高度（以像素为单位）。

scaleMethod

int用于缩放的方法

返回值

stdClass

resize

调整当前图像大小的方法。

resize( width,  height,  createNew = true,  scaleMethod = self::SCALE_INSIDE) : \Joomla\CMS\Image\Image
自版本

2.5.0
抛出

LogicException

参数

width

mixed调整大小的图像的宽度（以像素或百分比表示）。

height

mixed调整大小的图像的高度（以像素或百分比表示）。

createNew

bool如果为 true，则当前图像将被克隆、调整大小并返回；否则，当前图像将被调整大小并返回。

scaleMethod

int使用哪种缩放方法

返回值

Image

rotate

旋转当前图像的方法。

rotate( angle,  background = -1,  createNew = true) : \Joomla\CMS\Image\Image
自版本

2.5.0
抛出

LogicException

参数

angle

mixed图像的旋转角度

background

int由于旋转而添加区域时使用的背景颜色

createNew

bool如果为 true，则当前图像将被克隆、旋转并返回；否则，当前图像将被旋转并返回。

返回值

Image

sanitizeHeight

清理高度值的方法。

sanitizeHeight( height,  width) :
自版本

2.5.0

参数

height

mixed要清理的输入高度值。

width

mixed输入宽度值以供参考。

返回值

int

sanitizeOffset

清理偏移量值（如左侧或顶部）的方法。

sanitizeOffset( offset) :
自版本

2.5.0

参数

offset

mixed偏移量值。

返回值

int

sanitizeWidth

清理宽度值的方法。

sanitizeWidth( width,  height) :
自版本

2.5.0

参数

width

mixed要清理的输入宽度值。

height

mixed输入高度值以供参考。

返回值

int

setThumbnailGenerate

设置生成缩略图方法选项的方法

setThumbnailGenerate( quality = true) :
自版本

3.7.0

参数

quality

bool最佳质量为 true。最佳速度为 false。

返回值

void

toFile

将当前图像写入文件或直接输出的方法。

toFile( path,  type = IMAGETYPE_JPEG, mixed||string|int options = []) :
link
自版本

2.5.0
抛出

LogicException

参数

path

mixed保存图像的文件系统路径。当为 null 时，原始图像流将直接输出。

type

int要保存文件的图像类型。

options

array<string|int, mixed>保存文件时使用的图像类型选项。对于 PNG 和 JPEG 格式，使用 quality 键设置压缩级别 (0..9 和 0..100)

返回值

bool

watermark

水印图像

watermark(\Joomla\CMS\Image\Image watermark,  transparency = 50,  bottomMargin,  rightMargin) : \Joomla\CMS\Image\Image
自版本

3.8.0
link

参数

watermark

Image包含水印图形的 Image 对象

transparency

int要用于水印图形的透明度

bottomMargin

int此图像底部的边距

rightMargin

int此图像右侧的边距

返回值

Image

常量

SCALE_FILL

值 1
const

integer
自版本

2.5.0

SCALE_INSIDE

值 2
const

integer
自版本

2.5.0

SCALE_OUTSIDE

值 3
const

integer
自版本

2.5.0

CROP

值 4
const

integer
自版本

2.5.0

CROP_RESIZE

值 5
const

integer
自版本

2.5.0

SCALE_FIT

值 6
const

integer
自版本

2.5.0

ORIENTATION_LANDSCAPE

值 'landscape'
const

string
自版本

3.4.2

ORIENTATION_PORTRAIT

值 'portrait'
const

string
自版本

3.4.2

ORIENTATION_SQUARE

值 'square'
const

string
自版本

3.4.2

属性

handle

图像资源句柄。

自版本

2.5.0

类型(s)

resource

path

源图像路径。

自版本

2.5.0

类型(s)

string

formats

是否支持不同的图像格式。

静态
自版本

2.5.0

类型(s)

array<string|int, mixed>

generateBestQuality

如果图像应使用可用的最佳质量，则为标志。禁用以提高性能。

自版本

3.7.0

类型(s)

bool
  • \ Joomla
  • \ CMS
  • \ Image
  • \ Image