#634 : Added ODFValidator

PHPOffice · Jul 8, 2021 · cb7d8bf · cb7d8bf
1 parent 743d0cf
commit cb7d8bf
Show file tree

Hide file tree

Showing 21 changed files with 283 additions and 109 deletions.
diff --git a/.github/workflows/odfvalidator.yml b/.github/workflows/odfvalidator.yml
@@ -0,0 +1,26 @@
+name: ODFValidator
+on: [push, pull_request]
+jobs:
+  php-cs-fixer:
+    name: ODFValidator
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '7.4'
+          extensions: mbstring, intl, gd, xml, dom, json, fileinfo, curl, zip, iconv
+      - uses: actions/checkout@v2
+
+      - name: Composer Install
+        run: composer install --ansi --prefer-dist --no-interaction --no-progress
+
+      - name: Generate samples files
+        run: composer run samples
+
+      - name: Download ODFValidator
+        run: wget https://repo1.maven.org/maven2/org/odftoolkit/odfvalidator/1.0.0-BETA1/odfvalidator-1.0.0-BETA1-jar-with-dependencies.jar
+
+      # https://odftoolkit.org/conformance/ODFValidator.html#what-is-checked
+      - name: Validate documents (ODF 1.2)
+        run: java -jar odfvalidator-1.0.0-BETA1-jar-with-dependencies.jar -1.2 -r samples/results/ 
diff --git a/composer.json b/composer.json
@@ -37,5 +37,31 @@
         "psr-4": {
             "PhpOffice\\PhpPresentation\\": "src/PhpPresentation/"
         }
+    },
+    "scripts": {
+        "samples": [
+            "php samples/Sample_01_Complex.php",
+            "php samples/Sample_01_Simple.php",
+            "php samples/Sample_03_Image.php",
+            "php samples/Sample_03_Video.php",
+            "php samples/Sample_04_Table.php",
+            "php samples/Sample_05_Chart_Line.php",
+            "php samples/Sample_05_Chart.php",
+            "php samples/Sample_05_Chart_with_PhpSpreadsheet.php",
+            "php samples/Sample_06_Fill.php",
+            "php samples/Sample_07_Border.php",
+            "php samples/Sample_08_Group.php",
+            "php samples/Sample_09_SlideNote.php",
+            "php samples/Sample_10_Transition.php",
+            "php samples/Sample_11_Shape.php",
+            "php samples/Sample_13_MarkAsFinal.php",
+            "php samples/Sample_14_Zoom.php",
+            "php samples/Sample_15_Background.php",
+            "php samples/Sample_16_Thumbnail.php",
+            "php samples/Sample_17_Comment.php",
+            "php samples/Sample_18_Animation.php",
+            "php samples/Sample_19_SlideMaster.php",
+            "php samples/Sample_20_ExternalSlide.php"
+        ]
     }
 }
diff --git a/samples/Sample_01_Simple.php b/samples/Sample_01_Simple.php
@@ -29,7 +29,7 @@
 $shape = $currentSlide->createDrawingShape();
 $shape->setName('PHPPresentation logo')
     ->setDescription('PHPPresentation logo')
-    ->setPath('./resources/phppowerpoint_logo.gif')
+    ->setPath(__DIR__ . '/resources/phppowerpoint_logo.gif')
     ->setHeight(36)
     ->setOffsetX(10)
     ->setOffsetY(10);

diff --git a/samples/Sample_02_Serialized.php b/samples/Sample_02_Serialized.php
@@ -30,7 +30,7 @@
 $shape = $currentSlide->createDrawingShape();
 $shape->setName('PHPPresentation logo')
     ->setDescription('PHPPresentation logo')
-    ->setPath('./resources/phppowerpoint_logo.gif')
+    ->setPath(__DIR__ . '/resources/phppowerpoint_logo.gif')
     ->setHeight(36)
     ->setOffsetX(10)
     ->setOffsetY(10);

diff --git a/samples/Sample_03_Image.php b/samples/Sample_03_Image.php
@@ -37,7 +37,7 @@
 $shape = new Drawing\File();
 $shape->setName('PHPPresentation logo')
     ->setDescription('PHPPresentation logo')
-    ->setPath('./resources/phppowerpoint_logo.gif')
+    ->setPath(__DIR__ . '/resources/phppowerpoint_logo.gif')
     ->setHeight(36)
     ->setOffsetX(10)
     ->setOffsetY(100);
@@ -47,7 +47,7 @@
 $shape = new Drawing\ZipFile();
 $shape->setName('PHPPresentation logo')
     ->setDescription('PHPPresentation logo')
-    ->setPath('zip://./resources/Sample_12.pptx#ppt/media/phppowerpoint_logo1.gif')
+    ->setPath('zip://' . __DIR__ . '/resources/Sample_12.pptx#ppt/media/phppowerpoint_logo1.gif')
     ->setResizeProportional(false)
     ->setHeight(36)
     ->setWidth(36)
@@ -74,7 +74,7 @@
 $shape = new Drawing\File();
 $shape->setName('PHPPresentation logo')
     ->setDescription('PHPPresentation logo')
-    ->setPath('./resources/logo_ubuntu_transparent.png')
+    ->setPath(__DIR__ . '/resources/logo_ubuntu_transparent.png')
     ->setHeight(100)
     ->setOffsetX(10)
     ->setOffsetY(250)

diff --git a/samples/Sample_03_Video.php b/samples/Sample_03_Video.php
@@ -17,7 +17,10 @@
 $shape = new Media();
 $shape->setName('Video')
     ->setDescription('Video')
