Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
1 | <?php |
||
11 | abstract class AbstractManager implements ManagerInterface |
||
12 | { |
||
13 | /** @var EntityManager */ |
||
14 | protected $entityManager; |
||
15 | |||
16 | /** @var EntityRepository */ |
||
17 | protected $repository; |
||
18 | |||
19 | /** |
||
20 | * @param EntityManager $entityManager |
||
21 | * @param $entity |
||
22 | */ |
||
23 | public function __construct(EntityManager $entityManager, $entity) |
||
28 | |||
29 | /** |
||
30 | * @param Entity $object |
||
31 | * |
||
32 | * @return Entity|boolean |
||
33 | * |
||
34 | * @throws ObjectClassNotAllowedException |
||
35 | */ |
||
36 | View Code Duplication | public function insert(Entity $object) |
|
47 | |||
48 | /** |
||
49 | * @param Entity $object |
||
50 | * |
||
51 | * @return Entity|boolean |
||
52 | * |
||
53 | * @throws ObjectClassNotAllowedException |
||
54 | */ |
||
55 | View Code Duplication | public function update(Entity $object) |
|
65 | |||
66 | /** |
||
67 | * @param Entity $object |
||
68 | * @throws ObjectClassNotAllowedException |
||
69 | */ |
||
70 | public function delete(Entity $object) |
||
78 | |||
79 | /** |
||
80 | * Finds an entity by its primary key / identifier. |
||
81 | * |
||
82 | * @param mixed $id The identifier. |
||
83 | * @param int|null $lockMode One of the \Doctrine\DBAL\LockMode::* constants |
||
84 | * or NULL if no specific lock mode should be used |
||
85 | * during the search. |
||
86 | * @param int|null $lockVersion The lock version. |
||
87 | * |
||
88 | * @return object|null The entity instance or NULL if the entity can not be found. |
||
89 | */ |
||
90 | public function find($id, $lockMode = null, $lockVersion = null) |
||
94 | |||
95 | /** |
||
96 | * Finds a single entity by a set of criteria. |
||
97 | * |
||
98 | * @param array $criteria |
||
99 | * @param array|null $orderBy |
||
100 | * |
||
101 | * @return object|null The entity instance or NULL if the entity can not be found. |
||
102 | */ |
||
103 | public function findOneBy(array $criteria, array $orderBy = null) |
||
107 | |||
108 | /** |
||
109 | * Finds entities by a set of criteria. |
||
110 | * |
||
111 | * @param array $criteria |
||
112 | * @param array|null $orderBy |
||
113 | * @param int|null $limit |
||
114 | * @param int|null $offset |
||
115 | * |
||
116 | * @return array The objects. |
||
117 | */ |
||
118 | public function findBy(array $criteria, array $orderBy = null, $limit = null, $offset = null) |
||
122 | |||
123 | /** |
||
124 | * Finds all entities in the repository. |
||
125 | * |
||
126 | * @return array The entities. |
||
127 | */ |
||
128 | public function findAll() |
||
132 | |||
133 | /** |
||
134 | * @return EntityRepository |
||
135 | */ |
||
136 | public function getRepository() |
||
140 | |||
141 | |||
142 | } |
||
143 |
Let’s assume that you have a directory layout like this:
and let’s assume the following content of
Bar.php
:If both files
OtherDir/Foo.php
andSomeDir/Foo.php
are loaded in the same runtime, you will see a PHP error such as the following:PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php
However, as
OtherDir/Foo.php
does not necessarily have to be loaded and the error is only triggered if it is loaded beforeOtherDir/Bar.php
, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: