PHPPresentation

https://github.com/phpoffice/phppresentation
Admin
PHPPresentation is a pure PHP library for creating and writing to different presentation file...
Tokens:69,337
Snippets:566
Trust Score:8.8
License:LGPL-3.0
Update:1 week ago
Show doc for...
Tokens:
Raw
### Register PHPPresentation autoloader

Source: https://github.com/phpoffice/phppresentation/blob/master/README.md

Registers the PHPPresentation autoloader for manual installation without Composer. Must be called before using the library.

```php
require_once 'path/to/PhpPresentation/src/PhpPresentation/Autoloader.php';
\PhpOffice\PhpPresentation\Autoloader::register();
```

--------------------------------

### Basic usage example of PHPPresentation library

Source: https://github.com/phpoffice/phppresentation/blob/master/README.md

Shows how to create a PowerPoint presentation with a drawing shape and a rich text shape, then save it in both PowerPoint 2007 and OpenDocument Presentation formats. Requires either manual autoloader registration or Composer's autoloader. The example creates a slide, adds a logo image and a centered text run, and saves the presentation to sample.pptx and sample.odp.

```php
// with your own install
require_once 'src/PhpPresentation/Autoloader.php';
\PhpOffice\PhpPresentation\Autoloader::register();
require_once 'src/Common/Autoloader.php';
\PhpOffice\Common\Autoloader::register();

// with Composer
require_once 'vendor/autoload.php';

use PhpOffice\PhpPresentation\PhpPresentation;
use PhpOffice\PhpPresentation\IOFactory;
use PhpOffice\PhpPresentation\Style\Color;
use PhpOffice\PhpPresentation\Style\Alignment;

$objPHPPowerPoint = new PhpPresentation();

// Create slide
$currentSlide = $objPHPPowerPoint->getActiveSlide();

// Create a shape (drawing)
$shape = $currentSlide->createDrawingShape();
$shape->setName('PHPPresentation logo')
      ->setDescription('PHPPresentation logo')
      ->setPath('./resources/phppowerpoint_logo.gif')
      ->setHeight(36)
      ->setOffsetX(10)
      ->setOffsetY(10);
$shape->getShadow()->setVisible(true)
                   ->setDirection(45)
                   ->setDistance(10);

// Create a shape (text)
$shape = $currentSlide->createRichTextShape()
      ->setHeight(300)
      ->setWidth(600)
      ->setOffsetX(170)
      ->setOffsetY(180);
$shape->getActiveParagraph()->getAlignment()->setHorizontal( Alignment::HORIZONTAL_CENTER );
$textRun = $shape->createTextRun('Thank you for using PHPPresentation!');
$textRun->getFont()->setBold(true)
                   ->setSize(60)
                   ->setColor( new Color( 'FFE06B20' ) );

$oWriterPPTX = IOFactory::createWriter($objPHPPowerPoint, 'PowerPoint2007');
$oWriterPPTX->save(__DIR__ . "/sample.pptx");
$oWriterODP = IOFactory::createWriter($objPHPPowerPoint, 'ODPresentation');
$oWriterODP->save(__DIR__ . "/sample.odp");
```

--------------------------------

### Composer require phpoffice/phppresentation

Source: https://github.com/phpoffice/phppresentation/blob/master/README.md

Adds the PHPPresentation library to a project via Composer. Recommended installation method. Requires PHP 7.1+ and the ZIP and XML Parser extensions.

```json
{
    "require": {
       "phpoffice/phppresentation": "dev-master"
    }
}
```

--------------------------------

### Register PHPOffice Common autoloader

Source: https://github.com/phpoffice/phppresentation/blob/master/README.md

Registers the PHPOffice Common autoloader, required for manual installation. Must be done in addition to the PHPPresentation autoloader.

```php
require_once 'path/to/PhpOffice/Common/src/Common/Autoloader.php';
\PhpOffice\Common\Autoloader::register();
```

--------------------------------

### Manual installation autoloader registration

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/install.md

Register the autoloaders for PHPPresentation and PHPOffice\Common after manually downloading and extracting the packages. Adjust the paths to match your installation.

```php
<?php

require_once 'path/to/PhpPresentation/src/PhpPresentation/Autoloader.php';
\PhpOffice\PhpPresentation\Autoloader::register();

require_once 'path/to/PhpOffice/Common/src/Common/Autoloader.php';
\PhpOffice\Common\Autoloader::register();

```

--------------------------------

### Composer requirement for PHPPresentation

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/install.md

Add this to your composer.json to install PHPPresentation via Composer. Requires PHP 5.3+ and the ZIP and XML Parser extensions.

```json
{
    "require": {
        "phpoffice/phppresentation": "dev-master"
    }
}
```

--------------------------------

### Install phpoffice/wmf for Windows metafiles

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/shapes/drawing.md

Required to add WMF, EMF, or EMF+ files. The library identifies the metafile type and measures it, which getimagesize() cannot do.

```sh
composer require phpoffice/wmf
```

--------------------------------

### Set and get slide size with DocumentLayout

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/presentation.md

Use the presentation's layout to set a preset or custom slide size in any unit, and read it back in any unit. The default unit for getters is EMU. The example outputs 10 when reading the width in inches.

```php
<?php

$presentation = new PhpPresentation();

$layout = $presentation->getLayout();
// A preset : 4/3, 16/9, A4, letter, ... (see DocumentLayout::LAYOUT_*)
$layout->setDocumentLayout(DocumentLayout::LAYOUT_SCREEN_16X9);
// Or a size of your own, in the unit of your choice
$layout->setCX(25.4, DocumentLayout::UNIT_CENTIMETER);
$layout->setCY(14.29, DocumentLayout::UNIT_CENTIMETER);

// Read it back in any unit : EMU (the default), CENTIMETER, MILLIMETER, INCH, POINT, PIXEL
echo $layout->getCX(DocumentLayout::UNIT_INCH);
// Output : 10
```

--------------------------------

### Set and get font capitalization

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/styles.md

Use Font::CAPITALIZATION_ALL to set all-caps formatting. The getCapitalization() method returns the current value.

```php
<?php

use PhpOffice\PhpPresentation\Style\Font;

$font = new Font();

// Set capitalization of font
$font->setCapitalization(Font::CAPITALIZATION_ALL);
// Get capitalization of font
echo $font->getCapitalization();
```

--------------------------------

### Set slide visibility with setIsVisible

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/slides/introduction.md

Controls whether a slide is visible. By default, a slide is visible. The example sets a slide to invisible and then dumps the result of isVisible().

```php
<?php

$slide = $presentation->createSlide();
$slide->setIsVisible(false);
var_dump($slide->isVisible());
```

--------------------------------

### Set and get font format

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/styles.md

Use Font::FORMAT_EAST_ASIAN to set the font format. The getFormat() method returns the current value.

```php
<?php

use PhpOffice\PhpPresentation\Style\Font;

$font = new Font();

// Set format of font
$font->setFormat(Font::FORMAT_EAST_ASIAN);
// Get format of font
echo $font->getFormat();
```

--------------------------------

### Set slide background with setBackground

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/slides/introduction.md

Defines a background for a slide or master slide. By default, slides have no background and the theme's light color shows through. The example sets a solid color background on the first master slide, affecting all slides based on it. Backgrounds are drawn over the whole page and may be excluded from tagged PDFs.

```php
<?php

use PhpOffice\PhpPresentation\Slide\Background\Color as BackgroundColor;
use PhpOffice\PhpPresentation\Style\Color;

$background = new BackgroundColor();
$background->setColor(new Color('FFCC00'));

$presentation->getAllMasterSlides()[0]->setBackground($background);
```

--------------------------------

### Set and get font panose

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/styles.md

Use setPanose() to set the Panose 1.0 identifier. The getPanose() method returns the current value.

```php
<?php

use PhpOffice\PhpPresentation\Style\Font;

$font = new Font();

// Set panose of font
$font->setPanose('4494D72242');
// Get panose of font
echo $font->getPanose();
```

--------------------------------

### Add slide to a specific position with addSlide

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/slides/introduction.md

Adds an existing slide at a given index. Without the $index parameter, the slide is appended to the end. The example shows adding before all slides (index 0), at position 1, and after all slides.

```php
<?php

use PhpOffice\PhpPresentation\Slide;

$slide = new Slide($presentation);
## Add it before all slides
$presentation->addSlide($slide, 0);
## Add it to position 1
$presentation->addSlide($slide, 1);
## Add it after all slides
$presentation->addSlide($slide);
```

--------------------------------

### Set and get display blank as behavior with setDisplayBlankAs

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/shapes/chart.md

Define how blank values are displayed in a chart using `setDisplayBlankAs`. Available constants: `Chart::BLANKAS_GAP` (Leave a gap), `Chart::BLANKAS_ZERO` (Assume zero, default), `Chart::BLANKAS_SPAN` (Continue line). The example sets the behavior to `BLANKAS_GAP` and retrieves it with `getDisplayBlankAs`.

```php
<?php

use PhpOffice\PhpPresentation\Shape\Chart;

// Set the behavior
$chart->setDisplayBlankAs(Chart::BLANKAS_GAP);
// Get the behavior
echo $chart->getDisplayBlankAs();
```

--------------------------------

### Set axis visibility with setIsVisible

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/shapes/chart.md

Controls visibility for each axis (X & Y). The example hides the X axis.

```php
<?php

$line = new Line();

$shape = $slide->createChartShape();
$shape->getPlotArea()->setType($line);
$shape->getPlotArea()->getAxisX()->setIsVisible(false);
```

--------------------------------

### getLayout()

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/presentation.md

Retrieves the document layout object for the presentation, which holds slide size information in EMU. The layout object provides methods to get and set dimensions in various units.

```APIDOC
## getLayout()

### Description
Retrieves the document layout object for the presentation, which holds slide size information in EMU. The layout object provides methods to get and set dimensions in various units.

### Method
`getLayout()`

### Endpoint
`PhpPresentation::getLayout()`

### Returns
- **DocumentLayout** - The layout object for the presentation.

### Example
```php
$presentation = new PhpPresentation();
$layout = $presentation->getLayout();
```
```

--------------------------------

### getOutline()->setWidth and getOutline()->getFill()->setFillType

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/shapes/chart.md

Defines the outline for each axis (X & Y) by setting the width and fill type. The fill type can be set to Fill::FILL_SOLID with a start color.

```APIDOC
## getOutline()->setWidth and getOutline()->getFill()->setFillType

### Description
Defines the outline for each axis (X & Y) by setting the width and fill type. The fill type can be set to Fill::FILL_SOLID with a start color.

### Method
setWidth, setFillType

### Parameters
- **width** (int) - Required - The outline width.
- **fillType** (Fill) - Required - The fill type, e.g., Fill::FILL_SOLID.
- **startColor** (Color) - Required - The start color for the fill.

### Example
```php
<?php

$line = new Line();

$shape = $slide->createChartShape();
$shape->getPlotArea()->setType($line);
$shape->getPlotArea()->getAxisX()->getOutline()->setWidth(10);
$shape->getPlotArea()->getAxisX()->getOutline()->getFill()->setFillType(Fill::FILL_SOLID)->setStartColor(new Color(Color::COLOR_BLUE));
```
```

--------------------------------

### Create Slide Number and Date Fields with Placeholder Types

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/slides/layout.md

Creates rich text shapes for slide number and date fields. The text runs are placeholders that get replaced by the actual slide number and current date when the presentation is opened.

```php
<?php

use PhpOffice\PhpPresentation\Shape\Placeholder;

$shape = $slide->createRichTextShape();
$shape->createTextRun('<number>');
$shape->setPlaceHolder(new Placeholder(Placeholder::PH_TYPE_SLIDENUM));

$shape = $slide->createRichTextShape();
$shape->createTextRun('01-01-25');
$shape->setPlaceHolder(new Placeholder(Placeholder::PH_TYPE_DATETIME));
```

--------------------------------

### Set axis bounds with setMinBounds and setMaxBounds

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/shapes/chart.md

Define the minimum and maximum bounds for an axis using `setMinBounds` and `setMaxBounds`. Pass `null` to reset them to default. The example sets the X-axis bounds from 0 to 200.

```php
<?php

use PhpOffice\PhpPresentation\Shape\Chart\Gridlines;

$line = new Line();

$shape = $slide->createChartShape();
$shape->getPlotArea()->setType($line);
$shape->getPlotArea()->getAxisX()->setMinBounds(0);
$shape->getPlotArea()->getAxisX()->setMaxBounds(200);
```

--------------------------------

### Convert units with DocumentLayout::convertUnit

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/presentation.md

Convert a value from one unit to another without a layout, such as a shape offset expressed in pixels. The example converts 2.5 centimeters to pixels.

```php
<?php

// 2.5 cm, in the pixels a shape is positioned with
$offsetX = DocumentLayout::convertUnit(2.5, DocumentLayout::UNIT_CENTIMETER, DocumentLayout::UNIT_PIXEL);
```

--------------------------------

### Change ZIP adapter for PowerPoint2007 writer

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/writers.md

Shows how to change the ZIP adapter for the PowerPoint2007 writer using setZipAdapter. The default adapter is ZipArchiveAdapter; this example uses PclZipAdapter.

```php
<?php

use PhpOffice\Common\Adapter\Zip\PclZipAdapter;
use PhpOffice\Common\Adapter\Zip\ZipArchiveAdapter;

$writer = IOFactory::createWriter($oPhpPresentation, 'PowerPoint2007');
$writer->setZipAdapter(new PclZipAdapter());
$writer->save(__DIR__ . '/sample.pptx');
```

--------------------------------

### Set major gridlines with setMajorGridlines

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/shapes/chart.md

Customize gridlines (minor and major) for each axis. The example creates a `Gridlines` object, sets its outline width to 10 points and fill to solid blue, then assigns it as the major gridlines for the X-axis.

```php
<?php

use PhpOffice\PhpPresentation\Shape\Chart\Gridlines;

$line = new Line();

$gridlines = new Gridlines();
$gridlines->getOutline()->setWidth(10);
$gridlines->getOutline()->getFill()->setFillType(Fill::FILL_SOLID)->setStartColor(new Color(Color::COLOR_BLUE));

$shape = $slide->createChartShape();
$shape->getPlotArea()->setType($line);
$shape->getPlotArea()->getAxisX()->setMajorGridlines($gridlines);
```

--------------------------------

### Create Keynote reader with IOFactory and load sample.key

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/readers.md

Creates a Keynote reader via IOFactory and loads a Keynote file. Reads slide text, speaker notes, and images from Keynote '13+ packages or Keynote '09 index.apxl; styles, tables, charts, and transitions are not read.

```php
<?php

$reader = IOFactory::createReader('Keynote');
$reader->load(__DIR__ . '/sample.key');
```

--------------------------------

### Create Serialized reader with IOFactory

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/readers.md

Use IOFactory::createReader('Serialized') to instantiate the reader for .phppt files, then load a sample file.

```php
<?php

$reader = IOFactory::createReader('Serialized');
$reader->load(__DIR__ . '/sample.phppt');
```

--------------------------------

### Set numeric bullet style with start at 3

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/shapes/richtext.md

Configures a numbered list with a specific numeric style and starting number.

```php
<?php

use PhpOffice\PhpPresentation\Shape\RichText\Paragraph;
use PhpOffice\PhpPresentation\Style\Bullet;

$paragraph = new Paragraph();
$paragraph->getBulletStyle()->setBulletType(Bullet::TYPE_NUMERIC);
$paragraph->getBulletStyle()->setBulletNumericStyle(Bullet::NUMERIC_ALPHALCPARENBOTH);
$paragraph->getBulletStyle()->setBulletNumericStartAt(3);
```

--------------------------------

### Bullet::setBulletNumericStartAt()

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/shapes/richtext.md

Sets the starting number for a numeric bullet list.

```APIDOC
## Bullet::setBulletNumericStartAt()

### Description
Sets the starting number for a numeric bullet list.

### Method
setBulletNumericStartAt

### Parameters
- **start** (int) - Required - The starting number (1 to 32767).

### Return Value
- **void** - No return value.

### Example
```php
$bulletStyle->setBulletNumericStartAt(3);
```
```

--------------------------------

### IOFactory::createReader('Keynote')

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/readers.md

