Merge pull request #189 from Progi1984/issue116

#116 : Support for Comments

Author: Progi1984

CHANGELOG.md

@@ -9,6 +9,7 @@
 - PhpOffice\PhpPresentation\Writer\PowerPoint2007 : Move to Design Pattern Decorator - @Progi1984
 
 ### Features
+- ODPresentation / PowerPoint2007 Writer : Add support for Comment - @Progi1984 GH-116
 - ODPresentation Writer : Thumbnail of the presentation - @Progi1984 GH-125
 - PowerPoint2007 Writer : Thumbnail of the presentation - @Progi1984 GH-125
 - ODPresentation Writer : Add Font Support For Chart Axis - @jrking4 GH-186

docs/index.rst

@@ -33,6 +33,7 @@ PHPPresentation is a library written in pure PHP that provides a set of classes
    :caption: Shapes
 
    shapes_chart
+   shapes_comment
    shapes_table
 
 Indices and tables

docs/shapes.rst

@@ -64,7 +64,12 @@ To create a line, use `createLineShape` method of slide.
 Chart
 -------
 
-The Chart has now :ref:`its own page <shapes_chart>`. 
+The Chart has now :ref:`its own page <shapes_chart>`.
+
+Comment
+-------
+
+The Comment has now :ref:`its own page <shapes_comment>`.
 
 Drawing
 -------

docs/shapes_chart.rst

@@ -12,7 +12,7 @@ Example:
 	$chartShape = $slide->createChartShape();
 	
 Parts
--------
+-----
 
 Title
 ^^^^^
@@ -29,7 +29,7 @@ For hiding it, you define its visibility to false.
 	$oShape->getTitle()->setVisible(false);
 	
 Types
--------
+-----
 
 Area
 ^^^^

docs/shapes_comment.rst

@@ -0,0 +1,62 @@
+.. _shapes_chart:
+
+Comments
+========
+
+To create a comment, create an object `Comment`.
+
+Example:
+
+.. code-block:: php
+
+    use PhpOffice\PhpPresentation\Shape\Comment;
+
+    $oComment = new Comment();
+    $oSlide->addShape($oComment);
+
+You can define text and date with setters.
+
+Example:
+
+.. code-block:: php
+
+    use PhpOffice\PhpPresentation\Shape\Comment;
+
+    $oComment = new Comment();
+    $oComment->setText('Text of the Comment');
+    $oComment->setDate(time());
+    $oSlide->addShape($oComment);
+
+
+Author
+------
+
+For a comment, you can define the author.
+
+Example:
+
+.. code-block:: php
+
+    use PhpOffice\PhpPresentation\Shape\Comment;
+    use PhpOffice\PhpPresentation\Shape\Comment\Author;
+
+    $oAuthor = new Author();
+    $oComment = new Comment();
+    $oComment->setAuthor($oAuthor);
+    $oSlide->addShape($oComment);
+
+You can define name and initials with setters.
+
+Example:
+
+.. code-block:: php
+
+    use PhpOffice\PhpPresentation\Shape\Comment;
+    use PhpOffice\PhpPresentation\Shape\Comment\Author;
+
+    $oAuthor = new Author();
+    $oAuthor->setName('Name of the author');
+    $oAuthor->setInitals('Nota');
+    $oComment = new Comment();
+    $oComment->setAuthor($oAuthor);
+    $oSlide->addShape($oComment);

samples/Sample_17_Comment.php

@@ -0,0 +1,48 @@
+<?php
+
+include_once 'Sample_Header.php';
+
+use PhpOffice\PhpPresentation\PhpPresentation;
+use PhpOffice\PhpPresentation\Slide\Background\Color;
+use PhpOffice\PhpPresentation\Style\Color as StyleColor;
+use \PhpOffice\PhpPresentation\Slide\Background\Image;
+
+// Create new PHPPresentation object
+echo date('H:i:s') . ' Create new PHPPresentation object' . EOL;
+$objPHPPresentation = new PhpPresentation();
+
+// Create slide
+echo date('H:i:s') . ' Create slide'.EOL;
+$oSlide1 = $objPHPPresentation->getActiveSlide();
+$oSlide1->addShape(clone $oShapeDrawing);
+$oSlide1->addShape(clone $oShapeRichText);
+
+$oAuthor = new \PhpOffice\PhpPresentation\Shape\Comment\Author();
+$oAuthor->setName('Progi1984');
+$oAuthor->setInitials('P');
+
+// Add Comment 1
+echo date('H:i:s') . ' Add Comment 1'.EOL;
+$oComment1 = new \PhpOffice\PhpPresentation\Shape\Comment();
+$oComment1->setText('Text A');
+$oComment1->setOffsetX(10);
+$oComment1->setOffsetY(55);
+$oComment1->setDate(time());
+$oComment1->setAuthor($oAuthor);
+$oSlide1->addShape($oComment1);
+
+// Add Comment
+echo date('H:i:s') . ' Add Comment 2'.EOL;
+$oComment2 = new \PhpOffice\PhpPresentation\Shape\Comment();
+$oComment2->setText('Text B');
+$oComment2->setOffsetX(170);
+$oComment2->setOffsetY(180);
+$oComment2->setDate(time());
+$oComment2->setAuthor($oAuthor);
+$oSlide1->addShape($oComment2);
+
+// Save file
+echo write($objPHPPresentation, basename(__FILE__, '.php'), $writers);
+if (!CLI) {
+    include_once 'Sample_Footer.php';
+}

