Is This Ever OK?
Out Of Date Warning
Languages change. Perspectives are different. Ideas move on. This article was published on September 27, 2008 which is more than two years ago. It may be out of date. You should verify that technical information in this article is still current before relying upon it for your own purposes.
As a developer I’m often torn between the concept of “it works” and the concept of “it’s right.” This is no less true than in the following example…
<?php
class Foo
{
public $property;
public function outputProperty($var = null)
{
// Some function processing here.
?>
The value of the property is <?php echo $this->property; ?>
<!-- html here !-->
<?php
}
}
?>
There’s great debate amongst the PHP community about when exiting PHP and printing strict HTML is permissible; this example clearly works (you can test it), but is it right?
In terms of readability, it’s terrible. If you’re in the midst of a class and all of a sudden you’re outputting straight HTML, it can confuse a reader. The best commenting in the world can’t help. Most programs that do code highlighting highlight PHP and echo() statements differently.
But on the other side, if you’re going to do a big long string of PHP, and you want to throw in some javascript, doing this isn’t very practical, especially if you have lots of Javascript and, like me, place your strings in single quotes rather than double quotes.
So what do you think, PHP community? Give me your thoughts.
Write better object
oriented PHP today.
A brand new book on object oriented PHP that will leave you an object oriented master.
Learn more about the book »
Books
Write better object oriented PHP today.
Object oriented programming always leaves you with a headache. What if you could master it instead? Stop struggling with object oriented PHP. Mastering Object Oriented PHP is the answer!
Write clear, compelling PHP code that communicates intent.
Imagine if you could write clear, compelling code each and every time you sat down to work. You can do this. I'll show you how with The Ten Commandments of Clean Code.
Brandon Savage has been a software developer since 2003. Ever since discovering that he could use software to automate routine tasks, he's been hooked. Brandon is passionate about perfecting the art of software development.
While I wouldn’t consider myself someone in a position to tell most people reading this what to do, I think I would pummel my devs if they did this. Partly for readability, partly because it seems off, but mostly because I can be pretty certain that layout and presentation is going to be making its way into your business logic.
One quick solution is to just pull the html out into a new php file and turn it into an include or require. Though even that case you would want to take a serious look at the overall architecture of your site as again you probably have a class trying to do too much.