Support for Visibility for slides

Author: Progi1984

CHANGELOG.md

@@ -22,6 +22,7 @@
 - ODPresentation & PowerPoint2007 & Serialized Writer : Support for Zip Adapter - @Progi1984 GH-176
 - ODPresentation & PowerPoint2007 Writer : language property to TextElement - @skrajewski & @Progi1984 GH-180
 - ODPresentation & PowerPoint2007 Writer : Add Font Support For Chart Axis - @jrking4 GH-186
+- ODPresentation & PowerPoint2007 Writer : Support for Visibility for slides - @Progi1984
 
 ## 0.6.0 - 2016-01-24
 

docs/slides.rst

@@ -6,12 +6,24 @@ Slides
 Slides are pages in a presentation. Slides are stored as a zero based array in ``PHPPresentation`` object. Use ``createSlide`` to create a new slide and retrieve the slide for other operation such as creating shapes for that slide.
 
 Name
--------
+----
 
 By default, a slide has not a name.
 You can define it with the method ``setName``.
 
 .. code-block:: php
 
 	$oSlide = $oPHPPresentation->createSlide();
-	$oSlide->setName('Title of the slide');
+	$oSlide->setName('Title of the slide');
+
+Visibility
+----------
+
+By default, a slide is visible.
+You can define it with the method ``setIsVisible``.
+
+.. code-block:: php
+
+	$oSlide = $oPHPPresentation->createSlide();
+	$oSlide->setIsVisible(false);
+	var_dump($oSlide->isVisible());

src/PhpPresentation/Slide.php

@@ -34,6 +34,12 @@
  */
 class Slide implements ComparableInterface, ShapeContainerInterface
 {
+    /**
+     * The slide is shown in presentation
+     * @var bool
+     */
+    protected $isVisible = true;
+
     /**
      * Parent presentation
      *
@@ -74,6 +80,7 @@ class Slide implements ComparableInterface, ShapeContainerInterface
      * @var \PhpOffice\PhpPresentation\Slide\Note
      */
     private $slideNote;
+
     /**
      *
      * @var \PhpOffice\PhpPresentation\Slide\Transition
@@ -515,4 +522,22 @@ public function setBackground(AbstractBackground $background = null)
         $this->background = $background;
         return $this;
     }
+
+    /**
+     * @return boolean
+     */
+    public function isVisible()
+    {
+        return $this->isVisible;
+    }
+
+    /**
+     * @param boolean $value
+     * @return Slide
+     */
+    public function setIsVisible($value = true)
+    {
+        $this->isVisible = (bool)$value;
+        return $this;
+    }
 }

src/PhpPresentation/Writer/ODPresentation/Content.php

@@ -1069,6 +1069,7 @@ public function writeStyleSlide(XMLWriter $objWriter, Slide $slide, $incPage)
         $objWriter->writeAttribute('style:name', 'stylePage'.$incPage);
         // style:style/style:drawing-page-properties
         $objWriter->startElement('style:drawing-page-properties');
