API

API für Entwickler. Wir Entwickler.

• 1. Entwickler-Kit
• 2. Verzeichnisstruktur
• 3. Objekte
• 3.1. Yellow-Page
• 3.2. Yellow-Page-Collection
• 3.3. Yellow-Content
• 3.4. Yellow-Media
• 3.5. Yellow-System
• 3.6. Yellow-Text
• 3.7. Yellow-Text-Kodierung
• 3.8. Yellow-Toolbox
• 3.9. Yellow-Extensions
• 4. Ereignisse
• 4.1. Yellow-Core-Ereignisse
• 4.2. Yellow-Edit-Ereignisse
• 4.3. Yellow-Command-Ereignisse
• 5. Fehlersuche

Entwickler-Kit

Installiere das Entwickler-Kit. Das Entwickler-Kit für Datenstrom Yellow enthält Beispiele und Tests. Du kannst ausprobieren wie man kleine Webseiten, Blogs und Wikis macht. Du kannst lernen wie du deine Webseite anpasst. Es ist eine grossartige Art um loszulegen.

Falls Probleme auftreten, überprüfe bitte die Servereinstellungen oder frage den Support.

Verzeichnisstruktur

Die folgenden Verzeichnisse sind vorhanden:

├── content               = Inhaltsdateien
├── media                 = Mediendateien
│   ├── downloads         = Dateien zum Herunterladen
│   ├── images            = Bilder für den Inhalt
│   └── thumbnails        = Miniaturbilder
└── system                = Systemdateien
    ├── extensions        = installierte Erweiterungen
    ├── layouts           = Layoutdateien, HTML-Dateien
    ├── resources         = Resourcendateien, CSS-Dateien usw.
    ├── settings          = Konfigurationsdateien, INI-Dateien
    └── trash             = gelöschte Dateien

Objekte

Die folgenden Objekte sind vorhanden:

$this->yellow->page = Zugang zur aktuellen Seite
$this->yellow->content = Zugang zu Inhaltsdateien vom Dateisystem
$this->yellow->media = Zugang zu Mediendateien vom Dateisystem
$this->yellow->system = Zugang zu Systemeinstellungen
$this->yellow->text = Zugang zu Texteinstellungen
$this->yellow->toolbox = Zugang zur Werkzeugkiste mit Helfern
$this->yellow->extensions = Zugang zu Funktionen und Themen

Yellow-Page

Yellow-Page gibt Zugang zur aktuellen Seite:

$this->yellow->page->get($key)
Hole eine Einstellung der Seite

$this->yellow->page->getHtml($key)
Hole eine Einstellung der Seite, HTML-kodiert

$this->yellow->page->getDate($key, $format = "")
Hole eine Einstellung der Seite als sprachspezifisches Datumsformat

$this->yellow->page->getDateHtml($key, $format = "")
Hole eine Einstellung der Seite als sprachspezifisches Datumsformat, HTML-kodiert

$this->yellow->page->getDateRelative($key, $format = "", $daysLimit = 30)
Hole eine Einstellung der Seite als sprachspezifisches Datumsformat, relativ zu heute

$this->yellow->page->getDateRelativeHtml($key, $format = "", $daysLimit = 30)
Hole eine Einstellung der Seite als sprachspezifisches Datumsformat, relativ zu heute, HTML-kodiert

$this->yellow->page->getDateFormatted($key, $format)
Hole eine Einstellung der Seite mit maßgeschneidertem Datumsformat

$this->yellow->page->getDateFormattedHtml($key, $format)
Hole eine Einstellung der Seite mit maßgeschneidertem Datumsformat, HTML-kodiert

$this->yellow->page->getContent($rawFormat = false, $sizeMax = 0)
Hole den Seitenhalt, HTML-kodiert oder Rohformat

$this->yellow->page->getParent()
Hole die Elternseite, null falls nicht vorhanden

$this->yellow->page->getParentTop($homeFallback = false)
Hole die oberste Elternseite, null falls nicht vorhanden

$this->yellow->page->getSiblings($showInvisible = false)
Hole eine Page-Collection mit Seiten auf dem selben Level

$this->yellow->page->getChildren($showInvisible = false)
Hole eine Page-Collection mit Kinderseiten

$this->yellow->page->getPages()
Hole eine Page-Collection mit zusätzlichen Seiten

$this->yellow->page->getPage($key)
Hole eine zugehörige Seite

$this->yellow->page->getBase($multiLanguage = false)
Hole die Basis der Seite

$this->yellow->page->getLocation($absoluteLocation = false)
Hole den Ort der Seite

$this->yellow->page->getUrl()
Hole die URL der Seite

$this->yellow->page->getExtra($name)
Hole Extradaten der Seite

$this->yellow->page->getHeader($key)
Hole den Responseheader der Seite

