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 |
||
| 20 | class Handler implements BaseLanguageHandler |
||
| 21 | { |
||
| 22 | /** |
||
| 23 | * Language Gateway. |
||
| 24 | * |
||
| 25 | * @var \eZ\Publish\Core\Persistence\Legacy\Content\Language\Gateway |
||
| 26 | */ |
||
| 27 | protected $languageGateway; |
||
| 28 | |||
| 29 | /** |
||
| 30 | * Language Mapper. |
||
| 31 | * |
||
| 32 | * @var \eZ\Publish\Core\Persistence\Legacy\Content\Language\Mapper |
||
| 33 | */ |
||
| 34 | protected $languageMapper; |
||
| 35 | |||
| 36 | /** |
||
| 37 | * Creates a new Language Handler. |
||
| 38 | * |
||
| 39 | * @param \eZ\Publish\Core\Persistence\Legacy\Content\Language\Gateway $languageGateway |
||
| 40 | * @param \eZ\Publish\Core\Persistence\Legacy\Content\Language\Mapper $languageMapper |
||
| 41 | */ |
||
| 42 | public function __construct(Gateway $languageGateway, Mapper $languageMapper) |
||
| 47 | |||
| 48 | /** |
||
| 49 | * Create a new language. |
||
| 50 | * |
||
| 51 | * @param \eZ\Publish\SPI\Persistence\Content\Language\CreateStruct $struct |
||
| 52 | * |
||
| 53 | * @return \eZ\Publish\SPI\Persistence\Content\Language |
||
| 54 | */ |
||
| 55 | public function create(CreateStruct $struct) |
||
| 64 | |||
| 65 | /** |
||
| 66 | * Update language. |
||
| 67 | * |
||
| 68 | * @param \eZ\Publish\SPI\Persistence\Content\Language $language |
||
| 69 | */ |
||
| 70 | public function update(Language $language) |
||
| 74 | |||
| 75 | /** |
||
| 76 | * Get language by id. |
||
| 77 | * |
||
| 78 | * @param mixed $id |
||
| 79 | * |
||
| 80 | * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException If language could not be found by $id |
||
| 81 | * |
||
| 82 | * @return \eZ\Publish\SPI\Persistence\Content\Language |
||
| 83 | */ |
||
| 84 | View Code Duplication | public function load($id) |
|
| 96 | |||
| 97 | /** |
||
| 98 | * {@inheritdoc} |
||
| 99 | */ |
||
| 100 | public function loadList(array $ids): iterable |
||
| 107 | |||
| 108 | /** |
||
| 109 | * Get language by Language Code (eg: eng-GB). |
||
| 110 | * |
||
| 111 | * @param string $languageCode |
||
| 112 | * |
||
| 113 | * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException If language could not be found by $languageCode |
||
| 114 | * |
||
| 115 | * @return \eZ\Publish\SPI\Persistence\Content\Language |
||
| 116 | */ |
||
| 117 | View Code Duplication | public function loadByLanguageCode($languageCode) |
|
| 129 | |||
| 130 | /** |
||
| 131 | * {@inheritdoc} |
||
| 132 | */ |
||
| 133 | public function loadListByLanguageCodes(array $languageCodes): iterable |
||
| 139 | |||
| 140 | /** |
||
| 141 | * Get all languages. |
||
| 142 | * |
||
| 143 | * @return \eZ\Publish\SPI\Persistence\Content\Language[] |
||
| 144 | */ |
||
| 145 | public function loadAll() |
||
| 151 | |||
| 152 | /** |
||
| 153 | * Delete a language. |
||
| 154 | * |
||
| 155 | * @param mixed $id |
||
| 156 | * |
||
| 157 | * @throws LogicException If language could not be deleted |
||
| 158 | */ |
||
| 159 | public function delete($id) |
||
| 167 | } |
||
| 168 |