PHP - Heredoc & Nowdoc: A Friendly Guide for Beginners

Hello there, aspiring PHP programmers! Today, we're going to dive into two nifty features of PHP that can make your life a whole lot easier when dealing with strings: Heredoc and Nowdoc. Don't worry if these terms sound like alien languages to you - by the end of this tutorial, you'll be using them like a pro!

PHP - Heredoc & Nowdoc

What Are Heredoc and Nowdoc?

Before we jump into the nitty-gritty, let's understand what Heredoc and Nowdoc are in simple terms. Imagine you're writing a long letter to a friend. Instead of using quotation marks for every line, wouldn't it be nice if you could just write freely? That's exactly what Heredoc and Nowdoc allow you to do in PHP - write multi-line strings without worrying about escaping quotes.

Heredoc Strings in PHP

What is Heredoc?

Heredoc is a way to define strings in PHP that allows you to write multiple lines of text without using quotation marks. It's particularly useful when you need to include a large block of text in your code, like HTML snippets or long messages.

How to Use Heredoc

To use Heredoc, you start with <<< followed by an identifier (let's call it EOD for "End of Document"), then your text, and finally the same identifier to close it. Here's a simple example:

<?php
$name = "Alice";
$message = <<<EOD
Hello, $name!
Welcome to the wonderful world of PHP.
This is a Heredoc string.
EOD;

echo $message;
?>

When you run this code, it will output:

Hello, Alice!
Welcome to the wonderful world of PHP.
This is a Heredoc string.

Let's break this down:

We start the Heredoc string with <<<EOD
We write our multi-line message
We end the Heredoc string with EOD; on a new line
PHP replaces $name with "Alice" because Heredoc allows variable interpolation

Variable Interpolation in Heredoc

One of the cool things about Heredoc is that it automatically interprets variables. Let's see another example:

<?php
$fruit = "apple";
$count = 5;

$shopping_list = <<<EOD
My shopping list:
- $count {$fruit}s
- 2 bananas
- 1 loaf of bread
EOD;

echo $shopping_list;
?>

This will output:

My shopping list:
- 5 apples
- 2 bananas
- 1 loaf of bread

Notice how $count and $fruit were replaced with their values. The {$fruit}s syntax allows us to append an 's' directly to the variable value.

Heredoc with HTML

Heredoc is super handy when you need to include HTML in your PHP code. Here's an example:

<?php
$title = "My Awesome Page";
$content = "Welcome to my website!";

$html = <<<EOD
<!DOCTYPE html>
<html>
<head>
    <title>$title</title>
</head>
<body>
    <h1>$title</h1>
    <p>$content</p>
</body>
</html>
EOD;

echo $html;
?>

This generates a complete HTML page without the need to escape any quotes!

Nowdoc Strings in PHP

What is Nowdoc?

Nowdoc is very similar to Heredoc, but with one key difference: it treats the content as a literal string, meaning it doesn't interpret variables or escape sequences.

How to Use Nowdoc

To use Nowdoc, you use single quotes around the identifier. Here's an example:

<?php
$name = "Bob";
$message = <<<'EOD'
Hello, $name!
This is a Nowdoc string.
Variables are not interpreted here.
EOD;

echo $message;
?>

This will output:

Hello, $name!
This is a Nowdoc string.
Variables are not interpreted here.

Notice that $name was not replaced with "Bob". That's the key difference between Heredoc and Nowdoc.

When to Use Nowdoc

Nowdoc is perfect when you need to include code samples or any text that shouldn't have variables interpreted. For example:

<?php
$php_code = <<<'CODE'
<?php
$greeting = "Hello, World!";
echo $greeting;
?>
CODE;

echo "Here's a PHP code sample:\n\n";
echo $php_code;
?>

This will output:

Here's a PHP code sample:

<?php
$greeting = "Hello, World!";
echo $greeting;
?>

The PHP code inside the Nowdoc string is displayed exactly as written, without any interpretation.

Comparing Heredoc and Nowdoc

To summarize the differences between Heredoc and Nowdoc, let's look at a comparison table:

Feature	Heredoc	Nowdoc
Syntax	`<<<EOD`	`<<<'EOD'`
Variable Interpolation	Yes	No
Escape Sequences	Interpreted	Not Interpreted
Use Case	Dynamic content, HTML	Literal strings, Code samples

Conclusion

And there you have it, folks! Heredoc and Nowdoc are powerful tools in your PHP toolkit. Heredoc is great when you need to work with multi-line strings that include variables, while Nowdoc is perfect for situations where you need the string to be taken literally.

Remember, programming is all about choosing the right tool for the job. Now that you understand Heredoc and Nowdoc, you can write cleaner, more readable code when dealing with long strings or HTML snippets.

Keep practicing, and soon you'll be stringing together PHP code like a pro! Happy coding!

Credits: Image by storyset

Previous Tutorial:

PHP - Maths Functions

Next Tutorial:

PHP - Compound Types