Raul Fraile will present on refactoring PHP/Symfony apps. The agenda includes refactoring 101, coding standards, using an IDE effectively, separating code and data, avoiding environment coupling, and reducing duplicated code (DRY). The example project is an API for jokes. It allows getting a list of jokes or adding/editing jokes and sends email on changes. Special cases are that Java jokes are not allowed. The code will be refactored over the steps in the tags.

1. REFACTORING
PHP/SYMFONY2
APPS

2. Thank you to all our sponsors!

3. Raúl Fraile
• Software developer at
• PHP 5.3 Zend Certified Engineer
• Symfony Certified Developer
• LadybugPHP
raulfraile

4. 1. Refactoring 101
2. Coding Standard
3. IDE
4. Code/Data separation
5. Environment coupling
6. Don’t Repeat Yourself
7. Fat controllers
Agenda

5. Test project

6. APIJokes (I)
GET /api/list
Get the jokes list in JSON
POST /api/add
Add a new joke
POST /api/edit
Edit an existing joke
GET /
Public website with the joke list in HTML

7. APIJokes (II)
Special cases
Every time a joke is added or edited,
an email is sent to the administrator.
We don’t allow jokes about Java.

8. raulfraile/apijokes
There are tags for each step!

9. Refactoring 101

10. Rewrite VS Refactor

11. Rewrite
http://www.flickr.com/photos/meliah/2601885140/

12. http://www.flickr.com/photos/90692443@N05/8239219385/
Refactor

13. Refactoring is a
continuous process

15. Always taking a software
that works...

16. ...and which has tests

17. Coding Standard

18. http://www.flickr.com/photos/zpeckler/2835570492/
Change my CS?!

19. Important: Choose a CS
and be consistent

20. Open source projects:
share the same CS

21. PSR-1/2

23. http://cs.sensiolabs.org

24. php-cs-fixer fix ApiJokesBundle/ --level=all --dry-run --diff -v
1) Controller/WebsiteController.php (braces, return)
---------- begin diff ----------
--- Original
+++ New
@@ @@
-class WebsiteController extends Controller {
- public function indexAction() {
+class WebsiteController extends Controller
+{
+ public function indexAction()
+ {
$em = $this->getDoctrine()->getManager();
$jokes = $em->getRepository('...')->findAll();
+
return $this->render('...', array(
'jokes' => $jokes
));
}
}
---------- end diff ----------

25. IDE

26. Problems: DIC, foreach,
repositories...

27. <?php
$mailer = $this->get('mailer');
$mailer->send($message);

28. <?php
/** @var $mailer Swift_Mailer */
$mailer = $this->get('mailer');
$mailer->send($message);

29. Type hints, not only to
help the IDE...

30. <?php
$data = array_map(function ($item) {
return array(
'id' => $item->getId(),
'content' => $item->getContent()
);
}, $jokes);

31. <?php
$data = array_map(function (Joke $item)
{
return array(
'id' => $item->getId(),
'content' => $item->getContent()
);
}, $jokes);

32. Code/Data
separation

33. They are different
http://www.flickr.com/photos/yukariryu/121153772/

34. A change in the data or
configuration should’t
require changing the code

35. public function load(ObjectManager $manager)
{
$jokes = array(
'There’s no place like 127.0.0.1',
'If at first you don’t succeed; call it version 1.0',
'Beware of programmers that carry screwdrivers',
'What color do you want that database?'
);
foreach ($jokes as $item) {
$joke = new Joke();
$joke->setContent($item);
$manager->persist($joke);
}
$manager->flush();
}

36. # fixtures/joke.yml
jokes:
- 'I would love to change the world, but they won’t...'
- 'There’s no place like 127.0.0.1'
- 'If at first you don’t succeed; call it version 1.0'
- 'You know it’s love when you memorize her IP...'
- 'Beware of programmers that carry screwdrivers'
- 'Best file compression around: “rm *.*” = 100...'
- 'The truth is out there…anybody got the URL?'
- 'What color do you want that database?'

37. public function load(ObjectManager $manager)
{
$jokes = Yaml::parse(__DIR__ . '/fixtures/joke.yml');
foreach ($jokes['jokes'] as $item) {
$joke = new Joke();
$joke->setContent($item);
$manager->persist($joke);
}
$manager->flush();
}

38. Environment coupling

39. http://www.flickr.com/photos/darkhornet/4945282009/
FAIL

40. {% if app.environment == 'prod' %}
<script type="text/javascript">
// Google Analytics code
</script>
{% endif %}

41. The software shouldn’t
take any decision based
on the environment

42. Better approach:
different configuration
for each environment

43. {% if enable_analytics %}
<script type="text/javascript">
// Google Analytics code
</script>
{% endif %}

44. Don’t Repeat
Yourself

45. // do not allow jokes about java)
if (stripos($content, 'java') !== false) {
throw new BadRequestHttpException(
'Java jokes are not allowed'
);
}

46. use SymfonyComponentValidatorConstraint;
/**
* @Annotation
*/
class ContainsJava extends Constraint
{
public $message = 'Java jokes are not allowed';
}

47.
use SymfonyComponentValidatorConstraint;
use SymfonyComponentValidatorConstraintValidator;
class ContainsJavaValidator extends ConstraintValidator
{
public function validate($value, Constraint $constraint)
{
if (stripos($value, 'java') !== false) {
$this->context->addViolation($constraint->message);
}
}
}

48. Fat controllers

49. Go on a diet!
http://www.flickr.com/photos/golf_pictures/3017331832/

50. Configuration, events,
annotations, services, simpler
methods, inheritance, param
converters...

51. https://joind.in/8835
Questions?