$this->yellow->page->getModified($httpFormat = false)
Hole das Änderungsdatum der Seite, Unix-Zeit oder HTTP-Format

$this->yellow->page->getLastModified($httpFormat = false)
Hole das letzte Änderungsdatum der Seite, Unix-Zeit oder HTTP-Format

$this->yellow->page->getStatusCode($httpFormat = false)
Hole den Statuscode der Seite, Zahl oder HTTP-Format

$this->yellow->page->error($statusCode, $pageError = "")
Antworte mit Fehlerseite

$this->yellow->page->clean($statusCode, location = "")
Antworte mit Statuscode, ohne Seiteninhalt

$this->yellow->page->isAvailable()
Teste ob die Seite vorhanden ist

$this->yellow->page->isVisible()
Teste ob die Seite sichtbar ist

$this->yellow->page->isActive()
Teste ob die Seite innerhalb der aktuellen HTTP-Anfrage ist

$this->yellow->page->isCacheable()
Teste ob die Seite cachebar ist

$this->yellow->page->isError()
Teste ob die Seite einen Fehler hat

$this->yellow->page->isHeader($key)
Teste ob der Responseheader existiert

$this->yellow->page->isExisting($key)
Teste ob die Einstellung der Seite existiert

$this->yellow->page->isPage($key)
Teste ob die zugehörige Seite existiert

Hier ist ein Beispiel-Layout um den Seiteninhalt anzuzeigen:

<?php $this->yellow->layout("header") ?>
<div class="content">
<div class="main" role="main">
<h1><?php echo $this->yellow->page->getHtml("titleContent") ?></h1>
<?php echo $this->yellow->page->getContent() ?>
</div>
</div>
<?php $this->yellow->layout("footer") ?>

Hier ist ein Beispiel-Layout um den Seiteninhalt und zusätzliche Einstellung anzuzeigen:

<?php $this->yellow->layout("header") ?>
<div class="content">
<div class="main" role="main">
<h1><?php echo $this->yellow->page->getHtml("titleContent") ?></h1>
<p><?php echo $this->yellow->page->getHtml("author") ?></p>
<?php echo $this->yellow->page->getContent() ?>
</div>
</div>
<?php $this->yellow->layout("footer") ?>

Hier ist ein Beispiel-Layout um den Seiteninhalt und zusätzliches Datum anzuzeigen:

<?php $this->yellow->layout("header") ?>
<div class="content">
<div class="main" role="main">
<h1><?php echo $this->yellow->page->getHtml("titleContent") ?></h1>
<p><?php echo $this->yellow->page->getDateHtml("modified", "dateFormatMedium") ?></p>
<?php echo $this->yellow->page->getContent() ?>
</div>
</div>
<?php $this->yellow->layout("footer") ?>

Yellow-Page-Collection

Yellow-Page-Collection gibt Zugang zu mehreren Seiten:

$pages->filter($key, $value, $exactMatch = true)
Filtere eine Page-Collection nach Einstellung

$pages->match($regex = "/.*/")
Filtere eine Page-Collection nach Dateinamen

$pages->sort($key, $ascendingOrder = true)
Sortiere eine Page-Collection nach Einstellung

$pages->similar($page, $ascendingOrder = false)
Sortiere eine Page-Collection nach Einstellungsähnlichkeit

$pages->merge($input)
Vereinige eine Page-Collection

$pages->append($page)
Hänge an das Ende der Page-Collection

$pages->prepend($page)
Stelle an den Anfang der Page-Collection

$pages->limit($pagesMax)
Begrenze die Anzahl der Seiten in der Page-Collection

$pages->reverse()
Drehe die Page-Collection um

$pages->shuffle()
Mach die Page-Collection zufällig

$pages->pagination($limit, $reverse = true)
Erstelle eine Pagination für die Page-Collection

$pages->getPaginationNumber()
Hole die aktuelle Seitennummer in der Pagination

$pages->getPaginationCount()
Hole die höchste Seitennummer in der Pagination

$pages->getPaginationLocation($absoluteLocation = true, $pageNumber = 1)
Hole den Ort einer Seite in der Pagination

$pages->getPaginationPrevious($absoluteLocation = true)
Hole den Ort der vorherigen Seite in der Pagination

$pages->getPaginationNext($absoluteLocation = true)
Hole den Ort der nächsten Seite in der Pagination

$pages->getPagePrevious($page)
Hole die vorherige Seite in der Page-Collection, null falls nicht vorhanden

$pages->getPageNext($page)
Hole die nächste Seite in der Page-Collection, null falls nicht vorhanden

$pages->getFilter()
Hole den aktuellen Seitenfilter

$pages->getModified($httpFormat = false)
Hole das Änderungsdatum der Page-Collection, Unix-Zeit oder HTTP-Format

