Aller au contenu

Référence

phil/accessibility-check

Vérification

TypeRôle
AccessibilityCheckerExécute les règles retenues par la politique sur du HTML (checkHtml()) ou un document UJO (checkUjo()), et retourne un Report
PolicyLimites, titres, contraste et couleurs, jetons de couleur, langue, textes de lien génériques, règles désactivées ou dotées d'une autre sévérité, locale
HeadingPolicySingle, None ou Any : les titres de premier niveau qu'un contenu peut avoir
ContrastLevelAA ou AAA : les rapports de contraste exigés et leur critère de succès
SeverityError, Warning ou Notice, avec isAtLeast()
SuccessCriterionLes 86 critères de succès de WCAG 2.2 par numéro, avec title(), level() et understandingUrl()
ConformanceLevelA, AA ou AAA

Le rapport

TypeRôle
ReportLe résultat de chaque règle et les constats, filtrés, traduits et sérialisés en JSON
RuleResultLe résultat d'une règle : identifiant, critère, sévérité, nombre de constats, passed()
FindingUn problème : règle, critère, sévérité, message, emplacement
LocationL'emplacement d'un constat : ligne, chemin de l'élément et extrait en HTML ; bloc, type et pointeur en UJO
MessageUne clé du domaine phil_accessibility_check et les valeurs de ses paramètres substituables
ViolationCe que produit une règle : un emplacement, un message, et sa propre sévérité ou son propre critère s'il y a lieu

Règles

TypeRôle
Contract\RuleIdentifiant, critère de succès et sévérité d'une règle
Contract\HtmlRuleUne règle qui lit du HTML
Contract\UjoRuleUne règle qui lit des documents UJO
Rule\DefaultRulesLes quinze règles de la bibliothèque, dans leur ordre d'exécution
Rule\FragmentRuleLa base d'une règle qui lit les données de chaque bloc, puis chacun de ses champs HTML
Rule\ImageAlt, HeadingOrder, HeadingH1, EmptyHeading, LinkName, ButtonName, LinkText, ColorContrast, TableHeaders, HtmlLang, LangChange, FrameTitle, VideoCaptions, DuplicateId, SvgNameLes règles : voir Règles
Rule\HeadingUn titre d'un contenu, en HTML ou en UJO
Rule\FileNameSi un texte de remplacement est un nom de fichier
Rule\GenericLinkTextLes textes de lien génériques de six langues, et la façon d'y comparer un nom de lien

Lecture

TypeRôle
Html\HtmlTargetLe HTML analysé et indexé, avec ce que les règles demandent d'un élément
Ujo\UjoTargetUn document UJO tel que le lisent les règles : ses blocs et ses champs HTML
Ujo\UjoReaderParcourt les blocs et leurs données pour UjoTarget
Ujo\BlockVisitUn bloc tel que le rencontre la vérification : son pointeur et sa langue
Ujo\FragmentUn champ HTML d'un bloc, analysé
Ujo\PlainFieldsLes champs de données de bloc qui ne contiennent jamais de HTML
Colour\ColourUne couleur sRGB, avec la luminance relative et le rapport de contraste de WCAG
Colour\ColourParserLit les couleurs CSS
Language\LanguageTagSi une étiquette de langue BCP 47 est bien formée, et sa langue principale

Messages

TypeRôle
Translation\MessagesLes messages pour symfony/translation : resources(), translator(), translate(), locale()
Translation\English, French, Spanish, German, Italian, PortugueseLes messages de chaque langue

Symfony

TypeRôle
Validator\AccessibleContent, AccessibleContentValidatorLa contrainte et son validateur
Workflow\PublicationGuardLa garde qui retient une publication
Contract\SubjectContentLe contenu du sujet d'un workflow, pour la garde
Console\CheckCommandLa commande phil:accessibility:check

Exceptions

TypeRôle
Exception\AccessibilityCheckExceptionImplémentée par chaque exception de la bibliothèque
Exception\InvalidPolicyUne politique ou un ensemble de règles inutilisable
Exception\LimitExceededUn contenu qui dépasse une limite de la politique
Exception\InvalidContentDu HTML qui n'est pas en UTF-8