| Conditions | 7 |
| Paths | 11 |
| Total Lines | 141 |
| Code Lines | 84 |
| Lines | 0 |
| Ratio | 0 % |
| Changes | 9 | ||
| Bugs | 2 | Features | 1 |
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
| 1 | <?php |
||
| 143 | protected function generateRelationshipMethods(PhpTrait $trait, Table $model) { |
||
| 144 | if ($model->isReadOnly()) { |
||
| 145 | return; |
||
| 146 | } |
||
| 147 | |||
| 148 | $fields = []; |
||
| 149 | $methods = []; |
||
| 150 | $plural = []; |
||
| 151 | $relationships = $this->modelService->getRelationships($model); |
||
| 152 | $methodNameGenerator = $this->factory->getRelationshipMethodNameGenerator(); |
||
| 153 | |||
| 154 | // add self link for relationships if there are any |
||
| 155 | if ($relationships->size() > 0) { |
||
| 156 | $trait->addUseStatement('Tobscure\\JsonApi\\Relationship'); |
||
| 157 | $trait->setMethod(PhpMethod::create('addRelationshipSelfLink') |
||
| 158 | ->addParameter(PhpParameter::create('relationship') |
||
| 159 | ->setType('Relationship') |
||
| 160 | ) |
||
| 161 | ->addParameter(PhpParameter::create('model') |
||
| 162 | ->setType('mixed') |
||
| 163 | ) |
||
| 164 | ->addParameter(PhpParameter::create('related') |
||
| 165 | ->setType('string') |
||
| 166 | ) |
||
| 167 | ->setAbstract(true) |
||
| 168 | ->setVisibility(PhpMethod::VISIBILITY_PROTECTED) |
||
| 169 | ->setType('Relationship') |
||
| 170 | ); |
||
| 171 | } |
||
| 172 | |||
| 173 | // iterate all relationships |
||
| 174 | foreach ($relationships->getAll() as $rel) { |
||
| 175 | // one-to-one |
||
| 176 | if ($rel->getType() == Relationship::ONE_TO_ONE) { |
||
| 177 | $foreign = $rel->getForeign(); |
||
| 178 | $relatedName = $rel->getRelatedName(); |
||
| 179 | $typeName = $rel->getRelatedTypeName(); |
||
| 180 | $method = NameUtils::toCamelCase($relatedName); |
||
| 181 | $fields[$typeName] = $foreign->getPhpName() . '::getSerializer()->getType(null)'; |
||
| 182 | $trait->addUseStatement($foreign->getNamespace() . '\\' . $foreign->getPhpName()); |
||
| 183 | $trait->addUseStatement('Tobscure\\JsonApi\\Resource'); |
||
| 184 | |||
| 185 | // read |
||
| 186 | $body = $this->twig->render('to-one-read.twig', [ |
||
| 187 | 'class' => $foreign->getPhpName(), |
||
| 188 | 'related' => $relatedName, |
||
| 189 | 'related_type' => $typeName |
||
| 190 | ]); |
||
| 191 | } |
||
| 192 | |||
| 193 | // ?-to-many |
||
| 194 | else { |
||
| 195 | $foreign = $rel->getForeign(); |
||
| 196 | $typeName = $rel->getRelatedPluralTypeName(); |
||
| 197 | $method = NameUtils::toCamelCase($rel->getRelatedPluralName()); |
||
| 198 | $fields[$typeName] = $foreign->getPhpName() . '::getSerializer()->getType(null)'; |
||
| 199 | $trait->addUseStatement($foreign->getNamespace() . '\\' . $foreign->getPhpName()); |
||
| 200 | $trait->addUseStatement('Tobscure\\JsonApi\\Collection'); |
||
| 201 | |||
| 202 | // read |
||
| 203 | $body = $this->twig->render('to-many-read.twig', [ |
||
| 204 | 'class' => $foreign->getPhpName(), |
||
| 205 | 'related' => $typeName, |
||
| 206 | 'related_type' => $rel->getRelatedTypeName() |
||
| 207 | ]); |
||
| 208 | |||
| 209 | // method name for collection |
||
| 210 | $methods[$typeName] = $methodNameGenerator->generateMethodName($rel); |
||
| 211 | $plural[$typeName] = $methodNameGenerator->generatePluralMethodName($rel); |
||
| 212 | // if ($rel->getType() == Relationship::MANY_TO_MANY |
||
| 213 | // && $rel->getForeign() == $rel->getModel()) { |
||
| 214 | // $lk = $rel->getLocalKey(); |
||
| 215 | // $methods[$typeName] = $foreign->getPhpName() . 'RelatedBy' . $lk->getLocalColumn()->getPhpName(); |
||
| 216 | // $plural[$typeName] = NameUtils::pluralize($foreign->getPhpName()) . 'RelatedBy' . $lk->getLocalColumn()->getPhpName(); |
||
| 217 | // } |
||
| 218 | } |
||
| 219 | |||
| 220 | // set read method on class |
||
| 221 | $trait->setMethod(PhpMethod::create($method) |
||
| 222 | ->addParameter(PhpParameter::create('model')) |
||
| 223 | ->setBody($body) |
||
| 224 | ->setType('Relationship') |
||
| 225 | ); |
||
| 226 | |||
| 227 | // add reverse many-to-many |
||
| 228 | if ($rel->getType() == Relationship::MANY_TO_MANY && $rel->isReflexive()) { |
||
| 229 | $foreign = $rel->getForeign(); |
||
| 230 | $typeName = $rel->getReverseRelatedPluralTypeName(); |
||
| 231 | $method = NameUtils::toCamelCase($rel->getReverseRelatedPluralName()); |
||
| 232 | $fields[$typeName] = $foreign->getPhpName() . '::getSerializer()->getType(null)'; |
||
| 233 | $trait->addUseStatement($foreign->getNamespace() . '\\' . $foreign->getPhpName()); |
||
| 234 | $trait->addUseStatement('Tobscure\\JsonApi\\Collection'); |
||
| 235 | |||
| 236 | // read |
||
| 237 | $body = $this->twig->render('to-many-read.twig', [ |
||
| 238 | 'class' => $foreign->getPhpName(), |
||
| 239 | 'related' => $typeName, |
||
| 240 | 'related_type' => $rel->getReverseRelatedTypeName() |
||
| 241 | ]); |
||
| 242 | |||
| 243 | $methods[$typeName] = $methodNameGenerator->generateReverseMethodName($rel); |
||
| 244 | $plural[$typeName] = $methodNameGenerator->generateReversePluralMethodName($rel); |
||
| 245 | |||
| 246 | // set read method on class |
||
| 247 | $trait->setMethod(PhpMethod::create($method) |
||
| 248 | ->addParameter(PhpParameter::create('model')) |
||
| 249 | ->setBody($body) |
||
| 250 | ->setType('Relationship') |
||
| 251 | ); |
||
| 252 | } |
||
| 253 | } |
||
| 254 | |||
| 255 | // method: getRelationships() : array |
||
| 256 | $trait->setMethod(PhpMethod::create('getRelationships') |
||
| 257 | ->setBody($this->twig->render('getRelationships.twig', [ |
||
| 258 | 'fields' => $fields |
||
| 259 | ])) |
||
| 260 | ); |
||
| 261 | |||
| 262 | // method: getCollectionMethodName($relatedName) : string |
||
| 263 | $trait->setProperty(PhpProperty::create('methodNames') |
||
| 264 | ->setExpression($this->codegenService->mapToCode($methods)) |
||
| 265 | ->setVisibility(PhpProperty::VISIBILITY_PRIVATE) |
||
| 266 | ); |
||
| 267 | $trait->setMethod(PhpMethod::create('getCollectionMethodName') |
||
| 268 | ->addParameter(PhpParameter::create('relatedName')) |
||
| 269 | ->setBody($this->twig->render('getCollectionMethodName.twig')) |
||
| 270 | ->setVisibility(PhpMethod::VISIBILITY_PROTECTED) |
||
| 271 | ); |
||
| 272 | |||
| 273 | // method: getCollectionMethodPluralName($relatedName) : string |
||
| 274 | $trait->setProperty(PhpProperty::create('methodPluralNames') |
||
| 275 | ->setExpression($this->codegenService->mapToCode($plural)) |
||
| 276 | ->setVisibility(PhpProperty::VISIBILITY_PRIVATE) |
||
| 277 | ); |
||
| 278 | $trait->setMethod(PhpMethod::create('getCollectionMethodPluralName') |
||
| 279 | ->addParameter(PhpParameter::create('relatedName')) |
||
| 280 | ->setBody($this->twig->render('getCollectionMethodPluralName.twig')) |
||
| 281 | ->setVisibility(PhpMethod::VISIBILITY_PROTECTED) |
||
| 282 | ); |
||
| 283 | } |
||
| 284 | |||
| 293 | } |
It seems like you are relying on a variable being defined by an iteration: