Muster in kernel/classes/help
Hinweis Diese Seite wird aus dem Quellcode von
php bin/php/exppatterncatalogue.php --writeerzeugt. Bearbeiten Sie sie nicht von Hand: Ändern Sie den Code oder den Generator und führen Sie den Befehl dann erneut aus. Wie die Muster erkannt werden: der Musterkatalog.
Jede Klasse, Schnittstelle und jeder Trait von kernel/classes/help mit den Mustern, als die sie erkannt wurden, gefolgt von den Modulansichten, Richtlinienfunktionen, Fetch-Funktionen, Template-Operatoren, Cronjobs, Ereignis-Hooks und INI-Plugin-Punkten des Bereichs. Alle Muster.
Klassen (57)
| Klasse | Art | Muster | Datei | Beschreibung |
|---|---|---|---|---|
expHelp | class | Hilfsklasse (statische Hilfsfunktionen) | kernel/classes/help/exphelp.php:11 | Die gemeinsamen Helfer des Hilfesystems (doc/eng-us/features/6.0/help-system.md): seine Einstellungen, ob es aktiv ist, das Installationsverzeichnis, aus dem es liest, und die UR… |
expHelpAllowlist | class | Fabrik und statische Fabrikmethoden | kernel/classes/help/exphelpallowlist.php:37 | Die Dateien, die das Hilfesystem anzeigen darf (doc/eng-us/features/6.0/help-system.md, "Which files are shown"). |
expHelpAudience | class | Fabrik und statische Fabrikmethoden | kernel/classes/help/exphelpaudience.php:34 | Für wen eine Hilfeseite ist, zu welchem Abschnitt der Hilfe sie gehört und was für eine Seite sie ist (doc/eng-us/features/6.0/help-system.md, „Audiences, cate… |
expHelpCommitFeed | class | Fabrik und statische Fabrikmethoden | kernel/classes/help/exphelpcommitfeed.php:29 | Die neuesten Commits des Exponential-Repositorys für die Entwickler-Landingpage der Hilfe (exphelp/audience/developer, doc/eng-us/features/6.0/he… |
expHelpContentAccess | class | Fabrik und statische Fabrikmethoden | kernel/classes/help/content/exphelpcontentaccess.php:18 | Wer ein Thema, Handbuch oder Kapitel der als Inhalt gepflegten Hilfe sehen darf, entschieden anhand der einfachen Daten, die das Repository zu jedem Objekt führt (expHelpContent… |
expHelpContentBookCheck | class | – | kernel/classes/help/content/exphelpcontentbookcheck.php:26 | Die Prüfungen eines EPUB eines Hilfehandbuchs (doc/eng-us/specifications/6.0/help-system.md, Auslieferungsweg 3: „epubcheck + Ace by DAISY“; doc/eng-us/specifi… |
expHelpContentDita | class | – | kernel/classes/help/content/exphelpcontentdita.php:45 | Der DITA-1.3-Export der als Inhalt gepflegten Hilfe (doc/eng-us/specifications/6.0/help-system.md, „The standard: what DITA means here“ und Auslieferungspf… |
expHelpContentDitaHistory | class | – | kernel/classes/help/content/exphelpcontentditahistory.php:21 | Der Änderungsverlauf der Hilfe in git (doc/eng-us/specifications/6.0/help-system.md, Auslieferungsweg 4: „the DITA export runs regularly into its own gi… |
expHelpContentEbooks | class | Fabrik und statische Fabrikmethoden | kernel/classes/help/content/exphelpcontentebooks.php:26 | E-Books von als Inhalt gespeicherten Hilfehandbüchern (doc/eng-us/specifications/6.0/help-system.md, Auslieferungsweg 3: „stored as a file object under E-books (sec… |
expHelpContentEditionProvider | class extends expHelpContentProvider | Strategie / Handler | kernel/classes/help/content/exphelpcontenteditionprovider.php:16 | Was in eine gespeicherte Ausgabe eines Handbuchs gelangt (expHelpContentEbooks): jedes Objekt im Status Released, wer auch immer das Buch erstellt, und bei einem öffentlichen Handbuch nur was… |
expHelpContentExport | class | – | kernel/classes/help/content/exphelpcontentexport.php:21 | E-Books eines als Inhalt gepflegten Hilfehandbuchs (doc/eng-us/features/6.0/help-content.md, „E-books“): EPUB 3 (hier geschrieben, reines PHP mit ZipArchiv… |
expHelpContentFeedback | class | Hilfsklasse (statische Hilfsfunktionen) | kernel/classes/help/content/exphelpcontentfeedback.php:21 | „War das hilfreich?“ bei jedem Hilfethema (doc/eng-us/specifications/6.0/help-system.md, Phase 7; ISO/IEC/IEEE 26514, Gebrauchstauglichkeit der Informationen): die… |
expHelpContentHelpIds | class | Hilfsklasse (statische Hilfsfunktionen) | kernel/classes/help/content/exphelpcontenthelpids.php:21 | Die help_ids, die Released waren (doc/eng-us/specifications/6.0/help-style-guide.md, Abschnitt 7: „A help_id is never renamed and never reused“): die Tabelle… |
expHelpContentInstaller | class | – | kernel/classes/help/content/exphelpcontentinstaller.php:23 | Legt das Inhaltsmodell der als Inhalt gepflegten Hilfe auf einer installierten Website an, idempotent: die acht help_*-Klassen (Klassengruppe "Help"), die Sektio… |
expHelpContentPackage | class | Fabrik und statische Fabrikmethoden, Hilfsklasse (statische Hilfsfunktionen) | kernel/classes/help/content/exphelpcontentpackage.php:23 | Die Hilfeklassen als Content-Klassen-Paket (doc/eng-us/specifications/6.0/help-content-package.md, CJW #16564): die acht help_*-Klassen von expHelpC… |
expHelpContentProvider | class implements expHelpContextProviderInterface, expHelpContextPageInterface | INI-Plugin-Punkt (Erweiterungspunkt), Singleton / instance(), Strategie / Handler | kernel/classes/help/content/exphelpcontentprovider.php:19 | Als Inhalt gepflegte Hilfe, ausgeliefert in das Hilfesystem (exphelp): die Themen, die der aktuelle Benutzer sehen darf, gerendert mit dem Markdown-Renderer der Hilfe… |
expHelpContentRepository | class | INI-Plugin-Punkt (Erweiterungspunkt), Singleton / instance() | kernel/classes/help/content/exphelpcontentrepository.php:15 | Liest als Inhalt gepflegte Hilfe aus der Datenbank in einfache Arrays (die Formen, die expHelpContentValidator beschreibt), ohne jeden Berechtigungsfilter:… |
expHelpContentReview | class | Hilfsklasse (statische Hilfsfunktionen) | kernel/classes/help/content/exphelpcontentreview.php:23 | Überfällige Reviews von als Inhalt gepflegter Hilfe (doc/eng-us/specifications/6.0/help-system.md, Phase 7 „a list of outdated topics (review date passed)… |
expHelpContentSchema | class | Hilfsklasse (statische Hilfsfunktionen) | kernel/classes/help/content/exphelpcontentschema.php:20 | Das Inhaltsmodell der als Inhalt gepflegten Hilfe (doc/eng-us/specifications/6.0/help-system.md, doc/eng-us/features/6.0/help-content.md): die acht Hilfe… |
expHelpContentSeeder | class | – | kernel/classes/help/content/exphelpcontentseeder.php:15 | Legt das anfängliche Glossar, die Themen, Kapitel und Handbücher aus einer Datendatei an (share/help/seed-glossary.json, share/help/seed-topics.json). |
expHelpContentSite | class | – | kernel/classes/help/content/exphelpcontentsite.php:21 | Hilfe, die als Inhalt auf den eigenen Seiten einer Website gepflegt wird (doc/eng-us/specifications/6.0/help-system.md, Auslieferungsweg 1: „templates full/help_*.tpl and line/… |
expHelpContentTables | class | Hilfsklasse (statische Hilfsfunktionen) | kernel/classes/help/content/exphelpcontenttables.php:21 | Die zwei Tabellen der als Inhalt gepflegten Hilfe (doc/eng-us/features/6.0/help-content.md) auf jeder Engine: ob sie existieren, und ihre Erstellung aus ihren… |
expHelpContentValidator | class | – | kernel/classes/help/content/exphelpcontentvalidator.php:23 | Die maschinell prüfbaren Regeln des Hilfe-Styleguides (doc/eng-us/specifications/6.0/help-style-guide.md), auf einfachen Arrays: keine Datenbank. |
expHelpContentWorkflow | class | Hilfsklasse (statische Hilfsfunktionen) | kernel/classes/help/content/exphelpcontentworkflow.php:23 | Der Prüfablauf der als Inhalt gepflegten Hilfe (doc/eng-us/specifications/6.0/help-system.md, „Status“ und „Permissions“; Styleguide Abschnitt 8, „… |
expHelpContextPageInterface | interface | Schnittstelle (Vertrag) | kernel/classes/help/exphelpcontextpageinterface.php:16 | Ein Kontexthilfe-Anbieter (expHelpContextProviderInterface), der auch Seiten ausliefert, die keine Dateien unterhalb von doc/ sind: als Inhalt gepflegte Hilfethemen, w… |
expHelpContextProviderInterface | interface | Schnittstelle (Vertrag) | kernel/classes/help/exphelpcontextproviderinterface.php:15 | Eine Klasse, die „Hilfe zu dieser Seite“ im Code beantwortet, für das, was ein Map[]-Eintrag pro Ansicht nicht ausdrücken kann (eine Ansicht, deren Hilfe von ihren Parametern abhängt, eine Exte… |
expHelpContextRegistry | class | Fabrik und statische Fabrikmethoden, Registry, Singleton / instance() | kernel/classes/help/exphelpcontextregistry.php:45 | Kontexthilfe: welche Hilfeseite „Hilfe zu dieser Seite“ beantwortet, für ein Modul, eine Ansicht und ein Design. |
expHelpDitaMarkup | class | – | kernel/classes/help/content/exphelpditamarkup.php:21 | Der sichere HTML-Code der Hilfe (expHelpMarkdownRenderer) eines Topic-Feldes als DITA-1.3-Elemente, für den DITA-Export der als Inhalt gepflegten Hilfe (expHelpConte… |
expHelpDocumentIndex | class | Singleton / instance() | kernel/classes/help/exphelpdocumentindex.php:46 | Der Index der Hilfeseiten (doc/eng-us/features/6.0/help-system.md, „The index“): ein Eintrag je Dokument der Allowlist (expHelpAllowlist: git-tra… |
expHelpExamplesGenerator | class | Builder | kernel/classes/help/exphelpexamplesgenerator.php:25 | Schreibt die generierten Referenzbeispiele unter doc/eng-us/examples/ (doc/eng-us/examples/README.md, „How the generated pages are made“): eine Markdown… |
expHelpExamplesTranslation | class | Fabrik und statische Fabrikmethoden | kernel/classes/help/exphelpexamplestranslation.php:30 | Die Übersetzung der generierten Referenzbeispiele (expHelpExamplesGenerator) in eine Sprache der Hilfe, zum Beispiel Deutsch in doc/ger-de/ (doc/… |
expHelpFrontMatter | class | Hilfsklasse (statische Hilfsfunktionen) | kernel/classes/help/exphelpfrontmatter.php:28 | Der Front Matter einer Hilfeseite (doc/eng-us/features/6.0/help-system.md, „Front matter“): ein Block ganz oben in einer Markdown-Datei zwischen zwei Zeilen… |
expHelpFunctionCollection | class | Fetch-Funktion (Query Object, Fassade), Hilfsklasse (statische Hilfsfunktionen) | kernel/classes/help/exphelpfunctioncollection.php:10 | Die Fetch-Funktionen von exphelp (kernel/exphelp/function_definition.php). |
expHelpHighlighter | class | Registry, Hilfsklasse (statische Hilfsfunktionen) | kernel/classes/help/exphelphighlighter.php:29 | Serverseitige Syntaxhervorhebung der Codeblöcke der Hilfeseiten (exphelp, doc/eng-us/features/6.0/help-system.md), ohne JavaScript oder eine externe… |
expHelpIssueReport | class | – | kernel/classes/help/exphelpissuereport.php:18 | Fehler melden (exphelp/report, doc/eng-us/features/6.0/help-system.md „Reporting an error“): wo er zu melden ist (die Tracker von [IssueTrackers]… |
expHelpLanding | class | – | kernel/classes/help/exphelplanding.php:32 | Die Landingpage einer Zielgruppe der Hilfe: exphelp/audience/ (doc/eng-us/features/6.0/help-system.md, „Landing pages“). |
expHelpLanguage | class | Fabrik und statische Fabrikmethoden | kernel/classes/help/exphelplanguage.php:37 | Die Sprachen der Dokumentation (doc/eng-us/features/6.0/help-system.md, „The pages in the reader's language“; doc/eng-us/bc/6.0/translated-docume… |
expHelpLicense | class | Hilfsklasse (statische Hilfsfunktionen) | kernel/classes/help/exphelplicense.php:17 | Die Lizenz der Dokumentation, die die Hilfe anzeigt (exphelp.ini [License], doc/eng-us/README-LICENSE.md). |
expHelpLinkCheck | class | – | kernel/classes/help/exphelplinkcheck.php:25 | Prüft die Links und Bilder der Hilfeseiten (doc/eng-us/features/6.0/help-system.md, "Checking the documentation"; "./console exp:help check"). |
expHelpLinks | class | Hilfsklasse (statische Hilfsfunktionen) | kernel/classes/help/exphelplinks.php:12 | Die Link- und Bild-Resolver, die der Viewer expHelpMarkdownRenderer gibt (doc/eng-us/features/6.0/help-system.md): ein relativer Link auf eine erlaubte Seite wird… |
expHelpManualBuilder | class | Builder | kernel/classes/help/content/exphelpmanualbuilder.php:35 | Die Handbücher der als Inhalt gepflegten Hilfe, aus der Markdown-Hilfe erzeugt (doc/eng-us/features/6.0/help-content.md, „Manuals from the Markdown help“). |
expHelpManualSource | class | Fabrik und statische Fabrikmethoden | kernel/classes/help/content/exphelpmanualsource.php:13 | Die Markdown-Hilfe als Quelle der erzeugten Handbücher (expHelpManualBuilder): die Ordner und Seiten des Index der Hilfe einer Sprache (expHelpDo… |
expHelpManualSync | class | – | kernel/classes/help/content/exphelpmanualsync.php:22 | Bringt die Datenbank in Übereinstimmung mit einem Plan von expHelpManualBuilder: legt die fehlenden Handbücher, Kapitel und Themen an, aktualisiert die mit abweichenden Werten… |
expHelpMarkdownRenderer | class | Fabrik und statische Fabrikmethoden | kernel/classes/help/exphelpmarkdownrenderer.php:65 | Rendert das Markdown der Dokumentation (doc/**.md) zum HTML des Hilfe-Viewers (exphelp/viewer, doc/eng-us/features/6.0/help-system.md): Common… |
expHelpNavigation | class | – | kernel/classes/help/exphelpnavigation.php:20 | Der Navigationsbaum der Hilfe (doc/eng-us/features/6.0/help-system.md, "Viewer"): jede Seite, die der Index ausliefert, in ihren Ordnern, als verschachtelte Listen. |
expHelpPdf | class | Fabrik und statische Fabrikmethoden, Hilfsklasse (statische Hilfsfunktionen) | kernel/classes/help/exphelppdf.php:18 | Eine Hilfeseite als PDF-Datei (doc/eng-us/features/6.0/help-system.md, „Print and PDF“): die Ansicht exphelp/pdf/ und ./console exp:help pdf fragen hier an. |
expHelpPdfCanvas | class extends Cpdf | – | kernel/classes/help/exphelppdfcanvas.php:18 | Die Seitenfläche des PDFs einer Hilfeseite (doc/eng-us/features/6.0/help-system.md, „Print and PDF“): die eigene PDF-Bibliothek des Kernels (lib/ezpdf, Cpdf) mit… |
expHelpPdfFontSubset | class | Fabrik und statische Fabrikmethoden, Hilfsklasse (statische Hilfsfunktionen) | kernel/classes/help/exphelppdffontsubset.php:17 | Reduziert eine TrueType-Schrift auf die Glyphen, die ein PDF verwendet (doc/eng-us/features/6.0/help-system.md, „Print and PDF“). |
expHelpPdfWriter | class | – | kernel/classes/help/exphelppdfwriter.php:28 | Setzt eine ausgegebene Hilfeseite als PDF (doc/eng-us/features/6.0/help-system.md, "Print and PDF"). |
expHelpProjectFiles | class | Fabrik und statische Fabrikmethoden | kernel/classes/help/exphelpprojectfiles.php:29 | Die Projektdateien der Hilfe (doc/eng-us/features/6.0/help-system.md, „Project files“): die Markdown-Dateien des Repositorys außerhalb von doc/, die doku… |
expHelpReadPolicyGrant | class | Hilfsklasse (statische Hilfsfunktionen) | kernel/classes/help/exphelpreadpolicygrant.php:22 | Plant und wendet die Vergabe der Richtlinie exphelp/read an (bin/php/addexphelpreadpolicy.php): das Lesen des Hilfesystems (doc/eng-us/features/6.0/help-syst… |
expHelpRecordRenderer | class | – | kernel/classes/help/exphelprecordrenderer.php:36 | Reine Textseiten, die Listen von Datensätzen sind (doc/eng-us/release-overview, der Release-Verlauf; doc/branch-overview war eine, bis sie zu Markdown wurde) s… |
expHelpRemoteImages | class | – | kernel/classes/help/exphelpremoteimages.php:22 | Die Kopien der externen Bilder, die die Hilfeseiten zeigen (doc/eng-us/features/6.0/help-system.md, „External images“). |
expHelpRestController | class extends ezpRestMvcController | – | kernel/classes/help/content/rest/exphelprestcontroller.php:23 | Die Variablen der Route stammen aus ezcMvcController::__get() (ihren Eigenschaften); eine deklarierte Eigenschaft würde sie verdecken. |
expHelpRestProvider | class implements ezpRestProviderInterface | INI-Plugin-Punkt (Erweiterungspunkt), Strategie / Handler | kernel/classes/help/content/rest/exphelprestprovider.php:21 | Die REST-Routen der Kontexthilfe (doc/eng-us/features/6.0/help-content.md, „Context help by help_id“; Auslieferungsweg 2 des Plans: „internal topics wit… |
expHelpRestViewController | class implements ezpRestViewControllerInterface | – | kernel/classes/help/content/rest/exphelprestviewcontroller.php:10 | Die Ansicht der Kontexthilfe-Routen (expHelpRestProvider): JSON |
expHelpSearch | class | Fabrik und statische Fabrikmethoden | kernel/classes/help/exphelpsearch.php:34 | expHelpSearch: die Volltextsuche des Hilfesystems (doc/eng-us/features/6.0/help-system.md, "Search"). |