+        $objWriter->writeAttributeIf(!$slide->isVisible(), 'presentation:visibility', 'hidden');
         if (!is_null($oTransition = $slide->getTransition())) {
             $objWriter->writeAttribute('presentation:duration', 'PT'.number_format($oTransition->getAdvanceTimeTrigger() / 1000, 6, '.', '').'S');
             if ($oTransition->hasManualTrigger()) {

src/PhpPresentation/Writer/PowerPoint2007/PptSlides.php

@@ -362,8 +362,9 @@ public function writeSlide(Slide $pSlide)
         $objWriter->writeAttribute('xmlns:a', 'http://schemas.openxmlformats.org/drawingml/2006/main');
         $objWriter->writeAttribute('xmlns:r', 'http://schemas.openxmlformats.org/officeDocument/2006/relationships');
         $objWriter->writeAttribute('xmlns:p', 'http://schemas.openxmlformats.org/presentationml/2006/main');
+        $objWriter->writeAttributeIf(!$pSlide->isVisible(), 'show', 0);
 
-        // p:cSld
+        // p:sld\p:cSld
         $objWriter->startElement('p:cSld');
 
         // Background

tests/PhpPresentation/Tests/SlideTest.php

@@ -118,4 +118,14 @@ public function testTransition()
         $this->assertInstanceOf('PhpOffice\\PhpPresentation\\Slide', $object->setTransition(null));
         $this->assertNull($object->getTransition());
     }
+
+    public function testVisible()
+    {
+        $object = new Slide();
+        $this->assertTrue($object->isVisible());
+        $this->assertInstanceOf('PhpOffice\\PhpPresentation\\Slide', $object->setIsVisible(false));
+        $this->assertFalse($object->isVisible());
+        $this->assertInstanceOf('PhpOffice\\PhpPresentation\\Slide', $object->setIsVisible());
+        $this->assertTrue($object->isVisible());
+    }
 }

tests/PhpPresentation/Tests/Writer/ODPresentation/ContentTest.php

@@ -809,4 +809,21 @@ public function testTransition()
         $pres = TestHelperDOCX::getDocument($phpPresentation, 'ODPresentation');
         $this->assertContains('manual', $pres->getElementAttribute($element, 'presentation:transition-type', 'content.xml'));
     }
+
+    public function testVisibility()
+    {
+        $expectedElement = '/office:document-content/office:automatic-styles/style:style[@style:name=\'stylePage0\']/style:drawing-page-properties';
+
+        $pres = TestHelperDOCX::getDocument($this->oPresentation, 'ODPresentation');
+        $this->assertTrue($pres->elementExists($expectedElement, 'content.xml'));
+        $this->assertFalse($pres->attributeElementExists($expectedElement, 'presentation:visibility', 'content.xml'));
+
+        $oSlide = $this->oPresentation->getActiveSlide();
+        $oSlide->setIsVisible(false);
+
+        $pres = TestHelperDOCX::getDocument($this->oPresentation, 'ODPresentation');
+        $this->assertTrue($pres->elementExists($expectedElement, 'content.xml'));
+        $this->assertTrue($pres->attributeElementExists($expectedElement, 'presentation:visibility', 'content.xml'));
+        $this->assertEquals('hidden', $pres->getElementAttribute($expectedElement, 'presentation:visibility', 'content.xml'));
+    }
 }

tests/PhpPresentation/Tests/Writer/PowerPoint2007/PptSlidesTest.php

@@ -946,4 +946,23 @@ public function testTransition()
         $pres = TestHelperDOCX::getDocument($oPhpPresentation, 'PowerPoint2007');
         $this->assertContains('1', $pres->getElementAttribute($element, 'advClick', 'ppt/slides/slide1.xml'));
     }
+
+    public function testVisibility()
+    {
+        $expectedElement = '/p:sld';
+
+        $oPhpPresentation = new PhpPresentation();
+
+        $pres = TestHelperDOCX::getDocument($oPhpPresentation, 'PowerPoint2007');
+        $this->assertTrue($pres->elementExists($expectedElement, 'ppt/slides/slide1.xml'));
+        $this->assertFalse($pres->attributeElementExists($expectedElement, 'show', 'ppt/slides/slide1.xml'));
+
+        $oSlide = $oPhpPresentation->getActiveSlide();
+        $oSlide->setIsVisible(false);
+
+        $pres = TestHelperDOCX::getDocument($oPhpPresentation, 'PowerPoint2007');
+        $this->assertTrue($pres->elementExists($expectedElement, 'ppt/slides/slide1.xml'));
+        $this->assertTrue($pres->attributeElementExists($expectedElement, 'show', 'ppt/slides/slide1.xml'));
+        $this->assertEquals(0, $pres->getElementAttribute($expectedElement, 'show', 'ppt/slides/slide1.xml'));
+    }
 }