}> path => [file signature, header] */ private static array $memo = []; /** * The frontmatter of the first of a page's content files that has one: * the file for the page's own language, then (when given) the active * language's, then the untyped `{template}.md`, then any other * `{template}*.md`. Empty when none of them has frontmatter. * * @return array */ public static function forPage(PageInterface $page, ?string $activeLanguage = null): array { $path = $page->path(); // The content file's own name: a module's template() is // `modular/`, and a `template` header names no file at all. $template = PageTemplate::fileType($page); if (!$path || !$template) { return []; } $candidates = []; $language = $page->language(); if ($language) { $candidates[] = $path . '/' . $template . '.' . $language . '.md'; } if ($activeLanguage) { $candidates[] = $path . '/' . $template . '.' . $activeLanguage . '.md'; } $candidates[] = $path . '/' . $template . '.md'; foreach ($candidates as $file) { $header = self::parse($file); if ($header !== []) { return $header; } } foreach (glob($path . '/' . $template . '*.md') ?: [] as $file) { $header = self::parse($file); if ($header !== []) { return $header; } } return []; } /** * The YAML frontmatter of one file: the block between a leading `---` line * and the next one. Empty for a missing file, a file without frontmatter or * frontmatter that doesn't parse to a map. * * @return array */ public static function parse(string $file): array { $stat = is_file($file) ? @stat($file) : false; if ($stat === false) { return []; } $signature = $stat['mtime'] . ':' . $stat['size'] . ':' . $stat['ino']; $memo = self::$memo[$file] ?? null; if ($memo !== null && $memo[0] === $signature) { return $memo[1]; } $cache = self::cache(); $key = self::CACHE_PREFIX . md5($file); if ($cache !== null) { $cached = $cache->fetch($key); if (is_array($cached) && ($cached[0] ?? null) === $signature && is_array($cached[1] ?? null)) { self::$memo[$file] = $cached; return $cached[1]; } } $header = self::parseContents(@file_get_contents($file)); $entry = [$signature, $header]; self::$memo[$file] = $entry; $cache?->save($key, $entry); return $header; } /** * Forget what this request has read. For tests; the Grav cache entries * stay, and are checked against the file anyway. */ public static function reset(): void { self::$memo = []; } /** * @return array */ private static function parseContents(string|false $contents): array { if ($contents === false) { return []; } // Grav frontmatter: content between leading `---\n` and the next `---\n`. if (!preg_match('/^---\r?\n(.*?)\r?\n---\r?\n/s', $contents, $matches)) { return []; } try { $parsed = Yaml::parse($matches[1]); } catch (Throwable) { return []; } return is_array($parsed) ? $parsed : []; } private static function cache(): ?object { try { $cache = Grav::instance()['cache'] ?? null; } catch (Throwable) { return null; } return is_object($cache) && method_exists($cache, 'fetch') && method_exists($cache, 'save') ? $cache : null; } }