template name to "it does not exist" */ private array $missing = []; private bool $typesAsked = false; /** @var list|null */ private ?array $types = null; public function __construct(private readonly Grav $grav) {} /** * The registered modular types: what the theme's and plugins' blueprints * and `templates/modular/` folders declare, and what the admin offers. * * @return list|null null when the registry cannot be asked */ public function types(): ?array { if (!$this->typesAsked) { $this->types = $this->askTypes(); $this->typesAsked = true; } return $this->types; } /** * The registered spelling of `$template` (`modular/hero` for `Hero`), or * null when it is not a registered type. Case does not matter, so `Hero` * does not become a `Hero.md` that only renders on a case-insensitive * filesystem. */ public function registered(string $template): ?string { foreach ($this->types() ?? [] as $type) { if (strcasecmp($type, $template) === 0) { return $type; } } return null; } /** * Whether a module rendering with `$template` (as `Page::template()` reports * it, so `modular/` unless a `template` header says otherwise) would * hit core's "template not found" heading. * * False when the registry or Twig cannot be asked: a warning that might be * wrong is worse than none. */ public function isMissing(string $template): bool { $template = trim($template); return $this->missing[$template] ??= $this->lookUp($template); } /** @param list $types */ public function hint(array $types): string { return $types ? 'Modular types on this site: ' . implode(', ', $types) . '.' : 'This site has no modular types: its theme has no templates/modular folder.'; } /** * The warning for a module that will render with a template this site does * not have, or null when it exists (or cannot be checked). * * @param string $field `template`, or `header.template` when a header sets it * @return array{field: string, code: string, message: string}|null */ public function warning(string $template, string $field = 'template'): ?array { $template = trim($template); if (!$this->isMissing($template)) { return null; } $where = $field === 'header.template' ? "The 'template' header names '{$template}', which" : "Template '{$template}'"; return [ 'field' => $field, 'code' => 'template_missing', 'message' => $where . " doesn't exist on this site, so the page this module belongs to will show a 'template not found' error until it does. " . $this->hint($this->types() ?? []), ]; } private function lookUp(string $template): bool { $types = $this->types(); if ($types === null || $template === '') { return false; } if (in_array($template, $types, true)) { return false; } return $this->twigHas($template) === false; } /** @return list|null */ private function askTypes(): ?array { $pages = $this->grav['pages']; if (!method_exists($pages, 'types') || !method_exists($pages, 'modularTypes')) { return null; } try { // Core always registers `default`, so an empty list of page types // means the registry was never built (the theme was not ready). if (!$pages::types()) { return null; } return array_map('strval', array_keys($pages::modularTypes())); } catch (\Throwable) { return null; } } /** * Whether Twig can find `