Merge pull request #204 from Progi1984/issue120

#120 : Presentation with predefined View Type

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
+- PowerPoint2007 Writer : Presentation with predefined View Type - @Progi1984 GH-120
 
 ## 0.6.0 - 2016-01-24
 

docs/general.rst

@@ -75,6 +75,41 @@ Presentation Properties
 
 You can define some properties which are relative to the presentation, like the zoom or the thumbnail.
 
+Comments
+````````
+
+You can define if the presentation display or not the comments with the method ``setCommentVisible``.
+
+.. code-block:: php
+
+    $oPresentation = new PhpPresentation();
+    $oProperties = $oPresentation->getPresentationProperties();
+    // Get the display for comment
+    var_export($oProperties->isCommentVisible());
+    // Output : false
+    // Enable the display for comment
+    $oProperties->setCommentVisible(true);
+    // Get the display for comment
+    var_export($oProperties->isCommentVisible());
+    // Output : true
+
+Last View
+`````````
+
+You can define the last view of the presentation with the method ``setLastView``.
+
+.. code-block:: php
+
+    $oPresentation = new PhpPresentation();
+    $oProperties = $oPresentation->getPresentationProperties();
+    // Get the last view of the presentation
+    echo $oProperties->getZoom();
+    // Output : PresentationProperties::VIEW_SLIDE
+    // Set the last view of the presentation
+    $oProperties->setLastView(PresentationProperties::VIEW_NOTES);
+    // Get the last view of the presentation
+    echo $oProperties->getZoom();
+    // Output : PresentationProperties::VIEW_NOTES
 
 Thumbnail
 `````````
@@ -99,7 +134,11 @@ You can define the zoom of the presentation with the method ``setZoom``.
 
     $oPresentation = new PhpPresentation();
     $oProperties = $oPresentation->getPresentationProperties();
+    // Get zoom of the presentation
+    echo $oProperties->getZoom();
+    // Output : 1
     // Set zoom of the presentation (3 = 300%)
     $oProperties->setZoom(3);
     // Get zoom of the presentation
     echo $oProperties->getZoom();
+    // Output : 3

src/PhpPresentation/PhpPresentation.php

@@ -30,35 +30,35 @@ class PhpPresentation
      *
      * @var \PhpOffice\PhpPresentation\DocumentProperties
      */
-    private $documentProperties;
-    
+    protected $documentProperties;
+
     /**
      * Presentation properties
      *
      * @var \PhpOffice\PhpPresentation\PresentationProperties
      */
-    private $presentationProperties;
+    protected $presentationProps;
 
     /**
      * Document layout
      *
      * @var \PhpOffice\PhpPresentation\DocumentLayout
      */
-    private $layout;
+    protected $layout;
 
     /**
      * Collection of Slide objects
      *
      * @var \PhpOffice\PhpPresentation\Slide[]
      */
-    private $slideCollection = array();
+    protected $slideCollection = array();
 
     /**
      * Active slide index
      *
      * @var int
      */
-    private $activeSlideIndex = 0;
+    protected $activeSlideIndex = 0;
 
     /**
      * Create a new PhpPresentation with one Slide
@@ -128,7 +128,7 @@ public function setDocumentProperties(DocumentProperties $value)
      */
     public function getPresentationProperties()
     {
-        return $this->presentationProperties;
+        return $this->presentationProps;
     }
 
     /**
@@ -139,7 +139,7 @@ public function getPresentationProperties()
      */
     public function setPresentationProperties(PresentationProperties $value)
     {
-        $this->presentationProperties = $value;
+        $this->presentationProps = $value;
         return $this;
     }
 

src/PhpPresentation/PresentationProperties.php

