symfony2admingenerator /
GeneratorBundle
| Conditions | 1 |
| Paths | 1 |
| Total Lines | 132 |
| Lines | 0 |
| Ratio | 0 % |
| Changes | 0 | ||
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 |
||
| 234 | public function getConfigTreeBuilder() |
||
| 235 | { |
||
| 236 | $treeBuilder = new TreeBuilder(); |
||
| 237 | $rootNode = $treeBuilder->root($this->rootName); |
||
| 238 | |||
| 239 | $rootNode |
||
| 240 | ->children() |
||
| 241 | ->booleanNode('use_doctrine_orm')->defaultFalse()->end() |
||
| 242 | ->booleanNode('use_doctrine_odm')->defaultFalse()->end() |
||
| 243 | ->booleanNode('use_propel')->defaultFalse()->end() |
||
| 244 | ->booleanNode('use_jms_security')->defaultFalse()->end() |
||
| 245 | ->booleanNode('guess_required')->defaultTrue()->end() |
||
| 246 | ->booleanNode('default_required')->defaultTrue()->end() |
||
| 247 | ->booleanNode('overwrite_if_exists')->defaultFalse()->end() |
||
| 248 | ->booleanNode('throw_exceptions')->defaultFalse()->end() |
||
| 249 | ->scalarNode('base_admin_template') |
||
| 250 | ->defaultValue("AdmingeneratorGeneratorBundle::base.html.twig") |
||
| 251 | ->end() |
||
| 252 | ->scalarNode('dashboard_route')->defaultNull()->end() |
||
| 253 | ->scalarNode('login_route')->defaultNull()->end() |
||
| 254 | ->scalarNode('logout_route')->defaultNull()->end() |
||
| 255 | ->scalarNode('exit_route')->defaultNull()->end() |
||
| 256 | ->scalarNode('generator_cache')->defaultNull()->end() |
||
| 257 | ->scalarNode('default_action_after_save')->defaultValue('edit')->end() |
||
| 258 | ->scalarNode('knp_menu_alias')->defaultNull()->end() |
||
| 259 | ->booleanNode('use_doctrine_orm_batch_remove')->defaultFalse()->end() |
||
| 260 | ->booleanNode('use_doctrine_odm_batch_remove')->defaultFalse()->end() |
||
| 261 | ->booleanNode('use_propel_batch_remove')->defaultFalse()->end() |
||
| 262 | ->arrayNode('twig') |
||
| 263 | ->addDefaultsIfNotSet() |
||
| 264 | ->children() |
||
| 265 | ->booleanNode('use_form_resources')->defaultTrue()->end() |
||
| 266 | ->booleanNode('use_localized_date')->defaultFalse()->end() |
||
| 267 | ->scalarNode('date_format')->defaultValue('Y-m-d')->end() |
||
| 268 | ->scalarNode('datetime_format')->defaultValue('Y-m-d H:i:s')->end() |
||
| 269 | ->scalarNode('localized_date_format')->defaultValue('medium')->end() |
||
| 270 | ->scalarNode('localized_datetime_format')->defaultValue('medium')->end() |
||
| 271 | ->arrayNode('number_format') |
||
| 272 | ->addDefaultsIfNotSet() |
||
| 273 | ->children() |
||
| 274 | ->scalarNode('decimal')->defaultValue(0)->end() |
||
| 275 | ->scalarNode('decimal_point')->defaultValue('.')->end() |
||
| 276 | ->scalarNode('thousand_separator')->defaultValue(',')->end() |
||
| 277 | ->end() |
||
| 278 | ->end() |
||
| 279 | ->end() |
||
| 280 | ->end() |
||
| 281 | ->arrayNode('templates_dirs') |
||
| 282 | ->prototype('scalar')->end() |
||
| 283 | ->end() |
||
| 284 | ->arrayNode('form_types') |
||
| 285 | ->addDefaultsIfNotSet() |
||
| 286 | ->children() |
||
| 287 | ->arrayNode('doctrine_orm') |
||
| 288 | ->useAttributeAsKey('name') |
||
| 289 | ->prototype('scalar')->end() |
||
| 290 | ->defaultValue($this->defaultFormTypes['doctrine_orm']) |
||
| 291 | ->validate() |
||
| 292 | ->ifNotInArray(array_keys($this->defaultFormTypes['doctrine_orm'])) |
||
| 293 | ->then(function($v) { |
||
| 294 | return array_merge($this->defaultFormTypes['doctrine_orm'], $v); |
||
| 295 | }) |
||
| 296 | ->end() |
||
| 297 | ->end() |
||
| 298 | ->arrayNode('doctrine_odm') |
||
| 299 | ->useAttributeAsKey('name') |
||
| 300 | ->prototype('scalar')->end() |
||
| 301 | ->defaultValue($this->defaultFormTypes['doctrine_odm']) |
||
| 302 | ->validate() |
||
| 303 | ->ifNotInArray(array_values($this->defaultFormTypes['doctrine_odm'])) |
||
| 304 | ->then(function ($v){ |
||
| 305 | return array_merge($this->defaultFormTypes['doctrine_odm'], $v); |
||
| 306 | }) |
||
| 307 | ->end() |
||
| 308 | ->end() |
||
| 309 | ->arrayNode('propel') |
||
| 310 | ->useAttributeAsKey('name') |
||
| 311 | ->prototype('scalar')->end() |
||
| 312 | ->defaultValue($this->defaultFormTypes['propel']) |
||
| 313 | ->validate() |
||
| 314 | ->ifNotInArray(array_values($this->defaultFormTypes['propel'])) |
||
| 315 | ->then(function ($v){ |
||
| 316 | return array_merge($this->defaultFormTypes['propel'], $v); |
||
| 317 | }) |
||
| 318 | ->end() |
||
| 319 | ->end() |
||
| 320 | ->end() |
||
| 321 | ->end() |
||
| 322 | ->arrayNode('filter_types') |
||
| 323 | ->addDefaultsIfNotSet() |
||
| 324 | ->children() |
||
| 325 | ->arrayNode('doctrine_orm') |
||
| 326 | ->useAttributeAsKey('name') |
||
| 327 | ->prototype('scalar')->end() |
||
| 328 | ->defaultValue($this->defaultFilterTypes['doctrine_orm']) |
||
| 329 | ->validate() |
||
| 330 | ->ifNotInArray(array_values($this->defaultFilterTypes['doctrine_orm'])) |
||
| 331 | ->then(function ($v){ |
||
| 332 | return array_merge($this->defaultFilterTypes['doctrine_orm'], $v); |
||
| 333 | }) |
||
| 334 | ->end() |
||
| 335 | ->end() |
||
| 336 | ->arrayNode('doctrine_odm') |
||
| 337 | ->useAttributeAsKey('name') |
||
| 338 | ->prototype('scalar')->end() |
||
| 339 | ->defaultValue($this->defaultFilterTypes['doctrine_odm']) |
||
| 340 | ->validate() |
||
| 341 | ->ifNotInArray(array_keys($this->defaultFilterTypes['doctrine_odm'])) |
||
| 342 | ->then(function ($v){ |
||
| 343 | return array_merge($this->defaultFilterTypes['doctrine_odm'], $v); |
||
| 344 | }) |
||
| 345 | ->end() |
||
| 346 | ->end() |
||
| 347 | ->arrayNode('propel') |
||
| 348 | ->useAttributeAsKey('name') |
||
| 349 | ->prototype('scalar')->end() |
||
| 350 | ->defaultValue($this->defaultFilterTypes['propel']) |
||
| 351 | ->validate() |
||
| 352 | ->ifNotInArray(array_values($this->defaultFilterTypes['propel'])) |
||
| 353 | ->then(function ($v){ |
||
| 354 | return array_merge($this->defaultFilterTypes['propel'], $v); |
||
| 355 | }) |
||
| 356 | ->end() |
||
| 357 | ->end() |
||
| 358 | ->end() |
||
| 359 | ->end() |
||
| 360 | ->append($this->getStylesheetNode()) |
||
| 361 | ->append($this->getJavascriptsNode()) |
||
| 362 | ->end(); |
||
| 363 | |||
| 364 | return $treeBuilder; |
||
| 365 | } |
||
| 366 | |||
| 405 | } |
Loading history...
Let’s take a look at an example:
In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break.
Available Fixes
Change the type-hint for the parameter:
Add an additional type-check:
Add the method to the parent class: