I'm a fairly experienced PHP coder, and am just wondering what the best way of echoing large chunks of HTML code is (best practise).
Is it better to do this:
<?php
echo "<head>
<title>title</title>
<style></style>
</head>";
?>
or this:
<?php
define("rn","\r\n");
echo "<head>".rn
."<title>title</title>".rn
."<style></style".rn
."</head>".rn;
?>
I tend to use the second as it doesn't mess up indenting in the php source. Is this the way most people do it?
IMO, The best way is typically to store the HTML separately in a template file. This is a file that typically contains HTML with some fields that need to get filled in. You can then use some templating framework to safely fill in the fields in the html document as needed.
Smarty is one popular framework, here's an example how that works (taken from Smarty's crash course).
Template File
<html>
<head>
<title>User Info</title>
</head>
<body>
User Information:<p>
Name: {$name}<br>
Address: {$address}<br>
</body>
</html>
Php code that plugs name & address into template file:
include('Smarty.class.php');
// create object
$smarty = new Smarty;
// assign some content. This would typically come from
// a database or other source, but we'll use static
// values for the purpose of this example.
$smarty->assign('name', 'george smith');
$smarty->assign('address', '45th & Harris');
// display it
$smarty->display('index.tpl');
Aside from Smarty there's dozens of reasonable choices for templating frameworks to fit your tastes. Some are simple, many have some rather sophisticated features.
You could also place your HTML outside of the PHP code block:
<?php
// PHP code
?>
<head>
<title>title</title>
<style></style>
</head>
<?php
// further PHP code
?>
Dont forget you also have access to HEREDOC (http://www.php.net/manual/en/language.types.string.php#language.types.string.syntax.heredoc)
echo <<< HERE
<head>
<title>title</title>
<style></style>
</head>
HERE;
Also, I would look into something like Smarty templates - and more importantly the MVC design pattern which enforces separating markup from business logic.
user heredoc syntax
echo <<<NO_MORE
<head>
<title>title</title>
<style></style>
</head>
NO_MORE;
or just escape from php output html directly ?> ... <?php
I think neither is the best solution. Echoing html is not very readable. I always put the html outside of the php tags. This way, you get the indentation, and it's more readable too.
Something like this:
?>
<head>
<title>title</title>
<style></style>
</head>
<?php
And if you want to take it further, you can use a template system to really separate the logic from the presentation.
Since there is already enough alternatives given, I'd just comment on your second approach. If you want to do it with echo, it is better to use:
echo "<head>", PHP_EOL,
"<title>title</title>", PHP_EOL
"<style></style", PHP_EOL
"</head>", PHP_EOL;
Using PHP_EOL instead of a custom constant does not litter the global scope with a superfluous constant and also makes the newline OS-independent, as it will use what is defined for the OS PHP is running on.
Using commas instead of concatenation saves you some memory due to PHP not having to concatenate at all, but just flushing whatever you throw at echo.
This worked fine for me!
<?php
echo '
<!DOCTYPE HTML>
<html lang="en-US">
<head>
<meta charset="utf-8" />
<link rel="stylesheet" type="text/css" href="styles.css" />
<script type="text/javascript" src="js/jquery.js"></script>
<script type="text/javascript" src="js/java.js"></script>
</head>
<body>
<div id="wrap">
<div id="main_home"></div>
<div id="nav_circle"></div>
<input type="text" id="search_text" value="Your search starts here">
</div>
</body>
</html>
';
?>
You can echo large amount of HTML code like this in PHP. You have to be sure that is no ' inside HTML. Replace it with " and it will go on!!
The first form is more efficient, as it does not perform string concatenation (.).
If you're using quotes to display HTML, use the single quote ' ones because PHP searches for variables into the double quotes ", which is less preferment for showing static strings.
For me, the best method remains the one outside the PHP block, some like others answered.
Also, don't forget the shortcut.