$pages->isPagination()
Teste ob eine Pagination vorhanden ist

Hier ist ein Beispiel-Layout um drei zufällige Seiten anzuzeigen:

<?php $this->yellow->layout("header") ?>
<div class="content">
<div class="main" role="main">
<h1><?php echo $this->yellow->page->getHtml("titleContent") ?></h1>
<?php $pages = $this->yellow->content->index()->shuffle()->limit(3) ?>
<?php $this->yellow->page->setLastModified($pages->getModified()) ?>
<ul>
<?php foreach ($pages as $page): ?>
<li><?php echo $page->getHtml("title") ?></li>
<?php endforeach ?>
</ul>
</div>
</div>
<?php $this->yellow->layout("footer") ?>

Hier ist ein Beispiel-Layout um die neusten Seiten anzuzeigen:

<?php $this->yellow->layout("header") ?>
<div class="content">
<div class="main" role="main">
<h1><?php echo $this->yellow->page->getHtml("titleContent") ?></h1>
<?php $pages = $this->yellow->content->index()->sort("modified", false) ?>
<?php $this->yellow->page->setLastModified($pages->getModified()) ?>
<ul>
<?php foreach ($pages as $page): ?>
<li><?php echo $page->getHtml("title") ?></li>
<?php endforeach ?>
</ul>
</div>
</div>
<?php $this->yellow->layout("footer") ?>

Hier ist ein Beispiel-Layout um Entwurfseiten anzuzeigen:

<?php $this->yellow->layout("header") ?>
<div class="content">
<div class="main" role="main">
<h1><?php echo $this->yellow->page->getHtml("titleContent") ?></h1>
<?php $pages = $this->yellow->content->index(true, true)->filter("status", "draft") ?>
<?php $this->yellow->page->setLastModified($pages->getModified()) ?>
<ul>
<?php foreach ($pages as $page): ?>
<li><?php echo $page->getHtml("title") ?></li>
<?php endforeach ?>
</ul>
</div>
</div>
<?php $this->yellow->layout("footer") ?>

Yellow-Content

Yellow-Content gibt Zugang zu Inhaltsdateien vom Dateisystem:

$this->yellow->content->find($location, $absoluteLocation = false)
Hole eine Page vom Dateisystem, null falls nicht vorhanden

$this->yellow->content->index($showInvisible = false, $multiLang = false, $levelMax = 0)
Hole eine Page-Collection mit allen Seiten

$this->yellow->content->top($showInvisible = false)
Hole eine Page-Collection mit Hauptseiten der Navigation

$this->yellow->content->path($location, $absoluteLocation = false)
Hole eine Page-Collection mit Pfad in der Navigation

$this->yellow->content->multi($location, $absoluteLocation = false, $showInvisible = false)
Hole eine Page-Collection mit mehreren Sprachen im Mehrsprachen-Modus

$this->yellow->content->shared($name)
Hole eine Page mit geteiltem Inhalt, null falls nicht vorhanden

$this->yellow->content->clean()
Hole eine Page-Collection die leer ist

Hier ist ein Beispiel-Layout um alle Seiten anzuzeigen:

<?php $this->yellow->layout("header") ?>
<div class="content">
<div class="main" role="main">
<h1><?php echo $this->yellow->page->getHtml("titleContent") ?></h1>
<?php $pages = $this->yellow->content->index(true, true) ?>
<?php $this->yellow->page->setLastModified($pages->getModified()) ?>
<ul>
<?php foreach ($pages as $page): ?>
<li><?php echo $page->getHtml("title") ?></li>
<?php endforeach ?>
</ul>
</div>
</div>
<?php $this->yellow->layout("footer") ?>

Hier ist ein Beispiel-Layout um Seiten unterhalb einer bestimmten Orts anzuzeigen:

<?php $this->yellow->layout("header") ?>
<div class="content">
<div class="main" role="main">
<h1><?php echo $this->yellow->page->getHtml("titleContent") ?></h1>
<?php $pages = $this->yellow->content->find("/help/")->getChildren(true) ?>
<?php $this->yellow->page->setLastModified($pages->getModified()) ?>
<ul>
<?php foreach ($pages as $page): ?>
<li><?php echo $page->getHtml("title") ?></li>
<?php endforeach ?>
</ul>
</div>
</div>
<?php $this->yellow->layout("footer") ?>

Hier ist ein Beispiel-Layout um die Hauptseiten der Navigation anzuzeigen:

<?php $this->yellow->layout("header") ?>
<div class="content">
<div class="main" role="main">
<h1><?php echo $this->yellow->page->getHtml("titleContent") ?></h1>
<?php $pages = $this->yellow->content->top() ?>
<?php $this->yellow->page->setLastModified($pages->getModified()) ?>
<ul>
<?php foreach ($pages as $page): ?>
<li><?php echo $page->getHtml("titleNavigation") ?></li>
<?php endforeach ?>
</ul>
</div>
</div>
<?php $this->yellow->layout("footer") ?>

