PHP Class PhpOffice\PhpPresentation\Slide\AbstractSlide

Inheritance: implements PhpOffice\PhpPresentation\ComparableInterface, implements PhpOffice\PhpPresentation\ShapeContainerInterface

Show file Open project: phpoffice/phppowerpoint Class Usage Examples

Protected Properties

Property	Type	Description
$background	AbstractBackground	Background of the slide
$extentX	integer	Extent X
$extentY	integer	Extent Y
$hashIndex	string	Hash index
$identifier	string	Slide identifier
$offsetX	integer	Offset X
$offsetY	integer	Offset Y
$parent	PhpOffice\PhpPresentation\PhpPresentation	Parent presentation
$relsIndex	string
$shapeCollection	ArrayObject \| PhpOffice\PhpPresentation\AbstractShape[]	Collection of shapes
$slideTransition	PhpOffice\PhpPresentation\Slide\Transition

Public Methods

Method	Description
addShape ( AbstractShape $shape ) : AbstractShape	Add shape to slide
createChartShape ( ) : Chart	Create chart shape
createDrawingShape ( ) : File	Create drawing shape
createGroup ( ) : Group	Creates a group within this slide
createLineShape ( integer $fromX, integer $fromY, integer $toX, integer $toY ) : Line	Create line shape
createRichTextShape ( ) : RichText	Create rich text shape
createTableShape ( integer $columns = 1 ) : Table	Create table shape
getBackground ( ) : AbstractBackground
getExtentX ( ) : integer	Get X Extent
getExtentY ( ) : integer	Get Y Extent
getHashCode ( ) : string	Get hash code
getHashIndex ( ) : string	Get hash index
getOffsetX ( ) : integer	Get X Offset
getOffsetY ( ) : integer	Get Y Offset
getParent ( ) : PhpPresentation	Get parent
getRelsIndex ( ) : string
getShapeCollection ( ) : ArrayObject \| AbstractShape[]	Get collection of shapes
getTransition ( ) : PhpOffice\PhpPresentation\Slide\Transition
rebindParent ( PhpPresentation $parent ) : Slide	Re-bind parent
setBackground ( AbstractBackground $background = null ) : Slide
setHashIndex ( string $value )	Set hash index
setRelsIndex ( string $indexName )
setShapeCollection ( $shapeCollection = [] ) : AbstractSlide	Get collection of shapes
setTransition ( PhpOffice\PhpPresentation\Slide\Transition $transition = null ) : Slide

Method Details

addShape() public method

Add shape to slide

public addShape ( AbstractShape $shape ) : AbstractShape
$shape	PhpOffice\PhpPresentation\AbstractShape
return	PhpOffice\PhpPresentation\AbstractShape

createChartShape() public method

Create chart shape

public createChartShape ( ) : Chart
return	PhpOffice\PhpPresentation\Shape\Chart

createDrawingShape() public method

Create drawing shape

public createDrawingShape ( ) : File
return	PhpOffice\PhpPresentation\Shape\Drawing\File

createGroup() public method

Creates a group within this slide

public createGroup ( ) : Group
return	PhpOffice\PhpPresentation\Shape\Group

createLineShape() public method

Create line shape

public createLineShape ( integer $fromX, integer $fromY, integer $toX, integer $toY ) : Line
$fromX	integer	Starting point x offset
$fromY	integer	Starting point y offset
$toX	integer	Ending point x offset
$toY	integer	Ending point y offset
return	PhpOffice\PhpPresentation\Shape\Line

createRichTextShape() public method

Create rich text shape

public createRichTextShape ( ) : RichText
return	PhpOffice\PhpPresentation\Shape\RichText

createTableShape() public method

Create table shape

public createTableShape ( integer $columns = 1 ) : Table
$columns	integer	Number of columns
return	PhpOffice\PhpPresentation\Shape\Table

getBackground() public method

public getBackground ( ) : AbstractBackground
return	AbstractBackground

getExtentX() public method

Get X Extent

public getExtentX ( ) : integer
return	integer

getExtentY() public method

Get Y Extent

public getExtentY ( ) : integer
return	integer

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

getOffsetX() public method

Get X Offset

public getOffsetX ( ) : integer
return	integer

getOffsetY() public method

Get Y Offset

public getOffsetY ( ) : integer
return	integer

getParent() public method

Get parent

public getParent ( ) : PhpPresentation
return	PhpOffice\PhpPresentation\PhpPresentation

getRelsIndex() public method

public getRelsIndex ( ) : string
return	string

getShapeCollection() public method

Get collection of shapes

public getShapeCollection ( ) : ArrayObject \| AbstractShape[]
return	ArrayObject \| PhpOffice\PhpPresentation\AbstractShape[]

getTransition() public method

public getTransition ( ) : PhpOffice\PhpPresentation\Slide\Transition
return	PhpOffice\PhpPresentation\Slide\Transition

rebindParent() public method

Re-bind parent

public rebindParent ( PhpPresentation $parent ) : Slide
$parent	PhpOffice\PhpPresentation\PhpPresentation
return	PhpOffice\PhpPresentation\Slide

setBackground() public method

public setBackground ( AbstractBackground $background = null ) : Slide
$background	AbstractBackground
return	PhpOffice\PhpPresentation\Slide

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

setRelsIndex() public method

public setRelsIndex ( string $indexName )
$indexName	string

setShapeCollection() public method

Get collection of shapes

public setShapeCollection ( $shapeCollection = [] ) : AbstractSlide
return	AbstractSlide

setTransition() public method

public setTransition ( PhpOffice\PhpPresentation\Slide\Transition $transition = null ) : Slide
$transition	PhpOffice\PhpPresentation\Slide\Transition
return	PhpOffice\PhpPresentation\Slide

Property Details

$background protected property

Background of the slide

protected AbstractBackground $background
return	AbstractBackground

$extentX protected property

Extent X

protected int $extentX
return	integer

$extentY protected property

Extent Y

protected int $extentY
return	integer

$hashIndex protected property

Hash index

protected string $hashIndex
return	string

$identifier protected property

Slide identifier

protected string $identifier
return	string

$offsetX protected property

Offset X

protected int $offsetX
return	integer

$offsetY protected property

Offset Y

protected int $offsetY
return	integer

$parent protected property

Parent presentation

protected PhpPresentation,PhpOffice\PhpPresentation $parent
return	PhpOffice\PhpPresentation\PhpPresentation

$relsIndex protected property

protected string $relsIndex
return	string

$shapeCollection protected property

Collection of shapes

protected ArrayObject\|AbstractShape[],PhpOffice\PhpPresentation $shapeCollection
return	ArrayObject \| PhpOffice\PhpPresentation\AbstractShape[]

$slideTransition protected property

protected Transition,PhpOffice\PhpPresentation\Slide $slideTransition
return	PhpOffice\PhpPresentation\Slide\Transition