PHP Класс PhpOffice\PhpPresentation\PhpPresentation

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$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

Открытые методы

Метод Описание
__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)

Описание методов

__construct() публичный Метод

Create a new PhpPresentation with one Slide
public __construct ( )

addExternalSlide() публичный Метод

Add external slide
public addExternalSlide ( Slide $slide ) : Slide
$slide Slide External slide to add
Результат Slide

addMasterSlide() публичный Метод

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

addSlide() публичный Метод

Add slide
public addSlide ( Slide $slide = null ) : Slide
$slide Slide
Результат Slide

copy() публичный Метод

Copy presentation (!= clone!)
public copy ( ) : PhpPresentation
Результат PhpPresentation

createMasterSlide() публичный Метод

Create a masterslide and add it to this presentation
public createMasterSlide ( ) : SlideMaster
Результат PhpOffice\PhpPresentation\Slide\SlideMaster

createSlide() публичный Метод

Create slide and add it to this presentation
public createSlide ( ) : Slide
Результат Slide

getActiveSlide() публичный Метод

Get active slide
public getActiveSlide ( ) : Slide
Результат Slide

getActiveSlideIndex() публичный Метод

Get active slide index
public getActiveSlideIndex ( ) : integer
Результат integer Active slide index

getAllMasterSlides() публичный Метод

public getAllMasterSlides ( ) : ArrayObject | SlideMaster[]
Результат ArrayObject | PhpOffice\PhpPresentation\Slide\SlideMaster[]

getAllSlides() публичный Метод

Get all slides
public getAllSlides ( ) : Slide[]
Результат Slide[]

getDocumentProperties() публичный Метод

Get properties
public getDocumentProperties ( ) : PhpOffice\PhpPresentation\DocumentProperties
Результат PhpOffice\PhpPresentation\DocumentProperties

getIndex() публичный Метод

Get index for slide
public getIndex ( AbstractSlide $slide ) : integer
$slide PhpOffice\PhpPresentation\Slide\AbstractSlide
Результат integer

getLayout() публичный Метод

Get layout
public getLayout ( ) : DocumentLayout
Результат DocumentLayout

getPresentationProperties() публичный Метод

Get presentation properties
public getPresentationProperties ( ) : PresentationProperties
Результат PresentationProperties

getProperties() публичный Метод

Get properties
Устаревший: for getDocumentProperties
public getProperties ( ) : PhpOffice\PhpPresentation\DocumentProperties
Результат PhpOffice\PhpPresentation\DocumentProperties

getSlide() публичный Метод

Get slide by index
public getSlide ( integer $index ) : Slide
$index integer Slide index
Результат Slide

getSlideCount() публичный Метод

Get slide count
public getSlideCount ( ) : integer
Результат integer

getSlideIterator() публичный Метод

Get slide iterator
public getSlideIterator ( ) : PhpOffice\PhpPresentation\Slide\Iterator
Результат PhpOffice\PhpPresentation\Slide\Iterator

getZoom() публичный Метод

Return the zoom (in percentage)
Устаревший: for getPresentationProperties()->getZoom()
public getZoom ( ) : float
Результат float

isMarkedAsFinal() публичный Метод

Return if this document is marked as final
Устаревший: for getPresentationProperties()->isMarkedAsFinal()
public isMarkedAsFinal ( ) : boolean
Результат boolean

markAsFinal() публичный Метод

Mark a document as final
Устаревший: for getPresentationProperties()->markAsFinal()
public markAsFinal ( boolean $state = true ) : PhpPresentation
$state boolean
Результат PhpPresentation

removeSlideByIndex() публичный Метод

Remove slide by index
public removeSlideByIndex ( integer $index ) : PhpPresentation
$index integer Slide index
Результат PhpPresentation

setActiveSlideIndex() публичный Метод

Set active slide index
public setActiveSlideIndex ( integer $index ) : Slide
$index integer Active slide index
Результат Slide

setAllMasterSlides() публичный Метод

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

setDocumentProperties() публичный Метод

Set properties
public setDocumentProperties ( PhpOffice\PhpPresentation\DocumentProperties $value ) : PhpPresentation
$value PhpOffice\PhpPresentation\DocumentProperties
Результат PhpPresentation

setLayout() публичный Метод

Set layout
public setLayout ( DocumentLayout $value ) : PhpPresentation
$value DocumentLayout
Результат PhpPresentation

setPresentationProperties() публичный Метод

Set presentation properties
public setPresentationProperties ( PresentationProperties $value ) : PhpPresentation
$value PresentationProperties
Результат PhpPresentation

setProperties() публичный Метод

Set properties
Устаревший: for setDocumentProperties
public setProperties ( PhpOffice\PhpPresentation\DocumentProperties $value ) : PhpPresentation
$value PhpOffice\PhpPresentation\DocumentProperties
Результат PhpPresentation

setZoom() публичный Метод

Set the zoom of the document (in percentage)
Устаревший: for getPresentationProperties()->setZoom()
public setZoom ( float $zoom = 1 ) : PhpPresentation
$zoom float
Результат PhpPresentation

Описание свойств

$activeSlideIndex защищенное свойство

Active slide index
protected int $activeSlideIndex
Результат integer

$documentProperties защищенное свойство

Document properties
protected DocumentProperties,PhpOffice\PhpPresentation $documentProperties
Результат PhpOffice\PhpPresentation\DocumentProperties

$layout защищенное свойство

Document layout
protected DocumentLayout,PhpOffice\PhpPresentation $layout
Результат DocumentLayout

$presentationProps защищенное свойство

Presentation properties
protected PresentationProperties,PhpOffice\PhpPresentation $presentationProps
Результат PresentationProperties

$slideCollection защищенное свойство

Collection of Slide objects
protected Slide[],PhpOffice\PhpPresentation $slideCollection
Результат Slide[]

$slideMasters защищенное свойство

Collection of Master Slides
protected ArrayObject|SlideMaster[],PhpOffice\PhpPresentation\Slide $slideMasters
Результат ArrayObject | PhpOffice\PhpPresentation\Slide\SlideMaster[]