Yellow-Media

Yellow-Media gibt Zugang zu Mediendateien vom Dateisystem:

$this->yellow->media->find($location, $absoluteLocation = false)
Hole eine Page mit Informationen über Mediendatei, null falls nicht vorhanden

$this->yellow->media->index($showInvisible = false, $multiPass = false, $levelMax = 0)
Hole eine Page-Collection mit allen Mediendateien

$this->yellow->media->clean()
Hole eine Page-Collection die leer ist

Hier ist ein Beispiel-Layout um alle Mediendateien anzuzeigen:

<?php $this->yellow->layout("header") ?>
<div class="content">
<div class="main" role="main">
<h1><?php echo $this->yellow->page->getHtml("titleContent") ?></h1>
<?php $files = $this->yellow->media->index(true) ?>
<?php $this->yellow->page->setLastModified($files->getModified()) ?>
<ul>
<?php foreach ($files as $file): ?>
<li><?php echo $file->getLocation(true) ?></li>
<?php endforeach ?>
</ul>
</div>
</div>
<?php $this->yellow->layout("footer") ?>

Hier ist ein Beispiel-Layout um die neusten Mediendateien anzuzeigen:

<?php $this->yellow->layout("header") ?>
<div class="content">
<div class="main" role="main">
<h1><?php echo $this->yellow->page->getHtml("titleContent") ?></h1>
<?php $files = $this->yellow->media->index(true)->sort("modified", false) ?>
<?php $this->yellow->page->setLastModified($files->getModified()) ?>
<ul>
<?php foreach ($files as $file): ?>
<li><?php echo $file->getLocation(true) ?></li>
<?php endforeach ?>
</ul>
</div>
</div>
<?php $this->yellow->layout("footer") ?>

Hier ist ein Beispiel-Layout um Mediendateien eines bestimmten Types anzuzeigen:

<?php $this->yellow->layout("header") ?>
<div class="content">
<div class="main" role="main">
<h1><?php echo $this->yellow->page->getHtml("titleContent") ?></h1>
<?php $files = $this->yellow->media->index(true)->filter("type", "pdf") ?>
<?php $this->yellow->page->setLastModified($files->getModified()) ?>
<ul>
<?php foreach ($files as $file): ?>
<li><?php echo $file->getLocation(true) ?></li>
<?php endforeach ?>
</ul>
</div>
</div>
<?php $this->yellow->layout("footer") ?>

Yellow-System

Yellow-System gibt Zugang zu Systemeinstellungen :

$this->yellow->system->get($key)
Hole eine Systemeinstellung

$this->yellow->system->getHtml($key)
Hole eine Systemeinstellung, HTML-kodiert

$this->yellow->system->getData($filterStart = "", $filterEnd = "")
Hole Systemeinstellungen

$this->yellow->system->getModified($httpFormat = false)
Hole das Änderungsdatum von Systemeinstellungen, Unix-Zeit oder HTTP-Format

$this->yellow->system->isExisting($key)
Teste ob die Systemeinstellung existiert

Hier ist ein Beispiel-Layout um statische Webseiten-Einstellungen anzuzeigen:

<?php $this->yellow->layout("header") ?>
<div class="content">
<div class="main" role="main">
<h1><?php echo $this->yellow->page->getHtml("titleContent") ?></h1>
<p>
<?php foreach ($this->yellow->system->getData("static") as $key=>$value): ?>
<?php echo htmlspecialchars("$key: $value") ?><br />
<?php endforeach ?>
</p>
</div>
</div>
<?php $this->yellow->layout("footer") ?>

Hier ist ein Beispiel-Layout um Webmaster-Einstellungen anzuzeigen:

<?php $this->yellow->layout("header") ?>
<div class="content">
<div class="main" role="main">
<h1><?php echo $this->yellow->page->getHtml("titleContent") ?></h1>
<p>
<?php echo "Author: ".$this->yellow->system->getHtml("author")."<br />" ?>
<?php echo "Email: ".$this->yellow->system->getHtml("email")."<br />" ?>
</p>
</div>
</div>
<?php $this->yellow->layout("footer") ?>

Hier ist ein Beispiel-Layout um anzuzeigen ob der sichere Modus aktiviert ist:

<?php $this->yellow->layout("header") ?>
<div class="content">
<div class="main" role="main">
<h1><?php echo $this->yellow->page->getHtml("titleContent") ?></h1>
<p>
<?php $safeMode = $this->yellow->system->get("safeMode") ?>
Safe mode is <?php echo htmlspecialchars($safeMode ? "on" : "off") ?>.
</p>
</div>
</div>
<?php $this->yellow->layout("footer") ?>

