Cecil

FrontmatterDoctor

Front matter diagnosis domain service.

Table of Contents

Constants

MAX_ERRORS_PER_FILE  : mixed = 20

Methods

diagnose()  : array{summary: array{files_scanned: int, files_with_frontmatter: int, valid_frontmatters: int, invalid_frontmatters: int, files_without_frontmatter: int}, findings: array}
collectFrontmatterErrors()  : array<int, array{line: int|null, details: string}>

Constants

Methods

diagnose()

public diagnose(Builder $builder[, array{page?: string} $options = [] ]) : array{summary: array{files_scanned: int, files_with_frontmatter: int, valid_frontmatters: int, invalid_frontmatters: int, files_without_frontmatter: int}, findings: array}
Parameters
$builder : Builder
$options : array{page?: string} = []
Return values
array{summary: array{files_scanned: int, files_with_frontmatter: int, valid_frontmatters: int, invalid_frontmatters: int, files_without_frontmatter: int}, findings: array}

collectFrontmatterErrors()

private collectFrontmatterErrors(Converter $converter, string $frontmatter, string $format) : array<int, array{line: int|null, details: string}>
Parameters
$converter : Converter
$frontmatter : string
$format : string
Return values
array<int, array{line: int|null, details: string}>
On this page

Search results