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 |
||
23 | class RevisionGetter { |
||
24 | |||
25 | /** |
||
26 | * @var MediawikiApi |
||
27 | */ |
||
28 | protected $api; |
||
29 | |||
30 | /** |
||
31 | * @var Deserializer |
||
32 | */ |
||
33 | protected $entityDeserializer; |
||
34 | |||
35 | /** |
||
36 | * @param MediawikiApi $api |
||
37 | * @param Deserializer $entityDeserializer |
||
38 | */ |
||
39 | 3 | public function __construct( MediawikiApi $api, Deserializer $entityDeserializer ) { |
|
43 | |||
44 | /** |
||
45 | * @since 0.1 |
||
46 | * @param string|EntityId $id |
||
47 | * @return Revision |
||
48 | */ |
||
49 | 2 | public function getFromId( $id ) { |
|
57 | |||
58 | /** |
||
59 | * @since 0.1 |
||
60 | * @param SiteLink $siteLink |
||
61 | * @return Revision |
||
62 | */ |
||
63 | public function getFromSiteLink( SiteLink $siteLink ) { |
||
70 | |||
71 | /** |
||
72 | * @since 0.1 |
||
73 | * @param string $siteId |
||
74 | * @param string $title |
||
75 | * @return Revision |
||
76 | */ |
||
77 | public function getFromSiteAndTitle( $siteId, $title ) { |
||
84 | |||
85 | /** |
||
86 | * @param array $entityResult |
||
87 | * @return Revision |
||
88 | * @todo this could be factored into a different class? |
||
89 | */ |
||
90 | 2 | private function newRevisionFromResult( array $entityResult ) { |
|
103 | |||
104 | /** |
||
105 | * @param Item|Property $entity |
||
106 | * |
||
107 | * @throws RuntimeException |
||
108 | * @return ItemContent|PropertyContent |
||
109 | * @todo this could be factored into a different class? |
||
110 | */ |
||
111 | 2 | View Code Duplication | private function getContentFromEntity( $entity ) { |
121 | |||
122 | } |
||
123 |
If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.
Let’s take a look at an example:
Our function
my_function
expects aPost
object, and outputs the author of the post. The base classPost
returns a simple string and outputting a simple string will work just fine. However, the child classBlogPost
which is a sub-type ofPost
instead decided to return anobject
, and is therefore violating the SOLID principles. If aBlogPost
were passed tomy_function
, PHP would not complain, but ultimately fail when executing thestrtoupper
call in its body.