Creates a Keynote reader instance and loads a Keynote presentation file. The reader extracts slide text, speaker notes, and images from Keynote '13 (and later) packages and Keynote '09 packages.

```APIDOC
## IOFactory::createReader('Keynote')

### Description
Creates a Keynote reader instance and loads a Keynote presentation file. The reader extracts slide text, speaker notes, and images from Keynote '13 (and later) packages and Keynote '09 packages.

### Method
createReader

### Endpoint
IOFactory::createReader('Keynote')

### Parameters
#### Reader Name
- **readerName** (string) - Required - The name of the reader, 'Keynote'.

### Request Example
```php
<?php

$reader = IOFactory::createReader('Keynote');
$reader->load(__DIR__ . '/sample.key');
```

### Response
#### Success Response
Returns a reader instance that can load the presentation file.

#### Response Example
```php
$reader = IOFactory::createReader('Keynote');
```
```

--------------------------------

### getColumnSpacing

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/shapes/richtext.md

Gets the current column spacing of a rich text shape, in pixels.

```APIDOC
## getColumnSpacing

### Description
Gets the current column spacing of a rich text shape, in pixels.

### Method
getColumnSpacing

### Parameters
None.

### Request Example
```php
$columnSpacing = $richText->getColumnSpacing();
```

### Response
Returns the column spacing as an integer.

```

--------------------------------

### Create PowerPoint97 reader with IOFactory and load sample.ppt

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/readers.md

Creates a PowerPoint97 reader via IOFactory and loads a PowerPoint 97-2003 .ppt file.

```php
<?php

$reader = IOFactory::createReader('PowerPoint97');
$reader->load(__DIR__ . '/sample.ppt');
```

--------------------------------

### Get bullet style from paragraph

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/shapes/richtext.md

Retrieves the bullet style object from a paragraph to configure bullet appearance.

```php
<?php

use PhpOffice\PhpPresentation\Shape\RichText\Paragraph;
use PhpOffice\PhpPresentation\Style\Bullet;

$paragraph = new Paragraph();
$paragraph->getBulletStyle();
```

--------------------------------

### setColumnSpacing

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/shapes/richtext.md

Sets the spacing between columns of a rich text shape, in pixels. This has no effect on a shape left with the single column it starts with.

```APIDOC
## setColumnSpacing

### Description
Sets the spacing between columns of a rich text shape, in pixels. This has no effect on a shape left with the single column it starts with.

### Method
setColumnSpacing

### Parameters
- **spacing** (int) - Required - The column spacing in pixels.

### Request Example
```php
$richText->setColumnSpacing(200);
```

### Response
Returns void.

```

--------------------------------

### Create PowerPoint2007 reader with IOFactory

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/readers.md

Use IOFactory::createReader('PowerPoint2007') to instantiate the reader for PPTX files, then load a sample file.

```php
<?php

$reader = IOFactory::createReader('PowerPoint2007');
$reader->load(__DIR__ . '/sample.pptx');
```

--------------------------------

### Create ODPresentation reader with IOFactory and load sample.odp

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/readers.md

Creates an ODPresentation reader via IOFactory and loads an OpenDocument Presentation file.

```php
<?php

$reader = IOFactory::createReader('ODPresentation');
$reader->load(__DIR__ . '/sample.odp');
```

--------------------------------

### Keynote::load()

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/readers.md

Loads a Keynote presentation file into the reader. Optionally, you can skip loading images by passing the Keynote::SKIP_IMAGES constant as a second argument.

```APIDOC
## Keynote::load()

### Description
Loads a Keynote presentation file into the reader. Optionally, you can skip loading images by passing the Keynote::SKIP_IMAGES constant as a second argument.

### Method
load

### Endpoint
Keynote::load()

### Parameters
#### Path Parameters
- **filename** (string) - Required - The path to the Keynote file.

#### Optional Parameters
- **flags** (int) - Optional - A bitmask of flags. Use Keynote::SKIP_IMAGES to skip loading images.

### Request Example
```php
<?php

use PhpOffice\PhpPresentation\Reader\Keynote;

$reader = new Keynote();
$reader->load(__DIR__ . '/sample.key', Keynote::SKIP_IMAGES);
```

### Response
#### Success Response
Loads the presentation and returns the reader instance (or void).
```

--------------------------------

### Load Keynote presentation without images using Keynote::SKIP_IMAGES

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/readers.md

Instantiates the Keynote reader directly and loads a presentation while skipping images via the Keynote::SKIP_IMAGES option.

```php
<?php

use PhpOffice\PhpPresentation\Reader\Keynote;

$reader = new Keynote();
$reader->load(__DIR__ . '/sample.key', Keynote::SKIP_IMAGES);
```

--------------------------------

### Set and get AutoShape text

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/shapes/autoshape.md

Defines the text of the AutoShape using setText and retrieves it with getText. The text is stored as a plain string.

```php
<?php

use PhpOffice\PhpPresentation\Shape\AutoShape;

$shape = new AutoShape();
// Define the text
$shape->setText('ABC');
// Return the text
$shape->getText();
```

--------------------------------

### Validate XML with xmllint against pml.xsd

Source: https://github.com/phpoffice/phppresentation/blob/master/tests/resources/schema/ecma-376/readme.md

Use xmllint to validate an XML file (e.g., theme1.xml) against the pml.xsd schema. The --noout flag suppresses output on success; errors are shown if validation fails.

```bash
$ xmllint --noout --schema pml.xsd ../../../../samples/results/theme1.xml
```

--------------------------------

### Create a chart shape with createChartShape

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/shapes/chart.md