@@ -21,6 +21,26 @@
  */
 class PresentationProperties
 {
+    const VIEW_HANDOUT = 'handoutView';
+    const VIEW_NOTES = 'notesView';
+    const VIEW_NOTES_MASTER = 'notesMasterView';
+    const VIEW_OUTLINE = 'outlineView';
+    const VIEW_SLIDE = 'sldView';
+    const VIEW_SLIDE_MASTER = 'sldMasterView';
+    const VIEW_SLIDE_SORTER = 'sldSorterView';
+    const VIEW_SLIDE_THUMBNAIL = 'sldThumbnailView';
+
+    protected $arrayView = array(
+        self::VIEW_HANDOUT,
+        self::VIEW_NOTES,
+        self::VIEW_NOTES_MASTER,
+        self::VIEW_OUTLINE,
+        self::VIEW_SLIDE,
+        self::VIEW_SLIDE_MASTER,
+        self::VIEW_SLIDE_SORTER,
+        self::VIEW_SLIDE_THUMBNAIL,
+    );
+
     /*
      * @var boolean
      */
@@ -42,6 +62,16 @@ class PresentationProperties
      * @var float
      */
     protected $zoom = 1;
+
+    /*
+     * @var boolean
+     */
+    protected $lastView = self::VIEW_SLIDE;
+
+    /*
+     * @var boolean
+     */
+    protected $isCommentVisible = false;
 
     /**
      * @return bool
@@ -128,4 +158,44 @@ public function getZoom()
     {
         return $this->zoom;
     }
+
+    /**
+     * @param string $value
+     * @return $this
+     */
+    public function setLastView($value = self::VIEW_SLIDE)
+    {
+        if (in_array($value, $this->arrayView)) {
+            $this->lastView = $value;
+        }
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getLastView()
+    {
+        return $this->lastView;
+    }
+
+    /**
+     * @param bool $value
+     * @return $this
+     */
+    public function setCommentVisible($value = false)
+    {
+        if (is_bool($value)) {
+            $this->isCommentVisible = $value;
+        }
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function isCommentVisible()
+    {
+        return $this->isCommentVisible;
+    }
 }

src/PhpPresentation/Writer/PowerPoint2007/PptViewProps.php

@@ -21,7 +21,8 @@ public function render()
         $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->writeAttribute('showComments', '0');
+        $objWriter->writeAttribute('showComments', $this->getPresentation()->getPresentationProperties()->isCommentVisible() ? 1 : 0);
+        $objWriter->writeAttribute('lastView', $this->getPresentation()->getPresentationProperties()->getLastView());
 
         // p:viewPr > p:slideViewPr
         $objWriter->startElement('p:slideViewPr');

tests/PhpPresentation/Tests/PhpPresentationTest.php

@@ -20,6 +20,7 @@
 use PhpOffice\PhpPresentation\DocumentLayout;
 use PhpOffice\PhpPresentation\DocumentProperties;
 use PhpOffice\PhpPresentation\PhpPresentation;
+use PhpOffice\PhpPresentation\PresentationProperties;
 
 /**
  * Test class for PhpPresentation
@@ -59,6 +60,14 @@ public function testProperties()
         $this->assertInstanceOf('PhpOffice\\PhpPresentation\\DocumentProperties', $object->getDocumentProperties());
     }
 
+    public function testPresentationProperties()
+    {
+        $object = new PhpPresentation();
+        $this->assertInstanceOf('PhpOffice\\PhpPresentation\\PresentationProperties', $object->getPresentationProperties());
+        $this->assertInstanceOf('PhpOffice\\PhpPresentation\\PhpPresentation', $object->setPresentationProperties(new PresentationProperties()));
+        $this->assertInstanceOf('PhpOffice\\PhpPresentation\\PresentationProperties', $object->getPresentationProperties());
+    }
+
     /**
      * Test add external slide
      */

tests/PhpPresentation/Tests/PresentationPropertiesTest.php

@@ -26,6 +26,20 @@
  */
 class PresentationPropertiesTest extends \PHPUnit_Framework_TestCase
 {
+    public function testCommentVisible()
+    {
+        $object = new PresentationProperties();
+        $this->assertFalse($object->isCommentVisible());
+        $this->assertInstanceOf('PhpOffice\\PhpPresentation\\PresentationProperties', $object->setCommentVisible('AAAA'));
+        $this->assertFalse($object->isCommentVisible());
+        $this->assertInstanceOf('PhpOffice\\PhpPresentation\\PresentationProperties', $object->setCommentVisible(true));
+        $this->assertTrue($object->isCommentVisible());
+        $this->assertInstanceOf('PhpOffice\\PhpPresentation\\PresentationProperties', $object->setCommentVisible(false));
+        $this->assertFalse($object->isCommentVisible());
+        $this->assertInstanceOf('PhpOffice\\PhpPresentation\\PresentationProperties', $object->setCommentVisible());
+        $this->assertFalse($object->isCommentVisible());
+    }
+
     public function testLoopUntilEsc()
     {
         $object = new PresentationProperties();
@@ -40,6 +54,18 @@ public function testLoopUntilEsc()
         $this->assertFalse($object->isLoopContinuouslyUntilEsc());
     }
 
+    public function testLastView()
+    {
+        $object = new PresentationProperties();
+        $this->assertEquals(PresentationProperties::VIEW_SLIDE, $object->getLastView());
+        $this->assertInstanceOf('PhpOffice\\PhpPresentation\\PresentationProperties', $object->setLastView('AAAA'));
+        $this->assertEquals(PresentationProperties::VIEW_SLIDE, $object->getLastView());
+        $this->assertInstanceOf('PhpOffice\\PhpPresentation\\PresentationProperties', $object->setLastView(PresentationProperties::VIEW_OUTLINE));
+        $this->assertEquals(PresentationProperties::VIEW_OUTLINE, $object->getLastView());
+        $this->assertInstanceOf('PhpOffice\\PhpPresentation\\PresentationProperties', $object->setLastView());
+        $this->assertEquals(PresentationProperties::VIEW_SLIDE, $object->getLastView());
+    }
+
     public function testMarkAsFinal()
     {
         $object = new PresentationProperties();

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

@@ -9,6 +9,7 @@
 namespace PhpPresentation\Tests\Writer\PowerPoint2007;
 
 use PhpOffice\PhpPresentation\PhpPresentation;
+use PhpOffice\PhpPresentation\PresentationProperties;
 use PhpOffice\PhpPresentation\Tests\TestHelperDOCX;
 
 class PptViewPropsTest extends \PHPUnit_Framework_TestCase
@@ -23,12 +24,41 @@ public function tearDown()
 
     public function testRender()
     {
+        $expectedElement = '/p:viewPr';
+
+        $oPhpPresentation = new PhpPresentation();
+
+        $oXMLDoc = TestHelperDOCX::getDocument($oPhpPresentation, 'PowerPoint2007');
+        $this->assertTrue($oXMLDoc->fileExists('ppt/viewProps.xml'));
+        $this->assertTrue($oXMLDoc->elementExists($expectedElement, 'ppt/viewProps.xml'));
+        $this->assertEquals('0', $oXMLDoc->getElementAttribute($expectedElement, 'showComments', 'ppt/viewProps.xml'));
+        $this->assertEquals(PresentationProperties::VIEW_SLIDE, $oXMLDoc->getElementAttribute($expectedElement, 'lastView', 'ppt/viewProps.xml'));
+    }
+
+    public function testCommentVisible()
+    {
+        $expectedElement ='/p:viewPr';
+
+        $oPhpPresentation = new PhpPresentation();
+        $oPhpPresentation->getPresentationProperties()->setCommentVisible(true);
+
+        $oXMLDoc = TestHelperDOCX::getDocument($oPhpPresentation, 'PowerPoint2007');
+        $this->assertTrue($oXMLDoc->fileExists('ppt/viewProps.xml'));
+        $this->assertTrue($oXMLDoc->elementExists($expectedElement, 'ppt/viewProps.xml'));
+        $this->assertEquals(1, $oXMLDoc->getElementAttribute($expectedElement, 'showComments', 'ppt/viewProps.xml'));
+    }
+
+    public function testLastView()
+    {
+        $expectedElement ='/p:viewPr';
+        $expectedLastView = PresentationProperties::VIEW_OUTLINE;
+
         $oPhpPresentation = new PhpPresentation();
+        $oPhpPresentation->getPresentationProperties()->setLastView($expectedLastView);
 
         $oXMLDoc = TestHelperDOCX::getDocument($oPhpPresentation, 'PowerPoint2007');
         $this->assertTrue($oXMLDoc->fileExists('ppt/viewProps.xml'));
-        $element = '/p:viewPr';
-        $this->assertTrue($oXMLDoc->elementExists($element, 'ppt/viewProps.xml'));
-        $this->assertEquals('0', $oXMLDoc->getElementAttribute($element, 'showComments', 'ppt/viewProps.xml'));
+        $this->assertTrue($oXMLDoc->elementExists($expectedElement, 'ppt/viewProps.xml'));
+        $this->assertEquals($expectedLastView, $oXMLDoc->getElementAttribute($expectedElement, 'lastView', 'ppt/viewProps.xml'));
     }
 }