src/PhpPresentation/Shape/Comment.php

@@ -0,0 +1,145 @@
+<?php
+/**
+ * This file is part of PHPPresentation - A pure PHP library for reading and writing
+ * presentations documents.
+ *
+ * PHPPresentation is free software distributed under the terms of the GNU Lesser
+ * General Public License version 3 as published by the Free Software Foundation.
+ *
+ * For the full copyright and license information, please read the LICENSE
+ * file that was distributed with this source code. For the full list of
+ * contributors, visit https://github.com/PHPOffice/PHPPresentation/contributors.
+ *
+ * @link        https://github.com/PHPOffice/PHPPresentation
+ * @copyright   2009-2015 PHPPresentation contributors
+ * @license     http://www.gnu.org/licenses/lgpl.txt LGPL version 3
+ */
+
+namespace PhpOffice\PhpPresentation\Shape;
+
+use PhpOffice\PhpPresentation\AbstractShape;
+use PhpOffice\PhpPresentation\ComparableInterface;
+use PhpOffice\PhpPresentation\Shape\Comment\Author;
+
+/**
+ * Comment shape
+ */
+class Comment extends AbstractShape implements ComparableInterface
+{
+    /**
+     * @var Author
+     */
+    protected $author;
+
+    /**
+     * @var int
+     */
+    protected $dtComment;
+
+    /**
+     * @var string
+     */
+    protected $text;
+
+    public function __construct()
+    {
+        parent::__construct();
+        $this->setDate(time());
+    }
+
+    /**
+     * @return Author
+     */
+    public function getAuthor()
+    {
+        return $this->author;
+    }
+
+    /**
+     * @param Author $author
+     * @return Comment
+     */
+    public function setAuthor(Author $author)
+    {
+        $this->author = $author;
+        return $this;
+    }
+
+    /**
+     * @return int
+     */
+    public function getDate()
+    {
+        return $this->dtComment;
+    }
+
+    /**
+     * @param int $dtComment timestamp of the comment
+     * @return Comment
+     */
+    public function setDate($dtComment)
+    {
+        $this->dtComment = (int)$dtComment;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getText()
+    {
+        return $this->text;
+    }
+
+    /**
+     * @param string $text
+     * @return Comment
+     */
+    public function setText($text = '')
+    {
+        $this->text = $text;
+        return $this;
+    }
+
+    /**
+     * Comment has not height
+     *
+     * @return null
+     */
+    public function getHeight()
+    {
+        return null;
+    }
+
+    /**
+     * Set Height
+     *
+     * @param  int $pValue
+     * @return self
+     */
+    public function setHeight($pValue = 0)
+    {
+        return $this;
+    }
+
+    /**
+     * Comment has not width
+     *
+     * @return null
+     */
+    public function getWidth()
+    {
+        return null;
+    }
+
+    /**
+     * Set Width
+     *
+     * @param  int $pValue
+     * @return self
+     */
+    public function setWidth($pValue = 0)
+    {
+        return $this;
+    }
+}

src/PhpPresentation/Shape/Comment/Author.php

@@ -0,0 +1,85 @@
+<?php
+
+namespace PhpOffice\PhpPresentation\Shape\Comment;
+
+class Author
+{
+    /**
+     * @var int
+     */
+    protected $idxAuthor;
+
+    /**
+     * @var string
+     */
+    protected $initials;
+
+    /**
+     * @var string
+     */
+    protected $name;
+
+    /**
+     * @return int
+     */
+    public function getIndex()
+    {
+        return $this->idxAuthor;
+    }
+
+    /**
+     * @param int $idxAuthor
+     * @return Author
+     */
+    public function setIndex($idxAuthor)
+    {
+        $this->idxAuthor = (int) $idxAuthor;
+        return $this;
+    }
+
+    /**
+     * @return mixed
+     */
+    public function getInitials()
+    {
+        return $this->initials;
+    }
+
+    /**
+     * @param mixed $initials
+     * @return Author
+     */
+    public function setInitials($initials)
+    {
+        $this->initials = $initials;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getName()
+    {
+        return $this->name;
+    }
+
+    /**
+     * @param string $name
+     * @return Author
+     */
+    public function setName($name)
+    {
+        $this->name = $name;
+        return $this;
+    }
+
+    /**
+     * Get hash code
+     *
+     * @return string Hash code
+     */
+    public function getHashCode()
+    {
+        return md5($this->getInitials() . $this->getName() . __CLASS__);
+    }
+}