Use the `createChartShape` method on a Slide object to add a chart shape to the slide. This is the starting point for creating any chart.

```php
<?php

$chartShape = $slide->createChartShape();
```

--------------------------------

### Set alignment RTL/LTR

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/styles.md

Creates an Alignment object and demonstrates setting RTL (true) and LTR (false) modes, plus checking the current state with isRTL().

```php
<?php

use PhpOffice\PhpPresentation\Style\Alignment;

$alignment = new Alignment();

// Set alignment to RTL
$alignment->setIsRTL(true);
// Set alignment to LTR
$alignment->setIsRTL(false);
// Is the alignment RTL?
echo $alignment->isRTL();
```

--------------------------------

### Mark presentation as final with markAsFinal

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/presentation.md

Use markAsFinal to set the presentation as final. Without parameters it sets the state to true; passing false resets it to false, and passing true sets it to true. isMarkedAsFinal returns the current state.

```php
<?php

// Default
$state = $presentation->isMarkedAsFinal();
// $state = false

// Without parameter
$presentation->markAsFinal();
$state = $presentation->isMarkedAsFinal();
// $state = true

// Parameter = false
$presentation->markAsFinal(false);
$state = $presentation->isMarkedAsFinal();
// $state = false

// Parameter = true
$presentation->markAsFinal(true);
$state = $presentation->isMarkedAsFinal();
// $state = true
```

--------------------------------

### Set column spacing for RichText

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/shapes/richtext.md

Defines the spacing between columns in pixels for a rich text shape. It has no effect on a shape left with the single column it starts with.

```php
<?php

use PhpOffice\PhpPresentation\Shape\RichText;

$richText = new RichText();
$richText->setColumnSpacing(200);
$columnSpacing = $richText->getColumnSpacing();
```

--------------------------------

### Create a slide with createSlide

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/slides/introduction.md

Creates a new slide and appends it to the end of the slides collection. The returned slide object is used for further operations like adding shapes.

```php
<?php

$slide = $presentation->createSlide();
```

--------------------------------

### Set tick label font with setTickLabelFont

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/shapes/chart.md

Defines the font for tick labels on an axis. Pass null to reset. The example sets a red color for the font.

```php
<?php

use PhpOffice\PhpPresentation\Shape\Chart\Axis;
use PhpOffice\PhpPresentation\Style\Color;
use PhpOffice\PhpPresentation\Style\Font;

$line = new Line();
$font = new Font();
$font->setColor(new Color('C00000'))

$shape = $slide->createChartShape();
$shape->getPlotArea()->setType($line);
$shape->getPlotArea()->getAxisY()->setTickLabelFont($font);
```

--------------------------------

### setLanguage / getLanguage

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/shapes/chart.md

Sets or gets the language for a chart. The language tag is a string like 'de-DE', and null means the chart uses the document's language.

```APIDOC
## setLanguage / getLanguage

### Description
Sets or gets the language for a chart.

### Methods
- **setLanguage** (string|null $language) - Sets the language tag for the chart.
- **getLanguage** () - Returns the language tag, or null if the chart uses the document's language.

### Parameters
- **language** (string|null) - Required - A language tag such as 'de-DE', or null to use the document's language.

### Returns
- **string|null** - The language tag when using getLanguage.

### Example
```php
// Set the language
$chart->setLanguage('de-DE');
// Get the language, null when the chart is in the language of the document
echo $chart->getLanguage();
```
```

--------------------------------

### IOFactory::createReader('ODPresentation')

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/readers.md

Creates an ODPresentation reader instance and loads an ODP presentation file. The reader reads the presentation content from the ODP file.

```APIDOC
## IOFactory::createReader('ODPresentation')

### Description
Creates an ODPresentation reader instance and loads an ODP presentation file. The reader reads the presentation content from the ODP file.

### Method
createReader

### Endpoint
IOFactory::createReader('ODPresentation')

### Parameters
#### Reader Name
- **readerName** (string) - Required - The name of the reader, 'ODPresentation'.

### Request Example
```php
<?php

$reader = IOFactory::createReader('ODPresentation');
$reader->load(__DIR__ . '/sample.odp');
```

### Response
#### Success Response
Returns a reader instance that can load the presentation file.

#### Response Example
```php
$reader = IOFactory::createReader('ODPresentation');
```
```

--------------------------------

### Change ZIP Adapter for Serialized writer

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/writers.md

Shows how to set a custom ZIP adapter (PclZipAdapter) for the Serialized writer. The default adapter is ZipArchiveAdapter.

```php
<?php

use PhpOffice\Common\Adapter\Zip\PclZipAdapter;
use PhpOffice\Common\Adapter\Zip\ZipArchiveAdapter;

$writer = IOFactory::createWriter($oPhpPresentation, 'Serialized');
$writer->setZipAdapter(new PclZipAdapter());
$writer->save(__DIR__ . '/sample.phppt');
```

--------------------------------

### setDisplayBlankAs / getDisplayBlankAs

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/shapes/chart.md

Sets or gets how blank values are displayed in a chart. The method accepts constants like Chart::BLANKAS_GAP, Chart::BLANKAS_ZERO, or Chart::BLANKAS_SPAN.

```APIDOC
## setDisplayBlankAs / getDisplayBlankAs

### Description
Sets or gets how blank values are displayed in a chart.

### Methods
- **setDisplayBlankAs** (string $blankAs) - Sets the display behavior for blank values.
- **getDisplayBlankAs** () - Returns the current display behavior.

### Parameters
- **blankAs** (string) - Required - One of the constants: `Chart::BLANKAS_GAP`, `Chart::BLANKAS_ZERO`, `Chart::BLANKAS_SPAN`.

### Returns
- **string** - The current display behavior when using getDisplayBlankAs.

### Example
```php
use PhpOffice\PhpPresentation\Shape\Chart;

