PHP Image

AbstractGdDraw extends AbstractGdPixel
in package

Application

implements GdDrawInterface

AbstractYes

This is a simple GD Draw implementation that other GD Draw can inherit from.

Interfaces

GdDrawInterface

Constants

MAP = [ ["type" => \Samy\Image\Constant\GdImageType::BMP, "load" => "imagecreatefrombmp", "save" => "imagebmp"], //~ ["type" => GdImageType::GIF, "load" => "imagecreatefromgif", "save" => "imagegif"], ["type" => \Samy\Image\Constant\GdImageType::JPEG, "load" => "imagecreatefromjpeg", "save" => "imagejpeg"], ["type" => \Samy\Image\Constant\GdImageType::PNG, "load" => "imagecreatefrompng", "save" => "imagepng"], ["type" => \Samy\Image\Constant\GdImageType::WBMP, "load" => "imagecreatefromwbmp", "save" => "imagewbmp"], ["type" => \Samy\Image\Constant\GdImageType::WEBP, "load" => "imagecreatefromwebp", "save" => "imagewebp"], ["type" => \Samy\Image\Constant\GdImageType::XBM, "load" => "imagecreatefromxbm", "save" => "imagexbm"], ]

Properties

$image : mixed
$blend_mode : bool
$brush : mixed
$filename : string
$style : array<string|int, int>
$temporary : array<string|int, string>
$thickness : int
$type : int
$updated : bool

Methods

__destruct() : mixed
detach() : GdImage: Separates any underlying resource from the instance.
drawArc() : static: Draw an arc.
drawEllipse() : static: Draw an ellipse.
drawFilledArc() : static: Draw a filled arc.
drawFilledEllipse() : static: Draw a filled ellipse.
drawFilledPolygon() : static: Draw a filled polygon.
drawFilledRectangle() : static: Draw a filled rectangle.
drawLine() : static: Draw a line.
drawOpenPolygon() : static: Draw an open polygon.
drawPolygon() : static: Draw a polygon.
drawRectangle() : static: Draw a rectangle.
getAlpha() : int: Retrieve alpha color of a pixel.
getArgb() : int: Retrieve argb color of a pixel.
getBlendMode() : bool: Retrieve image blend mode.
getBlue() : int: Retrieve blue color of a pixel.
getContent() : string: Retrieve image file content.
getExtension() : string: Retrieve image file extension.
getGreen() : int: Retrieve green color of a pixel.
getHeight() : int: Retrieve image height.
getImage() : GdImage: Retrieve resource image.
getMd5() : string: Retrieve image md5 hash.
getMimeType() : string: Retrieve image mime content-type.
getRed() : int: Retrieve red color of a pixel.
getSha1() : string: Retrieve image sha1 hash.
getSize() : int: Retrieve image file size.
getStyle() : array<string|int, int>: Retrieve the style of line draw.
getThickness() : int: Retrieve the thickness of line draw.
getType() : int: Retrieve image type.
getWidth() : int: Retrieve image width.
hasBrush() : bool: Check if instance has a brush image.
hasImage() : bool: Check if instance has a resource image.
save() : static: Save image file.
withAlpha() : static: Return an instance with provided alpha color of a pixel.
withArgb() : static: Return an instance with provided argb color of a pixel.
withBlendMode() : static: Return an instance with provided image blend mode.
withBlue() : static: Return an instance with provided blue color of a pixel.
withBrush() : static: Return an instance with provided brush image.
withGreen() : static: Return an instance with provided green color of a pixel.
withRed() : static: Return an instance with provided red color of a pixel.
withStyle() : static: Return an instance with provided style of line draw.
withThickness() : static: Return an instance with provided thickness of line draw.
withType() : static: Return an instance with the provided image type.
addTemporary() : static: Return an instance with the added temprary filename.
alphaValue() : int: Retrieve alpha value from argb color.
applySelection() : static: Apply image selection.
blueValue() : int: Retrieve blue value from argb color.
clearTemporary() : static: Clear temporary data.
createImage() : GdImage: Create blank image.
getMap() : array<string, string>: Retrieve image map.
getRandomFilename() : string: Retrieve a random temporary filename.
greenValue() : int: Retrieve green value from argb color.
guardFile() : static: Guard image file.
guardImage() : static: Guard resource image.
loadImageLocation() : GdImage: Load image location.
makeSelection() : GdImage: Make image selection.
redValue() : int: Retrieve red value from argb color.
resetProperty() : static: Return an instance with reset property.
structureArea() : static: Return an instance with calculation draw area.
updateSignal() : static: Send update signal.
validateArc() : static: Return an instance with valid draw arc.
validateArea() : static: Return an instance with valid draw area.
validateBlur() : static: Return an instance with valid blur filter.
validateBrightness() : static: Return an instance with valid brightness filter.
validateColorize() : static: Return an instance with valid colorize filter.
validateContrast() : static: Return an instance with valid contrast filter.
validateCopy() : static: Return an instance with valid copy transform.
validateCorner() : static: Return an instance with valid corner transform.
validatePixelate() : static: Return an instance with valid pixelate filter.
validatePolygon() : static: Return an instance with valid draw polygon.
validateScatter() : static: Return an instance with valid scatetr filter.
validateSelection() : static: Return an instance with valid selection.
validateSmooth() : static: Return an instance with valid smooth filter.
validateTtf() : static: Return an instance with valid TTF.
isStyledColor() : bool: Check if color is build-in styled color.
loadImageFile() : GdImage: Load image file.
releaseBrush() : static: Release brush image.
releaseImage() : static: Release resource image.
structurePolygon() : static: Return an instance with calculation draw polygon.

MAP


    private
        mixed
    MAP
    = [
    ["type" => \Samy\Image\Constant\GdImageType::BMP, "load" => "imagecreatefrombmp", "save" => "imagebmp"],
    //~ ["type" => GdImageType::GIF, "load" => "imagecreatefromgif", "save" => "imagegif"],
    ["type" => \Samy\Image\Constant\GdImageType::JPEG, "load" => "imagecreatefromjpeg", "save" => "imagejpeg"],
    ["type" => \Samy\Image\Constant\GdImageType::PNG, "load" => "imagecreatefrompng", "save" => "imagepng"],
    ["type" => \Samy\Image\Constant\GdImageType::WBMP, "load" => "imagecreatefromwbmp", "save" => "imagewbmp"],
    ["type" => \Samy\Image\Constant\GdImageType::WEBP, "load" => "imagecreatefromwebp", "save" => "imagewebp"],
    ["type" => \Samy\Image\Constant\GdImageType::XBM, "load" => "imagecreatefromxbm", "save" => "imagexbm"],
]

$image


    protected
        mixed
    $image
     = null

$blend_mode


    private
        bool
    $blend_mode
     = false

$brush


    private
        mixed
    $brush
     = null

$filename


    private
        string
    $filename
     = ""

$style


    private
        array<string|int, int>
    $style
     = []

$temporary


    private
        array<string|int, string>
    $temporary
     = []

$thickness


    private
        int
    $thickness
     = 1

$type


    private
        int
    $type
     = 0

$updated


    private
        bool
    $updated
     = false

__destruct()


    public
                    __destruct() : mixed

detach()

Separates any underlying resource from the instance.


    public
                    detach() : GdImage

After the instance has been detached, the instance is in an unusable state.

Return values

GdImage

drawArc()

Draw an arc.


    public
                    drawArc(array<string, int> $Arc) : static

Parameters

$Arc : array<string, int>: The draw arc.

Return values

static

drawEllipse()

Draw an ellipse.


    public
                    drawEllipse(array<string, int> $Area) : static

Parameters

$Area : array<string, int>: The draw area.

Return values

static

drawFilledArc()

Draw a filled arc.


    public
                    drawFilledArc(array<string, int> $Arc) : static

Parameters

$Arc : array<string, int>: The draw arc.

Return values

static

drawFilledEllipse()

Draw a filled ellipse.


    public
                    drawFilledEllipse(array<string, int> $Area) : static

Parameters

$Area : array<string, int>: The draw area.

Return values

static

drawFilledPolygon()

Draw a filled polygon.


    public
                    drawFilledPolygon(array<string, mixed> $Polygon) : static

Parameters

$Polygon : array<string, mixed>: The draw polygon.

Return values

static

drawFilledRectangle()

Draw a filled rectangle.


    public
                    drawFilledRectangle(array<string, int> $Area) : static

Parameters

$Area : array<string, int>: The draw area.

Return values

static

drawLine()

Draw a line.


    public
                    drawLine(array<string, int> $Area) : static

Parameters

$Area : array<string, int>: The draw area.

Return values

static

drawOpenPolygon()

Draw an open polygon.


    public
                    drawOpenPolygon(array<string, mixed> $Polygon) : static

Parameters

$Polygon : array<string, mixed>: The draw polygon.

Return values

static

drawPolygon()

Draw a polygon.


    public
                    drawPolygon(array<string, mixed> $Polygon) : static

Parameters

$Polygon : array<string, mixed>: The draw polygon.

Return values

static

drawRectangle()

Draw a rectangle.


    public
                    drawRectangle(array<string, int> $Area) : static

Parameters

$Area : array<string, int>: The draw area.

Return values

static

getAlpha()

Retrieve alpha color of a pixel.


    public
                    getAlpha(int $X, int $Y) : int

Parameters

$X : int: The X coordinate of point
$Y : int: The Y coordinate of point

Return values

int

getArgb()

Retrieve argb color of a pixel.


    public
                    getArgb(int $X, int $Y) : int

Parameters

$X : int: The X coordinate of point
$Y : int: The Y coordinate of point

Return values

int

getBlendMode()

Retrieve image blend mode.


    public
                    getBlendMode() : bool

Return values

bool

getBlue()

Retrieve blue color of a pixel.


    public
                    getBlue(int $X, int $Y) : int

Parameters

$X : int: The X coordinate of point
$Y : int: The Y coordinate of point

Return values

int

getContent()

Retrieve image file content.


    public
                    getContent() : string

Return values

string

getExtension()

Retrieve image file extension.


    public
                    getExtension() : string

Return values

string

getGreen()

Retrieve green color of a pixel.


    public
                    getGreen(int $X, int $Y) : int

Parameters

$X : int: The X coordinate of point
$Y : int: The Y coordinate of point

Return values

int

getHeight()

Retrieve image height.


    public
                    getHeight() : int

Return values

int

getImage()

Retrieve resource image.


    public
                    getImage() : GdImage

Return values

GdImage

getMd5()

Retrieve image md5 hash.


    public
                    getMd5() : string

Return values

string

getMimeType()

Retrieve image mime content-type.


    public
                    getMimeType() : string

Return values

string

getRed()

Retrieve red color of a pixel.


    public
                    getRed(int $X, int $Y) : int

Parameters

$X : int: The X coordinate of point
$Y : int: The Y coordinate of point

Return values

int

getSha1()

Retrieve image sha1 hash.


    public
                    getSha1() : string

Return values

string

getSize()

Retrieve image file size.


    public
                    getSize() : int

Return values

int

getStyle()

Retrieve the style of line draw.


    public
                    getStyle() : array<string|int, int>

Return values

array<string|int, int>

getThickness()

Retrieve the thickness of line draw.


    public
                    getThickness() : int

Return values

int

getType()

Retrieve image type.


    public
                    getType() : int

Return values

int

getWidth()

Retrieve image width.


    public
                    getWidth() : int

Return values

int

hasBrush()

Check if instance has a brush image.


    public
                    hasBrush() : bool

Return values

bool

hasImage()

Check if instance has a resource image.


    public
                    hasImage() : bool

Return values

bool

save()

Save image file.


    public
                    save(string $Filename) : static

Parameters

$Filename : string: The filename.

Return values

static

withAlpha()

Return an instance with provided alpha color of a pixel.


    public
                    withAlpha(int $X, int $Y, int $Value) : static

Parameters

$X : int: The X coordinate of point
$Y : int: The Y coordinate of point
$Value : int: The alpha value

Return values

static

withArgb()

Return an instance with provided argb color of a pixel.


    public
                    withArgb(int $X, int $Y, int $Value) : static

Parameters

$X : int: The X coordinate of point
$Y : int: The Y coordinate of point
$Value : int: The argb value

Return values

static

withBlendMode()

Return an instance with provided image blend mode.


    public
                    withBlendMode(bool $BlendMode) : static

Parameters

$BlendMode : bool: The blend mode.

Return values

static

withBlue()

Return an instance with provided blue color of a pixel.


    public
                    withBlue(int $X, int $Y, int $Value) : static

Parameters

$X : int: The X coordinate of point
$Y : int: The Y coordinate of point
$Value : int: The blue value

Return values

static

withBrush()

Return an instance with provided brush image.


    public
                    withBrush(string $Location) : static

Parameters

$Location : string: The brush location.

Return values

static

withGreen()

Return an instance with provided green color of a pixel.


    public
                    withGreen(int $X, int $Y, int $Value) : static

Parameters

$X : int: The X coordinate of point
$Y : int: The Y coordinate of point
$Value : int: The green value

Return values

static

withRed()

Return an instance with provided red color of a pixel.


    public
                    withRed(int $X, int $Y, int $Value) : static

Parameters

$X : int: The X coordinate of point
$Y : int: The Y coordinate of point
$Value : int: The red value

Return values

static

withStyle()

Return an instance with provided style of line draw.


    public
                    withStyle(array<string|int, int> $Style) : static

Parameters

$Style : array<string|int, int>: The style.

Return values

static

withThickness()

Return an instance with provided thickness of line draw.


    public
                    withThickness(int $Thickness) : static

Parameters

$Thickness : int: The thickness.

Return values

static

withType()

Return an instance with the provided image type.


    public
                    withType(int $Type) : static

Parameters

$Type : int: The image type.

Return values

static

addTemporary()

Return an instance with the added temprary filename.


    protected
                    addTemporary(string $Filename) : static

Parameters

$Filename : string: The temporary filename.

Return values

static

alphaValue()

Retrieve alpha value from argb color.


    protected
                    alphaValue(int $Argb) : int

Parameters

$Argb : int: ARGB value

Return values

int

applySelection()

Apply image selection.


    protected
                    applySelection(array<string, int> $Selection, GdImage $Image) : static

Parameters

$Selection : array<string, int>: The image selection.
$Image : GdImage: The source image.

Return values

static

blueValue()

Retrieve blue value from argb color.


    protected
                    blueValue(int $Argb) : int

Parameters

$Argb : int: ARGB value

Return values

int

clearTemporary()

Clear temporary data.


    protected
                    clearTemporary() : static

Return values

static

createImage()

Create blank image.


    protected
                    createImage(int $Width, int $Height) : GdImage

Parameters

$Width : int: The image width.
$Height : int: The image height.

Return values

GdImage

getMap()

Retrieve image map.


    protected
                    getMap(int $Type) : array<string, string>

Parameters

$Type : int: The image type.

Return values

array<string, string>

getRandomFilename()

Retrieve a random temporary filename.


    protected
                    getRandomFilename(string $Namespace[, string $Extension = "tmp" ]) : string

Parameters

$Namespace : string: The file namespace.
$Extension : string = "tmp": The file extension.

Return values

string

greenValue()

Retrieve green value from argb color.


    protected
                    greenValue(int $Argb) : int

Parameters

$Argb : int: ARGB value

Return values

int

guardFile()

Guard image file.


    protected
                    guardFile() : static

Return values

static

guardImage()

Guard resource image.


    protected
                    guardImage() : static

Return values

static

loadImageLocation()

Load image location.


    protected
                    loadImageLocation(string $Location) : GdImage

Parameters

$Location : string: The image location.

Return values

GdImage

makeSelection()

Make image selection.


    protected
                    makeSelection(array<string, int> $Selection) : GdImage

Parameters

$Selection : array<string, int>: The image selection.

Return values

GdImage

redValue()

Retrieve red value from argb color.


    protected
                    redValue(int $Argb) : int

Parameters

$Argb : int: ARGB value

Return values

int

resetProperty()

Return an instance with reset property.


    protected
                    resetProperty(GdImage $Image) : static

Parameters

$Image : GdImage: The resource image.

Return values

static

structureArea()

Return an instance with calculation draw area.


    protected
                    structureArea(array<string, int> &$Area) : static

Parameters

$Area : array<string, int>: The draw area.

Return values

static

updateSignal()

Send update signal.


    protected
                    updateSignal() : static

Return values

static

validateArc()

Return an instance with valid draw arc.


    protected
                    validateArc(array<string, int> $Arc, bool $WithStyle) : static

Parameters

$Arc : array<string, int>: The draw arc.
$WithStyle : bool: With style key.

Return values

static

validateArea()

Return an instance with valid draw area.


    protected
                    validateArea(array<string, int> $Area) : static

Parameters

$Area : array<string, int>: The draw area.

Return values

static

validateBlur()

Return an instance with valid blur filter.


    protected
                    validateBlur(array<string, int> $Blur) : static

Parameters

$Blur : array<string, int>: The blur filter.

Return values

static

validateBrightness()

Return an instance with valid brightness filter.


    protected
                    validateBrightness(array<string, int> $Brightness) : static

Parameters

$Brightness : array<string, int>: The brightness filter.

Return values

static

validateColorize()

Return an instance with valid colorize filter.


    protected
                    validateColorize(array<string, mixed> $Colorize) : static

Parameters

$Colorize : array<string, mixed>: The colorize filter.

Return values

static

validateContrast()

Return an instance with valid contrast filter.


    protected
                    validateContrast(array<string, int> $Contrast) : static

Parameters

$Contrast : array<string, int>: The contrast filter.

Return values

static

validateCopy()

Return an instance with valid copy transform.


    protected
                    validateCopy(array<string, mixed> $Copy) : static

Parameters

$Copy : array<string, mixed>: The copy transform.

Return values

static

validateCorner()

Return an instance with valid corner transform.


    protected
                    validateCorner(array<string, int> $Corner) : static

Parameters

$Corner : array<string, int>: The corner transform.

Return values

static

validatePixelate()

Return an instance with valid pixelate filter.


    protected
                    validatePixelate(array<string, mixed> $Pixelate) : static

Parameters

$Pixelate : array<string, mixed>: The pixelate filter.

Return values

static

validatePolygon()

Return an instance with valid draw polygon.


    protected
                    validatePolygon(array<string, mixed> $Polygon) : static

Parameters

$Polygon : array<string, mixed>: The draw polygon.

Return values

static

validateScatter()

Return an instance with valid scatetr filter.


    protected
                    validateScatter(array<string, mixed> $Scatter) : static

Parameters

$Scatter : array<string, mixed>: The scatetr filter.

Return values

static

validateSelection()

Return an instance with valid selection.


    protected
                    validateSelection(array<string, int> $Selection) : static

Parameters

$Selection : array<string, int>: The selection.

Return values

static

validateSmooth()

Return an instance with valid smooth filter.


    protected
                    validateSmooth(array<string, int> $Smooth) : static

Parameters

$Smooth : array<string, int>: The smooth filter.

Return values

static

validateTtf()

Return an instance with valid TTF.


    protected
                    validateTtf(array<string, mixed> $Ttf, bool $WithEngrave) : static

Parameters

$Ttf : array<string, mixed>: The TTF.
$WithEngrave : bool: With engrave key.

Return values

static

isStyledColor()

Check if color is build-in styled color.


    private
                    isStyledColor(int $Color) : bool

Parameters

$Color : int: The color value.

Return values

bool

loadImageFile()

Load image file.


    private
                    loadImageFile(string $Filename) : GdImage

Parameters

$Filename : string: The image filename.

Return values

GdImage

releaseBrush()

Release brush image.


    private
                    releaseBrush() : static

Return values

static

releaseImage()

Release resource image.


    private
                    releaseImage() : static

Return values

static

structurePolygon()

Return an instance with calculation draw polygon.


    private
                    structurePolygon(array<string, mixed> &$Polygon) : static

Parameters

$Polygon : array<string, mixed>: The draw polygon.

Return values

static

AbstractGdDraw extends AbstractGdPixel in package Application implements GdDrawInterface

Table of Contents

Interfaces

Constants

Properties

Methods

Constants

MAP

Properties

$image

Tags

$blend_mode

$brush

Tags

$filename

$style

$temporary

$thickness

$type

$updated

Methods

__destruct()

detach()

Tags

Return values

drawArc()

Parameters

Tags

Return values

drawEllipse()

Parameters

Tags

Return values

drawFilledArc()

Parameters

Tags

Return values

drawFilledEllipse()

Parameters

Tags

Return values

drawFilledPolygon()

Parameters

Tags

Return values

drawFilledRectangle()

Parameters

Tags

Return values

drawLine()

Parameters

Tags

Return values

drawOpenPolygon()

Parameters

Tags

Return values

drawPolygon()

Parameters

Tags

Return values

drawRectangle()

Parameters

Tags

Return values

getAlpha()

Parameters

Tags

Return values

getArgb()

Parameters

Tags

Return values

getBlendMode()

Tags

Return values

getBlue()

Parameters

Tags

Return values

AbstractGdDraw extends AbstractGdPixel
in package

Application

implements GdDrawInterface