Merge remote-tracking branch 'upstream/develop' into develop

Author: Progi1984

CHANGELOG.md

@@ -13,6 +13,7 @@
 - PhpOffice\PhpPresentation\Shape\Type\AbstracType\setData has been deprecated for PhpOffice\PhpPresentation\Shape\Type\AbstracType\setSeries - @Progi1984 GH-169
 - Added documentation for chart series (font, outline, marker) - @Progi1984 GH-169
 - Internal Structure for Drawing Shape - @Progi1984 GH-192
+- Documentation about manual installation - @danielbair GH-254
 
 ### Features
 - ODPresentation & PowerPoint2007 Writer : Add support for Comment - @Progi1984 GH-116

README.md

@@ -48,6 +48,8 @@ PHPPresentation requires the following:
 
 ### Installation
 
+#### Composer method
+
 It is recommended that you install the PHPPresentation library [through composer](http://getcomposer.org/). To do so, add
 the following lines to your ``composer.json``.
 
@@ -59,14 +61,25 @@ the following lines to your ``composer.json``.
 }
 ```
 
-Alternatively, you can download the latest release from the [releases page](https://github.com/PHPOffice/PHPPresentation/releases).
-In this case, you will have to register the autoloader. Register autoloading is required only if you do not use composer in your project.
+#### Manual download method
+
+Alternatively, you can download the latest release from the [releases page](https://github.com/PHPOffice/PHPPresentation/releases).  
+In this case, you will have to register the autoloader.  
+(Register autoloading is required only if you do not use composer in your project.)
 
 ```php
 require_once 'path/to/PhpPresentation/src/PhpPresentation/Autoloader.php';
 \PhpOffice\PhpPresentation\Autoloader::register();
 ```
 
+You will also need to download the latest PHPOffice/Common release from its [releases page](https://github.com/PHPOffice/Common/releases).  
+And you will also have to register its autoloader, too. 
+
+```php
+require_once 'path/to/PhpOffice/Common/src/Common/Autoloader.php';
+\PhpOffice\Common\Autoloader::register();
+```
+
 ## Getting started
 
 The following is a basic usage example of the PHPPresentation library.
@@ -75,6 +88,8 @@ The following is a basic usage example of the PHPPresentation library.
 // with your own install
 require_once 'src/PhpPresentation/Autoloader.php';
 \PhpOffice\PhpPresentation\Autoloader::register();
+require_once 'src/Common/Autoloader.php';
+\PhpOffice\Common\Autoloader::register();
 
 // with Composer
 require_once 'vendor/autoload.php';

docs/credits.rst

@@ -3,4 +3,6 @@
 Credits
 =======
 
-	Images from chart page come from the `LibreOffice Core <https://github.com/LibreOffice/core/tree/master/icon-themes/galaxy/chart2/res>`.
+	Images from chart page come from the `LibreOffice Core <https://github.com/LibreOffice/core/tree/master/icon-themes/galaxy/chart2/res>`.
+
+    Some definitions come from the `Office Open XML <http://officeopenxml.com/>`.

docs/slides_layout.rst

@@ -0,0 +1,50 @@
+.. _slides_layout:
+
+Slides Layout
+=============
+
+A slide is a hierarchy of three components :
+- The master slide upon which the slide is based : it specifies such properties as the font styles for the title, body, and footer, placeholder positions for text and objects, bullets styles, and background ;
+- The slide layout which is applied to the the slide : it permits to override what is specified in the master slide ;
+- The slide itself : it contains content and formatting that is not already specified by the master slide and the slide layout
+
+Placeholders permit to link these three components together in order that the override is possible.
+
+Master slides
+-------------
+
+You can access to all master slides with the method ``getAllMasterSlides`` or create one with ``createMasterSlide``.
+
+.. code-block:: php
+
+    $arraySlideMasters = $oPHPPresentation->getAllMasterSlides();
+    $oMasterSlide = $oPHPPresentation->createMasterSlide();
+
+Slides Layout
+-------------
+
+You can access to all slide layout from a master with the method ``getAllSlideLayouts`` or create one with ``createSlideLayout``.
+
+.. code-block:: php
+
+    $arraySlideLayouts = $oMasterSlide->getAllSlideLayouts();
+    $oSlideLayout = $oMasterSlide->createSlideLayout();
+
+Placeholders
+------------
+
+For each master slide or slide layout, you can add any shape like on a slide.
+
+.. code-block:: php
+
+    $oShape = $oMasterSlide->createChartShape();
+    $oShape = $oSlideLayout->createTableShape();
+
+You can define a shape as a placeholder for each level with the method ``setPlaceHolder``.
+A shape defined in each level will have an override for its formatting in each level.
+
+.. code-block:: php
+
+    use PhpOffice\PhpPresentation\Shape\Placeholder;
+    $oShape->setPlaceHolder(new Placeholder(Placeholder::PH_TYPE_TITLE));
+

phpmd.xml.dist

@@ -18,8 +18,9 @@
     <rule ref="rulesets/design.xml/DepthOfInheritance" />
     <rule ref="rulesets/design.xml/CouplingBetweenObjects">
         <!-- PptSlides needs more coupling (default: 13) -->
-        <properties>
-            <property name="minimum" value="30" />
+        <!-- Writer/Office2007/AbstractSlide needs more coupling (default: 13) -->
+		<properties>
+            <property name="minimum" value="31" />
         </properties>
     </rule>
     <rule ref="rulesets/design.xml/NumberOfChildren">

samples/Sample_19_SlideMaster.php

@@ -26,14 +26,15 @@
 $currentSlide = $objPHPPresentation->getActiveSlide();
 
 // Create a master layout
-echo date('H:i:s') . ' Create masterslide' . EOL;
+echo date('H:i:s') . ' Create masterslide layout' . EOL;
 // Some decorative lines
 $oMasterSlide = $objPHPPresentation->getAllMasterSlides()[0];
 $shape = $oMasterSlide->createLineShape(0, 670, 960, 670)->getBorder()->setColor(new Color(Color::COLOR_RED))->setLineWidth(2);
 $shape = $oMasterSlide->createLineShape(0, 672, 960, 672)->getBorder()->setColor(new Color(Color::COLOR_WHITE))->setLineWidth(2);
 $shape = $oMasterSlide->createLineShape(0, 674, 960, 674)->getBorder()->setColor(new Color(Color::COLOR_DARKBLUE))->setLineWidth(2);
 // Title placeholder
-$shape = $oMasterSlide->createRichTextShape()->setWidthAndHeight(960, 80)->setOffsetX(0)->setOffsetY(60);
+$shape = $oMasterSlide->createRichTextShape();
+$shape->setWidthAndHeight(960, 80)->setOffsetX(0)->setOffsetY(60);
 $shape->getFill()->setFillType(Fill::FILL_SOLID)->setStartColor(new Color(Color::COLOR_BLUE));
 $shape->getActiveParagraph()->getAlignment()
     ->setHorizontal(Alignment::HORIZONTAL_RIGHT)->setMarginLeft(200)->setMarginRight(50)
@@ -46,23 +47,26 @@
 $textRun->getFont()->setBold(true)->setSize(30)->setColor(new Color(Color::COLOR_WHITE));
 $shape->setPlaceHolder(new Placeholder(Placeholder::PH_TYPE_TITLE));
 // Date placeholder
-$shape = $oMasterSlide->createRichTextShape()->setWidthAndHeight(140, 38)->setOffsetX(50)->setOffsetY(680);
+$shape = $oMasterSlide->createRichTextShape();
+$shape->setWidthAndHeight(140, 38)->setOffsetX(50)->setOffsetY(680);
 $shape->getActiveParagraph()->getAlignment()
     ->setHorizontal(Alignment::HORIZONTAL_LEFT)
     ->setVertical(Alignment::VERTICAL_BASE);
 $shape->setAutoFit(RichText::AUTOFIT_NORMAL);
 $textRun = $shape->createTextRun('01-02-2000')->getFont()->setSize(18);
 $shape->setPlaceHolder(new Placeholder(Placeholder::PH_TYPE_DATETIME))->getPlaceholder()->setIdx(10);
 // Footer placeholder