// Set the behavior
$chart->setDisplayBlankAs(Chart::BLANKAS_GAP);
// Get the behavior
echo $chart->getDisplayBlankAs();
```
```

--------------------------------

### getCX() and getCY()

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/presentation.md

Retrieves the slide width and height in the specified unit. The unit can be one of the DocumentLayout::UNIT_* constants (e.g., EMU, CENTIMETER, MILLIMETER, INCH, POINT, PIXEL).

```APIDOC
## getCX() and getCY()

### Description
Retrieves the slide width and height in the specified unit. The unit can be one of the DocumentLayout::UNIT_* constants (e.g., EMU, CENTIMETER, MILLIMETER, INCH, POINT, PIXEL).

### Method
`getCX()` and `getCY()`

### Endpoint
`DocumentLayout::getCX()` and `DocumentLayout::getCY()`

### Parameters
- **unit** (string) - Optional - The unit to return the value in. Defaults to EMU.

### Returns
- **float** - The dimension in the requested unit.

### Example
```php
echo $layout->getCX(DocumentLayout::UNIT_INCH); // Output: 10
```
```

--------------------------------

### Access and Create Master Slides with getAllMasterSlides and createMasterSlide

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/slides/layout.md

Retrieves all master slides from the presentation or creates a new one. Use these methods to manage the top-level slide templates that define base formatting and placeholder positions.

```php
<?php

$arraySlideMasters = $presentation->getAllMasterSlides();
$masterSlide = $presentation->createMasterSlide();
```

--------------------------------

### setIsVisible

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/slides/introduction.md

Sets the visibility of a slide. By default, a slide is visible. Use this method to hide or show a slide.

```APIDOC
## setIsVisible

### Description
Sets the visibility of a slide. By default, a slide is visible. Use this method to hide or show a slide.

### Method
setIsVisible

### Parameters
- **visible** (bool) - Required - Whether the slide should be visible.

### Example
```php
$slide = $presentation->createSlide();
$slide->setIsVisible(false);
var_dump($slide->isVisible());
```
```

--------------------------------

### Set thumbnail from file with setThumbnailPath

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/presentation.md

Use setThumbnailPath with THUMBNAIL_FILE to set the thumbnail from a file path. getThumbnailPath returns the path, and getThumbnail returns the content.

```php
<?php

use PhpOffice\PhpPresentation\PresentationProperties;

$presentation = new PhpPresentation();

$properties = $presentation->getPresentationProperties();
// Set path of the thumbnail
$properties->setThumbnailPath(
    __DIR__.'\resources\phppowerpoint_logo.gif',
    PresentationProperties::THUMBNAIL_FILE
);
// Get path of the thumbnail
echo $properties->getThumbnailPath();
// Get content of the thumbnail
echo $properties->getThumbnail();
```

--------------------------------

### setName

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/slides/introduction.md

Sets the name of a slide. By default, a slide has no name. The name is stored in the presentation file formats.

```APIDOC
## setName

### Description
Sets the name of a slide. By default, a slide has no name. The name is stored in the presentation file formats.

### Method
setName

### Parameters
- **name** (string) - Required - The name to assign to the slide.

### Example
```php
$slide = $presentation->createSlide();
$slide->setName('Title of the slide');
```
```

--------------------------------

### Set last view with setLastView

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/presentation.md

Use setLastView to define the last view of the presentation. The default view is PresentationProperties::VIEW_SLIDE, and getZoom returns the current view (note: the example uses getZoom to retrieve the view).

```php
<?php

$presentation = new PhpPresentation();

$properties = $presentation->getPresentationProperties();
// Get the last view of the presentation
echo $properties->getZoom();
// Output : PresentationProperties::VIEW_SLIDE
// Set the last view of the presentation
$properties->setLastView(PresentationProperties::VIEW_NOTES);
// Get the last view of the presentation
echo $properties->getZoom();
// Output : PresentationProperties::VIEW_NOTES
```

--------------------------------

### IOFactory::createReader('PowerPoint97')

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/readers.md

Creates a PowerPoint97 reader instance and loads a PowerPoint 97-2003 presentation file. The reader reads the presentation content from the PPT file.

```APIDOC
## IOFactory::createReader('PowerPoint97')

### Description
Creates a PowerPoint97 reader instance and loads a PowerPoint 97-2003 presentation file. The reader reads the presentation content from the PPT file.

### Method
createReader

### Endpoint
IOFactory::createReader('PowerPoint97')

### Parameters
#### Reader Name
- **readerName** (string) - Required - The name of the reader, 'PowerPoint97'.

### Request Example
```php
<?php

$reader = IOFactory::createReader('PowerPoint97');
$reader->load(__DIR__ . '/sample.ppt');
```

### Response
#### Success Response
Returns a reader instance that can load the presentation file.

#### Response Example
```php
$reader = IOFactory::createReader('PowerPoint97');
```
```

--------------------------------

### Set axis title and rotation with setTitle and setTitleRotation

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/shapes/chart.md

Define a title for an axis (X or Y) using `setTitle` and apply a rotation in degrees with `setTitleRotation`. The example sets the X-axis title to 'Axis X' and rotates it by 45 degrees.

