PHP Class PhpOffice\PhpPresentation\PhpPresentation

Show file Open project: phpoffice/phppowerpoint Class Usage Examples

Protected Properties

Property	Type	Description
$activeSlideIndex	integer	Active slide index
$documentProperties	PhpOffice\PhpPresentation\DocumentProperties	Document properties
$layout	DocumentLayout	Document layout
$presentationProps	PresentationProperties	Presentation properties
$slideCollection	Slide[]	Collection of Slide objects
$slideMasters	ArrayObject \| PhpOffice\PhpPresentation\Slide\SlideMaster[]	Collection of Master Slides

Public Methods

Method	Description
__construct ( )	Create a new PhpPresentation with one Slide
addExternalSlide ( Slide $slide ) : Slide	Add external slide
addMasterSlide ( SlideMaster $slide = null )	Add masterslide
addSlide ( Slide $slide = null ) : Slide	Add slide
copy ( ) : PhpPresentation	Copy presentation (!= clone!)
createMasterSlide ( ) : SlideMaster	Create a masterslide and add it to this presentation
createSlide ( ) : Slide	Create slide and add it to this presentation
getActiveSlide ( ) : Slide	Get active slide
getActiveSlideIndex ( ) : integer	Get active slide index
getAllMasterSlides ( ) : ArrayObject \| SlideMaster[]
getAllSlides ( ) : Slide[]	Get all slides
getDocumentProperties ( ) : PhpOffice\PhpPresentation\DocumentProperties	Get properties
getIndex ( AbstractSlide $slide ) : integer	Get index for slide
getLayout ( ) : DocumentLayout	Get layout
getPresentationProperties ( ) : PresentationProperties	Get presentation properties
getProperties ( ) : PhpOffice\PhpPresentation\DocumentProperties	Get properties
getSlide ( integer $index ) : Slide	Get slide by index
getSlideCount ( ) : integer	Get slide count
getSlideIterator ( ) : PhpOffice\PhpPresentation\Slide\Iterator	Get slide iterator
getZoom ( ) : float	Return the zoom (in percentage)
isMarkedAsFinal ( ) : boolean	Return if this document is marked as final
markAsFinal ( boolean $state = true ) : PhpPresentation	Mark a document as final
removeSlideByIndex ( integer $index ) : PhpPresentation	Remove slide by index
setActiveSlideIndex ( integer $index ) : Slide	Set active slide index
setAllMasterSlides ( ArrayObject \| SlideMaster[] $slideMasters = [] )
setDocumentProperties ( PhpOffice\PhpPresentation\DocumentProperties $value ) : PhpPresentation	Set properties
setLayout ( DocumentLayout $value ) : PhpPresentation	Set layout
setPresentationProperties ( PresentationProperties $value ) : PhpPresentation	Set presentation properties
setProperties ( PhpOffice\PhpPresentation\DocumentProperties $value ) : PhpPresentation	Set properties
setZoom ( float $zoom = 1 ) : PhpPresentation	Set the zoom of the document (in percentage)

Method Details

__construct() public method

Create a new PhpPresentation with one Slide

public __construct ( )

addExternalSlide() public method

Add external slide

public addExternalSlide ( Slide $slide ) : Slide
$slide	Slide	External slide to add
return	Slide

addMasterSlide() public method

Add masterslide

public addMasterSlide ( SlideMaster $slide = null )
$slide	PhpOffice\PhpPresentation\Slide\SlideMaster

addSlide() public method

Add slide

public addSlide ( Slide $slide = null ) : Slide
$slide	Slide
return	Slide

copy() public method

Copy presentation (!= clone!)

public copy ( ) : PhpPresentation
return	PhpPresentation

createMasterSlide() public method

Create a masterslide and add it to this presentation

public createMasterSlide ( ) : SlideMaster
return	PhpOffice\PhpPresentation\Slide\SlideMaster

createSlide() public method

Create slide and add it to this presentation

public createSlide ( ) : Slide
return	Slide

getActiveSlide() public method

Get active slide

public getActiveSlide ( ) : Slide
return	Slide

getActiveSlideIndex() public method

Get active slide index

public getActiveSlideIndex ( ) : integer
return	integer	Active slide index

getAllMasterSlides() public method

public getAllMasterSlides ( ) : ArrayObject \| SlideMaster[]
return	ArrayObject \| PhpOffice\PhpPresentation\Slide\SlideMaster[]

getAllSlides() public method

Get all slides

