Documentation

Gd extends AbstractDrawingAdapter
in package

Abstract drawing.

Table of Contents

Constants

MIMETYPE_DEFAULT  = 'image/png'
MIMETYPE_GIF  = 'image/gif'
MIMETYPE_JPEG  = 'image/jpeg'
MIMETYPE_PNG  = 'image/png'
RENDERING_DEFAULT  = 'imagepng'
RENDERING_GIF  = 'imagegif'
RENDERING_JPEG  = 'imagejpeg'
RENDERING_PNG  = 'imagepng'

Properties

$relationId  : string
Slide relation ID (should not be used by user code!).
$container  : null|ShapeContainerInterface
Container.
$description  : string
Description.
$height  : int
Height.
$hyperlink  : null|Hyperlink
$imageResource  : resource
Image resource.
$mimeType  : string
Mime type.
$name  : string
Name.
$offsetX  : int
Offset X.
$offsetY  : int
Offset Y.
$path  : string
$placeholder  : null|Placeholder
$renderingFunction  : string
Rendering function.
$resizeProportional  : bool
Proportional resize.
$rotation  : int
Rotation.
$shadow  : null|Shadow
Shadow.
$uniqueName  : string
Unique name.
$width  : int
Width.
$border  : Border
Border.
$fill  : null|Fill
$hashIndex  : int
Hash index.
$imageCounter  : int
Image counter.
$imageIndex  : int
Image index.

Methods

__clone()  : mixed
Magic Method : clone.
__construct()  : mixed
Gd constructor.
getBorder()  : Border
getContainer()  : ShapeContainerInterface|null
Get Container, Slide or Group.
getContents()  : string
getDescription()  : string
Get Description.
getExtension()  : string
getFill()  : Fill|null
getHashCode()  : string
Get hash code.
getHashIndex()  : null|int
Get hash index.
getHeight()  : int
Get Height.
getHyperlink()  : Hyperlink
Get Hyperlink.
getImageIndex()  : int
Get image index.
getImageResource()  : resource
Get image resource.
getIndexedFilename()  : string
getMimeType()  : string
Get mime type.
getName()  : string
Get Name.
getOffsetX()  : int
Get OffsetX.
getOffsetY()  : int
Get OffsetY.
getPath()  : string
Get Path.
getPlaceholder()  : Placeholder|null
getRenderingFunction()  : string
Get rendering function.
getRotation()  : int
Get Rotation.
getShadow()  : Shadow|null
getWidth()  : int
Get Width.
hasHyperlink()  : bool
Has Hyperlink?
isPlaceholder()  : bool
isResizeProportional()  : bool
Get ResizeProportional.
setContainer()  : $this
Set Container, Slide or Group.
setDescription()  : $this
Set Description.
setFill()  : self
setHashIndex()  : $this
Set hash index.
setHeight()  : self
Set Height.
setHyperlink()  : self
Set Hyperlink.
setImageResource()  : $this
Set image resource.
setMimeType()  : $this
Set mime type.
setName()  : static
Set Name.
setOffsetX()  : $this
Set OffsetX.
setOffsetY()  : $this
Set OffsetY.
setPath()  : self
setPlaceHolder()  : self
setRenderingFunction()  : $this
Set rendering function.
setResizeProportional()  : self
Set ResizeProportional.
setRotation()  : $this
Set Rotation.
setShadow()  : $this
setWidth()  : self
Set Width.
setWidthAndHeight()  : self
Set width and height with proportional resize.

Constants

MIMETYPE_DEFAULT

public mixed MIMETYPE_DEFAULT = 'image/png'

MIMETYPE_GIF

public mixed MIMETYPE_GIF = 'image/gif'

MIMETYPE_JPEG

public mixed MIMETYPE_JPEG = 'image/jpeg'

MIMETYPE_PNG

public mixed MIMETYPE_PNG = 'image/png'

RENDERING_DEFAULT

public mixed RENDERING_DEFAULT = 'imagepng'

RENDERING_GIF

public mixed RENDERING_GIF = 'imagegif'

RENDERING_JPEG

public mixed RENDERING_JPEG = 'imagejpeg'

RENDERING_PNG

public mixed RENDERING_PNG = 'imagepng'

Properties

$relationId

Slide relation ID (should not be used by user code!).

public string $relationId

$imageResource

Image resource.

protected resource $imageResource

$mimeType

Mime type.

protected string $mimeType = self::MIMETYPE_DEFAULT

$path

protected string $path

$renderingFunction

Rendering function.

protected string $renderingFunction = self::RENDERING_DEFAULT

$resizeProportional

Proportional resize.

protected bool $resizeProportional

$uniqueName

Unique name.

protected string $uniqueName

Methods

__construct()