Yellow-Text

Yellow-Text gibt Zugang zu Texteinstellungen:

$this->yellow->text->get($key)
Hole ein Textstring

$this->yellow->text->getHtml($key)
Hole ein Textstring, HTML-kodiert

$this->yellow->text->getText($key, $language )
Hole ein Textstring für eine bestimmte Sprache

$this->yellow->text->getTextHtml($key, $language )
Hole ein Textstring für eine bestimmte Sprache, HTML-kodiert

$this->yellow->text->getData($filterStart = "", $language = "")
Hole Textstrings

$this->yellow->text->getModified($httpFormat = false)
Hole das Änderungsdatum von Text, Unix-Zeit oder HTTP-Format

$this->yellow->text->getLanguages()
Hole Sprachen

$this->yellow->text->isLanguage($language)
Teste ob die Sprache existiert

$this->yellow->text->isExisting($key, $language = "")
Teste ob der Textstring existiert

Hier ist ein Beispiel-Layout um Fehlermeldungen anzuzeigen:

<?php $this->yellow->layout("header") ?>
<div class="content">
<div class="main" role="main">
<h1><?php echo $this->yellow->page->getHtml("titleContent") ?></h1>
<p>
<?php foreach ($this->yellow->text->getData("error") as $key=>$value): ?>
<?php echo htmlspecialchars("$key: $value") ?><br />
<?php endforeach ?>
</p>
</div>
</div>
<?php $this->yellow->layout("footer") ?>

Hier ist ein Beispiel-Layout um Sprachen und Übersetzer anzuzeigen:

<?php $this->yellow->layout("header") ?>
<div class="content">
<div class="main" role="main">
<h1><?php echo $this->yellow->page->getHtml("titleContent") ?></h1>
<p>
<?php foreach ($this->yellow->text->getLanguages() as $language): ?>
<?php echo $this->yellow->text->getTextHtml("languageDescription", $language) ?> - 
<?php echo $this->yellow->text->getTextHtml("languageTranslator", $language) ?><br />
<?php endforeach ?>
</p>
</div>
</div>
<?php $this->yellow->layout("footer") ?>

Hier ist ein Beispiel-Layout um zu testen ob eine bestimmte Sprache existiert:

<?php $this->yellow->layout("header") ?>
<div class="content">
<div class="main" role="main">
<h1><?php echo $this->yellow->page->getHtml("titleContent") ?></h1>
<?php $swedish = $this->yellow->text->isLanguage("sv") ?>
<p>Swedish language <?php echo htmlspecialchars($swedish ? "" : "not") ?> installed.</p>
</div>
</div>
<?php $this->yellow->layout("footer") ?>

Yellow-Text-Kodierung

Die folgenden Funktionen sind vorhanden zur Kodierung von Text:

htmlspecialchars($string) = kodiere Textstring ins HTML-Format
rawurlencode($string) = kodiere URL, z.B. Hyperlink-Argumente
strencode($string) = kodiere String, z.B. JavaScript-Argumente

Hier ist ein Beispiel-Layout um HTML-Argumente zu kodieren:

<?php list($name, $class) = $this->yellow->getLayoutArgs() ?>
<?php if (empty($class)) $class = "regular" ?>
<?php $this->yellow->layout("header") ?>
<div class="content">
<div class="main" role="main">
<h1><?php echo $this->yellow->page->getHtml("titleContent") ?></h1>
<p><img src="https://unsplash.it/210/140/?random" class="<?php echo htmlspecialchars($class) ?>" /></p>
</div>
</div>
<?php $this->yellow->layout("footer") ?>

Hier ist ein Beispiel-Layout um Hyperlink-Argumente zu kodieren:

<?php list($name, $id) = $this->yellow->getLayoutArgs() ?>
<?php if (empty($id)) $id = "821" ?>
<?php $this->yellow->layout("header") ?>
<div class="content">
<div class="main" role="main">
<h1><?php echo $this->yellow->page->getHtml("titleContent") ?></h1>
<p><img src="https://unsplash.it/210/140/?image=<?php echo rawurlencode($id) ?>" /></p>
</div>
</div>
<?php $this->yellow->layout("footer") ?>

Hier ist ein Beispiel-Layout um JavaScript-Argumente zu kodieren:

<?php list($name, $message) = $this->yellow->getLayoutArgs() ?>
<?php if (empty($message)) $message = "Hello world" ?>
<?php $this->yellow->layout("header") ?>
<div class="content">
<div class="main" role="main">
<h1><?php echo $this->yellow->page->getHtml("titleContent") ?></h1>
<script type="text/javascript">
console.log("<?php echo strencode($message) ?>");
</script>
</div>
</div>
<?php $this->yellow->layout("footer") ?>

Yellow-Toolbox