public getAllSlides ( ) : Slide[]
return	Slide[]

getDocumentProperties() public method

Get properties

public getDocumentProperties ( ) : PhpOffice\PhpPresentation\DocumentProperties
return	PhpOffice\PhpPresentation\DocumentProperties

getIndex() public method

Get index for slide

public getIndex ( AbstractSlide $slide ) : integer
$slide	PhpOffice\PhpPresentation\Slide\AbstractSlide
return	integer

getLayout() public method

Get layout

public getLayout ( ) : DocumentLayout
return	DocumentLayout

getPresentationProperties() public method

Get presentation properties

public getPresentationProperties ( ) : PresentationProperties
return	PresentationProperties

getProperties() public method

Get properties

Deprecation: for getDocumentProperties

public getProperties ( ) : PhpOffice\PhpPresentation\DocumentProperties
return	PhpOffice\PhpPresentation\DocumentProperties

getSlide() public method

Get slide by index

public getSlide ( integer $index ) : Slide
$index	integer	Slide index
return	Slide

getSlideCount() public method

Get slide count

public getSlideCount ( ) : integer
return	integer

getSlideIterator() public method

Get slide iterator

public getSlideIterator ( ) : PhpOffice\PhpPresentation\Slide\Iterator
return	PhpOffice\PhpPresentation\Slide\Iterator

getZoom() public method

Return the zoom (in percentage)

Deprecation: for getPresentationProperties()->getZoom()

public getZoom ( ) : float
return	float

isMarkedAsFinal() public method

Return if this document is marked as final

Deprecation: for getPresentationProperties()->isMarkedAsFinal()

public isMarkedAsFinal ( ) : boolean
return	boolean

markAsFinal() public method

Mark a document as final

Deprecation: for getPresentationProperties()->markAsFinal()

public markAsFinal ( boolean $state = true ) : PhpPresentation
$state	boolean
return	PhpPresentation

removeSlideByIndex() public method

Remove slide by index

public removeSlideByIndex ( integer $index ) : PhpPresentation
$index	integer	Slide index
return	PhpPresentation

setActiveSlideIndex() public method

Set active slide index

public setActiveSlideIndex ( integer $index ) : Slide
$index	integer	Active slide index
return	Slide

setAllMasterSlides() public method

public setAllMasterSlides ( ArrayObject \| SlideMaster[] $slideMasters = [] )
$slideMasters	ArrayObject \| PhpOffice\PhpPresentation\Slide\SlideMaster[]

setDocumentProperties() public method

Set properties

public setDocumentProperties ( PhpOffice\PhpPresentation\DocumentProperties $value ) : PhpPresentation
$value	PhpOffice\PhpPresentation\DocumentProperties
return	PhpPresentation

setLayout() public method

Set layout

public setLayout ( DocumentLayout $value ) : PhpPresentation
$value	DocumentLayout
return	PhpPresentation

setPresentationProperties() public method

Set presentation properties

public setPresentationProperties ( PresentationProperties $value ) : PhpPresentation
$value	PresentationProperties
return	PhpPresentation

setProperties() public method

Set properties

Deprecation: for setDocumentProperties

public setProperties ( PhpOffice\PhpPresentation\DocumentProperties $value ) : PhpPresentation
$value	PhpOffice\PhpPresentation\DocumentProperties
return	PhpPresentation

setZoom() public method

Set the zoom of the document (in percentage)

Deprecation: for getPresentationProperties()->setZoom()

public setZoom ( float $zoom = 1 ) : PhpPresentation
$zoom	float
return	PhpPresentation

Property Details

$activeSlideIndex protected property

Active slide index

protected int $activeSlideIndex
return	integer

$documentProperties protected property

Document properties

protected DocumentProperties,PhpOffice\PhpPresentation $documentProperties
return	PhpOffice\PhpPresentation\DocumentProperties

$layout protected property

Document layout

protected DocumentLayout,PhpOffice\PhpPresentation $layout
return	DocumentLayout

$presentationProps protected property

Presentation properties

protected PresentationProperties,PhpOffice\PhpPresentation $presentationProps
return	PresentationProperties

$slideCollection protected property

Collection of Slide objects

protected Slide[],PhpOffice\PhpPresentation $slideCollection
return	Slide[]

$slideMasters protected property

Collection of Master Slides

protected ArrayObject\|SlideMaster[],PhpOffice\PhpPresentation\Slide $slideMasters
return	ArrayObject \| PhpOffice\PhpPresentation\Slide\SlideMaster[]