MainLayout

The MainLayout class manages the layout metadata, dynamic scripts, and overall structure for head and footer HTML elements used across the application.

Purpose

The MainLayout class centralizes the handling of page metadata, reusable script management, and dynamic rendering of the HTML document head and footer. It ensures consistent and optimized injection of resources and metadata across pages.

Static Properties

  • static string $title: The current page's title.
  • static string $description: The page's meta description.
  • static string $children: Content to render in the main layout.
  • static string $childLayoutChildren: Nested layout content.
  • static string $html: The full HTML content output.

Script Management

  • addHeadScript(...$scripts): Adds one or more scripts to the <head>.
  • addFooterScript(...$scripts): Adds one or more scripts to the footer.
  • outputHeadScripts(): Returns the head scripts with dynamic attributes.
  • outputFooterScripts(): Returns all the footer scripts as a string.
  • clearHeadScripts(): Clears all added head scripts.
  • clearFooterScripts(): Clears all added footer scripts.

Metadata Management

  • addCustomMetadata($key, $value): Adds metadata to the head dynamically.
  • getCustomMetadata($key): Retrieves a custom metadata value.
  • outputMetadata(): Outputs metadata tags including default and custom meta tags.
  • clearCustomMetadata(): Clears all custom metadata.

Usage Examples

1. Set Title and Description

<?php
use Lib\MainLayout;

MainLayout::$title = 'Welcome';
MainLayout::$description = 'This is a sample page using MainLayout';

?>

2. Add and Output Head Scripts

<?php
use Lib\MainLayout;

MainLayout::addHeadScript('<script src="/js/main.js"></script>');

?>

3. Add and Output Footer Scripts

<?php
use Lib\MainLayout;

MainLayout::addFooterScript('<script src="/js/footer.js"></script>');
?>

4. Add Custom Metadata

<?php
use Lib\MainLayout;

MainLayout::addCustomMetadata('author', 'Abraham');
MainLayout::addCustomMetadata('keywords', 'layout, scripts, php');

?>

Note: When using MainLayout::addFooterScript or MainLayout::addHeadScript, the scripts are automatically added to the footer or head of the page. You only need to call outputHeadScripts or outputFooterScripts in special cases where manual rendering is required.

For more details, explore the implementation in the src/Lib/MainLayout.php file.