-$shape = $oMasterSlide->createRichTextShape()->setWidthAndHeight(468, 38)->setOffsetX(246)->setOffsetY(680);
+$shape = $oMasterSlide->createRichTextShape();
+$shape->setWidthAndHeight(468, 38)->setOffsetX(246)->setOffsetY(680);
 $shape->getActiveParagraph()->getAlignment()
     ->setHorizontal(Alignment::HORIZONTAL_CENTER)
     ->setVertical(Alignment::VERTICAL_BASE);
 $shape->setAutoFit(RichText::AUTOFIT_NORMAL);
 $textRun = $shape->createTextRun('Placeholder for Footer')->getFont()->setSize(18);
 $shape->setPlaceHolder(new Placeholder(Placeholder::PH_TYPE_FOOTER))->getPlaceholder()->setIdx(11);
 // Slidenumber placeholder
-$shape = $oMasterSlide->createRichTextShape()->setWidthAndHeight(140, 38)->setOffsetX(770)->setOffsetY(680);
+$shape = $oMasterSlide->createRichTextShape();
+$shape->setWidthAndHeight(140, 38)->setOffsetX(770)->setOffsetY(680);
 $shape->getActiveParagraph()->getAlignment()
     ->setHorizontal(Alignment::HORIZONTAL_RIGHT)
     ->setVertical(Alignment::VERTICAL_BASE);
@@ -86,14 +90,20 @@
 
 // Create a shape (text) linked to a PlaceHolder
 echo date('H:i:s') . ' Create a shape (rich text)' . EOL;
-$shape = $currentSlide->createRichTextShape()->setWidthAndHeight(960, 80)->setOffsetX(0)->setOffsetY(60);
+$shape = $currentSlide->createRichTextShape();
+$shape->setWidthAndHeight(960, 80)->setOffsetX(0)->setOffsetY(60);
 $shape->getFill()->setFillType(Fill::FILL_SOLID)->setStartColor(new Color(Color::COLOR_BLUE));
 $shape->getActiveParagraph()->getAlignment()
     ->setHorizontal(Alignment::HORIZONTAL_RIGHT)->setMarginLeft(200)->setMarginRight(50)
     ->setVertical(Alignment::VERTICAL_CENTER);
 $shape->setAutoFit(RichText::AUTOFIT_NORMAL);
 $shape->setPlaceHolder(new Placeholder(Placeholder::PH_TYPE_TITLE));
 
+echo date('H:i:s') . ' Apply the shape collection of the slide master to the slide layout' . EOL;
+$oSlideLayout = $oMasterSlide->getAllSlideLayouts()[0];
+$oSlideLayout->setShapeCollection($oMasterSlide->getShapeCollection());
+$currentSlide->setSlideLayout($oSlideLayout);
+
 // Save file
 echo write($objPHPPresentation, basename(__FILE__, '.php'), $writers);
 if (!CLI) {

src/PhpPresentation/Reader/PowerPoint2007.php

@@ -17,8 +17,6 @@
 
 namespace PhpOffice\PhpPresentation\Reader;
 
-/** This file will be edited to also read slideLayout things */
-
 use PhpOffice\PhpPresentation\Shape\RichText\Paragraph;
 use PhpOffice\PhpPresentation\Slide\AbstractSlide;
 use PhpOffice\PhpPresentation\Shape\Placeholder;

src/PhpPresentation/Reader/ReaderInterface.php

@@ -34,6 +34,7 @@ public function canRead($pFilename);
      * Loads PhpPresentation from file
      *
      * @param  string    $pFilename
+     * @return \PhpOffice\PhpPresentation\PhpPresentation
      * @throws \Exception
      */
     public function load($pFilename);

src/PhpPresentation/Shape/Line.php

@@ -43,7 +43,6 @@ public function __construct($fromX, $fromY, $toX, $toY)
         $this->setOffsetY($fromY);
         $this->setWidth($toX - $fromX);
         $this->setHeight($toY - $fromY);
-
     }
 
     /**

src/PhpPresentation/Slide/AbstractSlide.php

@@ -106,6 +106,17 @@ public function getShapeCollection()
         return $this->shapeCollection;
     }
 
+    /**
+     * Get collection of shapes
+     *
+     * @return AbstractSlide
+     */
+    public function setShapeCollection($shapeCollection = array())
+    {
+        $this->shapeCollection = $shapeCollection;
+        return $this;
+    }
+
     /**
      * Add shape to slide
      *