Skip to content

Commit

Permalink
Feedbacks from @Progi1984
Browse files Browse the repository at this point in the history
  • Loading branch information
Progi1984 committed Dec 14, 2023
1 parent 0e5dd85 commit 36b2486
Show file tree
Hide file tree
Showing 22 changed files with 532 additions and 200 deletions.
12 changes: 12 additions & 0 deletions docs/changes/1.1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,21 @@
- PowerPoint2007 Reader
- PowerPoint2007 Writer
- PowerPoint2007 Writer: Enable style and position of a Placeholder - [@qmachard](https://github.com/qmachard) in [#787](https://github.com/PHPOffice/PHPPresentation/pull/787)
- PowerPoint2007 Reader: Added support for thumbnail - [@devX2712](https://github.com/devX2712) in [#788](https://github.com/PHPOffice/PHPPresentation/pull/787)

## Improvements
- Slide : Raised max value for identifier rand call - [@Scheissy](https://github.com/Scheissy) in [#777](https://github.com/PHPOffice/PHPPresentation/pull/777)
- Document Properties : Support for Revision & Status - [@devX2712](https://github.com/devX2712) in [#788](https://github.com/PHPOffice/PHPPresentation/pull/787)
- PowerPoint2007 Reader
- PowerPoint2007 Writer
- Presentation Properties : Added support to define content of the thumbnail - [@devX2712](https://github.com/devX2712) in [#788](https://github.com/PHPOffice/PHPPresentation/pull/787)
- Font : Support for Strikethrough mode - [@devX2712](https://github.com/devX2712) in [#788](https://github.com/PHPOffice/PHPPresentation/pull/787)
- PowerPoint2007 Reader
- PowerPoint2007 Writer
- Font : Support for Pitch Family, Charset & Panose - [@devX2712](https://github.com/devX2712) in [#788](https://github.com/PHPOffice/PHPPresentation/pull/787)
- PowerPoint2007 Reader
- PowerPoint2007 Writer
(@todo Doc)

## Bugfixes

Expand Down
32 changes: 31 additions & 1 deletion docs/usage/presentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ $properties->setCreated(mktime(0, 0, 0, 3, 12, 2014));
$properties->setModified(mktime(0, 0, 0, 3, 14, 2014));
$properties->setSubject('My subject');
$properties->setKeywords('my, key, word');
$properties->setStatus('Work in Progress');
$properties->setRevision('Version 1.2.3');
```

### Custom Properties
Expand Down Expand Up @@ -203,16 +205,44 @@ echo $properties->getSlideshowType();

You can define the thumbnail of the presentation with the method `setThumbnailPath`.


#### From a file
``` php
<?php

use PhpOffice\PhpPresentation\PresentationProperties;

$presentation = new PhpPresentation();

$properties = $presentation->getPresentationProperties();
// Set path of the thumbnail
$properties->setThumbnailPath(__DIR__.'\resources\phppowerpoint_logo.gif');
$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();
```

#### From the content of the file
``` php
<?php

use PhpOffice\PhpPresentation\PresentationProperties;

$presentation = new PhpPresentation();

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

### Zoom
Expand Down
20 changes: 19 additions & 1 deletion docs/usage/styles.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,8 @@ echo $alignment->isRTL();
- `underline`
- `strikethrough`
- `color`
- `capitalization`
- `pitchFamily`
- `charset`

### Capitalization

Expand Down Expand Up @@ -145,6 +146,23 @@ $font->setFormat(Font::FORMAT_EAST_ASIAN);
// Get format of font
echo $font->getFormat();
```

### Panose
The support of Panose 1.0 is only used.

``` php
<?php

use PhpOffice\PhpPresentation\Style\Font;

$font = new Font();

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

## Bullet

- `bulletType`
Expand Down
35 changes: 15 additions & 20 deletions src/PhpPresentation/DocumentProperties.php
Original file line number Diff line number Diff line change
Expand Up @@ -102,11 +102,18 @@ class DocumentProperties
private $company;

/**
* revision
* Revision.
*
* @var string
*/
private $revision;

/**
* Status.
*
* @var string
*/
private $status;

/**
* Custom Properties.
Expand All @@ -116,14 +123,7 @@ class DocumentProperties
private $customProperties = [];

/**
* status
*
* @var string
*/
private $status;

/**
* Create a new \PhpOffice\PhpPresentation\DocumentProperties
* Create a new \PhpOffice\PhpPresentation\DocumentProperties.
*/
public function __construct()
{
Expand All @@ -139,7 +139,7 @@ public function __construct()
$this->category = '';
$this->company = 'Microsoft Corporation';
$this->revision = '';
$this->status = '';
$this->status = '';
}

/**
Expand Down Expand Up @@ -479,7 +479,7 @@ public function getRevision(): string
}

/**
* Set Revision
* Set Revision.
*/
public function setRevision(string $pValue = ''): self
{
Expand All @@ -489,22 +489,17 @@ public function setRevision(string $pValue = ''): self
}

/**
* Get Status
*
* @return string
* Get Status.
*/
public function getStatus()
public function getStatus(): string
{
return $this->status;
}

/**
* Set Status
*
* @param string $pValue
* @return \PhpOffice\PhpPresentation\DocumentProperties
* Set Status.
*/
public function setStatus($pValue = '')
public function setStatus(string $pValue = ''): self
{
$this->status = $pValue;

Expand Down
11 changes: 8 additions & 3 deletions src/PhpPresentation/Exception/InvalidParameterException.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,17 @@

class InvalidParameterException extends PhpPresentationException
{
public function __construct(string $parameter, string $value)
public function __construct(string $parameter, string $value, string $error = null)
{
parent::__construct(sprintf(
$message = sprintf(
'The parameter %s can\'t have the value "%s"',
$parameter,
$value
));
);
if ($error) {
$message = sprintf('%s (Validation: %s)', $message, $error);
}

parent::__construct($message);
}
}
45 changes: 23 additions & 22 deletions src/PhpPresentation/PresentationProperties.php
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ class PresentationProperties
public const VIEW_SLIDE_SORTER = 'sldSorterView';
public const VIEW_SLIDE_THUMBNAIL = 'sldThumbnailView';

public const THUMBNAIL_FILE = 'file'; // Thumbnail path is out of PPT
public const THUMBNAIL_ZIP = 'zip'; // Thumbnail path point to an image store into file loaded
public const THUMBNAIL_FILE = 'file';
public const THUMBNAIL_DATA = 'data';

/**
* @var array<int, string>
Expand Down Expand Up @@ -72,17 +72,17 @@ class PresentationProperties
*/
protected $markAsFinal = false;

/*
* @var string Define the thumbnail content (if content into zip file)
/**
* @var string|null Define the thumbnail content (if content into zip file)
*/
protected $thumbnail = null;

/*
* @var string Define the thumbnail place
/**
* @var string|null Define the thumbnail place
*/
protected $thumbnailPath = '';
protected $thumbnailPath = null;

/*
/**
* @var string Define if thumbnail is out of PPT or previouly store into PPT
*/
protected $thumbnailType = self::THUMBNAIL_FILE;
Expand Down Expand Up @@ -130,36 +130,38 @@ public function getThumbnailPath(): ?string
}

/**
* Return the content of thumbnail
*
* @return binary Content of image
* Return the content of thumbnail.
*/
public function getThumbnail()
public function getThumbnail(): ?string
{
// Return content of local file
if ($this->getThumbnailType() == self::THUMBNAIL_FILE) {
if (file_exists($this->getThumbnailPath()))
if ($this->getThumbnailPath()) {
return file_get_contents($this->getThumbnailPath());
}

return null;
}

// Return content of image stored into zip file
if ($this->getThumbnailType() == self::THUMBNAIL_ZIP) {
if ($this->getThumbnailType() == self::THUMBNAIL_DATA) {
return $this->thumbnail;
}
// Return null if no thumbnail

return null;
}

/**
* Define the path for the thumbnail file / preview picture.
*/
public function setThumbnailPath(string $path = '', $type = self::THUMBNAIL_FILE, $content = null)
public function setThumbnailPath(string $path = '', string $type = self::THUMBNAIL_FILE, string $content = null): self
{
if (file_exists($path) && ($type == self::THUMBNAIL_FILE)) {
if (file_exists($path) && $type == self::THUMBNAIL_FILE) {
$this->thumbnailPath = $path;
$this->thumbnailType = $type;
}
if (($path != '') && ($type == self::THUMBNAIL_ZIP)) {
$this->thumbnailPath = $path;
if ($content != '' && $type == self::THUMBNAIL_DATA) {
$this->thumbnailPath = '';
$this->thumbnailType = $type;
$this->thumbnail = $content;
}
Expand All @@ -168,10 +170,9 @@ public function setThumbnailPath(string $path = '', $type = self::THUMBNAIL_FILE
}

/**
* Return the thumbnail type
* @return string
* Return the thumbnail type.
*/
public function getThumbnailType()
public function getThumbnailType(): string
{
return $this->thumbnailType;
}
Expand Down
22 changes: 9 additions & 13 deletions src/PhpPresentation/Reader/PowerPoint2007.php
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ protected function loadDocumentProperties(string $sPart): void
'/cp:coreProperties/dcterms:modified' => 'setModified',
'/cp:coreProperties/cp:revision' => 'setRevision',
'/cp:coreProperties/cp:contentStatus' => 'setStatus',
);
];
$oProperties = $this->oPhpPresentation->getDocumentProperties();
foreach ($arrayProperties as $path => $property) {
$oElement = $xmlReader->getElement($path);
Expand All @@ -248,9 +248,8 @@ protected function loadDocumentProperties(string $sPart): void

/**
* Read information of the document thumbnail
* @param string $sPart Content of XML file for retrieving data
*/
protected function loadThumbnailProperties($sPart)
protected function loadThumbnailProperties(string $sPart): void
{
$xmlReader = new XMLReader();
if ($xmlReader->getDomFromString($sPart)) {
Expand All @@ -259,16 +258,13 @@ protected function loadThumbnailProperties($sPart)
$path = $oElement->getAttribute('Target');
$this->oPhpPresentation
->getPresentationProperties()
->setThumbnailPath($path
, \PhpOffice\PhpPresentation\PresentationProperties::THUMBNAIL_ZIP
, $this->oZip->getFromName($path));
->setThumbnailPath('', PresentationProperties::THUMBNAIL_DATA, $this->oZip->getFromName($path));
}
}
}

/**
* Read Custom Properties
* @param string $sPart
* Read Custom Properties.
*/
protected function loadCustomProperties(string $sPart): void
{
Expand Down Expand Up @@ -913,15 +909,15 @@ protected function loadEffect(XMLReader $document, \DOMElement $nodeEffect)
$effect = new \PhpOffice\PhpPresentation\Style\Effect($type);
// load blur radius
if ($node->hasAttribute('blurRad')) {
$effect->setBlurRadius(CommonDrawing::emuToPixels($node->getAttribute('blurRad')));
$effect->setBlurRadius(CommonDrawing::emuToPixels((int) $node->getAttribute('blurRad')));
}
// load distance
if ($node->hasAttribute('dist')) {
$effect->setDistance(CommonDrawing::emuToPixels($node->getAttribute('dist')));
$effect->setDistance(CommonDrawing::emuToPixels((int) $node->getAttribute('dist')));
}
// load direction
if ($node->hasAttribute('dir')) {
$effect->setDirection(CommonDrawing::angleToDegrees($node->getAttribute('dir')));
$effect->setDirection((int) CommonDrawing::angleToDegrees((int) $node->getAttribute('dir')));
}
// load alignment
if ($node->hasAttribute('algn')) {
Expand Down Expand Up @@ -1365,10 +1361,10 @@ protected function loadParagraph(XMLReader $document, DOMElement $oElement, $oSh
$oText->getFont()->setPanose($oElementFont->getAttribute('panose'));
}
if (($oElementFont instanceof \DOMElement) && $oElementFont->hasAttribute('pitchFamily')) {
$oText->getFont()->setPitchFamily($oElementFont->getAttribute('pitchFamily'));
$oText->getFont()->setPitchFamily((int) $oElementFont->getAttribute('pitchFamily'));
}
if (($oElementFont instanceof \DOMElement) && $oElementFont->hasAttribute('charset')) {
$oText->getFont()->setCharset($oElementFont->getAttribute('charset'));
$oText->getFont()->setCharset((int) $oElementFont->getAttribute('charset'));
}
// Load shape effects
$oEffect = $document->getElement('a:effectLst', $oElementrPr);
Expand Down
Loading

0 comments on commit 36b2486

Please sign in to comment.