annotate vendor/phpdocumentor/reflection-common/src/File.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 7a779792577d
children
rev   line source
Chris@12 1 <?php
Chris@12 2 /**
Chris@12 3 * This file is part of phpDocumentor.
Chris@12 4 *
Chris@12 5 * For the full copyright and license information, please view the LICENSE
Chris@12 6 * file that was distributed with this source code.
Chris@12 7 *
Chris@12 8 * @copyright 2010-2015 Mike van Riel<mike@phpdoc.org>
Chris@12 9 * @license http://www.opensource.org/licenses/mit-license.php MIT
Chris@12 10 * @link http://phpdoc.org
Chris@12 11 */
Chris@12 12
Chris@12 13 namespace phpDocumentor\Reflection;
Chris@12 14
Chris@12 15 /**
Chris@12 16 * Interface for files processed by the ProjectFactory
Chris@12 17 */
Chris@12 18 interface File
Chris@12 19 {
Chris@12 20 /**
Chris@12 21 * Returns the content of the file as a string.
Chris@12 22 *
Chris@12 23 * @return string
Chris@12 24 */
Chris@12 25 public function getContents();
Chris@12 26
Chris@12 27 /**
Chris@12 28 * Returns md5 hash of the file.
Chris@12 29 *
Chris@12 30 * @return string
Chris@12 31 */
Chris@12 32 public function md5();
Chris@12 33
Chris@12 34 /**
Chris@12 35 * Returns an relative path to the file.
Chris@12 36 *
Chris@12 37 * @return string
Chris@12 38 */
Chris@12 39 public function path();
Chris@12 40 }