File.php 786 B

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