```php
<?php

use PhpOffice\PhpPresentation\Shape\Chart\Gridlines;

$line = new Line();

$shape = $slide->createChartShape();
$shape->getPlotArea()->setType($line);

$shape->getPlotArea()->getAxisX()->setTitle('Axis X');
$shape->getPlotArea()->getAxisX()->setTitleRotation(45);
```

--------------------------------

### Load ODPresentation without images using ODPresentation::SKIP_IMAGES

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/readers.md

Instantiates the ODPresentation reader directly and loads a presentation while skipping images via the ODPresentation::SKIP_IMAGES option.

```php
<?php

use PhpOffice\PhpPresentation\Reader\ODPresentation;

$reader = new ODPresentation();
$reader->load(__DIR__ . '/sample.odp', ODPresentation::SKIP_IMAGES);
```

--------------------------------

### setCX() and setCY()

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/presentation.md

Sets the slide width and height in a specified unit. The unit can be one of the DocumentLayout::UNIT_* constants (e.g., CENTIMETER, MILLIMETER, INCH, POINT, PIXEL, EMU).

```APIDOC
## setCX() and setCY()

### Description
Sets the slide width and height in a specified unit. The unit can be one of the DocumentLayout::UNIT_* constants (e.g., CENTIMETER, MILLIMETER, INCH, POINT, PIXEL, EMU).

### Method
`setCX()` and `setCY()`

### Endpoint
`DocumentLayout::setCX()` and `DocumentLayout::setCY()`

### Parameters
- **value** (float) - Required - The dimension value.
- **unit** (string) - Required - The unit of the value, e.g., `DocumentLayout::UNIT_CENTIMETER`.

### Example
```php
$layout->setCX(25.4, DocumentLayout::UNIT_CENTIMETER);
$layout->setCY(14.29, DocumentLayout::UNIT_CENTIMETER);
```
```

--------------------------------

### Set axis number format with setFormatCode

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/shapes/chart.md

Define the number format for axis tick labels using `setFormatCode` with an OOXML format code. Available only on the PowerPoint2007 Writer. The default is `Axis::DEFAULT_FORMAT_CODE` (`general`). The example sets the Y-axis format to '#,##0.00'.

```php
<?php

use PhpOffice\PhpPresentation\Shape\Chart\Type\Line;

$line = new Line();

$shape = $slide->createChartShape();
$shape->getPlotArea()->setType($line);
$shape->getPlotArea()->getAxisY()->setFormatCode('#,##0.00');
```

--------------------------------

### Create a drawing from a ZipFile

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/shapes/drawing.md

Adds a drawing from a file inside a ZIP archive. The path uses a zip:// wrapper with the file path inside the archive.

```php
<?php

use PhpOffice\PhpPresentation\Shape\Drawing\ZipFile;

$shape = new ZipFile();
$shape->setName('Sample image')
    ->setDescription('Sample image')
    ->setPath('zip://myzipfile.zip#path/in/zip/img.ext')
$slide->addShape($shape);
```

--------------------------------

### Load PPTX without images using PowerPoint2007::SKIP_IMAGES

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/readers.md

Instantiate the PowerPoint2007 reader directly and pass the PowerPoint2007::SKIP_IMAGES flag to load a presentation without images.

```php
<?php

use PhpOffice\PhpPresentation\Reader\PowerPoint2007;

$reader = new PowerPoint2007();
$reader->load(__DIR__ . '/sample.pptx', PowerPoint2007::SKIP_IMAGES);
```

--------------------------------

### Set and get chart language with setLanguage

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/shapes/chart.md

Set a chart-specific language using `setLanguage` with a language tag like `de-DE`. Passing `null` makes the chart use the document language set via `DocumentProperties::setLanguage()`. The PowerPoint2007 Writer writes this and the Reader reads it back.

```php
<?php

// Set the language
$chart->setLanguage('de-DE');
// Get the language, null when the chart is in the language of the document
echo $chart->getLanguage();
```

--------------------------------

### Create Serialized writer and save presentation

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/writers.md

Creates a writer for the 'Serialized' format using IOFactory and saves the presentation to a .phppt file.

```php
<?php

$writer = IOFactory::createWriter($oPhpPresentation, 'Serialized');
$writer->save(__DIR__ . '/sample.phppt');
```

--------------------------------

### Set axis crossing with setCrossesAt

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/shapes/chart.md

Define where the perpendicular/horizontal axis crosses the target axis using `setCrossesAt`. Available only on the PowerPoint2007 Writer. Use constants like `Axis::CROSSES_AUTO`, `Axis::CROSSES_MIN`, `Axis::CROSSES_MAX`, or an absolute value as a string. The example sets the Y-axis crossing to auto and then to '3'.

```php
use PhpOffice\PhpPresentation\Shape\Axis;
use PhpOffice\PhpPresentation\Shape\Chart\Type\Bar;

$bar = new Bar();

$shape = $slide->createChartShape();
$shape->getPlotArea()->setType($bar);

// Usage of constant: Horizontal axis will cross the Y-Axis at `0`
$shape->getPlotArea()->getAxisY()->setCrossesAt(Axis::CROSSES_AUTO);

// Usage of individual value: Horizontal axis will cross the Y-Axis at `3`
$shape->getPlotArea()->getAxisY()->setCrossesAt('3');
```

--------------------------------

### Move a slide with moveSlide

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/slides/introduction.md

Moves an existing slide to a new position. The slide is removed before being reinserted, so the index counts without it. Throws OutOfBoundsException for an index past the last slide and InvalidParameterException for a slide not in the presentation.

```php
<?php

$presentation->moveSlide($slide, 2);
```

--------------------------------

