Merge pull request #6 from jaapio/feature/FileInterface

Project factory accepts File implementations only

Author: mvriel

src/File.php

@@ -0,0 +1,40 @@
+<?php
+/**
+ * This file is part of phpDocumentor.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @copyright 2010-2015 Mike van Riel<[email protected]>
+ * @license   http://www.opensource.org/licenses/mit-license.php MIT
+ * @link      http://phpdoc.org
+ */
+
+namespace phpDocumentor\Reflection;
+
+/**
+ * Interface for files processed by the ProjectFactory
+ */
+interface File
+{
+    /**
+     * Returns the content of the file as a string.
+     *
+     * @return string
+     */
+    public function getContents();
+
+    /**
+     * Returns md5 hash of the file.
+     *
+     * @return string
+     */
+    public function md5();
+
+    /**
+     * Returns an relative path to the file.
+     *
+     * @return string
+     */
+    public function path();
+}

src/ProjectFactory.php

@@ -20,7 +20,7 @@ interface ProjectFactory
      * Creates a project from the set of files.
      *
      * @param string $name
-     * @param string[] $files
+     * @param File[] $files
      * @return Project
      */
     public function create($name, array $files);