mouf/html.template.templateinterface

This package contains the definition of an HTML template (the TemplateInterface interface) and an helper class to build HTML templates easily (the BaseTemplate class).

v3.0.0 2022-12-01 16:05 UTC

Requires

• php: ^8.0
• mouf/html.htmlelement: ^2
• mouf/html.renderer: ^2
• mouf/html.utils.weblibrarymanager: ^4

Requires (Dev)

• maglnet/composer-require-checker: ^4.2
• phpstan/phpstan: ^1.9
• squizlabs/php_codesniffer: ^3.3.1
• thecodingmachine/phpstan-strict-rules: ^1.0

MIT

• David Négrier

• template
• interface
• templateinterface

README

TemplateInterface: a base interface to manage HTML templates in your project

TemplateInterface is a Mouf package that is the base building block of all HTML templates in Mouf.

You can use it without Mouf, but most of the time, you will use Mouf and its install process to get quickly started. Also, most of the time, you will not use the TemplateInterface package directly. Instead, you will use a Mouf template that is built using the TemplateInterface.

When you use a template object that implements TemplateInterface, you know this:

• The object has a "toHtml" method that will trigger the HTML output of the template. Call this method, and your template is displayed.
• The object has a "setTitle" method to set the title of the page.
• The object has a "getWebLibraryManager" method that returns a web library manager. The WebLibraryManager can be used to add JS/CSS files to your template.

Depending on the template you will use, there will be one or more zones (main content, left menu, header, etc...) This is template specific. If you use Mouf, each zone of the template will be represented by a HtmlBlock object. You will directly access this block to add content in it.

Here is a sample pseudo code:

// Let's access the "content" block:
Mouf::getContent()->addText("Hello world!");

// Let's write the template:
Mouf::getTemplate()->toHtml();

Internally, the template uses the "content" block, but you should not care about it.