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 | class Guzzle3 extends Guzzle |
||
| 12 | { |
||
| 13 | /** |
||
| 14 | * @var Client |
||
| 15 | */ |
||
| 16 | private $client; |
||
| 17 | |||
| 18 | /** |
||
| 19 | * {@InheritDoc} |
||
| 20 | */ |
||
| 21 | public function __construct($baseUri, $options = []) |
||
| 27 | |||
| 28 | private function setConfig($options = []) |
||
| 36 | |||
| 37 | public function setBaseUri($baseUri) |
||
| 41 | |||
| 42 | public function getBaseUri() |
||
| 46 | |||
| 47 | public function setDefaultOptions($options = []) |
||
| 51 | |||
| 52 | public function getDefaultOptions() |
||
| 56 | |||
| 57 | /** |
||
| 58 | * @return Client |
||
| 59 | */ |
||
| 60 | public function getClient() |
||
| 64 | |||
| 65 | /** |
||
| 66 | * @param Client $client |
||
| 67 | * |
||
| 68 | * @return self |
||
| 69 | */ |
||
| 70 | public function setClient(Client $client) |
||
| 76 | |||
| 77 | /** |
||
| 78 | * {@InheritDoc} |
||
| 79 | */ |
||
| 80 | View Code Duplication | public function send(Request $request) |
|
| 99 | |||
| 100 | /** |
||
| 101 | * use to mock client |
||
| 102 | * |
||
| 103 | * @param EventSubscriberInterface $subscriber |
||
| 104 | */ |
||
| 105 | public function addSubscriber(EventSubscriberInterface $subscriber) |
||
| 109 | } |
||
| 110 |
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_functionexpects aPostobject, and outputs the author of the post. The base classPostreturns a simple string and outputting a simple string will work just fine. However, the child classBlogPostwhich is a sub-type ofPostinstead decided to return anobject, and is therefore violating the SOLID principles. If aBlogPostwere passed tomy_function, PHP would not complain, but ultimately fail when executing thestrtouppercall in its body.