Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit ea43304

Browse files
fabpotfabpot
committed
feature #15805 [Finder] Deprecate adapters and related classes (nicolas-grekas)
This PR was merged into the 2.8 branch. Discussion ---------- [Finder] Deprecate adapters and related classes | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | yes | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | - Commits ------- c08cf4b [Finder] Deprecate adapters and related classes
2 parents 926d9b7 + c08cf4b commit ea43304

20 files changed

+255
-34
lines changed

‎src/Symfony/Component/Finder/Adapter/AbstractAdapter.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,14 @@
1111

1212
namespace Symfony\Component\Finder\Adapter;
1313

14+
@trigger_error('The '.__NAMESPACE__.'\AbstractAdapter class is deprecated since version 2.8 and will be removed in 3.0. Use directly the Finder class instead.', E_USER_DEPRECATED);
15+
1416
/**
1517
* Interface for finder engine implementations.
1618
*
1719
* @author Jean-François Simon <[email protected]>
20+
*
21+
* @deprecated since 2.8, to be removed in 3.0. Use Finder instead.
1822
*/
1923
abstract class AbstractAdapter implements AdapterInterface
2024
{

‎src/Symfony/Component/Finder/Adapter/AbstractFindAdapter.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111

1212
namespace Symfony\Component\Finder\Adapter;
1313

14+
@trigger_error('The '.__NAMESPACE__.'\AbstractFindAdapter class is deprecated since version 2.8 and will be removed in 3.0. Use directly the Finder class instead.', E_USER_DEPRECATED);
15+
1416
use Symfony\Component\Finder\Exception\AccessDeniedException;
1517
use Symfony\Component\Finder\Iterator;
1618
use Symfony\Component\Finder\Shell\Shell;
@@ -23,6 +25,8 @@
2325
* Shell engine implementation using GNU find command.
2426
*
2527
* @author Jean-François Simon <[email protected]>
28+
*
29+
* @deprecated since 2.8, to be removed in 3.0. Use Finder instead.
2630
*/
2731
abstract class AbstractFindAdapter extends AbstractAdapter
2832
{

‎src/Symfony/Component/Finder/Adapter/AdapterInterface.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@
1313

1414
/**
1515
* @author Jean-François Simon <[email protected]>
16+
*
17+
* @deprecated since 2.8, to be removed in 3.0.
1618
*/
1719
interface AdapterInterface
1820
{

‎src/Symfony/Component/Finder/Adapter/BsdFindAdapter.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111

1212
namespace Symfony\Component\Finder\Adapter;
1313

14+
@trigger_error('The '.__NAMESPACE__.'\BsdFindAdapter class is deprecated since version 2.8 and will be removed in 3.0. Use directly the Finder class instead.', E_USER_DEPRECATED);
15+
1416
use Symfony\Component\Finder\Shell\Shell;
1517
use Symfony\Component\Finder\Shell\Command;
1618
use Symfony\Component\Finder\Iterator\SortableIterator;
@@ -20,6 +22,8 @@
2022
* Shell engine implementation using BSD find command.
2123
*
2224
* @author Jean-François Simon <[email protected]>
25+
*
26+
* @deprecated since 2.8, to be removed in 3.0. Use Finder instead.
2327
*/
2428
class BsdFindAdapter extends AbstractFindAdapter
2529
{

‎src/Symfony/Component/Finder/Adapter/GnuFindAdapter.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111

1212
namespace Symfony\Component\Finder\Adapter;
1313

14+
@trigger_error('The '.__NAMESPACE__.'\GnuFindAdapter class is deprecated since version 2.8 and will be removed in 3.0. Use directly the Finder class instead.', E_USER_DEPRECATED);
15+
1416
use Symfony\Component\Finder\Shell\Shell;
1517
use Symfony\Component\Finder\Shell\Command;
1618
use Symfony\Component\Finder\Iterator\SortableIterator;
@@ -20,6 +22,8 @@
2022
* Shell engine implementation using GNU find command.
2123
*
2224
* @author Jean-François Simon <[email protected]>
25+
*
26+
* @deprecated since 2.8, to be removed in 3.0. Use Finder instead.
2327
*/
2428
class GnuFindAdapter extends AbstractFindAdapter
2529
{

‎src/Symfony/Component/Finder/Adapter/PhpAdapter.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,16 @@
1111

1212
namespace Symfony\Component\Finder\Adapter;
1313

14+
@trigger_error('The '.__NAMESPACE__.'\PhpAdapter class is deprecated since version 2.8 and will be removed in 3.0. Use directly the Finder class instead.', E_USER_DEPRECATED);
15+
1416
use Symfony\Component\Finder\Iterator;
1517

1618
/**
1719
* PHP finder engine implementation.
1820
*
1921
* @author Jean-François Simon <[email protected]>
22+
*
23+
* @deprecated since 2.8, to be removed in 3.0. Use Finder instead.
2024
*/
2125
class PhpAdapter extends AbstractAdapter
2226
{

‎src/Symfony/Component/Finder/CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
CHANGELOG
22
=========
33

4+
2.8.0
5+
-----
6+
7+
* deprecated adapters and related classes
8+
49
2.5.0
510
-----
611
* added support for GLOB_BRACE in the paths passed to Finder::in()

‎src/Symfony/Component/Finder/Exception/AdapterFailureException.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,16 @@
1111

1212
namespace Symfony\Component\Finder\Exception;
1313

14+
@trigger_error('The '.__NAMESPACE__.'\AdapterFailureException class is deprecated since version 2.8 and will be removed in 3.0.', E_USER_DEPRECATED);
15+
1416
use Symfony\Component\Finder\Adapter\AdapterInterface;
1517

1618
/**
1719
* Base exception for all adapter failures.
1820
*
1921
* @author Jean-François Simon <[email protected]>
22+
*
23+
* @deprecated since 2.8, to be removed in 3.0.
2024
*/
2125
class AdapterFailureException extends \RuntimeException implements ExceptionInterface
2226
{

‎src/Symfony/Component/Finder/Exception/OperationNotPermitedException.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,12 @@
1111

1212
namespace Symfony\Component\Finder\Exception;
1313

14+
@trigger_error('The '.__NAMESPACE__.'\OperationNotPermitedException class is deprecated since version 2.8 and will be removed in 3.0.', E_USER_DEPRECATED);
15+
1416
/**
1517
* @author Jean-François Simon <[email protected]>
18+
*
19+
* @deprecated since 2.8, to be removed in 3.0.
1620
*/
1721
class OperationNotPermitedException extends AdapterFailureException
1822
{

‎src/Symfony/Component/Finder/Exception/ShellCommandFailureException.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,15 @@
1111

1212
namespace Symfony\Component\Finder\Exception;
1313

14+
@trigger_error('The '.__NAMESPACE__.'\ShellCommandFailureException class is deprecated since version 2.8 and will be removed in 3.0.', E_USER_DEPRECATED);
15+
1416
use Symfony\Component\Finder\Adapter\AdapterInterface;
1517
use Symfony\Component\Finder\Shell\Command;
1618

1719
/**
1820
* @author Jean-François Simon <[email protected]>
21+
*
22+
* @deprecated since 2.8, to be removed in 3.0.
1923
*/
2024
class ShellCommandFailureException extends AdapterFailureException
2125
{

‎src/Symfony/Component/Finder/Finder.php

Lines changed: 125 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ class Finder implements \IteratorAggregate, \Countable
6262
private $iterators = array();
6363
private $contains = array();
6464
private $notContains = array();
65-
private $adapters = array();
65+
private $adapters = null;
6666
private $paths = array();
6767
private $notPaths = array();
6868
private $ignoreUnreadableDirs = false;
@@ -75,13 +75,6 @@ class Finder implements \IteratorAggregate, \Countable
7575
public function __construct()
7676
{
7777
$this->ignore = static::IGNORE_VCS_FILES | static::IGNORE_DOT_FILES;
78-
79-
$this
80-
->addAdapter(new GnuFindAdapter())
81-
->addAdapter(new BsdFindAdapter())
82-
->addAdapter(new PhpAdapter(), -50)
83-
->setAdapter('php')
84-
;
8578
}
8679

8780
/**
@@ -103,9 +96,15 @@ public static function create()
10396
* @param int $priority Highest is selected first
10497
*
10598
* @return Finder The current Finder instance
99+
*
100+
* @deprecated since 2.8, to be removed in 3.0.
106101
*/
107102
public function addAdapter(AdapterInterface $adapter, $priority = 0)
108103
{
104+
@trigger_error('The '.__METHOD__.' method is deprecated since version 2.8 and will be removed in 3.0.', E_USER_DEPRECATED);
105+
106+
$this->initDefaultAdapters();
107+
109108
$this->adapters[$adapter->getName()] = array(
110109
'adapter' => $adapter,
111110
'priority' => $priority,
@@ -119,9 +118,15 @@ public function addAdapter(AdapterInterface $adapter, $priority = 0)
119118
* Sets the selected adapter to the best one according to the current platform the code is run on.
120119
*
121120
* @return Finder The current Finder instance
121+
*
122+
* @deprecated since 2.8, to be removed in 3.0.
122123
*/
123124
public function useBestAdapter()
124125
{
126+
@trigger_error('The '.__METHOD__.' method is deprecated since version 2.8 and will be removed in 3.0.', E_USER_DEPRECATED);
127+
128+
$this->initDefaultAdapters();
129+
125130
$this->resetAdapterSelection();
126131

127132
return $this->sortAdapters();
@@ -135,9 +140,15 @@ public function useBestAdapter()
135140
* @throws \InvalidArgumentException
136141
*
137142
* @return Finder The current Finder instance
143+
*
144+
* @deprecated since 2.8, to be removed in 3.0.
138145
*/
139146
public function setAdapter($name)
140147
{
148+
@trigger_error('The '.__METHOD__.' method is deprecated since version 2.8 and will be removed in 3.0.', E_USER_DEPRECATED);
149+
150+
$this->initDefaultAdapters();
151+
141152
if (!isset($this->adapters[$name])) {
142153
throw new \InvalidArgumentException(sprintf('Adapter "%s" does not exist.', $name));
143154
}
@@ -152,9 +163,13 @@ public function setAdapter($name)
152163
* Removes all adapters registered in the finder.
153164
*
154165
* @return Finder The current Finder instance
166+
*
167+
* @deprecated since 2.8, to be removed in 3.0.
155168
*/
156169
public function removeAdapters()
157170
{
171+
@trigger_error('The '.__METHOD__.' method is deprecated since version 2.8 and will be removed in 3.0.', E_USER_DEPRECATED);
172+
158173
$this->adapters = array();
159174

160175
return $this;
@@ -164,9 +179,15 @@ public function removeAdapters()
164179
* Returns registered adapters ordered by priority without extra information.
165180
*
166181
* @return AdapterInterface[]
182+
*
183+
* @deprecated since 2.8, to be removed in 3.0.
167184
*/
168185
public function getAdapters()
169186
{
187+
@trigger_error('The '.__METHOD__.' method is deprecated since version 2.8 and will be removed in 3.0.', E_USER_DEPRECATED);
188+
189+
$this->initDefaultAdapters();
190+
170191
return array_values(array_map(function (array $adapter) {
171192
return $adapter['adapter'];
172193
}, $this->adapters));
@@ -774,8 +795,6 @@ private function sortAdapters()
774795
* @param $dir
775796
*
776797
* @return \Iterator
777-
*
778-
* @throws \RuntimeException When none of the adapters are supported
779798
*/
780799
private function searchInDirectory($dir)
781800
{
@@ -787,18 +806,93 @@ private function searchInDirectory($dir)
787806
$this->notPaths[] = '#(^|/)\..+(/|$)#';
788807
}
789808

790-
foreach ($this->adapters as $adapter) {
791-
if ($adapter['adapter']->isSupported()) {
792-
try {
793-
return $this
794-
->buildAdapter($adapter['adapter'])
795-
->searchInDirectory($dir);
796-
} catch (ExceptionInterface $e) {
809+
if ($this->adapters) {
810+
foreach ($this->adapters as $adapter) {
811+
if ($adapter['adapter']->isSupported()) {
812+
try {
813+
return $this
814+
->buildAdapter($adapter['adapter'])
815+
->searchInDirectory($dir);
816+
} catch (ExceptionInterface $e) {
817+
}
797818
}
798819
}
799820
}
800821

801-
throw new \RuntimeException('No supported adapter found.');
822+
$minDepth = 0;
823+
$maxDepth = PHP_INT_MAX;
824+
825+
foreach ($this->depths as $comparator) {
826+
switch ($comparator->getOperator()) {
827+
case '>':
828+
$minDepth = $comparator->getTarget() + 1;
829+
break;
830+
case '>=':
831+
$minDepth = $comparator->getTarget();
832+
break;
833+
case '<':
834+
$maxDepth = $comparator->getTarget() - 1;
835+
break;
836+
case '<=':
837+
$maxDepth = $comparator->getTarget();
838+
break;
839+
default:
840+
$minDepth = $maxDepth = $comparator->getTarget();
841+
}
842+
}
843+
844+
$flags = \RecursiveDirectoryIterator::SKIP_DOTS;
845+
846+
if ($this->followLinks) {
847+
$flags |= \RecursiveDirectoryIterator::FOLLOW_SYMLINKS;
848+
}
849+
850+
$iterator = new Iterator\RecursiveDirectoryIterator($dir, $flags, $this->ignoreUnreadableDirs);
851+
852+
if ($this->exclude) {
853+
$iterator = new Iterator\ExcludeDirectoryFilterIterator($iterator, $this->exclude);
854+
}
855+
856+
$iterator = new \RecursiveIteratorIterator($iterator, \RecursiveIteratorIterator::SELF_FIRST);
857+
858+
if ($minDepth > 0 || $maxDepth < PHP_INT_MAX) {
859+
$iterator = new Iterator\DepthRangeFilterIterator($iterator, $minDepth, $maxDepth);
860+
}
861+
862+
if ($this->mode) {
863+
$iterator = new Iterator\FileTypeFilterIterator($iterator, $this->mode);
864+
}
865+
866+
if ($this->names || $this->notNames) {
867+
$iterator = new Iterator\FilenameFilterIterator($iterator, $this->names, $this->notNames);
868+
}
869+
870+
if ($this->contains || $this->notContains) {
871+
$iterator = new Iterator\FilecontentFilterIterator($iterator, $this->contains, $this->notContains);
872+
}
873+
874+
if ($this->sizes) {
875+
$iterator = new Iterator\SizeRangeFilterIterator($iterator, $this->sizes);
876+
}
877+
878+
if ($this->dates) {
879+
$iterator = new Iterator\DateRangeFilterIterator($iterator, $this->dates);
880+
}
881+
882+
if ($this->filters) {
883+
$iterator = new Iterator\CustomFilterIterator($iterator, $this->filters);
884+
}
885+
886+
if ($this->paths || $this->notPaths) {
887+
$iterator = new Iterator\PathFilterIterator($iterator, $this->paths, $this->notPaths);
888+
}
889+
890+
if ($this->sort) {
891+
$iteratorAggregate = new Iterator\SortableIterator($iterator, $this->sort);
892+
$iterator = $iteratorAggregate->getIterator();
893+
}
894+
895+
return $iterator;
802896
}
803897

804898
/**
@@ -837,4 +931,17 @@ private function resetAdapterSelection()
837931
return $properties;
838932
}, $this->adapters);
839933
}
934+
935+
private function initDefaultAdapters()
936+
{
937+
if (null === $this->adapters) {
938+
$this->adapters = array();
939+
$this
940+
->addAdapter(new GnuFindAdapter())
941+
->addAdapter(new BsdFindAdapter())
942+
->addAdapter(new PhpAdapter(), -50)
943+
->setAdapter('php')
944+
;
945+
}
946+
}
840947
}

‎src/Symfony/Component/Finder/Iterator/FilePathsIterator.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,16 @@
1111

1212
namespace Symfony\Component\Finder\Iterator;
1313

14+
@trigger_error('The '.__NAMESPACE__.'\FilePathsIterator class is deprecated since version 2.8 and will be removed in 3.0.', E_USER_DEPRECATED);
15+
1416
use Symfony\Component\Finder\SplFileInfo;
1517

1618
/**
1719
* Iterate over shell command result.
1820
*
1921
* @author Jean-François Simon <[email protected]>
22+
*
23+
* @deprecated since 2.8, to be removed in 3.0.
2024
*/
2125
class FilePathsIterator extends \ArrayIterator
2226
{

0 commit comments

Comments
 (0)