Fix PHP Docs

PHPOffice · Oct 23, 2018 · d07784c · d07784c
1 parent 97da2d9
commit d07784c
Show file tree

Hide file tree

Showing 60 changed files with 243 additions and 86 deletions.
diff --git a/src/PhpPresentation/AbstractShape.php b/src/PhpPresentation/AbstractShape.php
@@ -143,7 +143,7 @@ public function __clone()
     /**
      * Get Container, Slide or Group
      *
-     * @return \PhpOffice\PhpPresentation\Container
+     * @return \PhpOffice\PhpPresentation\ShapeContainerInterface
      */
     public function getContainer()
     {
@@ -385,6 +385,7 @@ public function hasHyperlink()
      * Get Hyperlink
      *
      * @return \PhpOffice\PhpPresentation\Shape\Hyperlink
+     * @throws \Exception
      */
     public function getHyperlink()
     {

diff --git a/src/PhpPresentation/IOFactory.php b/src/PhpPresentation/IOFactory.php
@@ -35,6 +35,7 @@ class IOFactory
      * @param PhpPresentation $phpPresentation
      * @param string $name
      * @return \PhpOffice\PhpPresentation\Writer\WriterInterface
+     * @throws \Exception
      */
     public static function createWriter(PhpPresentation $phpPresentation, $name = 'PowerPoint2007')
     {
@@ -47,6 +48,7 @@ public static function createWriter(PhpPresentation $phpPresentation, $name = 'P
      *
      * @param  string $name
      * @return \PhpOffice\PhpPresentation\Reader\ReaderInterface
+     * @throws \Exception
      */
     public static function createReader($name = '')
     {
@@ -81,8 +83,8 @@ public static function load($pFilename)
      * @param string $name
      * @param string $type
      * @param \PhpOffice\PhpPresentation\PhpPresentation $phpPresentation
-     * @throws \Exception
-     * @return
+     * @return mixed
+     * @throws \ReflectionException
      */
     private static function loadClass($class, $name, $type, PhpPresentation $phpPresentation = null)
     {
@@ -102,6 +104,7 @@ private static function loadClass($class, $name, $type, PhpPresentation $phpPres
      *
      * @param string $class
      * @return bool
+     * @throws \ReflectionException
      */
     private static function isConcreteClass($class)
     {

diff --git a/src/PhpPresentation/PhpPresentation.php b/src/PhpPresentation/PhpPresentation.php
@@ -190,6 +190,7 @@ public function getActiveSlide()
      * Create slide and add it to this presentation
      *
      * @return \PhpOffice\PhpPresentation\Slide
+     * @throws \Exception
      */
     public function createSlide()
     {
@@ -340,6 +341,7 @@ public function getSlideIterator()
      * Create a masterslide and add it to this presentation
      *
      * @return \PhpOffice\PhpPresentation\Slide\SlideMaster
+     * @throws \Exception
      */
     public function createMasterSlide()
     {
@@ -366,6 +368,7 @@ public function addMasterSlide(SlideMaster $slide = null)
      * Copy presentation (!= clone!)
      *
      * @return PhpPresentation
+     * @throws \Exception
      */
     public function copy()
     {
@@ -383,7 +386,7 @@ public function copy()
     /**
      * Mark a document as final
      * @param bool $state
-     * @return PhpPresentation
+     * @return PresentationProperties
      * @deprecated for getPresentationProperties()->markAsFinal()
      */
     public function markAsFinal($state = true)
@@ -403,8 +406,8 @@ public function isMarkedAsFinal()
 
     /**
      * Set the zoom of the document (in percentage)
-     * @param float $zoom
-     * @return PhpPresentation
+     * @param int $zoom
+     * @return PresentationProperties
      * @deprecated for getPresentationProperties()->setZoom()
      */
     public function setZoom($zoom = 1)

diff --git a/src/PhpPresentation/PresentationProperties.php b/src/PhpPresentation/PresentationProperties.php
@@ -118,7 +118,7 @@ public function setThumbnailPath($path = '')
     /**
      * Mark a document as final
      * @param bool $state
-     * @return PhpPresentation
+     * @return PresentationProperties
      */
     public function markAsFinal($state = true)
     {
@@ -139,8 +139,8 @@ public function isMarkedAsFinal()
 
     /**
      * Set the zoom of the document (in percentage)
-     * @param float $zoom
-     * @return PhpPresentation
+     * @param int $zoom
+     * @return PresentationProperties
      */
     public function setZoom($zoom = 1)
     {

diff --git a/src/PhpPresentation/Reader/ODPresentation.php b/src/PhpPresentation/Reader/ODPresentation.php
@@ -118,8 +118,9 @@ public function load($pFilename)
     /**
      * Load PhpPresentation Serialized file
      *
-     * @param  string        $pFilename
+     * @param  string $pFilename
      * @return \PhpOffice\PhpPresentation\PhpPresentation
+     * @throws \Exception
      */
     protected function loadFile($pFilename)
     {
@@ -191,10 +192,12 @@ protected function loadSlides()
             }
         }
     }
-    
+
     /**
      * Extract style
      * @param \DOMElement $nodeStyle
+     * @return bool
+     * @throws \Exception
      */
     protected function loadStyle(\DOMElement $nodeStyle)
     {
@@ -350,6 +353,8 @@ protected function loadStyle(\DOMElement $nodeStyle)
      * Read Slide
      *
      * @param \DOMElement $nodeSlide
+     * @return bool
+     * @throws \Exception
      */
     protected function loadSlide(\DOMElement $nodeSlide)
     {
@@ -377,11 +382,12 @@ protected function loadSlide(\DOMElement $nodeSlide)
         }
         return true;
     }
-    
+
     /**
      * Read Shape Drawing
      *
      * @param \DOMElement $oNodeFrame
+     * @throws \Exception
      */
     protected function loadShapeDrawing(\DOMElement $oNodeFrame)
     {
@@ -428,6 +434,7 @@ protected function loadShapeDrawing(\DOMElement $oNodeFrame)
      * Read Shape RichText
      *
      * @param \DOMElement $oNodeFrame
+     * @throws \Exception
      */
     protected function loadShapeRichText(\DOMElement $oNodeFrame)
     {
@@ -456,11 +463,12 @@ protected function loadShapeRichText(\DOMElement $oNodeFrame)
     }
 
     protected $levelParagraph = 0;
-    
+
     /**
      * Read Paragraph
      * @param RichText $oShape
      * @param \DOMElement $oNodeParent
+     * @throws \Exception
      */
     protected function readParagraph(RichText $oShape, \DOMElement $oNodeParent)
     {
@@ -477,11 +485,12 @@ protected function readParagraph(RichText $oShape, \DOMElement $oNodeParent)
             $this->readParagraphItem($oParagraph, $oNodeRichTextElement);
         }
     }
-    
+
     /**
      * Read Paragraph Item
      * @param Paragraph $oParagraph
      * @param \DOMElement $oNodeParent
+     * @throws \Exception
      */
     protected function readParagraphItem(Paragraph $oParagraph, \DOMElement $oNodeParent)
     {
@@ -512,6 +521,7 @@ protected function readParagraphItem(Paragraph $oParagraph, \DOMElement $oNodePa
      *
      * @param RichText $oShape
      * @param \DOMElement $oNodeParent
+     * @throws \Exception
      */
     protected function readList(RichText $oShape, \DOMElement $oNodeParent)
     {
@@ -526,12 +536,13 @@ protected function readList(RichText $oShape, \DOMElement $oNodeParent)
             }
         }
     }
-    
+
     /**
      * Read List Item
      * @param RichText $oShape
      * @param \DOMElement $oNodeParent
      * @param \DOMElement $oNodeParagraph
+     * @throws \Exception
      */
     protected function readListItem(RichText $oShape, \DOMElement $oNodeParent, \DOMElement $oNodeParagraph)
     {

diff --git a/src/PhpPresentation/Reader/PowerPoint2007.php b/src/PhpPresentation/Reader/PowerPoint2007.php
@@ -131,6 +131,7 @@ public function load($pFilename)
      *
      * @param  string $pFilename
      * @return \PhpOffice\PhpPresentation\PhpPresentation
+     * @throws \Exception
      */
     protected function loadFile($pFilename)
     {
@@ -265,6 +266,8 @@ protected function loadViewProperties($sPart)
 
     /**
      * Extract all slides
+     * @param $sPart
+     * @throws \Exception
      */
     protected function loadSlides($sPart)
     {
@@ -302,6 +305,7 @@ protected function loadSlides($sPart)
      * Extract all MasterSlides
      * @param XMLReader $xmlReader
      * @param string $fileRels
+     * @throws \Exception
      */
     protected function loadMasterSlides(XMLReader $xmlReader, $fileRels)
     {
@@ -328,6 +332,7 @@ protected function loadMasterSlides(XMLReader $xmlReader, $fileRels)
      * Extract data from slide
      * @param string $sPart
      * @param string $baseFile
+     * @throws \Exception
      */
     protected function loadSlide($sPart, $baseFile)
     {
@@ -416,6 +421,7 @@ protected function loadSlide($sPart, $baseFile)
     /**
      * @param string $sPart
      * @param string $baseFile
+     * @throws \Exception
      */
     protected function loadMasterSlide($sPart, $baseFile)
     {
@@ -559,6 +565,7 @@ protected function loadMasterSlide($sPart, $baseFile)
      * @param string $baseFile
      * @param SlideMaster $oSlideMaster
      * @return SlideLayout|null
+     * @throws \Exception
      */
     protected function loadLayoutSlide($sPart, $baseFile, SlideMaster $oSlideMaster)
     {
@@ -632,6 +639,7 @@ protected function loadTheme($sPart, SlideMaster $oSlideMaster)
      * @param XMLReader $xmlReader
      * @param \DOMElement $oElement
      * @param AbstractSlide $oSlide
+     * @throws \Exception
      */
     protected function loadSlideBackground(XMLReader $xmlReader, \DOMElement $oElement, AbstractSlide $oSlide)
     {
@@ -692,6 +700,7 @@ protected function loadSlideBackground(XMLReader $xmlReader, \DOMElement $oEleme
     /**
      * @param string $baseFile
      * @param Slide $oSlide
+     * @throws \Exception
      */
     protected function loadSlideNote($baseFile, Slide $oSlide)
     {
@@ -711,6 +720,7 @@ protected function loadSlideNote($baseFile, Slide $oSlide)
      * @param XMLReader $document
      * @param \DOMElement $node
      * @param AbstractSlide $oSlide
+     * @throws \Exception
      */
     protected function loadShapeDrawing(XMLReader $document, \DOMElement $node, AbstractSlide $oSlide)
     {
@@ -1150,6 +1160,7 @@ protected function loadParagraph(XMLReader $document, \DOMElement $oElement, $oS
      * @param XMLReader $xmlReader
      * @param \DOMElement $oElement
      * @param Border $oBorder
+     * @throws \Exception
      */
     protected function loadStyleBorder(XMLReader $xmlReader, \DOMElement $oElement, Border $oBorder)
     {
@@ -1197,6 +1208,7 @@ protected function loadStyleColor(XMLReader $xmlReader, \DOMElement $oElement)
      * @param XMLReader $xmlReader
      * @param \DOMElement $oElement
      * @return null|Fill
+     * @throws \Exception
      */
     protected function loadStyleFill(XMLReader $xmlReader, \DOMElement $oElement)
     {
@@ -1240,7 +1252,6 @@ protected function loadStyleFill(XMLReader $xmlReader, \DOMElement $oElement)
 
     /**
      * @param string $fileRels
-     * @return string
      */
     protected function loadRels($fileRels)
     {
@@ -1265,6 +1276,7 @@ protected function loadRels($fileRels)
      * @param $oSlide
      * @param \DOMNodeList $oElements
      * @param XMLReader $xmlReader
+     * @throws \Exception
      * @internal param $baseFile
      */
     protected function loadSlideShapes($oSlide, $oElements, $xmlReader)