Yellow-Toolbox gibt Zugang zur Werkzeugkiste mit Helfern:

$this->yellow->toolbox->getLocation($filterStrict = true)
Hole den Ort der aktuellen HTTP-Anfrage

$this->yellow->toolbox->getLocationArgs()
Hole die Ortargumente der aktuellen HTTP-Anfrage

$this->yellow->toolbox->isLocationArgs($location = "")
Teste ob es Ortargumente gibt in der aktuellen HTTP-Anfrage

$this->yellow->toolbox->normaliseArgs($text, $appendSlash = true, $filterStrict = true)
Normalisiere Ortargumente

$this->yellow->toolbox->getDirectoryEntries($path, $regex = "/.*/", $sort = true, $directories = true, $includePath = true)
Hole Dateien und Verzeichnisse

$this->yellow->toolbox->readFile($fileName, $sizeMax = 0)
Lese eine Datei, leerer String falls nicht vorhanden

$this->yellow->toolbox->createFile($fileName, $fileData, $mkdir = false)
Erstelle eine Datei

$this->yellow->toolbox->appendFile($fileName, $fileData, $mkdir = false)
Hänge an eine Datei an

$this->yellow->toolbox->copyFile($fileNameSource, $fileNameDestination, $mkdir = false)
Kopiere eine Datei

$this->yellow->toolbox->renameFile($fileNameSource, $fileNameDestination, $mkdir = false)
Benenne eine Datei um

$this->yellow->toolbox->renameDirectory($pathSource, $pathDestination, $mkdir = false)
Benenne ein Verzeichnis um

$this->yellow->toolbox->deleteFile($fileName, $pathTrash = "")
Lösche eine Datei

$this->yellow->toolbox->deleteDirectory($path, $pathTrash = "")
Lösche ein Verzeichnis

$this->yellow->toolbox->modifyFile($fileName, $modified)
Setze das Änderungsdatum der Datei, Unix-Zeit

$this->yellow->toolbox->getFileModified($fileName)
Hole das Änderungsdatum der Datei, Unix-Zeit

$this->yellow->toolbox->getTextLines($text)
Hole die Zeilen eines Textstrings, einschließlich Zeilenumbruch

$this->yellow->toolbox->getTextArgs($text, $optional = "-")
Hole die Argumente eines Textstrings, durch Leerzeichen getrennt

Hier ist ein Beispiel-Layout um Ort und Argumente anzuzeigen:

<?php $this->yellow->layout("header") ?>
<div class="content">
<div class="main" role="main">
<h1><?php echo $this->yellow->page->getHtml("titleContent") ?></h1>
<p>
<?php echo htmlspecialchars($this->yellow->toolbox->getLocation()) ?><br />
<?php foreach ($_REQUEST as $key=>$value): ?>
<?php echo htmlspecialchars("$key: $value") ?><br />
<?php endforeach ?>
</p>
</div>
</div>
<?php $this->yellow->layout("footer") ?>

Hier ist ein Beispiel-Layout um Dateien in einem Verzeichnis anzuzeigen:

<?php $this->yellow->layout("header") ?>
<div class="content">
<div class="main" role="main">
<h1><?php echo $this->yellow->page->getHtml("titleContent") ?></h1>
<p>
<?php $path = $this->yellow->system->get("settingDir") ?>
<?php foreach ($this->yellow->toolbox->getDirectoryEntries($path, "/.*/", true, false) as $entry): ?>
<?php echo htmlspecialchars($entry) ?><br />
<?php endforeach ?>
</p>
</div>
</div>
<?php $this->yellow->layout("footer") ?>

Hier ist ein Beispiel-Layout um Textzeilen von Datei zu lesen:

<?php $this->yellow->layout("header") ?>
<div class="content">
<div class="main" role="main">
<h1><?php echo $this->yellow->page->getHtml("titleContent") ?></h1>
<p>
<?php $fileName = $this->yellow->system->get("settingDir").$this->yellow->system->get("systemFile") ?>
<?php $fileData = $this->yellow->toolbox->readFile($fileName) ?>
<?php foreach ($this->yellow->toolbox->getTextLines($fileData) as $line): ?>
<?php echo htmlspecialchars($line) ?><br />
<?php endforeach ?>
</p>
</div>
</div>
<?php $this->yellow->layout("footer") ?>

Yellow-Extensions

Yellow-Extensions gibt Zugang zu Funktionen und Themen:

$this->yellow->extensions->get($name)
Hole eine Erweiterung

$this->yellow->extensions->getData($type = "")
Hole die Versionsinformation von Erweiterungen

$this->yellow->extensions->getModified($httpFormat = false)
Hole das Änderungsdatum von Erweiterungen, Unix-Zeit oder HTTP-Format

$this->yellow->extensions->getExtensions($type = "")
Hole Erweiterungen

