PHP Class PhpOffice\PhpPresentation\AbstractShape

Inheritance: implements PhpOffice\PhpPresentation\ComparableInterface
Show file Open project: phpoffice/phppowerpoint Class Usage Examples

Protected Properties

Property Type Description
$container PhpOffice\PhpPresentation\ShapeContainerInterface Container
$height integer Height
$hyperlink PhpOffice\PhpPresentation\Shape\Hyperlink Hyperlink
$offsetX integer Offset X
$offsetY integer Offset Y
$placeholder PhpOffice\PhpPresentation\Shape\Placeholder PlaceHolder
$rotation integer Rotation
$shadow PhpOffice\PhpPresentation\Style\Shadow Shadow
$width integer Width

Public Methods

Method Description
__clone ( ) Magic Method : clone
__construct ( ) Create a new self
getBorder ( ) : PhpOffice\PhpPresentation\Style\Border Get Border
getContainer ( ) : PhpOffice\PhpPresentation\Container Get Container, Slide or Group
getFill ( ) : PhpOffice\PhpPresentation\Style\Fill Get Fill
getHashCode ( ) : string Get hash code
getHashIndex ( ) : string Get hash index
getHeight ( ) : integer Get Height
getHyperlink ( ) : PhpOffice\PhpPresentation\Shape\Hyperlink Get Hyperlink
getOffsetX ( ) : integer Get OffsetX
getOffsetY ( ) : integer Get OffsetY
getPlaceholder ( )
getRotation ( ) : integer Get Rotation
getShadow ( ) : PhpOffice\PhpPresentation\Style\Shadow Get Shadow
getWidth ( ) : integer Get Width
hasHyperlink ( ) : boolean Has Hyperlink?
isPlaceholder ( )
setContainer ( PhpOffice\PhpPresentation\ShapeContainerInterface $pValue = null, boolean $pOverrideOld = false ) : self Set Container, Slide or Group
setFill ( PhpOffice\PhpPresentation\Style\Fill $pValue = null ) : AbstractShape Set Fill
setHashIndex ( string $value ) Set hash index
setHeight ( integer $pValue ) : self Set Height
setHyperlink ( PhpOffice\PhpPresentation\Shape\Hyperlink $pHyperlink = null ) : self Set Hyperlink
setOffsetX ( integer $pValue ) : self Set OffsetX
setOffsetY ( integer $pValue ) : self Set OffsetY
setPlaceHolder ( Placeholder $placeholder )
setRotation ( integer $pValue ) : self Set Rotation
setShadow ( PhpOffice\PhpPresentation\Style\Shadow $pValue = null ) : self Set Shadow
setWidth ( integer $pValue ) : self Set Width
setWidthAndHeight ( integer $width, integer $height ) : self Set width and height with proportional resize

Method Details

__clone() public method

Magic Method : clone
public __clone ( )

__construct() public method

Create a new self
public __construct ( )

getBorder() public method

Get Border
public getBorder ( ) : PhpOffice\PhpPresentation\Style\Border
return PhpOffice\PhpPresentation\Style\Border

getContainer() public method

Get Container, Slide or Group
public getContainer ( ) : PhpOffice\PhpPresentation\Container
return PhpOffice\PhpPresentation\Container

getFill() public method

Get Fill
public getFill ( ) : PhpOffice\PhpPresentation\Style\Fill
return PhpOffice\PhpPresentation\Style\Fill

getHashCode() public method

Get hash code
public getHashCode ( ) : string
return string Hash code

getHashIndex() public method

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.
public getHashIndex ( ) : string
return string Hash index

getHeight() public method

Get Height
public getHeight ( ) : integer
return integer

getOffsetX() public method

Get OffsetX
public getOffsetX ( ) : integer
return integer

getOffsetY() public method

Get OffsetY
public getOffsetY ( ) : integer
return integer

getPlaceholder() public method

public getPlaceholder ( )

getRotation() public method

Get Rotation
public getRotation ( ) : integer
return integer

getShadow() public method

Get Shadow
public getShadow ( ) : PhpOffice\PhpPresentation\Style\Shadow
return PhpOffice\PhpPresentation\Style\Shadow

getWidth() public method

Get Width
public getWidth ( ) : integer
return integer

isPlaceholder() public method

public isPlaceholder ( )

setContainer() public method

Set Container, Slide or Group
public setContainer ( PhpOffice\PhpPresentation\ShapeContainerInterface $pValue = null, boolean $pOverrideOld = false ) : self
$pValue PhpOffice\PhpPresentation\ShapeContainerInterface
$pOverrideOld boolean If a Slide has already been assigned, overwrite it and remove image from old Slide?
return self

setFill() public method

Set Fill
public setFill ( PhpOffice\PhpPresentation\Style\Fill $pValue = null ) : AbstractShape
$pValue PhpOffice\PhpPresentation\Style\Fill
return AbstractShape

setHashIndex() public method

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.
public setHashIndex ( string $value )
$value string Hash index

setHeight() public method

Set Height
public setHeight ( integer $pValue ) : self
$pValue integer
return self

setOffsetX() public method

Set OffsetX
public setOffsetX ( integer $pValue ) : self
$pValue integer
return self

setOffsetY() public method

Set OffsetY
public setOffsetY ( integer $pValue ) : self
$pValue integer
return self

setPlaceHolder() public method

public setPlaceHolder ( Placeholder $placeholder )
$placeholder PhpOffice\PhpPresentation\Shape\Placeholder

setRotation() public method

Set Rotation
public setRotation ( integer $pValue ) : self
$pValue integer
return self

setShadow() public method

Set Shadow
public setShadow ( PhpOffice\PhpPresentation\Style\Shadow $pValue = null ) : self
$pValue PhpOffice\PhpPresentation\Style\Shadow
return self

setWidth() public method

Set Width
public setWidth ( integer $pValue ) : self
$pValue integer
return self

setWidthAndHeight() public method

Set width and height with proportional resize
public setWidthAndHeight ( integer $width, integer $height ) : self
$width integer
$height integer
return self

Property Details

$container protected property

Container
protected ShapeContainerInterface,PhpOffice\PhpPresentation $container
return PhpOffice\PhpPresentation\ShapeContainerInterface

$height protected property

Height
protected int $height
return integer

$offsetX protected property

Offset X
protected int $offsetX
return integer

$offsetY protected property

Offset Y
protected int $offsetY
return integer

$placeholder protected property

PlaceHolder
protected Placeholder,PhpOffice\PhpPresentation\Shape $placeholder
return PhpOffice\PhpPresentation\Shape\Placeholder

$rotation protected property

Rotation
protected int $rotation
return integer

$shadow protected property

Shadow
protected Shadow,PhpOffice\PhpPresentation\Style $shadow
return PhpOffice\PhpPresentation\Style\Shadow

$width protected property

Width
protected int $width
return integer