File.php 823 B

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