kaliop-uk /
ezmigrationbundle
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:
Complex classes like RepositoryExecutor often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use RepositoryExecutor, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 15 | abstract class RepositoryExecutor extends AbstractExecutor |
||
| 16 | { |
||
| 17 | use RepositoryUserSetterTrait; |
||
| 18 | use IgnorableStepExecutorTrait; |
||
| 19 | |||
| 20 | /** |
||
| 21 | * Constant defining the default language code (used if not specified by the migration or on the command line) |
||
| 22 | */ |
||
| 23 | const DEFAULT_LANGUAGE_CODE = 'eng-GB'; |
||
| 24 | |||
| 25 | /** |
||
| 26 | * The default Admin user Id, used when no Admin user is specified |
||
| 27 | */ |
||
| 28 | const ADMIN_USER_ID = 14; |
||
| 29 | |||
| 30 | /** Used if not specified by the migration */ |
||
| 31 | const USER_CONTENT_TYPE = 'user'; |
||
| 32 | |||
| 33 | const REFERENCE_TYPE_SCALAR = 'scalar'; |
||
| 34 | const REFERENCE_TYPE_ARRAY = 'array'; |
||
| 35 | |||
| 36 | /** |
||
| 37 | * @var array $dsl The parsed DSL instruction array |
||
| 38 | */ |
||
| 39 | //protected $dsl; |
||
| 40 | |||
| 41 | /** @var array $context The context (configuration) for the execution of the current step */ |
||
| 42 | //protected $context; |
||
| 43 | |||
| 44 | /** |
||
| 45 | * The eZ Publish 5 API repository. |
||
| 46 | * |
||
| 47 | * @var \eZ\Publish\API\Repository\Repository |
||
| 48 | */ |
||
| 49 | protected $repository; |
||
| 50 | |||
| 51 | protected $configResolver; |
||
| 52 | |||
| 53 | /** @var ReferenceResolverBagInterface $referenceResolver */ |
||
| 54 | protected $referenceResolver; |
||
| 55 | |||
| 56 | // to redefine in subclasses if they don't support all methods, or if they support more... |
||
| 57 | protected $supportedActions = array( |
||
| 58 | 'create', 'update', 'delete' |
||
| 59 | ); |
||
| 60 | |||
| 61 | 80 | public function setRepository(Repository $repository) |
|
| 62 | { |
||
| 63 | 80 | $this->repository = $repository; |
|
| 64 | 80 | } |
|
| 65 | |||
| 66 | 80 | public function setConfigResolver(ConfigResolverInterface $configResolver) |
|
| 67 | { |
||
| 68 | 80 | $this->configResolver = $configResolver; |
|
| 69 | 80 | } |
|
| 70 | |||
| 71 | 80 | public function setReferenceResolver(ReferenceResolverBagInterface $referenceResolver) |
|
| 72 | { |
||
| 73 | 80 | $this->referenceResolver = $referenceResolver; |
|
| 74 | 80 | } |
|
| 75 | |||
| 76 | 24 | public function execute(MigrationStep $step) |
|
| 77 | { |
||
| 78 | // base checks |
||
| 79 | 24 | parent::execute($step); |
|
| 80 | |||
| 81 | 24 | if (!isset($step->dsl['mode'])) { |
|
| 82 | throw new \Exception("Invalid step definition: missing 'mode'"); |
||
| 83 | } |
||
| 84 | |||
| 85 | // q: should we convert snake_case to camelCase ? |
||
| 86 | 24 | $action = $step->dsl['mode']; |
|
| 87 | |||
| 88 | 24 | if (!in_array($action, $this->supportedActions)) { |
|
| 89 | throw new \Exception("Invalid step definition: value '$action' is not allowed for 'mode'"); |
||
| 90 | } |
||
| 91 | |||
| 92 | 24 | if (method_exists($this, $action)) { |
|
| 93 | |||
| 94 | 24 | $this->skipStepIfNeeded($step); |
|
| 95 | |||
| 96 | 24 | $previousUserId = $this->loginUser($this->getAdminUserIdentifierFromContext($step->context)); |
|
| 97 | |||
| 98 | try { |
||
| 99 | 24 | $output = $this->$action($step); |
|
| 100 | 6 | } catch (\Exception $e) { |
|
| 101 | 6 | $this->loginUser($previousUserId); |
|
| 102 | 6 | throw $e; |
|
| 103 | } |
||
| 104 | |||
| 105 | // reset the environment as much as possible as we had found it before the migration |
||
| 106 | 22 | $this->loginUser($previousUserId); |
|
| 107 | |||
| 108 | 22 | return $output; |
|
| 109 | } else { |
||
| 110 | throw new \Exception("Invalid step definition: value '$action' is not a method of " . get_class($this)); |
||
| 111 | } |
||
| 112 | } |
||
| 113 | |||
| 114 | /** |
||
| 115 | * Method that each executor (subclass) has to implement. |
||
| 116 | * |
||
| 117 | * It is used to get values for references based on the DSL instructions executed in the current step, for later steps to reuse. |
||
| 118 | * |
||
| 119 | * @throws \InvalidArgumentException when trying to set a reference to an unsupported attribute. |
||
| 120 | * @param mixed $object a single element to extract reference values from |
||
| 121 | * @param array $referencesDefinitions the definitions of the references to extract |
||
| 122 | * @param MigrationStep $step |
||
| 123 | * @return array key: the reference name (taken from $referencesDefinitions[n]['identifier'], value: the ref. value |
||
| 124 | */ |
||
| 125 | abstract protected function getReferencesValues($object, array $referencesDefinitions, $step); |
||
| 126 | |||
| 127 | /** |
||
| 128 | * @param MigrationStep $step |
||
| 129 | * @return string |
||
| 130 | */ |
||
| 131 | 17 | protected function getLanguageCode($step) |
|
| 135 | |||
| 136 | /** |
||
| 137 | * @param array|null $context |
||
| 138 | * @return string |
||
| 139 | */ |
||
| 140 | 22 | protected function getLanguageCodeFromContext($context) |
|
| 153 | |||
| 154 | /** |
||
| 155 | * @param MigrationStep $step |
||
| 156 | * @return string |
||
| 157 | */ |
||
| 158 | 2 | protected function getUserContentType($step) |
|
| 162 | |||
| 163 | /** |
||
| 164 | * @param array $context |
||
| 165 | * @return string |
||
| 166 | */ |
||
| 167 | 2 | protected function getUserContentTypeFromContext($context) |
|
| 171 | |||
| 172 | /** |
||
| 173 | * @param array $context we have to return FALSE if that is set as adminUserLogin, whereas if NULL is set, we return the default admin |
||
| 174 | * @return int|string|false |
||
| 175 | */ |
||
| 176 | 49 | protected function getAdminUserIdentifierFromContext($context) |
|
| 184 | |||
| 185 | /** |
||
| 186 | * Sets references to certain attributes of the items returned by steps. |
||
| 187 | * |
||
| 188 | * @param \Object|AbstractCollection $item |
||
| 189 | * @param MigrationStep $step |
||
| 190 | * @throws \InvalidArgumentException When trying to set a reference to an unsupported attribute |
||
| 191 | * @return boolean |
||
| 192 | * @todo should we allow to be passed in plain arrays as well as Collections? |
||
| 193 | */ |
||
| 194 | 23 | protected function setReferences($item, $step) |
|
| 239 | |||
| 240 | /** |
||
| 241 | * @param mixed $entity |
||
| 242 | * @param array $referencesDefinition |
||
| 243 | * @return array the same as $referencesDefinition, with the references already treated having been removed |
||
| 244 | */ |
||
| 245 | 18 | protected function setReferencesCommon($entity, $referencesDefinition) |
|
| 268 | |||
| 269 | /** |
||
| 270 | * Verifies compatibility between the definition of the refences to be set and the data set to extarct them from, |
||
| 271 | * and returns a single entity |
||
| 272 | * |
||
| 273 | * @param AbstractCollection|mixed $entity |
||
| 274 | * @param array $referencesDefinition |
||
| 275 | * @param MigrationStep $step |
||
| 276 | * @return AbstractCollection|mixed |
||
| 277 | * @deprecated |
||
| 278 | */ |
||
| 279 | protected function insureSingleEntity($entity, $referencesDefinition, $step) |
||
| 289 | |||
| 290 | /** |
||
| 291 | * Verifies compatibility between the definition of the references to be set and the data set to extract them from. |
||
| 292 | * NB: for multivalued refs, we assume that the users always expect at least one value |
||
| 293 | * @param AbstractCollection|mixed $entity |
||
| 294 | * @param array $referencesDefinition |
||
| 295 | * @param MigrationStep $step |
||
| 296 | * @return void throws when incompatibility is found |
||
| 297 | * @todo should we allow to be passed in plain arrays as well as Collections? |
||
| 298 | */ |
||
| 299 | 18 | protected function insureEntityCountCompatibility($entity, $referencesDefinition, $step) |
|
| 314 | |||
| 315 | 18 | /** |
|
| 316 | * @param array $step |
||
| 317 | 18 | * @return string |
|
| 318 | */ |
||
| 319 | protected function getReferencesType($step) |
||
| 323 | 1 | ||
| 324 | 1 | /** |
|
| 325 | * @param array $step |
||
| 326 | 1 | * @return bool |
|
| 327 | */ |
||
| 328 | protected function allowEmptyReferences($step) |
||
| 336 | |||
| 337 | protected function getSelfName() |
||
| 345 | 19 | ||
| 346 | 19 | protected function getCollectionName($collection) |
|
| 354 | |||
| 355 | /** |
||
| 356 | * Courtesy code to avoid reimplementing it in every subclass |
||
| 357 | * @todo will be moved into the reference resolver classes |
||
| 358 | */ |
||
| 359 | View Code Duplication | protected function resolveReferencesRecursively($match) |
|
| 370 | } |
||
| 371 |
Loading history...
It seems like the type of the argument is not accepted by the function/method which you are calling.
In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.
We suggest to add an explicit type cast like in the following example: