HtmlDocument guide

PreviousItems cache NextCss and Javascript guide

Last updated 3 years ago

Was this helpful?

HtmlDocument guide

When you're using Cherrycake to build a web app, the module helps you create standard HTML structure headers and footers with some additional useful capabilities.

The two most important methods of the module are and , they both take care of building the usual <html><body> ... and ...</body></html> tags. For example, take this code that outputs a simple HTML response to show a webpage:

$e->Output->setResponse(new \Cherrycake\ResponseTextHtml([
    "code" => \Cherrycake\RESPONSE_OK,
    "payload" =>
        $e->HtmlDocument->header().
        "Hello world!".
        $e->HtmlDocument->footer()
]));

This would output the following HTML code:

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="robots" content="index,follow" />
<link rel="stylesheet" type="text/css" href="/css?set=coreUiComponents:718d83f2e5ae92b539f90f7dc7e3ba24" />
<script type="text/javascript" src="/js?set=coreUiComponents:d41d8cd98f00b204e9800998ecf8427e"></script>
<meta name="viewport" content="width=device-width, user-scalable=yes, initial-scale=1, maximum-scale=2" />
</head>
<body>
Hello world!</body>
</html>

Common usage with Patterns

For example, take a look at this HTML pattern named home.html:

<?= $e->HtmlDocument->header() ?>
Hello world!
<?= $e->HtmlDocument->footer() ?>

$e->Patterns->out("home.html");

And we get exactly the same "Hello World!" HTML page as above.

namespace CherrycakeApp\MyModule;

class MyModule extends \Cherrycake\Module {
    protected $dependentCoreModules = [
        "HtmlDocument"
    ];
    
    ...
}

PreviousItems cache NextCss and Javascript guide

Last updated 3 years ago

Was this helpful?

$e->Output->setResponse(new \Cherrycake\ResponseTextHtml([ "code" => \Cherrycake\RESPONSE_OK, "payload" => $e->HtmlDocument->header(). "Hello world!". $e->HtmlDocument->footer() ]));

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> <meta name="robots" content="index,follow" /> <link rel="stylesheet" type="text/css" href="/css?set=coreUiComponents:718d83f2e5ae92b539f90f7dc7e3ba24" /> <script type="text/javascript" src="/js?set=coreUiComponents:d41d8cd98f00b204e9800998ecf8427e"></script> <meta name="viewport" content="width=device-width, user-scalable=yes, initial-scale=1, maximum-scale=2" /> </head> <body> Hello world!</body> </html>

Common usage with Patterns

You might find quite helpful to use the and methods in your HTML . Just call them at the beginning and at the end of your pattern and you'll get a complete HTML document.

For example, take a look at this HTML pattern named home.html:

<?= $e->HtmlDocument->header() ?>
Hello world!
<?= $e->HtmlDocument->footer() ?>

Now we parse it and send it to the user's browser with :

$e->Patterns->out("home.html");

And we get exactly the same "Hello World!" HTML page as above.

Remembers to add the module to your module's list of dependent core modules so it is available to use, like this:

namespace CherrycakeApp\MyModule;

class MyModule extends \Cherrycake\Module {
    protected $dependentCoreModules = [
        "HtmlDocument"
    ];
    
    ...
}