### Define cell borders with getBorders method

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/shapes/table.md

Configure cell borders using the `getBorders` method. The example sets the bottom border to a double line with a dash style. Note that neighbouring cells share edges; the neighbour's border rule takes precedence when both define the same edge. The ODPresentation Writer maps OOXML line styles to ODF `fo:border` with limited CSS2 styles: `LINE_NONE` becomes `none`, `LINE_SINGLE` becomes `solid`, compound lines become `double`, and dash patterns become `dotted` or `dashed`.

```php
<?php

use PhpOffice\PhpPresentation\Style\Border;

$tableShape = $slide->createTableShape($columns);
$row = $tableShape->createRow();
$cellA1 = $row->nextCell();
$cellA1->getBorders()->getBottom()->setLineStyle(Border::LINE_DOUBLE);
$cellA1->getBorders()->getBottom()->setDashStyle(Border::DASH_DASH);
```

--------------------------------

### Create a drawing from a file using File class

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/shapes/drawing.md

Equivalent to createDrawingShape but uses the File class directly. Requires adding the shape to the slide manually.

```php
<?php

use PhpOffice\PhpPresentation\Shape\Drawing\File;

$shape = new File();
$shape->setName('Unique name')
    ->setDescription('Description of the drawing')
    ->setPath('/path/to/drawing.filename');
$slide->addShape($shape);
```

--------------------------------

### Access and Create Slide Layouts with getAllSlideLayouts and createSlideLayout

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/slides/layout.md

Retrieves all slide layouts from a master slide or creates a new one. Use these methods to manage layout templates that override master slide settings for specific slide types.

```php
<?php

$arraySlideLayouts = $masterSlide->getAllSlideLayouts();
$slideLayout = $masterSlide->createSlideLayout();
```

--------------------------------

### Color::__construct

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/styles.md

Creates a new Color object with a given color value. The color can be specified as six characters (RRGGBB) for opaque colors or eight characters (AARRGGBB) for colors with alpha. The class also provides predefined color constants like Color::COLOR_BLACK.

```APIDOC
## Color::__construct

### Description
Creates a new Color object with a given color value.

### Method
__construct

### Parameters
- **color** (string) - Required - The color value in RRGGBB or AARRGGBB format.

### Example
```php
$color = new Color('C00000');
```
```

--------------------------------

### Pattern Fill Configuration

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/styles.md

Sets a fill to one of the 54 DrawingML patterns, using startColor for the pattern and endColor for the background. Pattern constants are named after the pattern they write.

```APIDOC
## Pattern Fill Configuration

### Description
Sets a fill to one of the 54 DrawingML patterns, using startColor for the pattern and endColor for the background. Pattern constants are named after the pattern they write.

### Method
`getFill()`

### Endpoint
`$shape->getFill()`

### Parameters
#### Methods
- **setFillType** (Fill::FILL_PATTERN_*) - Required - Sets the pattern fill type (e.g., `Fill::FILL_PATTERN_WDDNDIAG`, `Fill::FILL_PATTERN_LGGRID`, `Fill::FILL_PATTERN_SOLIDDMND`, `Fill::FILL_PATTERN_DIAGBRICK`).
- **setStartColor** (Color) - Required - Sets the pattern color.
- **setEndColor** (Color) - Required - Sets the background color.

### Request Example
```php
$shape->getFill()
    ->setFillType(Fill::FILL_PATTERN_WDDNDIAG)
    ->setStartColor(new Color('FF4472C4'))
    ->setEndColor(new Color('FFFFFFFF'));
```

### Response
#### Success Response
- **fillType** (Fill::FILL_PATTERN_*) - The pattern fill type.
- **startColor** (Color) - The pattern color.
- **endColor** (Color) - The background color.

### Notes
- All pattern constants are listed in `Fill::PATTERN_TYPES`.
- OpenDocument does not support preset patterns; line patterns are written as hatches, others are painted solid in startColor.
```

--------------------------------

### createSlide

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/slides/introduction.md

Creates a new slide and appends it to the end of the slides collection. Returns the newly created slide object for further operations.

```APIDOC
## createSlide

### Description
Creates a new slide and adds it to the end of the slides collection.

### Method
createSlide

### Parameters
None

### Return Value
- **Slide** - The newly created slide object.

### Example
```php
$slide = $presentation->createSlide();
```
```

--------------------------------

### setBackground

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/slides/introduction.md

Sets the background of a slide or master slide. The background is a fill drawn over the whole page. Can be applied to a slide or to a master slide to affect all slides based on it.

```APIDOC
## setBackground

### Description
Sets the background of a slide or master slide. The background is a fill drawn over the whole page. Can be applied to a slide or to a master slide to affect all slides based on it.

### Method
setBackground

### Parameters
- **background** (Background) - Required - The background object to set.

### Example
```php
use PhpOffice\PhpPresentation\Slide\Background\Color as BackgroundColor;
use PhpOffice\PhpPresentation\Style\Color;

$background = new BackgroundColor();
$background->setColor(new Color('FFCC00'));

$presentation->getAllMasterSlides()[0]->setBackground($background);
```
```

--------------------------------

### Radar constructor

Source: https://github.com/phpoffice/phppresentation/blob/master/docs/usage/shapes/chart.md

Creates a new Radar chart type instance.

```APIDOC
## Radar::__construct

### Description
Creates a new Radar chart type instance.

### Method
__construct

### Request Example
```php
use PhpOffice\PhpPresentation\Shape\Chart\Type\Radar;

$radarChart = new Radar();
```
```
Tokens:
Raw