AbstractSlide
in package
implements
ComparableInterface, ShapeContainerInterface
uses
ShapeCollection
AbstractYes
Table of Contents
Interfaces
- ComparableInterface
- PhpOffice\PhpPresentation\ComparableInterface.
- ShapeContainerInterface
- PhpOffice\PhpPresentation\ShapeContainerInterface.
Properties
- $background : AbstractBackground
- Background of the slide.
- $extentX : int
- Extent X.
- $extentY : int
- Extent Y.
- $hashIndex : int
- Hash index.
- $identifier : string
- Slide identifier.
- $offsetX : int
- Offset X.
- $offsetY : int
- Offset Y.
- $parent : null|PhpPresentation
- Parent presentation.
- $relsIndex : string
- $shapeCollection : array<int, AbstractShape>
- Collection of shapes.
- $slideTransition : null|Transition
Methods
- addShape() : static
- createChartShape() : Chart
- Create chart shape.
- createDrawingShape() : File
- Create drawing shape.
- createGroup() : Group
- Creates a group within this slide.
- createLineShape() : Line
- Create line shape.
- createRichTextShape() : RichText
- Create rich text shape.
- createTableShape() : Table
- Create table shape.
- getBackground() : AbstractBackground|null
- getExtentX() : int
- Get X Extent.
- getExtentY() : int
- Get Y Extent.
- getHashCode() : string
- Get hash code.
- getHashIndex() : null|int
- Get hash index.
- getOffsetX() : int
- Get X Offset.
- getOffsetY() : int
- Get Y Offset.
- getParent() : PhpPresentation|null
- Get parent.
- getRelsIndex() : string
- getShapeCollection() : array<int, AbstractShape>
- Get collection of shapes.
- getTransition() : Transition|null
- rebindParent() : self
- Re-bind parent.
- searchShapes() : array<int, AbstractShape>
- Search into collection of shapes for a name or/and a type.
- setBackground() : self
- setHashIndex() : $this
- Set hash index.
- setRelsIndex() : self
- setShapeCollection() : self
- Get collection of shapes.
- setTransition() : self
- unsetShape() : static
Properties
$background
Background of the slide.
protected
AbstractBackground
$background
$extentX
Extent X.
protected
int
$extentX
$extentY
Extent Y.
protected
int
$extentY
$hashIndex
Hash index.
protected
int
$hashIndex
$identifier
Slide identifier.
protected
string
$identifier
$offsetX
Offset X.
protected
int
$offsetX
$offsetY
Offset Y.
protected
int
$offsetY
$parent
Parent presentation.
protected
null|PhpPresentation
$parent
$relsIndex
protected
string
$relsIndex
$shapeCollection
Collection of shapes.
protected
array<int, AbstractShape>
$shapeCollection
= []
$slideTransition
protected
null|Transition
$slideTransition
Methods
addShape()
public
addShape(AbstractShape $shape) : static
Parameters
- $shape : AbstractShape
Return values
staticcreateChartShape()
Create chart shape.
public
createChartShape() : Chart
Return values
ChartcreateDrawingShape()
Create drawing shape.
public
createDrawingShape() : File
Return values
FilecreateGroup()
Creates a group within this slide.
public
createGroup() : Group
Return values
GroupcreateLineShape()
Create line shape.
public
createLineShape(int $fromX, int $fromY, int $toX, int $toY) : Line
Parameters
- $fromX : int
-
Starting point x offset
- $fromY : int
-
Starting point y offset
- $toX : int
-
Ending point x offset
- $toY : int
-
Ending point y offset
Return values
LinecreateRichTextShape()
Create rich text shape.
public
createRichTextShape() : RichText
Return values
RichTextcreateTableShape()
Create table shape.
public
createTableShape([int $columns = 1 ]) : Table
Parameters
- $columns : int = 1
-
Number of columns
Return values
TablegetBackground()
public
getBackground() : AbstractBackground|null
Return values
AbstractBackground|nullgetExtentX()
Get X Extent.
public
getExtentX() : int
Return values
intgetExtentY()
Get Y Extent.
public
getExtentY() : int
Return values
intgetHashCode()
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
getOffsetX()
Get X Offset.
public
getOffsetX() : int
Return values
intgetOffsetY()
Get Y Offset.
public
getOffsetY() : int
Return values
intgetParent()
Get parent.
public
getParent() : PhpPresentation|null
Return values
PhpPresentation|nullgetRelsIndex()
public
getRelsIndex() : string
Return values
stringgetShapeCollection()
Get collection of shapes.
public
getShapeCollection() : array<int, AbstractShape>
Return values
array<int, AbstractShape>getTransition()
public
getTransition() : Transition|null
Return values
Transition|nullrebindParent()
Re-bind parent.
public
rebindParent(PhpPresentation $parent) : self
Parameters
- $parent : PhpPresentation
Return values
selfsearchShapes()
Search into collection of shapes for a name or/and a type.
public
searchShapes([string|null $name = null ][, string|null $type = null ]) : array<int, AbstractShape>
Parameters
- $name : string|null = null
- $type : string|null = null
Return values
array<int, AbstractShape>setBackground()
public
setBackground([AbstractBackground|null $background = null ]) : self
Parameters
- $background : AbstractBackground|null = null
Return values
selfsetHashIndex()
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
$thissetRelsIndex()
public
setRelsIndex(string $indexName) : self
Parameters
- $indexName : string
Return values
selfsetShapeCollection()
Get collection of shapes.
public
setShapeCollection([array<int, AbstractShape> $shapeCollection = [] ]) : self
Parameters
- $shapeCollection : array<int, AbstractShape> = []
Return values
selfsetTransition()
public
setTransition([Transition|null $transition = null ]) : self
Parameters
- $transition : Transition|null = null
Return values
selfunsetShape()
public
unsetShape(int $key) : static
Parameters
- $key : int