Feedbacks from @Progi1984

Progi1984 · Dec 15, 2023 · 038629c · 038629c
1 parent 0e5dd85
commit 038629c
Show file tree

Hide file tree

Showing 23 changed files with 607 additions and 280 deletions.
diff --git a/docs/changes/1.1.0.md b/docs/changes/1.1.0.md
@@ -17,9 +17,22 @@
     - 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)
+- Font : Replaced Superscript/Subscript by baseline in PowerPoint2007 Writer - [@devX2712](https://github.com/devX2712) in [#788](https://github.com/PHPOffice/PHPPresentation/pull/787)
 
 ## Bugfixes
 

diff --git a/docs/usage/presentation.md b/docs/usage/presentation.md
@@ -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
@@ -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

diff --git a/docs/usage/styles.md b/docs/usage/styles.md
@@ -97,12 +97,24 @@ echo $alignment->isRTL();
 - `name`
 - `bold`
 - `italic`
-- `superScript`
-- `subScript`
+- `superScript` (deprecated)
+- `subScript` (deprecated)
 - `underline`
 - `strikethrough`
 - `color`
-- `capitalization`
+- `pitchFamily`
+- `charset`
+
+### Baseline
+
+The baseline set the position relative to the line.
+The value is a percentage.
+
+You can use some predefined values :
+
+* `Font::BASELINE_SUPERSCRIPT` (= 30000 = 300%)
+* `Font::BASELINE_SUBSCRIPT` (= -25000 = -250%)
+
 
 ### Capitalization
 
@@ -145,6 +157,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`

diff --git a/samples/Sample_Header.php b/samples/Sample_Header.php
@@ -442,6 +442,7 @@ protected function displayShapeInfo(AbstractShape $oShape): void
                         $this->append('<abbr title="Italic">Italic</abbr> : ' . ($oRichText->getFont()->isItalic() ? 'Y' : 'N') . ' - ');
                         $this->append('<abbr title="Underline">Underline</abbr> : Underline::' . $this->getConstantName('\PhpOffice\PhpPresentation\Style\Font', $oRichText->getFont()->getUnderline()) . ' - ');
                         $this->append('<abbr title="Strikethrough">Strikethrough</abbr> : ' . ($oRichText->getFont()->isStrikethrough() ? 'Y' : 'N') . ' - ');
+                        $this->append('<abbr title="Baseline">Baseline</abbr> : ' . $oRichText->getFont()->getBaseline() . ' - ');
                         $this->append('<abbr title="SubScript">SubScript</abbr> : ' . ($oRichText->getFont()->isSubScript() ? 'Y' : 'N') . ' - ');
                         $this->append('<abbr title="SuperScript">SuperScript</abbr> : ' . ($oRichText->getFont()->isSuperScript() ? 'Y' : 'N'));
                         $this->append('</dd>');

diff --git a/src/PhpPresentation/DocumentProperties.php b/src/PhpPresentation/DocumentProperties.php
@@ -102,11 +102,18 @@ class DocumentProperties
     private $company;
 
     /**
-     * revision
+     * Revision.
      *
      * @var string
      */
     private $revision;
+
+    /**
+     * Status.
+     *
+     * @var string
+     */
+    private $status;
 
     /**
      * Custom Properties.
@@ -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()
     {
@@ -139,7 +139,7 @@ public function __construct()
         $this->category = '';
         $this->company = 'Microsoft Corporation';
         $this->revision = '';
-        $this->status         = '';
+        $this->status  = '';
     }
 
     /**
@@ -479,7 +479,7 @@ public function getRevision(): string
     }
 
     /**
-     * Set Revision
+     * Set Revision.
      */
     public function setRevision(string $pValue = ''): self
     {
@@ -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;
 

diff --git a/src/PhpPresentation/Exception/InvalidParameterException.php b/src/PhpPresentation/Exception/InvalidParameterException.php
@@ -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);
     }
 }
diff --git a/src/PhpPresentation/PresentationProperties.php b/src/PhpPresentation/PresentationProperties.php
@@ -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>
@@ -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;
@@ -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;
         }
@@ -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;
     }