AdapterInterface.php 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\Finder\Adapter;
  11. /**
  12. * @author Jean-François Simon <contact@jfsimon.fr>
  13. */
  14. interface AdapterInterface
  15. {
  16. /**
  17. * @param Boolean $followLinks
  18. *
  19. * @return AdapterInterface Current instance
  20. */
  21. public function setFollowLinks($followLinks);
  22. /**
  23. * @param integer $mode
  24. *
  25. * @return AdapterInterface Current instance
  26. */
  27. public function setMode($mode);
  28. /**
  29. * @param array $exclude
  30. *
  31. * @return AdapterInterface Current instance
  32. */
  33. public function setExclude(array $exclude);
  34. /**
  35. * @param array $depths
  36. *
  37. * @return AdapterInterface Current instance
  38. */
  39. public function setDepths(array $depths);
  40. /**
  41. * @param array $names
  42. *
  43. * @return AdapterInterface Current instance
  44. */
  45. public function setNames(array $names);
  46. /**
  47. * @param array $notNames
  48. *
  49. * @return AdapterInterface Current instance
  50. */
  51. public function setNotNames(array $notNames);
  52. /**
  53. * @param array $contains
  54. *
  55. * @return AdapterInterface Current instance
  56. */
  57. public function setContains(array $contains);
  58. /**
  59. * @param array $notContains
  60. *
  61. * @return AdapterInterface Current instance
  62. */
  63. public function setNotContains(array $notContains);
  64. /**
  65. * @param array $sizes
  66. *
  67. * @return AdapterInterface Current instance
  68. */
  69. public function setSizes(array $sizes);
  70. /**
  71. * @param array $dates
  72. *
  73. * @return AdapterInterface Current instance
  74. */
  75. public function setDates(array $dates);
  76. /**
  77. * @param array $filters
  78. *
  79. * @return AdapterInterface Current instance
  80. */
  81. public function setFilters(array $filters);
  82. /**
  83. * @param \Closure|integer $sort
  84. *
  85. * @return AdapterInterface Current instance
  86. */
  87. public function setSort($sort);
  88. /**
  89. * @param array $paths
  90. *
  91. * @return AdapterInterface Current instance
  92. */
  93. public function setPath(array $paths);
  94. /**
  95. * @param array $notPaths
  96. *
  97. * @return AdapterInterface Current instance
  98. */
  99. public function setNotPath(array $notPaths);
  100. /**
  101. * @param boolean $ignore
  102. *
  103. * @return AdapterInterface Current instance
  104. */
  105. public function ignoreUnreadableDirs($ignore = true);
  106. /**
  107. * @param string $dir
  108. *
  109. * @return \Iterator Result iterator
  110. */
  111. public function searchInDirectory($dir);
  112. /**
  113. * Tests adapter support for current platform.
  114. *
  115. * @return Boolean
  116. */
  117. public function isSupported();
  118. /**
  119. * Returns adapter name.
  120. *
  121. * @return string
  122. */
  123. public function getName();
  124. }