$this->yellow->extensions->isExisting($name)
Teste ob die Erweiterung existiert

Hier ist ein Beispiel-Layout um Informationen über Erweiterungen anzuzeigen:

<?php $this->yellow->layout("header") ?>
<div class="content">
<div class="main" role="main">
<h1><?php echo $this->yellow->page->getHtml("titleContent") ?></h1>
<p>
<?php foreach($this->yellow->extensions->getData() as $key=>$value): ?>
<?php echo htmlspecialchars("$key $value") ?><br />
<?php endforeach ?>
</p>
</div>
</div>
<?php $this->yellow->layout("footer") ?>

Hier ist eine Beispiel-Erweiterung um eigene Funktionen zu erstellen:

<?php
class YellowExample {
    const VERSION = "0.1.0";
    const TYPE = "feature";
}

Hier ist eine Beispiel-Erweiterung um eigene Themen zu erstellen:

<?php
class YellowExample {
    const VERSION = "0.1.0";
    const TYPE = "theme";
}

Ereignisse

Die folgenden Ereignisse sind vorhanden in Erweiterungen:

onLoad ───────▶ onStartup ─────────────────────────────────────────┐
                    │                                              │
                    ▼                                              │
                onRequest ─────────────────┐                       │
                    │                      │                       │
                    ▼                      ▼                       ▼
                onParseMeta             onEditUserRestriction  onCommand
                onParseContentRaw       onEditUserAccount      onCommandHelp
                onParseContentShortcut  onEditContentFile          │
                onParseContentText      onEditMediaFile            │
                onParsePageLayout          │                       ▼
                onParsePageExtra           │                   onLog
                onParsePageOutput          │                   onUpdate
                    │                      │                       │
                    ▼                      │                       │
exit ◀───────── onShutDown ◀───────────────┴───────────────────────┘

Wird eine Seite angezeigt, dann werden die Erweiterungen geladen und es wird onLoad aufgerufen. Sobald alle Erweiterungen geladen sind wird onStartup aufgerufen. Danach informiert der Core mit onRequest dass es eine Anfrage gibt. Die Seite kann mit verschiedenen onParse-Ereignisse analysiert werden. Dann wird der Inhalt der Seite erzeugt. Sollte ein Fehler auftreten, wird eine Fehlerseite erzeugt. Zum Schluss wird die Seite ausgegeben und es wird onShutdown aufgerufen.

Wird eine Seite bearbeitet, dann werden die Erweiterungen geladen und es wird onLoad aufgerufen. Sobald alle Erweiterungen geladen sind wird onStartup aufgerufen. Danach informiert der Core mit onRequest dass es eine Anfrage gibt, welche von der Edit-Erweiterung behandelt wird. Änderungen an der Seite können mit verschiedenen onEdit-Ereignisse überprüft werden. Dann wird die Seite im Dateisystem gespeichert. Zum Schluss wird ein Statuscode zum Neuladen der Seite ausgegeben und es wird onShutdown aufgerufen.

Wird ein Befehl ausgeführt, dann werden die Erweiterungen geladen und es wird onLoad aufgerufen. Sobald alle Erweiterungen geladen sind wird onStartup aufgerufen. Danach informiert der Core mit onCommand dass es einen Befehl gibt, welcher von der entsprechenden Erweiterung behandelt wird. Sollte kein Befehl in der Befehlszeile eingegeben worden sein, dann wird onCommandHelp aufgerufen und Erweiterungen können eine Hilfe zur Verfügung stellen. Zum Schluss wird ein Rückgabecode ausgegeben und es wird onShutdown aufgerufen.

Yellow-Core-Ereignisse

Yellow-Core-Ereignisse unterrichten wenn sich ein Zustand ändert:

public function onLoad($yellow)
Behandle die Initialisierung

public function onStartup()
Behandle das Hochfahren

public function onRequest($scheme, $address, $base, $location, $fileName)
Behandle die Anfrage

public function onParseMeta($page)
Behandle die Metadaten einer Seite

public function onParseContentRaw($page, $text)
Behandle den Seiteninhalt im Rohformat

public function onParseContentShortcut($page, $name, $text, $type)
Behandle den Seiteninhalt einer Abkürzung

public function onParseContentText($page, $text)
Behandle den Seiteninhalt

public function onParsePageLayout($page, $name)
Behandle das Layout einer Seite

public function onParsePageExtra($page, $name)
Behandle die Extradaten einer Seite

public function onParsePageOutput($page, $text)
Behandle die Ausgabedaten einer Seite

public function onLog($action, $message)
Behandle das Logging

public function onUpdate($action)
Behandle die Aktualisierung

public function onShutdown()
Behandle das Runterfahren

Hier ist eine Beispiel-Erweiterung um eine [example]-Abkürzung zu behandeln:

