Method name & code format for PSR/phpdoc compliance

Author: ivanlanin

CHANGELOG.md

@@ -8,15 +8,19 @@ This release marked the transformation to namespaces (PHP 5.3+).
 
 ### Features
 
-None yet
+None yet.
 
 ### Bugfixes
 
 - Preserve text doesn't render correctly when the text is not the first word, e.g. 'Page {PAGE}' - @ivanlanin
 
 ### Miscellaneous
 
-- Documentation - @Progi1984
+- Move documentation to [Read The Docs](http://phpword.readthedocs.org/en/develop/) - @Progi1984 @ivanlanin GH-82
+- Reorganize and redesign samples folder - @ivanlanin GH-137
+- Use `PhpOffice\PhpWord` namespace for PSR compliance - @RomanSyroeshko @gabrielbull GH-159 GH-58
+- Restructure folders and change folder name `Classes` to `src` and `Tests` to `test` for PSR compliance - @RomanSyroeshko @gabrielbull
+- Compliance to phpDocumentor - @ivanlanin
 
 ## 0.8.1 - 17 Mar 2014
 

docs/setup.rst

@@ -47,11 +47,13 @@ Manual install
 To install manually, `download PHPWord package from
 github <https://github.com/PHPOffice/PHPWord/archive/master.zip>`__.
 Extract the package and put the contents to your machine. To use the
-library, include ``src/PhpWord/PhpWord.php`` in your script like below.
+library, include ``src/PhpWord/Autoloader.php`` in your script and
+invoke ``Autoloader::register``.
 
 .. code-block:: php
 
-    require_once '/path/to/src/PhpWord/PhpWord.php';
+    require_once '/path/to/src/PhpWord/Autoloader.php';
+    PhpOffice\PhpWord\Autoloader::register();
 
 Using samples
 -------------

samples/Sample_07_TemplateCloneRow.php

@@ -53,7 +53,7 @@
 $document->setValue('userName#3', 'Ray');
 $document->setValue('userPhone#3', '+1 428 889 775');
 
-$name = 'Sample_07_TemplateCloneRow_result.docx';
+$name = 'Sample_07_TemplateCloneRow.docx';
 echo date('H:i:s'), " Write to Word2007 format", \EOL;
 $document->saveAs($name);
 rename($name, "results/{$name}");

samples/Sample_Header.php

@@ -5,7 +5,10 @@
 error_reporting(E_ALL);
 define('CLI', (PHP_SAPI == 'cli') ? true : false);
 define('EOL', CLI ? PHP_EOL : '<br />');
-require_once '../src/PhpWord/PhpWord.php';
+
+require_once '../src/PhpWord/Autoloader.php';
+PhpOffice\PhpWord\Autoloader::register();
+
 // Return to the caller script when runs by CLI
 if (CLI) {
     return;

src/PhpWord/Autoloader.php

@@ -25,11 +25,16 @@
 
 namespace PhpOffice\PhpWord;
 
+/**
+ * Autoloader
+ */
 class Autoloader
 {
     const NAMESPACE_PREFIX = 'PhpOffice\\PhpWord\\';
 
     /**
+     * Register
+     *
      * @return void
      */
     public static function register()
@@ -38,6 +43,8 @@ public static function register()
     }
 
     /**
+     * Autoload
+     *
      * @param string $class
      */
     public static function autoload($class)
@@ -51,4 +58,4 @@ public static function autoload($class)
             }
         }
     }
-}
+}

src/PhpWord/DocumentProperties.php

@@ -25,6 +25,9 @@
 
 namespace PhpOffice\PhpWord;
 
+/**
+ * Document properties
+ */
 class DocumentProperties
 {
     /** Constants */

src/PhpWord/Exceptions/Exception.php

@@ -26,6 +26,9 @@
  */
 namespace PhpOffice\PhpWord\Exceptions;
 
+/**
+ * General exception
+ */
 class Exception extends \Exception
 {
 }

src/PhpWord/Footnote.php

@@ -25,6 +25,9 @@
 
 namespace PhpOffice\PhpWord;
 
+/**
+ *  Footnote
+ */
 class Footnote
 {
     /**

src/PhpWord/HashTable.php

@@ -28,6 +28,8 @@
 use PhpOffice\PhpWord\Exceptions\Exception;
 
 /**
+ * Hash table
+ *
  * @codeCoverageIgnore Legacy from PHPExcel
  */
 class HashTable
@@ -47,6 +49,8 @@ class HashTable
     public $_keyMap = array();
 
     /**
+     * Create new
+     *
      * @param \PhpOffice\PhpWord\IComparable[] $pSource Optional source array to create HashTable from
      */
     public function __construct($pSource = null)
@@ -140,6 +144,8 @@ public function clear()
     }
 
     /**
+     * Get item count
+     *
      * @return int
      */
     public function count()
@@ -148,6 +154,8 @@ public function count()
     }
 
     /**
+     * Get hash code index
+     *
      * @param string $pHashCode
      * @return int Index
      */
@@ -157,6 +165,8 @@ public function getIndexForHashCode($pHashCode = '')
     }
 
     /**
+     * Get by index
+     *
      * @param int $pIndex
      * @return \PhpOffice\PhpWord\IComparable
      */
@@ -170,6 +180,7 @@ public function getByIndex($pIndex = 0)
     }
 
     /**
+     * Get by hashcode
      * @param string $pHashCode
      * @return \PhpOffice\PhpWord\IComparable
      *
@@ -184,6 +195,8 @@ public function getByHashCode($pHashCode = '')
     }
 
     /**
+     * Convert to array
+     *
      * @return \PhpOffice\PhpWord\IComparable[]
      */
     public function toArray()

src/PhpWord/IOFactory.php

@@ -27,9 +27,14 @@
 
 use PhpOffice\PhpWord\Exceptions\Exception;
 
+/**
+ * IO factory
+ */
 abstract class IOFactory
 {
     /**
+     * Create new writer
+     *
      * @param \PhpOffice\PhpWord\PhpWord $phpWord
      * @param string $name
      * @return \PhpOffice\PhpWord\Writer\IWriter
@@ -46,6 +51,8 @@ public static function createWriter(PhpWord $phpWord, $name)
     }
 
     /**
+     * Create new reader
+     *
      * @param string $name
      * @return \PhpOffice\PhpWord\Reader\IReader
      * @throws \PhpOffice\PhpWord\Exceptions\Exception