-    ->setPath('WIN' === strtoupper(substr(PHP_OS, 0, 3)) ? './resources/sintel_trailer-480p.wmv' : './resources/sintel_trailer-480p.ogv')
+    ->setPath(
+        __DIR__ . '/resources/sintel_trailer-480p' .
+        ('WIN' === strtoupper(substr(PHP_OS, 0, 3)) ? '.wmv' : '.ogv')
+    )
     ->setResizeProportional(false)
     ->setHeight(90)
     ->setWidth(90)

diff --git a/samples/Sample_08_Group.php b/samples/Sample_08_Group.php
@@ -29,7 +29,7 @@
 $shape = $currentGroup->createDrawingShape();
 $shape->setName('PHPPresentation logo')
     ->setDescription('PHPPresentation logo')
-    ->setPath('./resources/phppowerpoint_logo.gif')
+    ->setPath(__DIR__ . '/resources/phppowerpoint_logo.gif')
     ->setHeight(36)
     ->setOffsetX(10)
     ->setOffsetY(10);

diff --git a/samples/Sample_09_SlideNote.php b/samples/Sample_09_SlideNote.php
@@ -24,7 +24,7 @@
 $shape = $currentSlide->createDrawingShape();
 $shape->setName('PHPPresentation logo')
     ->setDescription('PHPPresentation logo')
-    ->setPath('./resources/phppowerpoint_logo.gif')
+    ->setPath(__DIR__ . '/resources/phppowerpoint_logo.gif')
     ->setHeight(36)
     ->setOffsetX(10)
     ->setOffsetY(10);

diff --git a/samples/Sample_10_Transition.php b/samples/Sample_10_Transition.php
@@ -30,7 +30,7 @@
 $shapeDrawing = $slide0->createDrawingShape();
 $shapeDrawing->setName('PHPPresentation logo')
     ->setDescription('PHPPresentation logo')
-    ->setPath('./resources/phppowerpoint_logo.gif')
+    ->setPath(__DIR__ . '/resources/phppowerpoint_logo.gif')
     ->setHeight(36)
     ->setOffsetX(10)
     ->setOffsetY(10);

diff --git a/samples/Sample_13_MarkAsFinal.php b/samples/Sample_13_MarkAsFinal.php
@@ -9,7 +9,7 @@
 $objPHPPresentation = new PhpPresentation();
 
 // Mark the document as final
-$objPHPPresentation->markAsFinal(true);
+$objPHPPresentation->getPresentationProperties()->markAsFinal(true);
 
 // Create slide
 echo date('H:i:s') . ' Create slide' . EOL;

diff --git a/samples/Sample_15_Background.php b/samples/Sample_15_Background.php
@@ -33,7 +33,7 @@
  * @link : http://publicdomainarchive.com/public-domain-images-cave-red-rocks-light-beam-cavern/
  */
 $oBkgImage = new Image();
-$oBkgImage->setPath('./resources/background.jpg');
+$oBkgImage->setPath(__DIR__ . '/resources/background.jpg');
 $oSlide2->setBackground($oBkgImage);
 
 // Save file

diff --git a/samples/Sample_19_SlideMaster.php b/samples/Sample_19_SlideMaster.php
@@ -80,7 +80,7 @@
 $shape = $currentSlide->createDrawingShape();
 $shape->setName('PHPPresentation logo')
     ->setDescription('PHPPresentation logo')
-    ->setPath('./resources/phppowerpoint_logo.gif')
+    ->setPath(__DIR__ . '/resources/phppowerpoint_logo.gif')
     ->setHeight(36)
     ->setOffsetX(10)
     ->setOffsetY(10);

diff --git a/samples/Sample_Header.php b/samples/Sample_Header.php
@@ -45,11 +45,6 @@
 // Set writers
 $writers = ['PowerPoint2007' => 'pptx', 'ODPresentation' => 'odp'];
 
-// Return to the caller script when runs by CLI
-if (CLI) {
-    return;
-}
-
 // Set titles and names
 $pageHeading = str_replace('_', ' ', SCRIPT_FILENAME);
 $pageTitle = IS_INDEX ? 'Welcome to ' : "{$pageHeading} - ";
@@ -59,7 +54,7 @@
 $oShapeDrawing = new Drawing\File();
 $oShapeDrawing->setName('PHPPresentation logo')
     ->setDescription('PHPPresentation logo')
-    ->setPath('./resources/phppowerpoint_logo.gif')
+    ->setPath(__DIR__ . '/resources/phppowerpoint_logo.gif')
     ->setHeight(36)
     ->setOffsetX(10)
     ->setOffsetY(10);
@@ -80,6 +75,11 @@
     ->setSize(60)
     ->setColor(new Color('FFE06B20'));
 
+// Return to the caller script when runs by CLI
+if (CLI) {
+    return;
+}
+
 // Populate samples
 $files = [];
 if ($handle = opendir('.')) {
@@ -183,7 +183,7 @@ function createTemplatedSlide(PhpOffice\PhpPresentation\PhpPresentation $objPHPP
     $shape = $slide->createDrawingShape();
     $shape->setName('PHPPresentation logo')
         ->setDescription('PHPPresentation logo')
-        ->setPath('./resources/phppowerpoint_logo.gif')
+        ->setPath(__DIR__ . '/resources/phppowerpoint_logo.gif')
         ->setHeight(36)
         ->setOffsetX(10)
         ->setOffsetY(10);

diff --git a/samples/results/.gitkeep b/samples/results/.gitkeep