PHP Class PhpOffice\PhpPresentation\PhpPresentation

Afficher le fichier Open project: phpoffice/phppowerpoint Class Usage Examples

Protected Properties

Свойство 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

Méthodes publiques

Méthode 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 méthode

Create a new PhpPresentation with one Slide
public __construct ( )

addExternalSlide() public méthode

Add external slide
public addExternalSlide ( Slide $slide ) : Slide
$slide Slide External slide to add
Résultat Slide

addMasterSlide() public méthode

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

addSlide() public méthode

Add slide
public addSlide ( Slide $slide = null ) : Slide
$slide Slide
Résultat Slide

copy() public méthode

Copy presentation (!= clone!)
public copy ( ) : PhpPresentation
Résultat PhpPresentation

createMasterSlide() public méthode

Create a masterslide and add it to this presentation
public createMasterSlide ( ) : SlideMaster
Résultat PhpOffice\PhpPresentation\Slide\SlideMaster

createSlide() public méthode

Create slide and add it to this presentation
public createSlide ( ) : Slide
Résultat Slide

getActiveSlide() public méthode

Get active slide
public getActiveSlide ( ) : Slide
Résultat Slide

getActiveSlideIndex() public méthode

Get active slide index
public getActiveSlideIndex ( ) : integer
Résultat integer Active slide index

getAllMasterSlides() public méthode

public getAllMasterSlides ( ) : ArrayObject | SlideMaster[]
Résultat ArrayObject | PhpOffice\PhpPresentation\Slide\SlideMaster[]

getAllSlides() public méthode

Get all slides
public getAllSlides ( ) : Slide[]
Résultat Slide[]

getDocumentProperties() public méthode

Get properties
public getDocumentProperties ( ) : PhpOffice\PhpPresentation\DocumentProperties
Résultat PhpOffice\PhpPresentation\DocumentProperties

getIndex() public méthode

Get index for slide
public getIndex ( AbstractSlide $slide ) : integer
$slide PhpOffice\PhpPresentation\Slide\AbstractSlide
Résultat integer

getLayout() public méthode

Get layout
public getLayout ( ) : DocumentLayout
Résultat DocumentLayout

getPresentationProperties() public méthode

Get presentation properties
public getPresentationProperties ( ) : PresentationProperties
Résultat PresentationProperties

getProperties() public méthode

Get properties
Deprecation: for getDocumentProperties
public getProperties ( ) : PhpOffice\PhpPresentation\DocumentProperties
Résultat PhpOffice\PhpPresentation\DocumentProperties

getSlide() public méthode

Get slide by index
public getSlide ( integer $index ) : Slide
$index integer Slide index
Résultat Slide

getSlideCount() public méthode

Get slide count
public getSlideCount ( ) : integer
Résultat integer

getSlideIterator() public méthode

Get slide iterator
public getSlideIterator ( ) : PhpOffice\PhpPresentation\Slide\Iterator
Résultat PhpOffice\PhpPresentation\Slide\Iterator

getZoom() public méthode

Return the zoom (in percentage)
Deprecation: for getPresentationProperties()->getZoom()
public getZoom ( ) : float
Résultat float

isMarkedAsFinal() public méthode

Return if this document is marked as final
Deprecation: for getPresentationProperties()->isMarkedAsFinal()
public isMarkedAsFinal ( ) : boolean
Résultat boolean

markAsFinal() public méthode

Mark a document as final
Deprecation: for getPresentationProperties()->markAsFinal()
public markAsFinal ( boolean $state = true ) : PhpPresentation
$state boolean
Résultat PhpPresentation

removeSlideByIndex() public méthode

Remove slide by index
public removeSlideByIndex ( integer $index ) : PhpPresentation
$index integer Slide index
Résultat PhpPresentation

setActiveSlideIndex() public méthode

Set active slide index
public setActiveSlideIndex ( integer $index ) : Slide
$index integer Active slide index
Résultat Slide

setAllMasterSlides() public méthode

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

setDocumentProperties() public méthode

Set properties
public setDocumentProperties ( PhpOffice\PhpPresentation\DocumentProperties $value ) : PhpPresentation
$value PhpOffice\PhpPresentation\DocumentProperties
Résultat PhpPresentation

setLayout() public méthode

Set layout
public setLayout ( DocumentLayout $value ) : PhpPresentation
$value DocumentLayout
Résultat PhpPresentation

setPresentationProperties() public méthode

Set presentation properties
public setPresentationProperties ( PresentationProperties $value ) : PhpPresentation
$value PresentationProperties
Résultat PhpPresentation

setProperties() public méthode

Set properties
Deprecation: for setDocumentProperties
public setProperties ( PhpOffice\PhpPresentation\DocumentProperties $value ) : PhpPresentation
$value PhpOffice\PhpPresentation\DocumentProperties
Résultat PhpPresentation

setZoom() public méthode

Set the zoom of the document (in percentage)
Deprecation: for getPresentationProperties()->setZoom()
public setZoom ( float $zoom = 1 ) : PhpPresentation
$zoom float
Résultat PhpPresentation

Property Details

$activeSlideIndex protected_oe property

Active slide index
protected int $activeSlideIndex
Résultat integer

$documentProperties protected_oe property

Document properties
protected DocumentProperties,PhpOffice\PhpPresentation $documentProperties
Résultat PhpOffice\PhpPresentation\DocumentProperties

$layout protected_oe property

Document layout
protected DocumentLayout,PhpOffice\PhpPresentation $layout
Résultat DocumentLayout

$presentationProps protected_oe property

Presentation properties
protected PresentationProperties,PhpOffice\PhpPresentation $presentationProps
Résultat PresentationProperties

$slideCollection protected_oe property

Collection of Slide objects
protected Slide[],PhpOffice\PhpPresentation $slideCollection
Résultat Slide[]

$slideMasters protected_oe property

Collection of Master Slides
protected ArrayObject|SlideMaster[],PhpOffice\PhpPresentation\Slide $slideMasters
Résultat ArrayObject | PhpOffice\PhpPresentation\Slide\SlideMaster[]