<?php
class YellowExample {
    const VERSION = "0.1.1";
    const TYPE = "feature";
    public $yellow;         //access to API

    // Handle initialisation
    public function onLoad($yellow) {
        $this->yellow = $yellow;
    }

    // Handle page content of shortcut
    public function onParseContentShortcut($page, $name, $text, $type) {
        $output = null;
        if ($name=="example" && ($type=="block" || $type=="inline")) {
            $output = "<div class=\"".htmlspecialchars($name)."\">";
            $output .= "Add more HTML code here";
            $output .= "</div>";
        }
        return $output;
    }
}

Yellow-Edit-Ereignisse

Yellow-Edit-Ereignisse unterrichten wenn eine Seite im Webbrowser bearbeitet wird:

public function onEditUserRestriction($email, $location, $fileName, $users)
Behandle Benutzerbeschränkung

public function onEditUserAccount($email, $password, $action, $users)
Behandle Änderungen am Benutzerkonto

public function onEditContentFile($page, $action)
Behandle Änderungen an Inhaltsdatei

public function onEditMediaFile($file, $action)
Behandle Änderungen an Mediendatei

Hier ist eine Beispiel-Erweiterung um bestimmte Benutzer zu beschränken:

<?php
class YellowExample {
    const VERSION = "0.1.3";
    const TYPE = "feature";
    public $yellow;         //access to API

    // Handle initialisation
    public function onLoad($yellow) {
        $this->yellow = $yellow;
    }

    // Handle user restriction
    public function onEditUserRestriction($email, $location, $fileName, $users) {
        return $users->getHome($email)=="/guests/";
    }
}

Yellow-Command-Ereignisse

Yellow-Command-Ereignisse unterrichten wenn ein Befehl ausgeführt wird:

public function onCommand($args)
Behandle Befehle

public function onCommandHelp()
Behandle Hilfe für Befehle

Hier ist eine Beispiel-Erweiterung um einen Befehl zu behandeln:

<?php
class YellowExample {
    const VERSION = "0.1.2";
    const TYPE = "feature";
    public $yellow;         //access to API

    // Handle initialisation
    public function onLoad($yellow) {
        $this->yellow = $yellow;
    }

    // Handle command help
    public function onCommandHelp() {
        return "example\n";
    }

    // Handle command
    public function onCommand($args) {
        $statusCode = 0;
        list($command) = $args;
        if ($command=="example") {
            echo "Yellow $command: Add more text here\n";
            $statusCode = 200;
        }
        return $statusCode;
    }
}

Fehlersuche

Systemdiagnose findet man in der Datei system/extensions/yellow.log. Hier ist ein Beispiel:

2019-03-12 13:33:37 info Datenstrom Yellow 0.8.3, PHP 7.1.23, Apache/2.4.33 Darwin
2019-03-12 13:33:37 info Checked Apache server configuration
2019-03-12 13:33:37 info Install language 'English'
2019-03-12 13:33:37 info Install language 'French'
2019-03-12 13:33:37 info Install language 'German'
2019-03-12 13:33:49 info Install webmaster 'Anna'
2019-03-12 13:33:49 info Install extension 'Blog 0.8.2'

Oder öffne die Datei system/extensions/core.php und ändere <?php define("DEBUG", 1);

YellowCore::sendPage Cache-Control: max-age=60
YellowCore::sendPage Content-Type: text/html; charset=utf-8
YellowCore::sendPage Content-Modified: Wed, 06 Feb 2019 13:54:17 GMT
YellowCore::sendPage Last-Modified: Thu, 07 Feb 2019 09:37:48 GMT
YellowCore::sendPage layout:blogpages theme:flatsite parser:markdown
YellowCore::processRequest file:content/1-en/2-features/1-blog/page.md
YellowCore::request status:200 handler:core time:19 ms

Dateisysteminformationen durch Erhöhen des Debuglevels zu <?php define("DEBUG", 2);

YellowSystem::load file:system/settings/system.ini
YellowEditUsers::load file:system/settings/user.ini
YellowText::load file:system/extensions/english-language.txt
YellowText::load file:system/extensions/french-language.txt
YellowText::load file:system/extensions/german-language.txt
YellowText::load file:system/settings/text.ini
YellowCore::load extensions:43 time:10 ms

Maximum Informationen durch Erhöhen des Debuglevels zu <?php define("DEBUG", 3);

YellowCore::load Datenstrom Yellow 0.8.3, PHP 7.1.23, Apache/2.4.33 Darwin
YellowSystem::load file:system/settings/system.ini
YellowSystem::load Sitename:Datenstrom developers
YellowSystem::load Author:Datenstrom
YellowSystem::load Email:webmaster
YellowSystem::load Language:en
YellowSystem::load Timezone:Europe/Stockholm

Weiter: HTML-Dateien →