Gd constructor.

public __construct() : mixed

getContents()

public getContents() : string
Return values
string

getDescription()

Get Description.

public getDescription() : string
Return values
string

getExtension()

public getExtension() : string
Return values
string

getHashCode()

Get hash code.

public getHashCode() : string
Return values
string

Hash code

getHashIndex()

Get hash index.

public getHashIndex() : null|int

Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

Return values
null|int

Hash index

getHeight()

Get Height.

public getHeight() : int
Return values
int

getImageIndex()

Get image index.

public getImageIndex() : int
Return values
int

getImageResource()

Get image resource.

public getImageResource() : resource
Return values
resource

getIndexedFilename()

public getIndexedFilename() : string
Return values
string

getMimeType()

Get mime type.

public getMimeType() : string
Return values
string

getName()

Get Name.

public getName() : string
Return values
string

getOffsetX()

Get OffsetX.

public getOffsetX() : int
Return values
int

getOffsetY()

Get OffsetY.

public getOffsetY() : int
Return values
int

getPath()

Get Path.

public getPath() : string
Return values
string

getRenderingFunction()

Get rendering function.

public getRenderingFunction() : string
Return values
string

getRotation()

Get Rotation.

public getRotation() : int
Return values
int

getWidth()

Get Width.

public getWidth() : int
Return values
int

Has Hyperlink?

public hasHyperlink() : bool
Return values
bool

isPlaceholder()

public isPlaceholder() : bool
Return values
bool

isResizeProportional()

Get ResizeProportional.

public isResizeProportional() : bool
Return values
bool

setContainer()

Set Container, Slide or Group.

public setContainer([ShapeContainerInterface|null $pValue = null ][, bool $pOverrideOld = false ]) : $this
Parameters
$pValue : ShapeContainerInterface|null = null
$pOverrideOld : bool = false

If a Slide has already been assigned, overwrite it and remove image from old Slide?

Return values
$this

setDescription()

Set Description.

public setDescription([string $pValue = '' ]) : $this
Parameters
$pValue : string = ''
Return values
$this

setFill()

public setFill([Fill|null $pValue = null ]) : self
Parameters
$pValue : Fill|null = null
Return values
self

setHashIndex()

Set hash index.

public setHashIndex(int $value) : $this

Note that this index may vary during script execution! Only reliable moment is while doing a write of a workbook and when changes are not allowed.

Parameters
$value : int

Hash index

Return values
$this

setHeight()

Set Height.

public setHeight([int $pValue = 0 ]) : self
Parameters
$pValue : int = 0
Return values
self

Set Hyperlink.

public setHyperlink([Hyperlink|null $pHyperlink = null ]) : self
Parameters
$pHyperlink : Hyperlink|null = null
Return values
self

setImageResource()

Set image resource.

public setImageResource([resource $value = null ]) : $this
Parameters
$value : resource = null
Return values
$this

setMimeType()

Set mime type.

public setMimeType([string $value = self::MIMETYPE_DEFAULT ]) : $this
Parameters
$value : string = self::MIMETYPE_DEFAULT
Return values
$this

setName()

Set Name.

public setName([string $pValue = '' ]) : static
Parameters
$pValue : string = ''
Return values
static

setOffsetX()

Set OffsetX.

public setOffsetX([int $pValue = 0 ]) : $this
Parameters
$pValue : int = 0
Return values
$this

setOffsetY()

Set OffsetY.

public setOffsetY([int $pValue = 0 ]) : $this
Parameters
$pValue : int = 0
Return values
$this

setPath()

public setPath(string $path) : self
Parameters
$path : string
Return values
self

setRenderingFunction()

Set rendering function.

public setRenderingFunction([string $value = self::RENDERING_DEFAULT ]) : $this
Parameters
$value : string = self::RENDERING_DEFAULT
Return values
$this

setResizeProportional()

Set ResizeProportional.

public setResizeProportional([bool $pValue = true ]) : self
Parameters
$pValue : bool = true
Return values
self

setRotation()

Set Rotation.

public setRotation([int $pValue = 0 ]) : $this
Parameters
$pValue : int = 0
Return values
$this

setShadow()

public setShadow([Shadow|null $pValue = null ]) : $this
Parameters
$pValue : Shadow|null = null
Return values
$this

setWidth()

Set Width.

public setWidth([int $pValue = 0 ]) : self
Parameters
$pValue : int = 0
Return values
self

setWidthAndHeight()

Set width and height with proportional resize.

public setWidthAndHeight([int $width = 0 ][, int $height = 0 ]) : self
Parameters
$width : int = 0
$height : int = 0
Tags
author

Vincent@luo MSN:kele_100@hotmail.com

Return values
self

        
On this page

Search results