https://wiki.stephanschlegel.de/api.php?action=feedcontributions&feedformat=atom&user=84.136.104.26Wikizone - Benutzerbeiträge [de]2026-05-06T16:01:17ZBenutzerbeiträgeMediaWiki 1.35.14https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Multilanguage_Website&diff=24405ProcessWire - Multilanguage Website2020-02-14T14:09:45Z<p>84.136.104.26: /* 3. Templates */</p>
<hr />
<div>Mehrsprachige Websites mit ProcessWire / Andere Default Sprache<br />
<br />
== Links ==<br />
* https://processwire.com/talk/topic/5518-multi-language-site/<br />
* http://processwire.com/api/multi-language-support/multi-language-urls/<br />
* https://processwire.com/talk/topic/9322-change-default-language-for-homepage/ (Modul Solution, mehr zur Anschauung)<br />
<br />
== Einleitung ==<br />
Es gibt mehrere Bereiche an die man denken muss. Einmal geht es um die Eingabe im Backend, die Ausgabe im Frontend, die Sprachnavigation auf der Website und die Templates:<br />
* Wie übersetze ich Text in meinen '''Templates''' ? Siehe unten i18n<br />
* Wie übersetze ich '''Inhalte''' im Backend ? Dafür ist das Modul Language Support Fields zuständig<br />
* Wie sollen meine URLs aussehen ? Prinzipiell kann man jedem User unterschiedliche Sprachen auch ohne andere Domain liefern (über seine Session) aber i.d.R wollen wir die URL anzupassen.<br />
** ''domain.de/en/meineSeite'' oder ''domain.de/myPage''<br />
** Um '''Seitennamen''' zu übersetzen oder ein Domainkürzel in der URL voranzustellen benötige ich das Modul '''Language Support Page Names''' <br />
<br />
== Welche Module benötige ich ==<br />
Da es einige Module in diesem Zusammenhang gibt hier eine Übersicht. Man findet Sie am besten unter <br />
Modules > Core > Language<br />
<br />
* '''Languages Support''' - ProcessWire multi-language support. Basis Modul bracht man für alle Beispiele unten. Reicht aus, wenn man nur die Standard-Sprache ändern will.<br />
* '''Languages Support - Fields''' Required to use multi-language fields. Basis für mehrsprachige Felder im Backend. <br />
* '''Languages Support - Page Names''' (LanguageSupportPageNames) Required to use multi-language page names. Braucht man nur wenn '''alle Seiten in allen Sprachen unterschiedliche Namen''' bekommen sollen.<br />
* '''Languages Support - Tabs''' Organizes multi-language fields into tabs for a cleaner easier to use interface.<br />
Für mehrsprachige Seiten benötigen wir im Frontend i.d.R. folgende Module: <br />
* '''Language Support Fields''' - Sind Felder, die im Backend für jede Sprache eine eigene Eingabe bieten.<br />
* '''Language Support Page Names''' benötigt man, damit man für die Sprachen eigene URLs angeben kann. Z.B. bei Home in Englisch /en/ usw. <br />
* '''FieldtypePageTitleLanguage''' benötigt man wenn man alle Seitenamen anpassen will (seite1_de seite1_fr ...) Für einen reinen Sprachpfad (/de/Seite) braucht man das nicht.<br />
== Deutsch als Default Sprache ==<br />
Wenn nur die Standardsprache verändern möchte, aber keine Mehrsprachige Seite benötigt brauchen wir nur das Modul '''Language Support'''<br />
* Enable languages support -> '''Core Module "Language Support" aktivieren'''. -> Sprachen stehen num im Backend Setup zur Verfügung<br />
* '''Titel der Default Sprache''' anpassen (z.B. Deutsch (default) )<br />
* Language Pack in der default Sprache installieren -> Dies ist ab jetzt die Default Sprache. Nicht vergessen auch den '''lang Tag im Header''' zu setzen, damit der Browser die Sprache richtig erkennt.<br />
<br />
== Mehrere Sprachen ==<br />
Für mehrsprachige Seiten benötigen wir i.d.R. folgende Module: <br />
* '''Language Support Fields''' für die Backend Übersetzungen und '''Language Support Page Names''' für die URLs.<br />
* '''FieldtypePageTitleLanguage''' benötigt man wenn man alle Seitenamen anpassen will (seite1_de seite1_fr ...) Für einen reinen Sprachpfad (/de/Seite) braucht man das nicht.<br />
* Für weitere Sprachen entsprechend hinzufügen.<br />
Vorgehen:<br />
* Language Packs installieren: drop in the none english language pack (for admin backend) into the default language, (e.g. german langpack)<br />
* As a nice sideeffect every new user in your system gets the native language per default without have it to select from the list.<br />
<br />
=== Beispiel Default Sprache Deutsch ===<br />
Todo Testen<br />
* Modul Language Support<br />
* Translation File unter Setup Sprachen hochladen<br />
* Übersetzungen von Hand hinzufügen<br />
<br />
== Templates für Multilanguage vorbereiten (i18n) ==<br />
https://processwire.com/docs/multi-language-support/code-i18n/<br />
https://processwire.com/blog/posts/functional-fields/<br />
=== Functional fields ===<br />
In PW3 kamen die functional Fields hinzu. Mit diesen kann man statischen Text dynamisch im Page Editor ansprechen. D.h. das Functional Field findet Texte im Template und macht sie automatisch editierbar im Page Editor. Das Ganze funktioniert auch Mehrsprachig.<br />
[[ProcessWire - Functional Fields]]<br />
https://processwire.com/blog/posts/functional-fields/<br />
Beispiele für die Ausgabe von <br />
<pre><br />
__text('your text');<br />
__textarea('your text');<br />
__richtext('<p>your text</p>'); <br />
__text('Subscribe Now', 'subscribe') // define a identifier for this text snippet...<br />
__text('subscribe') // ..reuse it this way<br />
$pages->get('/')->mytext->subscribe // reuse from another template<br />
__text('Subscribe Now', 'subscribe', 'Submit button'); // Label for page editor<br />
__text('Subscribe Now', 'subscribe', 'label=Submit button, notes=Test'); // or use a pw selector<br />
__text('Subscribe Now', 'name=subscribe, label=Submit button, notes=Test'); // equivalent to upper<br />
<br />
<br />
<br />
=== Standard Multilanguage nach i18n ===<br />
<br />
$out = $this->_("Live long and prosper"); // syntax within a class<br />
$out = __("Live long and prosper!"); // syntax outside of a class<br />
<br />
Dann im Backend unter der Sprache "Find files to translate" und die Template Datei auswählen.<br />
<br />
=== Variablen in i18n ===<br />
$out = sprintf(__("Created %d pages."), $count); <br />
$out = sprintf(__('Your city is %1$s, and your zip code is %2$s.'), $city, $zipcode);<br />
<br />
=== Plural in Multilanguage Files===<br />
Hierzu gibt es die _n() Funktion<br />
$out = sprintf(_n("Created %d page.", "Created %d pages.", $count), $count);<br />
=== Unterschiedliche Übersetzungen bei gleichem Wortlaut ===<br />
Manchmal muss der Begriff in anderen Sprachen unterschiedlich übersetzt werden, obwohl er in der Default Sprache gleich lautet:<br />
<pre><br />
$label = _x('Comment', 'noun'); // or $this->_x('Comment', 'noun') in a class<br />
...<br />
// some other place in the code<br />
echo _x('Comment', 'column name');<br />
</pre><br />
=== Kommentare für den Übersetzer und User ===<br />
$date = __('g:i:s a'); // Date string in PHP date() format<br />
echo __("Welcome Guest"); // Headline for guest user // Keep it short (2-3 words)<br />
=== Regeln ===<br />
* Eine Zeile ein Paar Anführungszeichen<br />
* Nur eine Übersetzungsfunktion pro Zeile<br />
<br />
== Language Switcher ==<br />
<pre><br />
// remember what language is set to<br />
$savedLanguage = $user->language;<br />
<br />
foreach($languages as $language) {<br />
<br />
// if user is already viewing the page in this language, skip it<br />
if($language->id == $savedLanguage->id) continue;<br />
<br />
// if this page isn't viewable (active) for the language, skip it<br />
if(!$page->viewable($language)) continue;<br />
<br />
// set the user's language, so that the $page->url and any other<br />
// fields we access from it will be reflective of the $language<br />
$user->language = $language;<br />
<br />
// output a link to this page in the other language<br />
echo "<li><a href='$page->url'>$language->title: $page->title</a></li>";<br />
}<br />
// restore the original language setting<br />
$user->language = $savedLanguage;<br />
</pre><br />
<br />
== Beispiele ==<br />
=== Multilanguage Page allgemeines Vorgehen ===<br />
==== 1. Module ====<br />
* s.o. alle benötigten installieren<br />
==== 2. Backend ====<br />
* Default Sprache festlegen<br />
* Alle Felder die Übersetzt werden sollen auf Multilanguage Felder umstellen<br />
==== 3. Templates ====<br />
Das '''lang Attribut''' sollte zur Sprache passen. Mit der _x Funktion kann PW beliebige Strings in Templates übersetzten. PW findet diese automatisch.<br />
_main.php (oder header..)<br />
<html lang="<?php echo _x('en', 'HTML language code'); ?>"<br />
Im Backend kann man nun in den Spracheinstellungen Verwaltung > Sprachen > meineSprache das Label HTML language code suchen und mit dem passenden lang tag ersetzen.<br />
Das Funktioniert auch mit beliebigen anderen Werten die man im Template hartkodiert hat.<br />
<br />
So etwas sollte auch möglich sein:<br />
<pre><br />
<? $lang = $pages->get(1)->getLanguageValue($user->language, 'name'); ?><br />
<html lang="<?php echo $lang ?>"><br />
</pre><br />
Hier wird einfach der Name der Sprache die der Benutzer im Moment hat (Session) ausgegeben. Der Name der Sprache sollte im Backend entsprechend der Norm gewählt sein. (de, it, fi...)<br />
<br />
==== Language Switcher ====<br />
Der Language Switcher sollte verschiedene Dinge berücksichtigen erledigen:<br />
<br />
<br />
=== Prantner ===<br />
language-switcher.inc<br />
<syntaxhighlight lang="php"><br />
<?php namespace ProcessWire;<br />
$imgMarkup = "";<br />
$out = "";<br />
foreach($languages as $language) {<br />
if(!$page->viewable($language)) continue; // is page viewable in this language?<br />
$url = $page->localUrl($language);<br />
$hreflang = $homepage->getLanguageValue($language, 'name');<br />
$imgUrl = $config->urls->templates.'assets/flags/'.$language->name.'_sq.png';<br />
$imgMarkup = "<img src=\"$imgUrl\" title=\"$language->title\" alt=\"$language->title\" class=\"circle z-depth-1\">";<br />
if($language->id == $user->language->id) {<br />
$out .= "<span class=\"lang-button current\">";<br />
} else {<br />
$out .= "<span class=\"lang-button\">";<br />
}<br />
$out .= "<a hreflang=\"$hreflang\" href=\"$url\">$imgMarkup</a></span>";<br />
}<br />
$out = '<div id="nav-lang">'.$out.'</div>';<br />
echo $out; <br />
?><br />
</syntaxhighlight><br />
<br />
language-switcher-mobile.inc<br />
<syntaxhighlight lang="php"><br />
<?php namespace ProcessWire;<br />
?><br />
<ul id="nav-mobile" class="right hide-on-med-and-down"><br />
<?php<br />
foreach($languages as $language) {<br />
if(!$page->viewable($language)) continue; // is page viewable in this language?<br />
if($language->id == $user->language->id) {<br />
echo "<li class='current'>";<br />
} else {<br />
echo "<li>";<br />
}<br />
$url = $page->localUrl($language);<br />
$hreflang = $homepage->getLanguageValue($language, 'name');<br />
echo "<a hreflang='$hreflang' href='$url'>$language->title</a></li>";<br />
}<br />
?><br />
</ul><br />
</syntaxhighlight></div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Multilanguage_Website&diff=24404ProcessWire - Multilanguage Website2020-02-14T14:07:58Z<p>84.136.104.26: </p>
<hr />
<div>Mehrsprachige Websites mit ProcessWire / Andere Default Sprache<br />
<br />
== Links ==<br />
* https://processwire.com/talk/topic/5518-multi-language-site/<br />
* http://processwire.com/api/multi-language-support/multi-language-urls/<br />
* https://processwire.com/talk/topic/9322-change-default-language-for-homepage/ (Modul Solution, mehr zur Anschauung)<br />
<br />
== Einleitung ==<br />
Es gibt mehrere Bereiche an die man denken muss. Einmal geht es um die Eingabe im Backend, die Ausgabe im Frontend, die Sprachnavigation auf der Website und die Templates:<br />
* Wie übersetze ich Text in meinen '''Templates''' ? Siehe unten i18n<br />
* Wie übersetze ich '''Inhalte''' im Backend ? Dafür ist das Modul Language Support Fields zuständig<br />
* Wie sollen meine URLs aussehen ? Prinzipiell kann man jedem User unterschiedliche Sprachen auch ohne andere Domain liefern (über seine Session) aber i.d.R wollen wir die URL anzupassen.<br />
** ''domain.de/en/meineSeite'' oder ''domain.de/myPage''<br />
** Um '''Seitennamen''' zu übersetzen oder ein Domainkürzel in der URL voranzustellen benötige ich das Modul '''Language Support Page Names''' <br />
<br />
== Welche Module benötige ich ==<br />
Da es einige Module in diesem Zusammenhang gibt hier eine Übersicht. Man findet Sie am besten unter <br />
Modules > Core > Language<br />
<br />
* '''Languages Support''' - ProcessWire multi-language support. Basis Modul bracht man für alle Beispiele unten. Reicht aus, wenn man nur die Standard-Sprache ändern will.<br />
* '''Languages Support - Fields''' Required to use multi-language fields. Basis für mehrsprachige Felder im Backend. <br />
* '''Languages Support - Page Names''' (LanguageSupportPageNames) Required to use multi-language page names. Braucht man nur wenn '''alle Seiten in allen Sprachen unterschiedliche Namen''' bekommen sollen.<br />
* '''Languages Support - Tabs''' Organizes multi-language fields into tabs for a cleaner easier to use interface.<br />
Für mehrsprachige Seiten benötigen wir im Frontend i.d.R. folgende Module: <br />
* '''Language Support Fields''' - Sind Felder, die im Backend für jede Sprache eine eigene Eingabe bieten.<br />
* '''Language Support Page Names''' benötigt man, damit man für die Sprachen eigene URLs angeben kann. Z.B. bei Home in Englisch /en/ usw. <br />
* '''FieldtypePageTitleLanguage''' benötigt man wenn man alle Seitenamen anpassen will (seite1_de seite1_fr ...) Für einen reinen Sprachpfad (/de/Seite) braucht man das nicht.<br />
== Deutsch als Default Sprache ==<br />
Wenn nur die Standardsprache verändern möchte, aber keine Mehrsprachige Seite benötigt brauchen wir nur das Modul '''Language Support'''<br />
* Enable languages support -> '''Core Module "Language Support" aktivieren'''. -> Sprachen stehen num im Backend Setup zur Verfügung<br />
* '''Titel der Default Sprache''' anpassen (z.B. Deutsch (default) )<br />
* Language Pack in der default Sprache installieren -> Dies ist ab jetzt die Default Sprache. Nicht vergessen auch den '''lang Tag im Header''' zu setzen, damit der Browser die Sprache richtig erkennt.<br />
<br />
== Mehrere Sprachen ==<br />
Für mehrsprachige Seiten benötigen wir i.d.R. folgende Module: <br />
* '''Language Support Fields''' für die Backend Übersetzungen und '''Language Support Page Names''' für die URLs.<br />
* '''FieldtypePageTitleLanguage''' benötigt man wenn man alle Seitenamen anpassen will (seite1_de seite1_fr ...) Für einen reinen Sprachpfad (/de/Seite) braucht man das nicht.<br />
* Für weitere Sprachen entsprechend hinzufügen.<br />
Vorgehen:<br />
* Language Packs installieren: drop in the none english language pack (for admin backend) into the default language, (e.g. german langpack)<br />
* As a nice sideeffect every new user in your system gets the native language per default without have it to select from the list.<br />
<br />
=== Beispiel Default Sprache Deutsch ===<br />
Todo Testen<br />
* Modul Language Support<br />
* Translation File unter Setup Sprachen hochladen<br />
* Übersetzungen von Hand hinzufügen<br />
<br />
== Templates für Multilanguage vorbereiten (i18n) ==<br />
https://processwire.com/docs/multi-language-support/code-i18n/<br />
https://processwire.com/blog/posts/functional-fields/<br />
=== Functional fields ===<br />
In PW3 kamen die functional Fields hinzu. Mit diesen kann man statischen Text dynamisch im Page Editor ansprechen. D.h. das Functional Field findet Texte im Template und macht sie automatisch editierbar im Page Editor. Das Ganze funktioniert auch Mehrsprachig.<br />
[[ProcessWire - Functional Fields]]<br />
https://processwire.com/blog/posts/functional-fields/<br />
Beispiele für die Ausgabe von <br />
<pre><br />
__text('your text');<br />
__textarea('your text');<br />
__richtext('<p>your text</p>'); <br />
__text('Subscribe Now', 'subscribe') // define a identifier for this text snippet...<br />
__text('subscribe') // ..reuse it this way<br />
$pages->get('/')->mytext->subscribe // reuse from another template<br />
__text('Subscribe Now', 'subscribe', 'Submit button'); // Label for page editor<br />
__text('Subscribe Now', 'subscribe', 'label=Submit button, notes=Test'); // or use a pw selector<br />
__text('Subscribe Now', 'name=subscribe, label=Submit button, notes=Test'); // equivalent to upper<br />
<br />
<br />
<br />
=== Standard Multilanguage nach i18n ===<br />
<br />
$out = $this->_("Live long and prosper"); // syntax within a class<br />
$out = __("Live long and prosper!"); // syntax outside of a class<br />
<br />
Dann im Backend unter der Sprache "Find files to translate" und die Template Datei auswählen.<br />
<br />
=== Variablen in i18n ===<br />
$out = sprintf(__("Created %d pages."), $count); <br />
$out = sprintf(__('Your city is %1$s, and your zip code is %2$s.'), $city, $zipcode);<br />
<br />
=== Plural in Multilanguage Files===<br />
Hierzu gibt es die _n() Funktion<br />
$out = sprintf(_n("Created %d page.", "Created %d pages.", $count), $count);<br />
=== Unterschiedliche Übersetzungen bei gleichem Wortlaut ===<br />
Manchmal muss der Begriff in anderen Sprachen unterschiedlich übersetzt werden, obwohl er in der Default Sprache gleich lautet:<br />
<pre><br />
$label = _x('Comment', 'noun'); // or $this->_x('Comment', 'noun') in a class<br />
...<br />
// some other place in the code<br />
echo _x('Comment', 'column name');<br />
</pre><br />
=== Kommentare für den Übersetzer und User ===<br />
$date = __('g:i:s a'); // Date string in PHP date() format<br />
echo __("Welcome Guest"); // Headline for guest user // Keep it short (2-3 words)<br />
=== Regeln ===<br />
* Eine Zeile ein Paar Anführungszeichen<br />
* Nur eine Übersetzungsfunktion pro Zeile<br />
<br />
== Language Switcher ==<br />
<pre><br />
// remember what language is set to<br />
$savedLanguage = $user->language;<br />
<br />
foreach($languages as $language) {<br />
<br />
// if user is already viewing the page in this language, skip it<br />
if($language->id == $savedLanguage->id) continue;<br />
<br />
// if this page isn't viewable (active) for the language, skip it<br />
if(!$page->viewable($language)) continue;<br />
<br />
// set the user's language, so that the $page->url and any other<br />
// fields we access from it will be reflective of the $language<br />
$user->language = $language;<br />
<br />
// output a link to this page in the other language<br />
echo "<li><a href='$page->url'>$language->title: $page->title</a></li>";<br />
}<br />
// restore the original language setting<br />
$user->language = $savedLanguage;<br />
</pre><br />
<br />
== Beispiele ==<br />
=== Multilanguage Page allgemeines Vorgehen ===<br />
==== 1. Module ====<br />
* s.o. alle benötigten installieren<br />
==== 2. Backend ====<br />
* Default Sprache festlegen<br />
* Alle Felder die Übersetzt werden sollen auf Multilanguage Felder umstellen<br />
==== 3. Templates ====<br />
Das '''lang Attribut''' sollte zur Sprache passen. Mit der _x Funktion kann PW beliebige Strings in Templates übersetzten. PW findet diese automatisch.<br />
_main.php (oder header..)<br />
<html lang="<?php echo _x('en', 'HTML language code'); ?>"<br />
Im Backend kann man nun in den Spracheinstellungen Verwaltung > Sprachen > meineSprache das Label HTML language code suchen und mit dem passenden lang tag ersetzen.<br />
<br />
So etwas sollte auch möglich sein:<br />
<pre><br />
<? $lang = $pages->get(1)->getLanguageValue($user->language, 'name'); ?><br />
<html lang="<?php echo $lang ?>"><br />
</pre><br />
Das Funktioniert auch mit beliebigen anderen Werten die man im Template hartkodiert hat.<br />
<br />
==== Language Switcher ====<br />
Der Language Switcher sollte verschiedene Dinge berücksichtigen erledigen:<br />
<br />
<br />
=== Prantner ===<br />
language-switcher.inc<br />
<syntaxhighlight lang="php"><br />
<?php namespace ProcessWire;<br />
$imgMarkup = "";<br />
$out = "";<br />
foreach($languages as $language) {<br />
if(!$page->viewable($language)) continue; // is page viewable in this language?<br />
$url = $page->localUrl($language);<br />
$hreflang = $homepage->getLanguageValue($language, 'name');<br />
$imgUrl = $config->urls->templates.'assets/flags/'.$language->name.'_sq.png';<br />
$imgMarkup = "<img src=\"$imgUrl\" title=\"$language->title\" alt=\"$language->title\" class=\"circle z-depth-1\">";<br />
if($language->id == $user->language->id) {<br />
$out .= "<span class=\"lang-button current\">";<br />
} else {<br />
$out .= "<span class=\"lang-button\">";<br />
}<br />
$out .= "<a hreflang=\"$hreflang\" href=\"$url\">$imgMarkup</a></span>";<br />
}<br />
$out = '<div id="nav-lang">'.$out.'</div>';<br />
echo $out; <br />
?><br />
</syntaxhighlight><br />
<br />
language-switcher-mobile.inc<br />
<syntaxhighlight lang="php"><br />
<?php namespace ProcessWire;<br />
?><br />
<ul id="nav-mobile" class="right hide-on-med-and-down"><br />
<?php<br />
foreach($languages as $language) {<br />
if(!$page->viewable($language)) continue; // is page viewable in this language?<br />
if($language->id == $user->language->id) {<br />
echo "<li class='current'>";<br />
} else {<br />
echo "<li>";<br />
}<br />
$url = $page->localUrl($language);<br />
$hreflang = $homepage->getLanguageValue($language, 'name');<br />
echo "<a hreflang='$hreflang' href='$url'>$language->title</a></li>";<br />
}<br />
?><br />
</ul><br />
</syntaxhighlight></div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Multilanguage_Website&diff=24403ProcessWire - Multilanguage Website2020-02-14T09:45:25Z<p>84.136.104.26: </p>
<hr />
<div>Mehrsprachige Websites mit ProcessWire / Andere Default Sprache<br />
<br />
== Links ==<br />
* https://processwire.com/talk/topic/5518-multi-language-site/<br />
* http://processwire.com/api/multi-language-support/multi-language-urls/<br />
* https://processwire.com/talk/topic/9322-change-default-language-for-homepage/ (Modul Solution, mehr zur Anschauung)<br />
<br />
== Einleitung ==<br />
Es gibt mehrere Bereiche an die man denken muss. Einmal geht es um die Eingabe im Backend, die Ausgabe im Frontend, die Sprachnavigation auf der Website und die Templates:<br />
* Wie übersetze ich Text in meinen '''Templates''' ? Siehe unten i18n<br />
* Wie übersetze ich '''Inhalte''' im Backend ? Dafür ist das Modul Language Support Fields zuständig<br />
* Wie sollen meine URLs aussehen ? Prinzipiell kann man jedem User unterschiedliche Sprachen auch ohne andere Domain liefern (über seine Session) aber i.d.R wollen wir die URL anzupassen.<br />
** ''domain.de/en/meineSeite'' oder ''domain.de/myPage''<br />
** Um '''Seitennamen''' zu übersetzen oder ein Domainkürzel in der URL voranzustellen benötige ich das Modul '''Language Support Page Names''' <br />
<br />
== Welche Module benötige ich ==<br />
Da es einige Module in diesem Zusammenhang gibt hier eine Übersicht. Man findet Sie am besten unter <br />
Modules > Core > Language<br />
<br />
* '''Languages Support''' - ProcessWire multi-language support. Basis Modul bracht man für alle Beispiele unten. Reicht aus, wenn man nur die Standard-Sprache ändern will.<br />
* '''Languages Support - Fields''' Required to use multi-language fields. Basis für mehrsprachige Felder im Backend. <br />
* '''Languages Support - Page Names''' (LanguageSupportPageNames) Required to use multi-language page names. Braucht man nur wenn '''alle Seiten in allen Sprachen unterschiedliche Namen''' bekommen sollen.<br />
* '''Languages Support - Tabs''' Organizes multi-language fields into tabs for a cleaner easier to use interface.<br />
<br />
== Deutsch als Default Sprache ==<br />
Wenn nur die Standardsprache verändert wird aber die Seite einsprachig bleibt brauchen wir nur das Modul '''Language Support'''<br />
* Enable languages support -> '''Core Module "Language Support" aktivieren'''. -> Languages stehen im Backend Setup zur Verfügung<br />
* '''Titel der Default Sprache''' anpassen (z.B. Deutsch (default) )<br />
* Language Pack in der default Sprache installieren -> Dies ist ab jetzt die Default Sprache. Nicht vergessen auch den '''lang Tag im Header''' zu setzen, damit der Browser die Sprache richtig erkennt.<br />
<br />
== Mehrere Sprachen ==<br />
Für mehrsprachige Seiten benötigen wir i.d.R. folgende Module: <br />
* '''Language Support Fields''' für die Backend Übersetzungen und '''Language Support Page Names''' für die URLs.<br />
* '''FieldtypePageTitleLanguage''' benötigt man wenn man alle Seitenamen anpassen will (seite1_de seite1_fr ...) Für einen reinen Sprachpfad (/de/Seite) braucht man das nicht.<br />
... ToDo<br />
<br />
<br />
* Für weitere Sprachen entsprechend hinzufügen.<br />
<br />
drop in the none english language pack (for admin backend) into the default language, (e.g. german langpack)<br />
<br />
add a new language to it and drop in a language pack for any none english language or simply don't drop in a language pack to get the english version (but not as the default one!)<br />
As a nice sideeffect every new user in your system gets the native language per default without have it to select from the list.<br />
<br />
So, yes, this is no solution if you once have set it up and need to switch the default language afterwards, but just want to note it.<br />
<br />
=== Beispiel Default Sprache Deutsch ===<br />
Todo Testen<br />
* Modul Language Support<br />
* Translation File unter Setup Sprachen hochladen<br />
* Übersetzungen von Hand hinzufügen<br />
<br />
== Templates für Multilanguage vorbereiten (i18n) ==<br />
https://processwire.com/docs/multi-language-support/code-i18n/<br />
https://processwire.com/blog/posts/functional-fields/<br />
=== Functional fields ===<br />
In PW3 kamen die functional Fields hinzu. Mit diesen kann man statischen Text dynamisch im Page Editor ansprechen. D.h. das Functional Field findet Texte im Template und macht sie automatisch editierbar im Page Editor. Das Ganze funktioniert auch Mehrsprachig.<br />
[[ProcessWire - Functional Fields]]<br />
https://processwire.com/blog/posts/functional-fields/<br />
Beispiele für die Ausgabe von <br />
<pre><br />
__text('your text');<br />
__textarea('your text');<br />
__richtext('<p>your text</p>'); <br />
__text('Subscribe Now', 'subscribe') // define a identifier for this text snippet...<br />
__text('subscribe') // ..reuse it this way<br />
$pages->get('/')->mytext->subscribe // reuse from another template<br />
__text('Subscribe Now', 'subscribe', 'Submit button'); // Label for page editor<br />
__text('Subscribe Now', 'subscribe', 'label=Submit button, notes=Test'); // or use a pw selector<br />
__text('Subscribe Now', 'name=subscribe, label=Submit button, notes=Test'); // equivalent to upper<br />
<br />
<br />
<br />
=== Standard Multilanguage nach i18n ===<br />
<br />
$out = $this->_("Live long and prosper"); // syntax within a class<br />
$out = __("Live long and prosper!"); // syntax outside of a class<br />
<br />
Dann im Backend unter der Sprache "Find files to translate" und die Template Datei auswählen.<br />
<br />
=== Variablen in i18n ===<br />
$out = sprintf(__("Created %d pages."), $count); <br />
$out = sprintf(__('Your city is %1$s, and your zip code is %2$s.'), $city, $zipcode);<br />
<br />
=== Plural in Multilanguage Files===<br />
Hierzu gibt es die _n() Funktion<br />
$out = sprintf(_n("Created %d page.", "Created %d pages.", $count), $count);<br />
=== Unterschiedliche Übersetzungen bei gleichem Wortlaut ===<br />
Manchmal muss der Begriff in anderen Sprachen unterschiedlich übersetzt werden, obwohl er in der Default Sprache gleich lautet:<br />
<pre><br />
$label = _x('Comment', 'noun'); // or $this->_x('Comment', 'noun') in a class<br />
...<br />
// some other place in the code<br />
echo _x('Comment', 'column name');<br />
</pre><br />
=== Kommentare für den Übersetzer und User ===<br />
$date = __('g:i:s a'); // Date string in PHP date() format<br />
echo __("Welcome Guest"); // Headline for guest user // Keep it short (2-3 words)<br />
=== Regeln ===<br />
* Eine Zeile ein Paar Anführungszeichen<br />
* Nur eine Übersetzungsfunktion pro Zeile<br />
<br />
== Language Switcher ==<br />
<pre><br />
// remember what language is set to<br />
$savedLanguage = $user->language;<br />
<br />
foreach($languages as $language) {<br />
<br />
// if user is already viewing the page in this language, skip it<br />
if($language->id == $savedLanguage->id) continue;<br />
<br />
// if this page isn't viewable (active) for the language, skip it<br />
if(!$page->viewable($language)) continue;<br />
<br />
// set the user's language, so that the $page->url and any other<br />
// fields we access from it will be reflective of the $language<br />
$user->language = $language;<br />
<br />
// output a link to this page in the other language<br />
echo "<li><a href='$page->url'>$language->title: $page->title</a></li>";<br />
}<br />
// restore the original language setting<br />
$user->language = $savedLanguage;<br />
</pre><br />
<br />
== Beispiele ==<br />
=== Prantner ===<br />
language-switcher.inc<br />
<syntaxhighlight lang="php"><br />
<?php namespace ProcessWire;<br />
$imgMarkup = "";<br />
$out = "";<br />
foreach($languages as $language) {<br />
if(!$page->viewable($language)) continue; // is page viewable in this language?<br />
$url = $page->localUrl($language);<br />
$hreflang = $homepage->getLanguageValue($language, 'name');<br />
$imgUrl = $config->urls->templates.'assets/flags/'.$language->name.'_sq.png';<br />
$imgMarkup = "<img src=\"$imgUrl\" title=\"$language->title\" alt=\"$language->title\" class=\"circle z-depth-1\">";<br />
if($language->id == $user->language->id) {<br />
$out .= "<span class=\"lang-button current\">";<br />
} else {<br />
$out .= "<span class=\"lang-button\">";<br />
}<br />
$out .= "<a hreflang=\"$hreflang\" href=\"$url\">$imgMarkup</a></span>";<br />
}<br />
$out = '<div id="nav-lang">'.$out.'</div>';<br />
echo $out; <br />
?><br />
</syntaxhighlight><br />
<br />
language-switcher-mobile.inc<br />
<syntaxhighlight lang="php"><br />
<?php namespace ProcessWire;<br />
?><br />
<ul id="nav-mobile" class="right hide-on-med-and-down"><br />
<?php<br />
foreach($languages as $language) {<br />
if(!$page->viewable($language)) continue; // is page viewable in this language?<br />
if($language->id == $user->language->id) {<br />
echo "<li class='current'>";<br />
} else {<br />
echo "<li>";<br />
}<br />
$url = $page->localUrl($language);<br />
$hreflang = $homepage->getLanguageValue($language, 'name');<br />
echo "<a hreflang='$hreflang' href='$url'>$language->title</a></li>";<br />
}<br />
?><br />
</ul><br />
</syntaxhighlight></div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Hooks&diff=24402ProcessWire - Hooks2020-02-13T19:10:30Z<p>84.136.104.26: /* Basic Starter Hook */</p>
<hr />
<div>== Wo setzt man hooks am Besten ein ==<br />
Es gibt einige Standard Dateien die für solche Zwecke geeignet sind:<br />
<br />
=== /site/init.php ===<br />
PW Boot -> Module mit autoload -> init.php<br />
This file is included during ProcessWire's boot initialization, immediately after autoload modules have been loaded and had their init() methods called. Anything you do in here will behave the same as an init() method on a module. When this file is called, the current $page has not yet been determined. This is an excellent place to attach '''hooks that don't need to know anything about the current page'''.<br />
<br />
=== /site/ready.php ===<br />
API geladen und ready -> $page bereit aber noch nicht gerendert<br />
This file is included immediately after the API is fully ready. It behaves the same as a ready() method in an autoload module. The current $page has been determined, but not yet rendered. This is an excellent place to '''attach hooks that may need to know something about the current page'''. It's also an excellent place to '''include additional classes or libraries that will be used on all pages''' in your site.<br />
<br />
=== /site/finished.php ===<br />
Seite gerendert<br />
This file is included when ProcessWire has finished rendering and delivering a page, and is in the process of shutting down. It is called immediately before the API is disengaged, so you can still access any API variable and '''update $session values''' as needed. Admittedly, this is probably '''not the place you would put hooks''', but it is an ideal place to '''perform your own shutdown''', should your application call for it.<br />
<br />
== Beispiele für Hooks ==<br />
=== Basic Starter Hook ===<br />
Erster Schritt zum ausprobieren<br />
<syntaxhighlight lang="php"><br />
// i.e. in ready.php<br />
$wire->addHookAfter('Pages::saved', function(HookEvent $event) {<br />
$page = $event->arguments(0);<br />
bd($page); // tracy debugger output<br />
});<br />
<br />
// more specific<br />
$wire->addHookAfter('Pages::added(template=basic-page)', function(HookEvent $event) {<br />
$page = $event->arguments(0);<br />
bd($page);<br />
});<br />
<br />
<br />
</syntaxhighlight><br />
<br />
=== Feld manipulieren ===<br />
Beim Speichern einer Seite ein Feld anpassen <br />
<syntaxhighlight lang="php"><br />
$pages->addHookAfter('saveReady', function(HookEvent $event) {<br />
$page = $event->arguments(0);<br />
// If the page has the relevant template...<br />
if($page->template == 'oe') {<br />
// make title uppercase<br />
$page->name = strtoupper($page->name);<br />
}<br />
});<br />
</syntaxhighlight><br />
<br />
=== Seiten im Backend sortieren ===<br />
<syntaxhighlight lang="php"><br />
/*sort clients of key account manager by title in backend*/<br />
$pages->addHookAfter('saveReady', function(HookEvent $event) {<br />
$page = $event->arguments(0);<br />
// If the page has the relevant template...<br />
if($page->template == 'key_account_manager') {<br />
// Sort the Page Reference field by title<br />
$page->pr_kam_clients->sort('title') ;<br />
}<br />
});<br />
</syntaxhighlight><br />
<br />
=== Externe Klasse verfügbar machen ===<br />
/site/ready.php<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
$pages->addHookAfter('saved', function($event) {<br />
$page = $event->object;<br />
if($page->template == 'product') {<br />
// update other related pages when 'product' page is saved<br />
}<br />
});<br />
<br />
if($page->template != 'admin') {<br />
// include an external helper class...<br />
require('./classes/ProductCart.php');<br />
// ...and establish it as a new $cart API variable, and<br />
// populate it with products saved in the user's session:<br />
$wire->wire('cart', new ProductCart($session->productsInCart));<br />
}<br />
</syntaxhighlight><br />
<br />
There is also a /site/finished.php that obtains the products from the $cart and saves them back to the session, ready for the next request:<br />
<br />
/site/finished.php<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
if($page->template != 'admin') {<br />
$session->productsInCart = $cart->getArray();<br />
}<br />
</syntaxhighlight><br />
<br />
=== Custom Hook Methode ===<br />
Beispiel aus der ready.php<br />
<syntaxhighlight lang="php"><br />
/** @var ProcessWire $wire */<br />
<br />
/**<br />
* Example of a custom hook method<br />
* <br />
* This hook adds a “numPosts” method to pages using template “category”.<br />
* The return value is the quantity of posts in category.<br />
*<br />
* Usage:<br />
* ~~~~~<br />
* $numPosts = $page->numPosts(); // returns integer<br />
* numPosts = $page->numPosts(true); // returns string like "5 posts"<br />
* ~~~~~<br />
*<br />
*/<br />
$wire->addHook('Page(template=category)::numPosts', function($event) {<br />
/** @var Page $page */<br />
$page = $event->object;<br />
<br />
// only category pages have numPosts<br />
if($page->template != 'category') return;<br />
<br />
// find number of posts<br />
$numPosts = $event->pages->count("template=blog-post, categories=$page");<br />
<br />
if($event->arguments(0) === true) {<br />
// if true argument was specified, format it as a "5 posts" type string<br />
$numPosts = sprintf(_n('%d post', '%d posts', $numPosts), $numPosts);<br />
}<br />
<br />
$event->return = $numPosts;<br />
}); <br />
</syntaxhighlight></div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Hooks&diff=24401ProcessWire - Hooks2020-02-13T19:10:11Z<p>84.136.104.26: /* Basic Starter Hook */</p>
<hr />
<div>== Wo setzt man hooks am Besten ein ==<br />
Es gibt einige Standard Dateien die für solche Zwecke geeignet sind:<br />
<br />
=== /site/init.php ===<br />
PW Boot -> Module mit autoload -> init.php<br />
This file is included during ProcessWire's boot initialization, immediately after autoload modules have been loaded and had their init() methods called. Anything you do in here will behave the same as an init() method on a module. When this file is called, the current $page has not yet been determined. This is an excellent place to attach '''hooks that don't need to know anything about the current page'''.<br />
<br />
=== /site/ready.php ===<br />
API geladen und ready -> $page bereit aber noch nicht gerendert<br />
This file is included immediately after the API is fully ready. It behaves the same as a ready() method in an autoload module. The current $page has been determined, but not yet rendered. This is an excellent place to '''attach hooks that may need to know something about the current page'''. It's also an excellent place to '''include additional classes or libraries that will be used on all pages''' in your site.<br />
<br />
=== /site/finished.php ===<br />
Seite gerendert<br />
This file is included when ProcessWire has finished rendering and delivering a page, and is in the process of shutting down. It is called immediately before the API is disengaged, so you can still access any API variable and '''update $session values''' as needed. Admittedly, this is probably '''not the place you would put hooks''', but it is an ideal place to '''perform your own shutdown''', should your application call for it.<br />
<br />
== Beispiele für Hooks ==<br />
=== Basic Starter Hook ===<br />
Erster Schritt zum ausprobieren (z.B. in ready.php)<br />
<syntaxhighlight lang="php"><br />
$wire->addHookAfter('Pages::saved', function(HookEvent $event) {<br />
$page = $event->arguments(0);<br />
bd($page); // tracy debugger output<br />
});<br />
<br />
// more specific<br />
$wire->addHookAfter('Pages::added(template=basic-page)', function(HookEvent $event) {<br />
$page = $event->arguments(0);<br />
bd($page);<br />
});<br />
<br />
<br />
</syntaxhighlight><br />
<br />
=== Feld manipulieren ===<br />
Beim Speichern einer Seite ein Feld anpassen <br />
<syntaxhighlight lang="php"><br />
$pages->addHookAfter('saveReady', function(HookEvent $event) {<br />
$page = $event->arguments(0);<br />
// If the page has the relevant template...<br />
if($page->template == 'oe') {<br />
// make title uppercase<br />
$page->name = strtoupper($page->name);<br />
}<br />
});<br />
</syntaxhighlight><br />
<br />
=== Seiten im Backend sortieren ===<br />
<syntaxhighlight lang="php"><br />
/*sort clients of key account manager by title in backend*/<br />
$pages->addHookAfter('saveReady', function(HookEvent $event) {<br />
$page = $event->arguments(0);<br />
// If the page has the relevant template...<br />
if($page->template == 'key_account_manager') {<br />
// Sort the Page Reference field by title<br />
$page->pr_kam_clients->sort('title') ;<br />
}<br />
});<br />
</syntaxhighlight><br />
<br />
=== Externe Klasse verfügbar machen ===<br />
/site/ready.php<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
$pages->addHookAfter('saved', function($event) {<br />
$page = $event->object;<br />
if($page->template == 'product') {<br />
// update other related pages when 'product' page is saved<br />
}<br />
});<br />
<br />
if($page->template != 'admin') {<br />
// include an external helper class...<br />
require('./classes/ProductCart.php');<br />
// ...and establish it as a new $cart API variable, and<br />
// populate it with products saved in the user's session:<br />
$wire->wire('cart', new ProductCart($session->productsInCart));<br />
}<br />
</syntaxhighlight><br />
<br />
There is also a /site/finished.php that obtains the products from the $cart and saves them back to the session, ready for the next request:<br />
<br />
/site/finished.php<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
if($page->template != 'admin') {<br />
$session->productsInCart = $cart->getArray();<br />
}<br />
</syntaxhighlight><br />
<br />
=== Custom Hook Methode ===<br />
Beispiel aus der ready.php<br />
<syntaxhighlight lang="php"><br />
/** @var ProcessWire $wire */<br />
<br />
/**<br />
* Example of a custom hook method<br />
* <br />
* This hook adds a “numPosts” method to pages using template “category”.<br />
* The return value is the quantity of posts in category.<br />
*<br />
* Usage:<br />
* ~~~~~<br />
* $numPosts = $page->numPosts(); // returns integer<br />
* numPosts = $page->numPosts(true); // returns string like "5 posts"<br />
* ~~~~~<br />
*<br />
*/<br />
$wire->addHook('Page(template=category)::numPosts', function($event) {<br />
/** @var Page $page */<br />
$page = $event->object;<br />
<br />
// only category pages have numPosts<br />
if($page->template != 'category') return;<br />
<br />
// find number of posts<br />
$numPosts = $event->pages->count("template=blog-post, categories=$page");<br />
<br />
if($event->arguments(0) === true) {<br />
// if true argument was specified, format it as a "5 posts" type string<br />
$numPosts = sprintf(_n('%d post', '%d posts', $numPosts), $numPosts);<br />
}<br />
<br />
$event->return = $numPosts;<br />
}); <br />
</syntaxhighlight></div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Hooks&diff=24400ProcessWire - Hooks2020-02-13T19:09:32Z<p>84.136.104.26: /* Beispiele für Hooks */</p>
<hr />
<div>== Wo setzt man hooks am Besten ein ==<br />
Es gibt einige Standard Dateien die für solche Zwecke geeignet sind:<br />
<br />
=== /site/init.php ===<br />
PW Boot -> Module mit autoload -> init.php<br />
This file is included during ProcessWire's boot initialization, immediately after autoload modules have been loaded and had their init() methods called. Anything you do in here will behave the same as an init() method on a module. When this file is called, the current $page has not yet been determined. This is an excellent place to attach '''hooks that don't need to know anything about the current page'''.<br />
<br />
=== /site/ready.php ===<br />
API geladen und ready -> $page bereit aber noch nicht gerendert<br />
This file is included immediately after the API is fully ready. It behaves the same as a ready() method in an autoload module. The current $page has been determined, but not yet rendered. This is an excellent place to '''attach hooks that may need to know something about the current page'''. It's also an excellent place to '''include additional classes or libraries that will be used on all pages''' in your site.<br />
<br />
=== /site/finished.php ===<br />
Seite gerendert<br />
This file is included when ProcessWire has finished rendering and delivering a page, and is in the process of shutting down. It is called immediately before the API is disengaged, so you can still access any API variable and '''update $session values''' as needed. Admittedly, this is probably '''not the place you would put hooks''', but it is an ideal place to '''perform your own shutdown''', should your application call for it.<br />
<br />
== Beispiele für Hooks ==<br />
=== Basic Starter Hook ===<br />
<syntaxhighlight lang="php"><br />
$wire->addHookAfter('Pages::saved', function(HookEvent $event) {<br />
$page = $event->arguments(0);<br />
bd($page); // tracy debugger output<br />
});<br />
<br />
// more specific<br />
$wire->addHookAfter('Pages::added(template=basic-page)', function(HookEvent $event) {<br />
$page = $event->arguments(0);<br />
bd($page);<br />
});<br />
<br />
<br />
</syntaxhighlight><br />
=== Feld manipulieren ===<br />
Beim Speichern einer Seite ein Feld anpassen <br />
<syntaxhighlight lang="php"><br />
$pages->addHookAfter('saveReady', function(HookEvent $event) {<br />
$page = $event->arguments(0);<br />
// If the page has the relevant template...<br />
if($page->template == 'oe') {<br />
// make title uppercase<br />
$page->name = strtoupper($page->name);<br />
}<br />
});<br />
</syntaxhighlight><br />
<br />
=== Seiten im Backend sortieren ===<br />
<syntaxhighlight lang="php"><br />
/*sort clients of key account manager by title in backend*/<br />
$pages->addHookAfter('saveReady', function(HookEvent $event) {<br />
$page = $event->arguments(0);<br />
// If the page has the relevant template...<br />
if($page->template == 'key_account_manager') {<br />
// Sort the Page Reference field by title<br />
$page->pr_kam_clients->sort('title') ;<br />
}<br />
});<br />
</syntaxhighlight><br />
<br />
=== Externe Klasse verfügbar machen ===<br />
/site/ready.php<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
$pages->addHookAfter('saved', function($event) {<br />
$page = $event->object;<br />
if($page->template == 'product') {<br />
// update other related pages when 'product' page is saved<br />
}<br />
});<br />
<br />
if($page->template != 'admin') {<br />
// include an external helper class...<br />
require('./classes/ProductCart.php');<br />
// ...and establish it as a new $cart API variable, and<br />
// populate it with products saved in the user's session:<br />
$wire->wire('cart', new ProductCart($session->productsInCart));<br />
}<br />
</syntaxhighlight><br />
<br />
There is also a /site/finished.php that obtains the products from the $cart and saves them back to the session, ready for the next request:<br />
<br />
/site/finished.php<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
if($page->template != 'admin') {<br />
$session->productsInCart = $cart->getArray();<br />
}<br />
</syntaxhighlight><br />
<br />
=== Custom Hook Methode ===<br />
Beispiel aus der ready.php<br />
<syntaxhighlight lang="php"><br />
/** @var ProcessWire $wire */<br />
<br />
/**<br />
* Example of a custom hook method<br />
* <br />
* This hook adds a “numPosts” method to pages using template “category”.<br />
* The return value is the quantity of posts in category.<br />
*<br />
* Usage:<br />
* ~~~~~<br />
* $numPosts = $page->numPosts(); // returns integer<br />
* numPosts = $page->numPosts(true); // returns string like "5 posts"<br />
* ~~~~~<br />
*<br />
*/<br />
$wire->addHook('Page(template=category)::numPosts', function($event) {<br />
/** @var Page $page */<br />
$page = $event->object;<br />
<br />
// only category pages have numPosts<br />
if($page->template != 'category') return;<br />
<br />
// find number of posts<br />
$numPosts = $event->pages->count("template=blog-post, categories=$page");<br />
<br />
if($event->arguments(0) === true) {<br />
// if true argument was specified, format it as a "5 posts" type string<br />
$numPosts = sprintf(_n('%d post', '%d posts', $numPosts), $numPosts);<br />
}<br />
<br />
$event->return = $numPosts;<br />
}); <br />
</syntaxhighlight></div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Hooks&diff=24399ProcessWire - Hooks2020-02-13T19:09:02Z<p>84.136.104.26: /* Custom Hook Methode */</p>
<hr />
<div>== Wo setzt man hooks am Besten ein ==<br />
Es gibt einige Standard Dateien die für solche Zwecke geeignet sind:<br />
<br />
=== /site/init.php ===<br />
PW Boot -> Module mit autoload -> init.php<br />
This file is included during ProcessWire's boot initialization, immediately after autoload modules have been loaded and had their init() methods called. Anything you do in here will behave the same as an init() method on a module. When this file is called, the current $page has not yet been determined. This is an excellent place to attach '''hooks that don't need to know anything about the current page'''.<br />
<br />
=== /site/ready.php ===<br />
API geladen und ready -> $page bereit aber noch nicht gerendert<br />
This file is included immediately after the API is fully ready. It behaves the same as a ready() method in an autoload module. The current $page has been determined, but not yet rendered. This is an excellent place to '''attach hooks that may need to know something about the current page'''. It's also an excellent place to '''include additional classes or libraries that will be used on all pages''' in your site.<br />
<br />
=== /site/finished.php ===<br />
Seite gerendert<br />
This file is included when ProcessWire has finished rendering and delivering a page, and is in the process of shutting down. It is called immediately before the API is disengaged, so you can still access any API variable and '''update $session values''' as needed. Admittedly, this is probably '''not the place you would put hooks''', but it is an ideal place to '''perform your own shutdown''', should your application call for it.<br />
<br />
== Beispiele für Hooks ==<br />
=== Basic Starter Hook ===<br />
<syntaxhighlight lang="php"><br />
$wire->addHookAfter('Pages::added', function(HookEvent $event) {<br />
$page = $event->arguments(0);<br />
bd($page); // tracy debugger output<br />
});<br />
<br />
// more specific<br />
$wire->addHookAfter('Pages::added(template=basic-page)', function(HookEvent $event) {<br />
$page = $event->arguments(0);<br />
bd($page);<br />
});<br />
<br />
<br />
</syntaxhighlight><br />
=== Feld manipulieren ===<br />
Beim Speichern einer Seite ein Feld anpassen <br />
<syntaxhighlight lang="php"><br />
$pages->addHookAfter('saveReady', function(HookEvent $event) {<br />
$page = $event->arguments(0);<br />
// If the page has the relevant template...<br />
if($page->template == 'oe') {<br />
// make title uppercase<br />
$page->name = strtoupper($page->name);<br />
}<br />
});<br />
</syntaxhighlight><br />
<br />
=== Seiten im Backend sortieren ===<br />
<syntaxhighlight lang="php"><br />
/*sort clients of key account manager by title in backend*/<br />
$pages->addHookAfter('saveReady', function(HookEvent $event) {<br />
$page = $event->arguments(0);<br />
// If the page has the relevant template...<br />
if($page->template == 'key_account_manager') {<br />
// Sort the Page Reference field by title<br />
$page->pr_kam_clients->sort('title') ;<br />
}<br />
});<br />
</syntaxhighlight><br />
<br />
=== Externe Klasse verfügbar machen ===<br />
/site/ready.php<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
$pages->addHookAfter('saved', function($event) {<br />
$page = $event->object;<br />
if($page->template == 'product') {<br />
// update other related pages when 'product' page is saved<br />
}<br />
});<br />
<br />
if($page->template != 'admin') {<br />
// include an external helper class...<br />
require('./classes/ProductCart.php');<br />
// ...and establish it as a new $cart API variable, and<br />
// populate it with products saved in the user's session:<br />
$wire->wire('cart', new ProductCart($session->productsInCart));<br />
}<br />
</syntaxhighlight><br />
<br />
There is also a /site/finished.php that obtains the products from the $cart and saves them back to the session, ready for the next request:<br />
<br />
/site/finished.php<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
if($page->template != 'admin') {<br />
$session->productsInCart = $cart->getArray();<br />
}<br />
</syntaxhighlight><br />
<br />
=== Custom Hook Methode ===<br />
Beispiel aus der ready.php<br />
<syntaxhighlight lang="php"><br />
/** @var ProcessWire $wire */<br />
<br />
/**<br />
* Example of a custom hook method<br />
* <br />
* This hook adds a “numPosts” method to pages using template “category”.<br />
* The return value is the quantity of posts in category.<br />
*<br />
* Usage:<br />
* ~~~~~<br />
* $numPosts = $page->numPosts(); // returns integer<br />
* numPosts = $page->numPosts(true); // returns string like "5 posts"<br />
* ~~~~~<br />
*<br />
*/<br />
$wire->addHook('Page(template=category)::numPosts', function($event) {<br />
/** @var Page $page */<br />
$page = $event->object;<br />
<br />
// only category pages have numPosts<br />
if($page->template != 'category') return;<br />
<br />
// find number of posts<br />
$numPosts = $event->pages->count("template=blog-post, categories=$page");<br />
<br />
if($event->arguments(0) === true) {<br />
// if true argument was specified, format it as a "5 posts" type string<br />
$numPosts = sprintf(_n('%d post', '%d posts', $numPosts), $numPosts);<br />
}<br />
<br />
$event->return = $numPosts;<br />
}); <br />
</syntaxhighlight></div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Hooks&diff=24398ProcessWire - Hooks2020-02-13T19:01:02Z<p>84.136.104.26: /* Beispiele für Hooks */</p>
<hr />
<div>== Wo setzt man hooks am Besten ein ==<br />
Es gibt einige Standard Dateien die für solche Zwecke geeignet sind:<br />
<br />
=== /site/init.php ===<br />
PW Boot -> Module mit autoload -> init.php<br />
This file is included during ProcessWire's boot initialization, immediately after autoload modules have been loaded and had their init() methods called. Anything you do in here will behave the same as an init() method on a module. When this file is called, the current $page has not yet been determined. This is an excellent place to attach '''hooks that don't need to know anything about the current page'''.<br />
<br />
=== /site/ready.php ===<br />
API geladen und ready -> $page bereit aber noch nicht gerendert<br />
This file is included immediately after the API is fully ready. It behaves the same as a ready() method in an autoload module. The current $page has been determined, but not yet rendered. This is an excellent place to '''attach hooks that may need to know something about the current page'''. It's also an excellent place to '''include additional classes or libraries that will be used on all pages''' in your site.<br />
<br />
=== /site/finished.php ===<br />
Seite gerendert<br />
This file is included when ProcessWire has finished rendering and delivering a page, and is in the process of shutting down. It is called immediately before the API is disengaged, so you can still access any API variable and '''update $session values''' as needed. Admittedly, this is probably '''not the place you would put hooks''', but it is an ideal place to '''perform your own shutdown''', should your application call for it.<br />
<br />
== Beispiele für Hooks ==<br />
=== Basic Starter Hook ===<br />
<syntaxhighlight lang="php"><br />
$wire->addHookAfter('Pages::added', function(HookEvent $event) {<br />
$page = $event->arguments(0);<br />
bd($page); // tracy debugger output<br />
});<br />
<br />
// more specific<br />
$wire->addHookAfter('Pages::added(template=basic-page)', function(HookEvent $event) {<br />
$page = $event->arguments(0);<br />
bd($page);<br />
});<br />
<br />
<br />
</syntaxhighlight><br />
=== Feld manipulieren ===<br />
Beim Speichern einer Seite ein Feld anpassen <br />
<syntaxhighlight lang="php"><br />
$pages->addHookAfter('saveReady', function(HookEvent $event) {<br />
$page = $event->arguments(0);<br />
// If the page has the relevant template...<br />
if($page->template == 'oe') {<br />
// make title uppercase<br />
$page->name = strtoupper($page->name);<br />
}<br />
});<br />
</syntaxhighlight><br />
<br />
=== Seiten im Backend sortieren ===<br />
<syntaxhighlight lang="php"><br />
/*sort clients of key account manager by title in backend*/<br />
$pages->addHookAfter('saveReady', function(HookEvent $event) {<br />
$page = $event->arguments(0);<br />
// If the page has the relevant template...<br />
if($page->template == 'key_account_manager') {<br />
// Sort the Page Reference field by title<br />
$page->pr_kam_clients->sort('title') ;<br />
}<br />
});<br />
</syntaxhighlight><br />
<br />
=== Externe Klasse verfügbar machen ===<br />
/site/ready.php<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
$pages->addHookAfter('saved', function($event) {<br />
$page = $event->object;<br />
if($page->template == 'product') {<br />
// update other related pages when 'product' page is saved<br />
}<br />
});<br />
<br />
if($page->template != 'admin') {<br />
// include an external helper class...<br />
require('./classes/ProductCart.php');<br />
// ...and establish it as a new $cart API variable, and<br />
// populate it with products saved in the user's session:<br />
$wire->wire('cart', new ProductCart($session->productsInCart));<br />
}<br />
</syntaxhighlight><br />
<br />
There is also a /site/finished.php that obtains the products from the $cart and saves them back to the session, ready for the next request:<br />
<br />
/site/finished.php<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
if($page->template != 'admin') {<br />
$session->productsInCart = $cart->getArray();<br />
}<br />
</syntaxhighlight><br />
<br />
=== Custom Hook Methode ===<br />
<syntaxhighlight lang="php"><br />
/** @var ProcessWire $wire */<br />
<br />
/**<br />
* Example of a custom hook method<br />
* <br />
* This hook adds a “numPosts” method to pages using template “category”.<br />
* The return value is the quantity of posts in category.<br />
*<br />
* Usage:<br />
* ~~~~~<br />
* $numPosts = $page->numPosts(); // returns integer<br />
* numPosts = $page->numPosts(true); // returns string like "5 posts"<br />
* ~~~~~<br />
*<br />
*/<br />
$wire->addHook('Page(template=category)::numPosts', function($event) {<br />
/** @var Page $page */<br />
$page = $event->object;<br />
<br />
// only category pages have numPosts<br />
if($page->template != 'category') return;<br />
<br />
// find number of posts<br />
$numPosts = $event->pages->count("template=blog-post, categories=$page");<br />
<br />
if($event->arguments(0) === true) {<br />
// if true argument was specified, format it as a "5 posts" type string<br />
$numPosts = sprintf(_n('%d post', '%d posts', $numPosts), $numPosts);<br />
}<br />
<br />
$event->return = $numPosts;<br />
}); <br />
</syntaxhighlight></div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Performance&diff=24397ProcessWire - Performance2020-02-13T15:56:07Z<p>84.136.104.26: /* wireCache */</p>
<hr />
<div>== Caching ==<br />
=== wireCache ===<br />
https://processwire.com/blog/posts/processwire-core-updates-2.5.28/#wirecache-upgrades<br />
https://processwire.com/talk/topic/15286-delete-and-generate-new-markup-cache/<br />
https://processwire.com/talk/topic/10548-my-way-of-using-wirecache-and-some-hints-to-make-life-easier-with-it/<br />
<br />
Auf die WireCache Klasse kann mit der '''$cache''' variable zugegriffen werden. Die angelegten Caches werden in der PW Datenbank gespeichert. Es gibt diverse Methoden<br />
https://processwire.com/api/ref/wire-cache/<br />
Standard Cachezeit ist 24h<br />
<br />
''' Beispiel - delayed output variable eines Templates cachen.<br />
Je nach Seite wird ein neues Cache Objekt angelegt. Wir nutzen ein Prefix (c für cache und content für die Variable $content) und hängen die Page ID an. So kann man den Cache leicht identifizieren. <br />
<br />
<syntaxhighlight lang="php"><br />
$cacheId = 'c_content_'.$page->id;<br />
$content = $cache->get($cacheId);<br />
if(!$content) {<br />
include("./partials/layout-blocks.inc");<br />
$content = renderLayoutBlocks($page,$additionalHeaderData); // 2nd passed by reference<br />
$cache->save($cacheId, $content);<br />
}<br />
</syntaxhighlight><br />
<br />
==== Beispiel Cache für AJAX, GET, POST umgehen ====<br />
<syntaxhighlight lang="php"><br />
if (!count($input->get) && !count($input->post) && !$config->ajax) {<br />
// cache logic from above<br />
}<br />
</syntaxhighlight><br />
<br />
== Performante Datenbankabfragen ==<br />
Mit Modul oder per Hand (pdo) möglich.<br />
https://modules.processwire.com/modules/rock-finder/<br />
https://processwire.com/talk/topic/16346-how-to-transform-page-selectors-into-sql-queries/<br />
my module is a companion module for RockGrid. Those grids always need an array of objects as data source. Using $pages->find() and then foreach() to create such an array is terribly inefficient when dealing with several thousands of pages. That's why I built RockFinder -> it creates an efficient SQL statement for you and it is almost as easy as using regular PW selectors.<br />
<br />
The benefit of using SQL is that it is incredibly efficient. The downside is that some pw-related tasks become a headache (like checking for published state, sort order, multilanguage field values, to name just a few). RockFinder takes care of all that.<br />
<br />
It returns an array of objects that you can easily pass to a RockGrid or do whatever you want with it.<br />
<br />
== Performance Testen ==<br />
=== Zeit und RAM ===<br />
<syntaxhighlight lang="php"><br />
<br />
// 8000 pages with title and body fields<br />
$pp = $pages('template=basic, parent=1384');<br />
$out = '';<br />
foreach($pp as $p) {<br />
$t = $p->title . microtime();<br />
$b = $p->body . mt_rand(0, 1e5);<br />
$out .= $t . $b;<br />
}<br />
echo strlen($out);<br />
// 18384.08ms, 25.00 MB<br />
<br />
// 8000 pages with title and body fields<br />
$pp = $pages('template=basic, parent=1384');<br />
$out = '';<br />
foreach($pp as $p) {<br />
$out .= $p->title . microtime();<br />
$out .= $p->body . mt_rand(0, 1e5);<br />
}<br />
echo strlen($out);<br />
// 17617.05ms, 25.00MB<br />
<br />
$out = '';<br />
foreach($pages('template=basic, parent=1384') as $p) {<br />
$out .= $p->title . microtime();<br />
$out .= $p->body . mt_rand(0, 1e5);<br />
}<br />
echo strlen($out);<br />
// 17927.9ms, 25.00MB<br />
</syntaxhighlight><br />
<br />
<syntaxhighlight lang="php"><br />
</syntaxhighlight><br />
<br />
== Performance und Repeater Matrix ==<br />
https://processwire.com/talk/topic/20156-are-there-hidden-scalabilityperformance-issues-when-making-heavy-use-of-repeater-matrix-or-pagetable-fields/<br />
=== Backend ===<br />
* Repeater Items per AJAX laden <br />
https://processwire.com/blog/posts/more-repeaters-repeater-matrix-and-new-field-rendering/#repeater-upgrades-continued-in-pw-3.0.5<br />
=== Frontend ===<br />
* Können viele Datenbank (PDO) Queries auslösen, da alle Page Objekte geladen werden müssen.<br />
<br />
=== Auswahl aus verschiedenen Repeatern über ein Select, statt einzelnes RepeaterMatrix Feld ===<br />
Evtl. könnte man ein Auswahlfeld generieren, das dann wiederum einen Contentblock wählt, statt alles in ein RepeaterMatrix Feld zu packen.<br />
<br />
* Layoutblock -> Select Feld<br />
* Optionen werden geladen.<br />
<br />
=== Alternativ PageTables ===<br />
https://processwire.com/talk/topic/7459-module-pagetableextended/<br />
Könnte Performancemäßig die bessere Alternative sein. Prüfen und auch mit PageTableExtended verbinden.</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Performance&diff=24396ProcessWire - Performance2020-02-13T15:54:24Z<p>84.136.104.26: /* Caching */</p>
<hr />
<div>== Caching ==<br />
=== wireCache ===<br />
https://processwire.com/blog/posts/processwire-core-updates-2.5.28/#wirecache-upgrades<br />
https://processwire.com/talk/topic/15286-delete-and-generate-new-markup-cache/<br />
https://processwire.com/talk/topic/10548-my-way-of-using-wirecache-and-some-hints-to-make-life-easier-with-it/<br />
<br />
Auf die WireCache Klasse kann mit der '''$cache''' variable zugegriffen werden. Die angelegten Caches werden in der PW Datenbank gespeichert. Es gibt diverse Methoden<br />
https://processwire.com/api/ref/wire-cache/<br />
Standard Cachezeit ist 24h<br />
<br />
''' Beispiel - delayed output variable eines Templates cachen.<br />
Je nach Seite wird ein neues Cache Objekt angelegt. Wir nutzen ein Prefix (c für cache und content für die Variable $content) und hängen die Page ID an. So kann man den Cache leicht identifizieren. <br />
<br />
<syntaxhighlight lang="php"><br />
$cacheId = 'c_content_'.$page->id;<br />
$content = $cache->get($cacheId);<br />
if(!$content) {<br />
include("./partials/layout-blocks.inc");<br />
$content = renderLayoutBlocks($page,$additionalHeaderData); // 2nd passed by reference<br />
$cache->save($cacheId, $content);<br />
}<br />
</syntaxhighlight><br />
<br />
== Performante Datenbankabfragen ==<br />
Mit Modul oder per Hand (pdo) möglich.<br />
https://modules.processwire.com/modules/rock-finder/<br />
https://processwire.com/talk/topic/16346-how-to-transform-page-selectors-into-sql-queries/<br />
my module is a companion module for RockGrid. Those grids always need an array of objects as data source. Using $pages->find() and then foreach() to create such an array is terribly inefficient when dealing with several thousands of pages. That's why I built RockFinder -> it creates an efficient SQL statement for you and it is almost as easy as using regular PW selectors.<br />
<br />
The benefit of using SQL is that it is incredibly efficient. The downside is that some pw-related tasks become a headache (like checking for published state, sort order, multilanguage field values, to name just a few). RockFinder takes care of all that.<br />
<br />
It returns an array of objects that you can easily pass to a RockGrid or do whatever you want with it.<br />
<br />
== Performance Testen ==<br />
=== Zeit und RAM ===<br />
<syntaxhighlight lang="php"><br />
<br />
// 8000 pages with title and body fields<br />
$pp = $pages('template=basic, parent=1384');<br />
$out = '';<br />
foreach($pp as $p) {<br />
$t = $p->title . microtime();<br />
$b = $p->body . mt_rand(0, 1e5);<br />
$out .= $t . $b;<br />
}<br />
echo strlen($out);<br />
// 18384.08ms, 25.00 MB<br />
<br />
// 8000 pages with title and body fields<br />
$pp = $pages('template=basic, parent=1384');<br />
$out = '';<br />
foreach($pp as $p) {<br />
$out .= $p->title . microtime();<br />
$out .= $p->body . mt_rand(0, 1e5);<br />
}<br />
echo strlen($out);<br />
// 17617.05ms, 25.00MB<br />
<br />
$out = '';<br />
foreach($pages('template=basic, parent=1384') as $p) {<br />
$out .= $p->title . microtime();<br />
$out .= $p->body . mt_rand(0, 1e5);<br />
}<br />
echo strlen($out);<br />
// 17927.9ms, 25.00MB<br />
</syntaxhighlight><br />
<br />
<syntaxhighlight lang="php"><br />
</syntaxhighlight><br />
<br />
== Performance und Repeater Matrix ==<br />
https://processwire.com/talk/topic/20156-are-there-hidden-scalabilityperformance-issues-when-making-heavy-use-of-repeater-matrix-or-pagetable-fields/<br />
=== Backend ===<br />
* Repeater Items per AJAX laden <br />
https://processwire.com/blog/posts/more-repeaters-repeater-matrix-and-new-field-rendering/#repeater-upgrades-continued-in-pw-3.0.5<br />
=== Frontend ===<br />
* Können viele Datenbank (PDO) Queries auslösen, da alle Page Objekte geladen werden müssen.<br />
<br />
=== Auswahl aus verschiedenen Repeatern über ein Select, statt einzelnes RepeaterMatrix Feld ===<br />
Evtl. könnte man ein Auswahlfeld generieren, das dann wiederum einen Contentblock wählt, statt alles in ein RepeaterMatrix Feld zu packen.<br />
<br />
* Layoutblock -> Select Feld<br />
* Optionen werden geladen.<br />
<br />
=== Alternativ PageTables ===<br />
https://processwire.com/talk/topic/7459-module-pagetableextended/<br />
Könnte Performancemäßig die bessere Alternative sein. Prüfen und auch mit PageTableExtended verbinden.</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Performance&diff=24395ProcessWire - Performance2020-02-13T15:52:17Z<p>84.136.104.26: /* Caching */</p>
<hr />
<div>== Caching ==<br />
=== wireCache ===<br />
https://processwire.com/blog/posts/processwire-core-updates-2.5.28/#wirecache-upgrades<br />
https://processwire.com/talk/topic/15286-delete-and-generate-new-markup-cache/<br />
https://processwire.com/talk/topic/10548-my-way-of-using-wirecache-and-some-hints-to-make-life-easier-with-it/<br />
<br />
Auf die WireCache Klasse kann mit der '''$cache''' variable zugegriffen werden. Die angelegten Caches werden in der PW Datenbank gespeichert. Es gibt diverse Methoden<br />
https://processwire.com/api/ref/wire-cache/<br />
Standard Cachezeit ist 24h<br />
<br />
''' Beispiel - delayed output variable eines Templates cachen.<br />
<syntaxhighlight lang="php"><br />
$cacheId = 'c_content_'.$page->id;<br />
$content = $cache->get($cacheId);<br />
if(!$content) {<br />
include("./partials/layout-blocks.inc");<br />
$content = renderLayoutBlocks($page,$additionalHeaderData); // 2nd passed by reference<br />
$cache->save($cacheId, $content);<br />
}<br />
</syntaxhighlight><br />
<br />
== Performante Datenbankabfragen ==<br />
Mit Modul oder per Hand (pdo) möglich.<br />
https://modules.processwire.com/modules/rock-finder/<br />
https://processwire.com/talk/topic/16346-how-to-transform-page-selectors-into-sql-queries/<br />
my module is a companion module for RockGrid. Those grids always need an array of objects as data source. Using $pages->find() and then foreach() to create such an array is terribly inefficient when dealing with several thousands of pages. That's why I built RockFinder -> it creates an efficient SQL statement for you and it is almost as easy as using regular PW selectors.<br />
<br />
The benefit of using SQL is that it is incredibly efficient. The downside is that some pw-related tasks become a headache (like checking for published state, sort order, multilanguage field values, to name just a few). RockFinder takes care of all that.<br />
<br />
It returns an array of objects that you can easily pass to a RockGrid or do whatever you want with it.<br />
<br />
== Performance Testen ==<br />
=== Zeit und RAM ===<br />
<syntaxhighlight lang="php"><br />
<br />
// 8000 pages with title and body fields<br />
$pp = $pages('template=basic, parent=1384');<br />
$out = '';<br />
foreach($pp as $p) {<br />
$t = $p->title . microtime();<br />
$b = $p->body . mt_rand(0, 1e5);<br />
$out .= $t . $b;<br />
}<br />
echo strlen($out);<br />
// 18384.08ms, 25.00 MB<br />
<br />
// 8000 pages with title and body fields<br />
$pp = $pages('template=basic, parent=1384');<br />
$out = '';<br />
foreach($pp as $p) {<br />
$out .= $p->title . microtime();<br />
$out .= $p->body . mt_rand(0, 1e5);<br />
}<br />
echo strlen($out);<br />
// 17617.05ms, 25.00MB<br />
<br />
$out = '';<br />
foreach($pages('template=basic, parent=1384') as $p) {<br />
$out .= $p->title . microtime();<br />
$out .= $p->body . mt_rand(0, 1e5);<br />
}<br />
echo strlen($out);<br />
// 17927.9ms, 25.00MB<br />
</syntaxhighlight><br />
<br />
<syntaxhighlight lang="php"><br />
</syntaxhighlight><br />
<br />
== Performance und Repeater Matrix ==<br />
https://processwire.com/talk/topic/20156-are-there-hidden-scalabilityperformance-issues-when-making-heavy-use-of-repeater-matrix-or-pagetable-fields/<br />
=== Backend ===<br />
* Repeater Items per AJAX laden <br />
https://processwire.com/blog/posts/more-repeaters-repeater-matrix-and-new-field-rendering/#repeater-upgrades-continued-in-pw-3.0.5<br />
=== Frontend ===<br />
* Können viele Datenbank (PDO) Queries auslösen, da alle Page Objekte geladen werden müssen.<br />
<br />
=== Auswahl aus verschiedenen Repeatern über ein Select, statt einzelnes RepeaterMatrix Feld ===<br />
Evtl. könnte man ein Auswahlfeld generieren, das dann wiederum einen Contentblock wählt, statt alles in ein RepeaterMatrix Feld zu packen.<br />
<br />
* Layoutblock -> Select Feld<br />
* Optionen werden geladen.<br />
<br />
=== Alternativ PageTables ===<br />
https://processwire.com/talk/topic/7459-module-pagetableextended/<br />
Könnte Performancemäßig die bessere Alternative sein. Prüfen und auch mit PageTableExtended verbinden.</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Performance&diff=24394ProcessWire - Performance2020-02-13T14:56:40Z<p>84.136.104.26: /* Caching */</p>
<hr />
<div>== Caching ==<br />
=== wireCache ===<br />
https://processwire.com/blog/posts/processwire-core-updates-2.5.28/#wirecache-upgrades<br />
https://processwire.com/talk/topic/15286-delete-and-generate-new-markup-cache/<br />
https://processwire.com/talk/topic/10548-my-way-of-using-wirecache-and-some-hints-to-make-life-easier-with-it/<br />
<br />
Example als Hook für die ready.php (ungetestet)<br />
<syntaxhighlight lang="php"><br />
// the next ensures that the following code will only run on front end (otherwise back end would get cached, too which results in problems)<br />
// make sure to place anything you need in the backend before this line or change it to your needs..<br />
if ((strpos($page->url, wire('config')->urls->admin) !== false) || ($page->id && $page->is('parent|has_parent=2'))) return;<br />
<br />
$cacheName = "prefix__$page->id-$page->template-{$user->language->name}";<br />
if ($urlSegment1) $cacheName .= "-$urlSegment1";<br />
if ($urlSegment2) $cacheName .= "-$urlSegment2";<br />
if ($urlSegment3) $cacheName .= "-$urlSegment3";<br />
if ($input->pageNum > 1) $cacheName .= "-page$input->pageNum";<br />
<br />
// if already cached exit here printing cached content (only 1 db query)<br />
$wire->addHookBefore('Page::render', function() use($cache, $cacheName) {<br />
<br />
$cached = $cache->get($cacheName);<br />
if ($cached) {<br />
exit($cached);<br />
}<br />
<br />
});<br />
<br />
// not cached so far, continue as usual but save generated content to cache<br />
$wire->addHookAfter('Page::render', function($event) use($cache, $cacheName) {<br />
<br />
$cached = $cache->get($cacheName);<br />
<br />
if (!$cached) {<br />
$cache->save($cacheName, $event->return);<br />
}<br />
<br />
unset($cached);<br />
<br />
});<br />
/* of course not the same as a proper flat file cache like procache but at least saving many database queries<br />
make sure to adjust the $cacheName as needed, you can even cache query strings, almost everything you'd like<br />
and you could wrap everything in a condition to only run if no incoming post or query strings so form submits keep working<br />
example<br />
*/<br />
<br />
if (!count($input->get) && !count($input->post) && !$config->ajax) {<br />
// cache logic from above<br />
}<br />
</syntaxhighlight><br />
<br />
== Performante Datenbankabfragen ==<br />
Mit Modul oder per Hand (pdo) möglich.<br />
https://modules.processwire.com/modules/rock-finder/<br />
https://processwire.com/talk/topic/16346-how-to-transform-page-selectors-into-sql-queries/<br />
my module is a companion module for RockGrid. Those grids always need an array of objects as data source. Using $pages->find() and then foreach() to create such an array is terribly inefficient when dealing with several thousands of pages. That's why I built RockFinder -> it creates an efficient SQL statement for you and it is almost as easy as using regular PW selectors.<br />
<br />
The benefit of using SQL is that it is incredibly efficient. The downside is that some pw-related tasks become a headache (like checking for published state, sort order, multilanguage field values, to name just a few). RockFinder takes care of all that.<br />
<br />
It returns an array of objects that you can easily pass to a RockGrid or do whatever you want with it.<br />
<br />
== Performance Testen ==<br />
=== Zeit und RAM ===<br />
<syntaxhighlight lang="php"><br />
<br />
// 8000 pages with title and body fields<br />
$pp = $pages('template=basic, parent=1384');<br />
$out = '';<br />
foreach($pp as $p) {<br />
$t = $p->title . microtime();<br />
$b = $p->body . mt_rand(0, 1e5);<br />
$out .= $t . $b;<br />
}<br />
echo strlen($out);<br />
// 18384.08ms, 25.00 MB<br />
<br />
// 8000 pages with title and body fields<br />
$pp = $pages('template=basic, parent=1384');<br />
$out = '';<br />
foreach($pp as $p) {<br />
$out .= $p->title . microtime();<br />
$out .= $p->body . mt_rand(0, 1e5);<br />
}<br />
echo strlen($out);<br />
// 17617.05ms, 25.00MB<br />
<br />
$out = '';<br />
foreach($pages('template=basic, parent=1384') as $p) {<br />
$out .= $p->title . microtime();<br />
$out .= $p->body . mt_rand(0, 1e5);<br />
}<br />
echo strlen($out);<br />
// 17927.9ms, 25.00MB<br />
</syntaxhighlight><br />
<br />
<syntaxhighlight lang="php"><br />
</syntaxhighlight><br />
<br />
== Performance und Repeater Matrix ==<br />
https://processwire.com/talk/topic/20156-are-there-hidden-scalabilityperformance-issues-when-making-heavy-use-of-repeater-matrix-or-pagetable-fields/<br />
=== Backend ===<br />
* Repeater Items per AJAX laden <br />
https://processwire.com/blog/posts/more-repeaters-repeater-matrix-and-new-field-rendering/#repeater-upgrades-continued-in-pw-3.0.5<br />
=== Frontend ===<br />
* Können viele Datenbank (PDO) Queries auslösen, da alle Page Objekte geladen werden müssen.<br />
<br />
=== Auswahl aus verschiedenen Repeatern über ein Select, statt einzelnes RepeaterMatrix Feld ===<br />
Evtl. könnte man ein Auswahlfeld generieren, das dann wiederum einen Contentblock wählt, statt alles in ein RepeaterMatrix Feld zu packen.<br />
<br />
* Layoutblock -> Select Feld<br />
* Optionen werden geladen.<br />
<br />
=== Alternativ PageTables ===<br />
https://processwire.com/talk/topic/7459-module-pagetableextended/<br />
Könnte Performancemäßig die bessere Alternative sein. Prüfen und auch mit PageTableExtended verbinden.</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Performance&diff=24393ProcessWire - Performance2020-02-13T14:55:29Z<p>84.136.104.26: /* Caching */</p>
<hr />
<div>== Caching ==<br />
=== wireCache ===<br />
https://processwire.com/blog/posts/processwire-core-updates-2.5.28/#wirecache-upgrades<br />
https://processwire.com/talk/topic/15286-delete-and-generate-new-markup-cache/<br />
https://processwire.com/talk/topic/10548-my-way-of-using-wirecache-and-some-hints-to-make-life-easier-with-it/<br />
<br />
Example (ungetestet)<br />
<syntaxhighlight lang="php"><br />
// the next ensures that the following code will only run on front end (otherwise back end would get cached, too which results in problems)<br />
// make sure to place anything you need in the backend before this line or change it to your needs..<br />
if ((strpos($page->url, wire('config')->urls->admin) !== false) || ($page->id && $page->is('parent|has_parent=2'))) return;<br />
<br />
$cacheName = "prefix__$page->id-$page->template-{$user->language->name}";<br />
if ($urlSegment1) $cacheName .= "-$urlSegment1";<br />
if ($urlSegment2) $cacheName .= "-$urlSegment2";<br />
if ($urlSegment3) $cacheName .= "-$urlSegment3";<br />
if ($input->pageNum > 1) $cacheName .= "-page$input->pageNum";<br />
<br />
// if already cached exit here printing cached content (only 1 db query)<br />
$wire->addHookBefore('Page::render', function() use($cache, $cacheName) {<br />
<br />
$cached = $cache->get($cacheName);<br />
if ($cached) {<br />
exit($cached);<br />
}<br />
<br />
});<br />
<br />
// not cached so far, continue as usual but save generated content to cache<br />
$wire->addHookAfter('Page::render', function($event) use($cache, $cacheName) {<br />
<br />
$cached = $cache->get($cacheName);<br />
<br />
if (!$cached) {<br />
$cache->save($cacheName, $event->return);<br />
}<br />
<br />
unset($cached);<br />
<br />
});<br />
/* of course not the same as a proper flat file cache like procache but at least saving many database queries<br />
make sure to adjust the $cacheName as needed, you can even cache query strings, almost everything you'd like<br />
and you could wrap everything in a condition to only run if no incoming post or query strings so form submits keep working<br />
example<br />
*/<br />
<br />
if (!count($input->get) && !count($input->post) && !$config->ajax) {<br />
// cache logic from above<br />
}<br />
</syntaxhighlight><br />
<br />
== Performante Datenbankabfragen ==<br />
Mit Modul oder per Hand (pdo) möglich.<br />
https://modules.processwire.com/modules/rock-finder/<br />
https://processwire.com/talk/topic/16346-how-to-transform-page-selectors-into-sql-queries/<br />
my module is a companion module for RockGrid. Those grids always need an array of objects as data source. Using $pages->find() and then foreach() to create such an array is terribly inefficient when dealing with several thousands of pages. That's why I built RockFinder -> it creates an efficient SQL statement for you and it is almost as easy as using regular PW selectors.<br />
<br />
The benefit of using SQL is that it is incredibly efficient. The downside is that some pw-related tasks become a headache (like checking for published state, sort order, multilanguage field values, to name just a few). RockFinder takes care of all that.<br />
<br />
It returns an array of objects that you can easily pass to a RockGrid or do whatever you want with it.<br />
<br />
== Performance Testen ==<br />
=== Zeit und RAM ===<br />
<syntaxhighlight lang="php"><br />
<br />
// 8000 pages with title and body fields<br />
$pp = $pages('template=basic, parent=1384');<br />
$out = '';<br />
foreach($pp as $p) {<br />
$t = $p->title . microtime();<br />
$b = $p->body . mt_rand(0, 1e5);<br />
$out .= $t . $b;<br />
}<br />
echo strlen($out);<br />
// 18384.08ms, 25.00 MB<br />
<br />
// 8000 pages with title and body fields<br />
$pp = $pages('template=basic, parent=1384');<br />
$out = '';<br />
foreach($pp as $p) {<br />
$out .= $p->title . microtime();<br />
$out .= $p->body . mt_rand(0, 1e5);<br />
}<br />
echo strlen($out);<br />
// 17617.05ms, 25.00MB<br />
<br />
$out = '';<br />
foreach($pages('template=basic, parent=1384') as $p) {<br />
$out .= $p->title . microtime();<br />
$out .= $p->body . mt_rand(0, 1e5);<br />
}<br />
echo strlen($out);<br />
// 17927.9ms, 25.00MB<br />
</syntaxhighlight><br />
<br />
<syntaxhighlight lang="php"><br />
</syntaxhighlight><br />
<br />
== Performance und Repeater Matrix ==<br />
https://processwire.com/talk/topic/20156-are-there-hidden-scalabilityperformance-issues-when-making-heavy-use-of-repeater-matrix-or-pagetable-fields/<br />
=== Backend ===<br />
* Repeater Items per AJAX laden <br />
https://processwire.com/blog/posts/more-repeaters-repeater-matrix-and-new-field-rendering/#repeater-upgrades-continued-in-pw-3.0.5<br />
=== Frontend ===<br />
* Können viele Datenbank (PDO) Queries auslösen, da alle Page Objekte geladen werden müssen.<br />
<br />
=== Auswahl aus verschiedenen Repeatern über ein Select, statt einzelnes RepeaterMatrix Feld ===<br />
Evtl. könnte man ein Auswahlfeld generieren, das dann wiederum einen Contentblock wählt, statt alles in ein RepeaterMatrix Feld zu packen.<br />
<br />
* Layoutblock -> Select Feld<br />
* Optionen werden geladen.<br />
<br />
=== Alternativ PageTables ===<br />
https://processwire.com/talk/topic/7459-module-pagetableextended/<br />
Könnte Performancemäßig die bessere Alternative sein. Prüfen und auch mit PageTableExtended verbinden.</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Rendering_Funktionen&diff=24392ProcessWire - Rendering Funktionen2020-02-13T10:46:49Z<p>84.136.104.26: /* Links */</p>
<hr />
<div>In den Template Strategiene sind einige Methoden beschrieben wie man Seiten in ProcessWire rendern kann.<br />
PW stellt aber auch einige Funktionen bereit, mit denen man Dateien oder Seiten direkt rendern kann. Diese arbeiten auch gut mit dem WireCache zusammen. So kann man Teile der Ausgabe rendern und gleich Cachen.<br />
<br />
== Links ==<br />
https://processwire.com/api/ref/wire-file-tools/render/<br />
https://processwire.com/api/ref/functions/wire-render-file/<br />
https://processwire.com/api/ref/page/render-field/<br />
https://processwire.com/talk/topic/20797-clean-syntax-for-rendering-pages-with-specific-template/<br />
https://processwire.com/talk/topic/3145-multiple-views-for-templates/page/2/?tab=comments#comment-32876 (ergiebiger thread)<br />
https://processwire.com/api/ref/inputfield-checkboxes/render/<br />
https://processwire.com/api/ref/page/render-field/<br />
https://processwire.com/api/ref/page/render-value/ (mit Markup File)<br />
https://processwire.com/docs/front-end/output/delayed/ (delayed output)<br />
https://processwire.com/talk/topic/13958-help-understanding-render-and-rendervalue/<br />
<br />
== Functions ==<br />
$files->render // modern version for wireRenderFile<br />
$page->render<br />
https://processwire.com/api/ref/page/render-field/<br />
<br />
== Snippets ==<br />
<syntaxhighlight lang="php"><br />
$page->render($filename); // $filename assumed in /site/templates/<br />
$page->render($pathname); // $pathname is full path, but must resolve somewhere in web root<br />
$page->render($options); // array of options and/or your own variables<br />
$page->render(array('foo' => 'bar')); // same as above<br />
$page->render($filename, $options); // specify filename and options/vars, etc.<br />
<br />
<br />
$content .= $files->render('teasers', ['items' => $pages->find("template=article")]);<br />
<br />
foreach ($pages->find("template=article") as $article) {<br />
$content .= $article->render('teaser.php');<br />
}<br />
</syntaxhighlight><br />
=== Pass global vars ===<br />
You can pass variable via render like:<br />
<br />
echo $pages->get($child->id)->render(array('mobile' => $mobile));<br />
<br />
=== Check if File is called directly or via wireRenderFile ===<br />
https://processwire.com/talk/topic/20915-wirerenderfile-question-about-page/<br />
Is there a way to check in my included template file if this child page is called directly, or whether it has been included from somewhere else? A simple check, so I can use the template in both scenarios (stand-alone view for just this page, or in cases I use wireRenderFile somewhere else). Right now I am passing the child page's ID like this:<br />
<br />
wireRenderFile('my_template', array('pid' => $child->id));<br />
And in my_template, to access it's own page fields, etc. I use<br />
<br />
$thisPage = pages()->get($pid);<br />
$myField = $thisPage->foo; // etc.<br />
Is that the way to go, or do I overlook something obvious?<br />
<br />
d'oh of course, it's as simple as:<br />
<br />
if(isset($pid)) {<br />
$thisPage = pages()->get($pid); // we get called with wireRenderFile<br />
} else {<br />
$thisPage = $page; // business as usual<br />
}</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Rendering_Funktionen&diff=24391ProcessWire - Rendering Funktionen2020-02-13T10:40:19Z<p>84.136.104.26: /* Links */</p>
<hr />
<div>In den Template Strategiene sind einige Methoden beschrieben wie man Seiten in ProcessWire rendern kann.<br />
PW stellt aber auch einige Funktionen bereit, mit denen man Dateien oder Seiten direkt rendern kann. Diese arbeiten auch gut mit dem WireCache zusammen. So kann man Teile der Ausgabe rendern und gleich Cachen.<br />
<br />
== Links ==<br />
https://processwire.com/api/ref/wire-file-tools/render/<br />
https://processwire.com/api/ref/functions/wire-render-file/<br />
https://processwire.com/api/ref/page/render-field/<br />
https://processwire.com/talk/topic/20797-clean-syntax-for-rendering-pages-with-specific-template/<br />
https://processwire.com/talk/topic/3145-multiple-views-for-templates/page/2/?tab=comments#comment-32876 (ergiebiger thread)<br />
https://processwire.com/api/ref/inputfield-checkboxes/render/<br />
https://processwire.com/api/ref/page/render-field/<br />
https://processwire.com/api/ref/page/render-value/ (mit Markup File)<br />
https://processwire.com/docs/front-end/output/delayed/ (delayed output)<br />
<br />
== Functions ==<br />
$files->render // modern version for wireRenderFile<br />
$page->render<br />
https://processwire.com/api/ref/page/render-field/<br />
<br />
== Snippets ==<br />
<syntaxhighlight lang="php"><br />
$page->render($filename); // $filename assumed in /site/templates/<br />
$page->render($pathname); // $pathname is full path, but must resolve somewhere in web root<br />
$page->render($options); // array of options and/or your own variables<br />
$page->render(array('foo' => 'bar')); // same as above<br />
$page->render($filename, $options); // specify filename and options/vars, etc.<br />
<br />
<br />
$content .= $files->render('teasers', ['items' => $pages->find("template=article")]);<br />
<br />
foreach ($pages->find("template=article") as $article) {<br />
$content .= $article->render('teaser.php');<br />
}<br />
</syntaxhighlight><br />
=== Pass global vars ===<br />
You can pass variable via render like:<br />
<br />
echo $pages->get($child->id)->render(array('mobile' => $mobile));<br />
<br />
=== Check if File is called directly or via wireRenderFile ===<br />
https://processwire.com/talk/topic/20915-wirerenderfile-question-about-page/<br />
Is there a way to check in my included template file if this child page is called directly, or whether it has been included from somewhere else? A simple check, so I can use the template in both scenarios (stand-alone view for just this page, or in cases I use wireRenderFile somewhere else). Right now I am passing the child page's ID like this:<br />
<br />
wireRenderFile('my_template', array('pid' => $child->id));<br />
And in my_template, to access it's own page fields, etc. I use<br />
<br />
$thisPage = pages()->get($pid);<br />
$myField = $thisPage->foo; // etc.<br />
Is that the way to go, or do I overlook something obvious?<br />
<br />
d'oh of course, it's as simple as:<br />
<br />
if(isset($pid)) {<br />
$thisPage = pages()->get($pid); // we get called with wireRenderFile<br />
} else {<br />
$thisPage = $page; // business as usual<br />
}</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Rendering_Funktionen&diff=24390ProcessWire - Rendering Funktionen2020-02-13T10:38:13Z<p>84.136.104.26: </p>
<hr />
<div>In den Template Strategiene sind einige Methoden beschrieben wie man Seiten in ProcessWire rendern kann.<br />
PW stellt aber auch einige Funktionen bereit, mit denen man Dateien oder Seiten direkt rendern kann. Diese arbeiten auch gut mit dem WireCache zusammen. So kann man Teile der Ausgabe rendern und gleich Cachen.<br />
<br />
== Links ==<br />
https://processwire.com/api/ref/wire-file-tools/render/<br />
https://processwire.com/api/ref/functions/wire-render-file/<br />
https://processwire.com/api/ref/page/render-field/<br />
https://processwire.com/talk/topic/20797-clean-syntax-for-rendering-pages-with-specific-template/<br />
https://processwire.com/talk/topic/3145-multiple-views-for-templates/page/2/?tab=comments#comment-32876 (ergiebiger thread)<br />
<br />
== Functions ==<br />
$files->render // modern version for wireRenderFile<br />
$page->render<br />
https://processwire.com/api/ref/page/render-field/<br />
<br />
== Snippets ==<br />
<syntaxhighlight lang="php"><br />
$page->render($filename); // $filename assumed in /site/templates/<br />
$page->render($pathname); // $pathname is full path, but must resolve somewhere in web root<br />
$page->render($options); // array of options and/or your own variables<br />
$page->render(array('foo' => 'bar')); // same as above<br />
$page->render($filename, $options); // specify filename and options/vars, etc.<br />
<br />
<br />
$content .= $files->render('teasers', ['items' => $pages->find("template=article")]);<br />
<br />
foreach ($pages->find("template=article") as $article) {<br />
$content .= $article->render('teaser.php');<br />
}<br />
</syntaxhighlight><br />
=== Pass global vars ===<br />
You can pass variable via render like:<br />
<br />
echo $pages->get($child->id)->render(array('mobile' => $mobile));<br />
<br />
=== Check if File is called directly or via wireRenderFile ===<br />
https://processwire.com/talk/topic/20915-wirerenderfile-question-about-page/<br />
Is there a way to check in my included template file if this child page is called directly, or whether it has been included from somewhere else? A simple check, so I can use the template in both scenarios (stand-alone view for just this page, or in cases I use wireRenderFile somewhere else). Right now I am passing the child page's ID like this:<br />
<br />
wireRenderFile('my_template', array('pid' => $child->id));<br />
And in my_template, to access it's own page fields, etc. I use<br />
<br />
$thisPage = pages()->get($pid);<br />
$myField = $thisPage->foo; // etc.<br />
Is that the way to go, or do I overlook something obvious?<br />
<br />
d'oh of course, it's as simple as:<br />
<br />
if(isset($pid)) {<br />
$thisPage = pages()->get($pid); // we get called with wireRenderFile<br />
} else {<br />
$thisPage = $page; // business as usual<br />
}</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Rendering_Funktionen&diff=24389ProcessWire - Rendering Funktionen2020-02-13T10:31:09Z<p>84.136.104.26: </p>
<hr />
<div>In den Template Strategiene sind einige Methoden beschrieben wie man Seiten in ProcessWire rendern kann.<br />
PW stellt aber auch einige Funktionen bereit, mit denen man Dateien oder Seiten direkt rendern kann. Diese arbeiten auch gut mit dem WireCache zusammen. So kann man Teile der Ausgabe rendern und gleich Cachen.<br />
<br />
== Links ==<br />
https://processwire.com/api/ref/functions/wire-render-file/<br />
https://processwire.com/api/ref/page/render-field/<br />
https://processwire.com/talk/topic/20797-clean-syntax-for-rendering-pages-with-specific-template/<br />
https://processwire.com/talk/topic/3145-multiple-views-for-templates/page/2/?tab=comments#comment-32876 (ergiebiger thread)<br />
<br />
== Functions ==<br />
$files->render // modern version for wireRenderFile<br />
$page->render<br />
https://processwire.com/api/ref/page/render-field/<br />
<br />
== Snippets ==<br />
<syntaxhighlight lang="php"><br />
$page->render($filename); // $filename assumed in /site/templates/<br />
$page->render($pathname); // $pathname is full path, but must resolve somewhere in web root<br />
$page->render($options); // array of options and/or your own variables<br />
$page->render(array('foo' => 'bar')); // same as above<br />
$page->render($filename, $options); // specify filename and options/vars, etc.<br />
<br />
<br />
$content .= $files->render('teasers', ['items' => $pages->find("template=article")]);<br />
<br />
foreach ($pages->find("template=article") as $article) {<br />
$content .= $article->render('teaser.php');<br />
}<br />
</syntaxhighlight><br />
=== Pass global vars ===<br />
You can pass variable via render like:<br />
<br />
echo $pages->get($child->id)->render(array('mobile' => $mobile));<br />
<br />
=== Check if File is called directly or via wireRenderFile ===<br />
https://processwire.com/talk/topic/20915-wirerenderfile-question-about-page/<br />
Is there a way to check in my included template file if this child page is called directly, or whether it has been included from somewhere else? A simple check, so I can use the template in both scenarios (stand-alone view for just this page, or in cases I use wireRenderFile somewhere else). Right now I am passing the child page's ID like this:<br />
<br />
wireRenderFile('my_template', array('pid' => $child->id));<br />
And in my_template, to access it's own page fields, etc. I use<br />
<br />
$thisPage = pages()->get($pid);<br />
$myField = $thisPage->foo; // etc.<br />
Is that the way to go, or do I overlook something obvious?<br />
<br />
d'oh of course, it's as simple as:<br />
<br />
if(isset($pid)) {<br />
$thisPage = pages()->get($pid); // we get called with wireRenderFile<br />
} else {<br />
$thisPage = $page; // business as usual<br />
}</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Rendering_Funktionen&diff=24388ProcessWire - Rendering Funktionen2020-02-13T10:27:58Z<p>84.136.104.26: /* Snippets */</p>
<hr />
<div>In den Template Strategiene sind einige Methoden beschrieben wie man Seiten in ProcessWire rendern kann.<br />
PW stellt aber auch einige Funktionen bereit, mit denen man Dateien oder Seiten direkt rendern kann. Diese arbeiten auch gut mit dem WireCache zusammen. So kann man Teile der Ausgabe rendern und gleich Cachen.<br />
<br />
== Links ==<br />
https://processwire.com/api/ref/functions/wire-render-file/<br />
https://processwire.com/api/ref/page/render-field/<br />
<br />
== Functions ==<br />
$files->render // shorthand for wireRenderFile<br />
$page->render<br />
https://processwire.com/api/ref/page/render-field/<br />
<br />
== Snippets ==<br />
<syntaxhighlight lang="php"><br />
$content .= $files->render('teasers', ['items' => $pages->find("template=article")]);<br />
<br />
foreach ($pages->find("template=article") as $article) {<br />
$content .= $article->render('teaser.php');<br />
}<br />
</syntaxhighlight><br />
=== Pass global vars ===<br />
You can pass variable via render like:<br />
<br />
echo $pages->get($child->id)->render(array('mobile' => $mobile));<br />
<br />
=== Check if File is called directly or via wireRenderFile ===<br />
https://processwire.com/talk/topic/20915-wirerenderfile-question-about-page/<br />
Is there a way to check in my included template file if this child page is called directly, or whether it has been included from somewhere else? A simple check, so I can use the template in both scenarios (stand-alone view for just this page, or in cases I use wireRenderFile somewhere else). Right now I am passing the child page's ID like this:<br />
<br />
wireRenderFile('my_template', array('pid' => $child->id));<br />
And in my_template, to access it's own page fields, etc. I use<br />
<br />
$thisPage = pages()->get($pid);<br />
$myField = $thisPage->foo; // etc.<br />
Is that the way to go, or do I overlook something obvious?<br />
<br />
d'oh of course, it's as simple as:<br />
<br />
if(isset($pid)) {<br />
$thisPage = pages()->get($pid); // we get called with wireRenderFile<br />
} else {<br />
$thisPage = $page; // business as usual<br />
}</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Rendering_Funktionen&diff=24387ProcessWire - Rendering Funktionen2020-02-13T10:27:37Z<p>84.136.104.26: </p>
<hr />
<div>In den Template Strategiene sind einige Methoden beschrieben wie man Seiten in ProcessWire rendern kann.<br />
PW stellt aber auch einige Funktionen bereit, mit denen man Dateien oder Seiten direkt rendern kann. Diese arbeiten auch gut mit dem WireCache zusammen. So kann man Teile der Ausgabe rendern und gleich Cachen.<br />
<br />
== Links ==<br />
https://processwire.com/api/ref/functions/wire-render-file/<br />
https://processwire.com/api/ref/page/render-field/<br />
<br />
== Functions ==<br />
$files->render // shorthand for wireRenderFile<br />
$page->render<br />
https://processwire.com/api/ref/page/render-field/<br />
<br />
== Snippets ==<br />
<syntaxhighlight lang="php"><br />
$content .= $files->render('teasers', ['items' => $pages->find("template=article")]);<br />
<br />
foreach ($pages->find("template=article") as $article) {<br />
$content .= $article->render('teaser.php');<br />
}<br />
</syntaxhiglight><br />
=== Pass global vars ===<br />
You can pass variable via render like:<br />
<br />
echo $pages->get($child->id)->render(array('mobile' => $mobile));<br />
<br />
=== Check if File is called directly or via wireRenderFile ===<br />
https://processwire.com/talk/topic/20915-wirerenderfile-question-about-page/<br />
Is there a way to check in my included template file if this child page is called directly, or whether it has been included from somewhere else? A simple check, so I can use the template in both scenarios (stand-alone view for just this page, or in cases I use wireRenderFile somewhere else). Right now I am passing the child page's ID like this:<br />
<br />
wireRenderFile('my_template', array('pid' => $child->id));<br />
And in my_template, to access it's own page fields, etc. I use<br />
<br />
$thisPage = pages()->get($pid);<br />
$myField = $thisPage->foo; // etc.<br />
Is that the way to go, or do I overlook something obvious?<br />
<br />
d'oh of course, it's as simple as:<br />
<br />
if(isset($pid)) {<br />
$thisPage = pages()->get($pid); // we get called with wireRenderFile<br />
} else {<br />
$thisPage = $page; // business as usual<br />
}</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Rendering_Funktionen&diff=24386ProcessWire - Rendering Funktionen2020-02-13T10:18:13Z<p>84.136.104.26: /* Functions */</p>
<hr />
<div>In den Template Strategiene sind einige Methoden beschrieben wie man Seiten in ProcessWire rendern kann.<br />
PW stellt aber auch einige Funktionen bereit, mit denen man Dateien oder Seiten direkt rendern kann. Diese arbeiten auch gut mit dem WireCache zusammen. So kann man Teile der Ausgabe rendern und gleich Cachen.<br />
<br />
== Links ==<br />
<br />
== Functions ==<br />
$files->render<br />
$page->render<br />
<br />
== Snippets ==<br />
$content .= $files->render('teasers', ['items' => $pages->find("template=article")]);<br />
=== Pass global vars ===<br />
You can pass variable via render like:<br />
<br />
echo $pages->get($child->id)->render(array('mobile' => $mobile));<br />
<br />
=== Check if File is called directly or via wireRenderFile ===<br />
https://processwire.com/talk/topic/20915-wirerenderfile-question-about-page/<br />
Is there a way to check in my included template file if this child page is called directly, or whether it has been included from somewhere else? A simple check, so I can use the template in both scenarios (stand-alone view for just this page, or in cases I use wireRenderFile somewhere else). Right now I am passing the child page's ID like this:<br />
<br />
wireRenderFile('my_template', array('pid' => $child->id));<br />
And in my_template, to access it's own page fields, etc. I use<br />
<br />
$thisPage = pages()->get($pid);<br />
$myField = $thisPage->foo; // etc.<br />
Is that the way to go, or do I overlook something obvious?<br />
<br />
d'oh of course, it's as simple as:<br />
<br />
if(isset($pid)) {<br />
$thisPage = pages()->get($pid); // we get called with wireRenderFile<br />
} else {<br />
$thisPage = $page; // business as usual<br />
}</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Rendering_Funktionen&diff=24385ProcessWire - Rendering Funktionen2020-02-13T10:17:12Z<p>84.136.104.26: </p>
<hr />
<div>In den Template Strategiene sind einige Methoden beschrieben wie man Seiten in ProcessWire rendern kann.<br />
PW stellt aber auch einige Funktionen bereit, mit denen man Dateien oder Seiten direkt rendern kann. Diese arbeiten auch gut mit dem WireCache zusammen. So kann man Teile der Ausgabe rendern und gleich Cachen.<br />
<br />
== Links ==<br />
<br />
== Functions ==<br />
$files->render<br />
$page->render<br />
== Snippets ==<br />
$content .= $files->render('teasers', ['items' => $pages->find("template=article")]);<br />
=== Pass global vars ===<br />
You can pass variable via render like:<br />
<br />
echo $pages->get($child->id)->render(array('mobile' => $mobile));<br />
<br />
=== Check if File is called directly or via wireRenderFile ===<br />
https://processwire.com/talk/topic/20915-wirerenderfile-question-about-page/<br />
Is there a way to check in my included template file if this child page is called directly, or whether it has been included from somewhere else? A simple check, so I can use the template in both scenarios (stand-alone view for just this page, or in cases I use wireRenderFile somewhere else). Right now I am passing the child page's ID like this:<br />
<br />
wireRenderFile('my_template', array('pid' => $child->id));<br />
And in my_template, to access it's own page fields, etc. I use<br />
<br />
$thisPage = pages()->get($pid);<br />
$myField = $thisPage->foo; // etc.<br />
Is that the way to go, or do I overlook something obvious?<br />
<br />
d'oh of course, it's as simple as:<br />
<br />
if(isset($pid)) {<br />
$thisPage = pages()->get($pid); // we get called with wireRenderFile<br />
} else {<br />
$thisPage = $page; // business as usual<br />
}</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Performance&diff=24384ProcessWire - Performance2020-02-13T10:17:07Z<p>84.136.104.26: </p>
<hr />
<div>== Caching ==<br />
=== wireCache ===<br />
https://processwire.com/blog/posts/processwire-core-updates-2.5.28/#wirecache-upgrades<br />
https://processwire.com/talk/topic/15286-delete-and-generate-new-markup-cache/<br />
<br />
== Performante Datenbankabfragen ==<br />
Mit Modul oder per Hand (pdo) möglich.<br />
https://modules.processwire.com/modules/rock-finder/<br />
https://processwire.com/talk/topic/16346-how-to-transform-page-selectors-into-sql-queries/<br />
my module is a companion module for RockGrid. Those grids always need an array of objects as data source. Using $pages->find() and then foreach() to create such an array is terribly inefficient when dealing with several thousands of pages. That's why I built RockFinder -> it creates an efficient SQL statement for you and it is almost as easy as using regular PW selectors.<br />
<br />
The benefit of using SQL is that it is incredibly efficient. The downside is that some pw-related tasks become a headache (like checking for published state, sort order, multilanguage field values, to name just a few). RockFinder takes care of all that.<br />
<br />
It returns an array of objects that you can easily pass to a RockGrid or do whatever you want with it.<br />
<br />
== Performance Testen ==<br />
=== Zeit und RAM ===<br />
<syntaxhighlight lang="php"><br />
<br />
// 8000 pages with title and body fields<br />
$pp = $pages('template=basic, parent=1384');<br />
$out = '';<br />
foreach($pp as $p) {<br />
$t = $p->title . microtime();<br />
$b = $p->body . mt_rand(0, 1e5);<br />
$out .= $t . $b;<br />
}<br />
echo strlen($out);<br />
// 18384.08ms, 25.00 MB<br />
<br />
// 8000 pages with title and body fields<br />
$pp = $pages('template=basic, parent=1384');<br />
$out = '';<br />
foreach($pp as $p) {<br />
$out .= $p->title . microtime();<br />
$out .= $p->body . mt_rand(0, 1e5);<br />
}<br />
echo strlen($out);<br />
// 17617.05ms, 25.00MB<br />
<br />
$out = '';<br />
foreach($pages('template=basic, parent=1384') as $p) {<br />
$out .= $p->title . microtime();<br />
$out .= $p->body . mt_rand(0, 1e5);<br />
}<br />
echo strlen($out);<br />
// 17927.9ms, 25.00MB<br />
</syntaxhighlight><br />
<br />
<syntaxhighlight lang="php"><br />
</syntaxhighlight><br />
<br />
== Performance und Repeater Matrix ==<br />
https://processwire.com/talk/topic/20156-are-there-hidden-scalabilityperformance-issues-when-making-heavy-use-of-repeater-matrix-or-pagetable-fields/<br />
=== Backend ===<br />
* Repeater Items per AJAX laden <br />
https://processwire.com/blog/posts/more-repeaters-repeater-matrix-and-new-field-rendering/#repeater-upgrades-continued-in-pw-3.0.5<br />
=== Frontend ===<br />
* Können viele Datenbank (PDO) Queries auslösen, da alle Page Objekte geladen werden müssen.<br />
<br />
=== Auswahl aus verschiedenen Repeatern über ein Select, statt einzelnes RepeaterMatrix Feld ===<br />
Evtl. könnte man ein Auswahlfeld generieren, das dann wiederum einen Contentblock wählt, statt alles in ein RepeaterMatrix Feld zu packen.<br />
<br />
* Layoutblock -> Select Feld<br />
* Optionen werden geladen.<br />
<br />
=== Alternativ PageTables ===<br />
https://processwire.com/talk/topic/7459-module-pagetableextended/<br />
Könnte Performancemäßig die bessere Alternative sein. Prüfen und auch mit PageTableExtended verbinden.</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Performance&diff=24383ProcessWire - Performance2020-02-13T10:12:35Z<p>84.136.104.26: /* Caching */</p>
<hr />
<div>== Caching ==<br />
=== wireCache ===<br />
https://processwire.com/blog/posts/processwire-core-updates-2.5.28/#wirecache-upgrades<br />
https://processwire.com/talk/topic/15286-delete-and-generate-new-markup-cache/<br />
<br />
== Performance Testen ==<br />
=== Zeit und RAM ===<br />
<syntaxhighlight lang="php"><br />
<br />
// 8000 pages with title and body fields<br />
$pp = $pages('template=basic, parent=1384');<br />
$out = '';<br />
foreach($pp as $p) {<br />
$t = $p->title . microtime();<br />
$b = $p->body . mt_rand(0, 1e5);<br />
$out .= $t . $b;<br />
}<br />
echo strlen($out);<br />
// 18384.08ms, 25.00 MB<br />
<br />
// 8000 pages with title and body fields<br />
$pp = $pages('template=basic, parent=1384');<br />
$out = '';<br />
foreach($pp as $p) {<br />
$out .= $p->title . microtime();<br />
$out .= $p->body . mt_rand(0, 1e5);<br />
}<br />
echo strlen($out);<br />
// 17617.05ms, 25.00MB<br />
<br />
$out = '';<br />
foreach($pages('template=basic, parent=1384') as $p) {<br />
$out .= $p->title . microtime();<br />
$out .= $p->body . mt_rand(0, 1e5);<br />
}<br />
echo strlen($out);<br />
// 17927.9ms, 25.00MB<br />
</syntaxhighlight><br />
<br />
<syntaxhighlight lang="php"><br />
</syntaxhighlight><br />
<br />
== Performance und Repeater Matrix ==<br />
https://processwire.com/talk/topic/20156-are-there-hidden-scalabilityperformance-issues-when-making-heavy-use-of-repeater-matrix-or-pagetable-fields/<br />
=== Backend ===<br />
* Repeater Items per AJAX laden <br />
https://processwire.com/blog/posts/more-repeaters-repeater-matrix-and-new-field-rendering/#repeater-upgrades-continued-in-pw-3.0.5<br />
=== Frontend ===<br />
* Können viele Datenbank (PDO) Queries auslösen, da alle Page Objekte geladen werden müssen.<br />
<br />
=== Auswahl aus verschiedenen Repeatern über ein Select, statt einzelnes RepeaterMatrix Feld ===<br />
Evtl. könnte man ein Auswahlfeld generieren, das dann wiederum einen Contentblock wählt, statt alles in ein RepeaterMatrix Feld zu packen.<br />
<br />
* Layoutblock -> Select Feld<br />
* Optionen werden geladen.<br />
<br />
=== Alternativ PageTables ===<br />
https://processwire.com/talk/topic/7459-module-pagetableextended/<br />
Könnte Performancemäßig die bessere Alternative sein. Prüfen und auch mit PageTableExtended verbinden.</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Rendering_Funktionen&diff=24382ProcessWire - Rendering Funktionen2020-02-13T10:09:47Z<p>84.136.104.26: Die Seite wurde neu angelegt: „In den Template Strategiene sind einige Methoden beschrieben wie man Seiten in ProcessWire rendern kann. PW stellt aber auch einige Funktionen bereit, mit dene…“</p>
<hr />
<div>In den Template Strategiene sind einige Methoden beschrieben wie man Seiten in ProcessWire rendern kann.<br />
PW stellt aber auch einige Funktionen bereit, mit denen man Dateien oder Seiten direkt rendern kann. Diese arbeiten auch gut mit dem WireCache zusammen. So kann man Teile der Ausgabe rendern und gleich Cachen.<br />
<br />
== Links ==<br />
<br />
== Functions ==<br />
$files->render<br />
$page->render<br />
== Snippets ==<br />
$content .= $files->render('teasers', ['items' => $pages->find("template=article")]);<br />
<br />
=== Check if File is called directly or via wireRenderFile ===<br />
Is there a way to check in my included template file if this child page is called directly, or whether it has been included from somewhere else? A simple check, so I can use the template in both scenarios (stand-alone view for just this page, or in cases I use wireRenderFile somewhere else). Right now I am passing the child page's ID like this:<br />
<br />
wireRenderFile('my_template', array('pid' => $child->id));<br />
And in my_template, to access it's own page fields, etc. I use<br />
<br />
$thisPage = pages()->get($pid);<br />
$myField = $thisPage->foo; // etc.<br />
Is that the way to go, or do I overlook something obvious?<br />
<br />
d'oh of course, it's as simple as:<br />
<br />
if(isset($pid)) {<br />
$thisPage = pages()->get($pid); // we get called with wireRenderFile<br />
} else {<br />
$thisPage = $page; // business as usual<br />
}</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Module_schreiben&diff=24253ProcessWire - Module schreiben2020-01-06T10:19:15Z<p>84.136.104.26: /* = Konfigurationsdatei statt getModuleInfo */</p>
<hr />
<div>== Links ==<br />
Wichtigste Resourcen<br />
https://processwire.com/docs/modules/development/ - Guter Ausgangspunkt<br />
https://processwire.com/api/ref/module/ - Module API<br />
https://processwire.com/api/ref/configurable-module/ - Klasse für Konfigurierbare Module<br />
https://processwire.com/docs/modules/types/ - Welche Modultypen gibt es ?<br />
https://github.com/ryancramerdesign/ProcessHello - Modul Skelett Beispiel für eigene Backend (Process) Module<br />
https://github.com/ryancramerdesign/FieldtypeMapMarker - Beispiel für ein Fieldtype und Inputfield Modul<br />
https://processwire.com/talk/topic/778-module-dependencies/ - Module die andere Module benötigen<br />
https://processwire.com/talk/forum/19-moduleplugin-development/ - Forum zum Thema Module entwickeln<br />
http://somatonic.github.io/Captain-Hook/ - Hook Cheatsheet<br />
https://processwire.com/blog/posts/new-module-configuration-options/ - Neuere Konfigurationsmöglichkeiten<br />
Weitere Links<br />
https://webdesign.tutsplus.com/tutorials/a-beginners-introduction-to-writing-modules-in-processwire--cms-26862<br />
https://processwire.com/docs/modules/ - Introduction, Development, Hooks, Types, Pro Modules, Third Party<br />
<br />
<br />
<br />
<br />
[[ProcessWire - Module Snippets]]<br />
<br />
== Wo - Was ? ==<br />
=== Welche Typen von Modulen gibt es ? ===<br />
https://processwire.com/docs/modules/types/<br />
* '''Fieldtype''': Repräsentiert einen Datentyp. Meistens keine Public API, Handelt Daten / Datenbank - https://processwire.com/api/ref/fieldtype/<br />
* '''Inputfield''': Sammelt User Eingaben über ein Formular im Admin Bereich. Im Gegensatz zum Fieldtype geht es hier um das UI im Backend. Das Handling der Daten liegt beim Fieldtype.<br />
* '''Process''' for creating admin processes/applications.<br />
* '''Textformatter''' for formatting text.<br />
* '''AdminTheme''' for creating themes in the admin.<br />
* '''WireMail''' for modules that send email and extend the WireMail class.<br />
* '''Tfa''' for implementing a specific kind of two-factor authentication.<br />
* '''ImageSizerEngine''' for modules that extend ImageSizerEngine for resizing images.<br />
* '''FileCompiler''' for modules that extend FileCompilerModule for compilation of files.<br />
* '''FileValidator''' for modules that extend FileValidatorModule for validation of files.<br />
<br />
=== Wie werden Felder in der Datenbank angelegt ? ===<br />
Dazu nutzt man den Typ "Fieldtype"<br />
<br />
=== Wo rendert man die Ausgabe ? ===<br />
Bei Ryan Cramers Event Beispiel legt er zwei Klassen Event und EventArray an, die auch die Render Funktionen enthalten.<br />
<br />
== Spezielle Funktionen in Modulen ==<br />
<br />
=== getModuleInfo ===<br />
Ist die einzige Pflichtfunktion in Modulen. Hier werden title, version, summary und weitere Daten hinterlegt. Hier kann man auch angeben ob ein Modul ein Autoload Modul ist.<br />
<br />
Statt einer getModuleInfo() Funktion kann man auch eine json Konfiguration als Datei hinterlegen<br />
<br />
Siehe Beispiel unten<br />
<br />
=== init ===<br />
public function init(){}<br />
Initialisiert das Modul. ProcessWire ruft diese Funktion auf, wenn das Modul geladen ist. Bei Autoload Modulen wird es aufgerufen wenn die ProcessWire API bereit ist. Daher ist es ein guter Ort um Hooks einzubinden.<br />
<br />
=== ready ===<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
if($this->page->template == 'admin') {<br />
$this->message($this->hi());<br />
}<br />
}<br />
</syntaxhighlight><br />
Wird in autoload Modulen aufgerufen wenn die API bereit ist. Nützlich für Hooks:<br />
<br />
=== execute ===<br />
<syntaxhighlight lang="php"><br />
/**<br />
* This function is executed when a page with your Process assigned is accessed. <br />
*<br />
* This can be seen as your main or index function. You'll probably want to replace<br />
* everything in this function. <br />
*<br />
*/<br />
public function ___execute() {<br />
// greetingType and greeting are automatically populated to this module<br />
// and they were defined in ProcessHello.config.php<br />
if($this->greetingType == 'message') {<br />
$this->message($this->greeting); <br />
} else if($this->greetingType == 'warning') {<br />
$this->warning($this->greeting); <br />
} else {<br />
$this->error($this->greeting); <br />
}<br />
// generate some navigation<br />
$out = "<br />
<h2>$this->greeting</h2><br />
<dl class='nav'><br />
<dt><a href='./something/'>Do Something</a></dt><br />
<dd>Runs the executeSomething() function.</dd><br />
</dl><br />
";<br />
return $out;<br />
} <br />
</syntaxhighlight><br />
<br />
=== executeSomething ===<br />
<syntaxhighlight lang="php"><br />
/**<br />
* Called when the URL is this module's page URL + "/something/"<br />
*<br />
*/<br />
public function ___executeSomething() {<br />
// set a new headline, replacing the one used by our page<br />
// this is optional as PW will auto-generate a headline <br />
$this->headline('This is something!'); <br />
// add a breadcrumb that returns to our main page <br />
// this is optional as PW will auto-generate breadcrumbs<br />
$this->breadcrumb('../', 'Hello'); <br />
$out = "<br />
<h2>Not much to to see here</h2><br />
<p><a href='../'>Go Back</a></p><br />
";<br />
return $out; <br />
}<br />
</syntaxhighlight><br />
<br />
=== install & uninstall ===<br />
<syntaxhighlight lang="php"><br />
<br />
/**<br />
* Called only when your module is installed<br />
*<br />
* If you don't need anything here, you can simply remove this method. <br />
*<br />
*/<br />
public function ___install() {<br />
parent::___install(); // always remember to call parent method<br />
}<br />
/**<br />
* Called only when your module is uninstalled<br />
*<br />
* This should return the site to the same state it was in before the module was installed. <br />
*<br />
* If you don't need anything here, you can simply remove this method. <br />
*<br />
*/<br />
public function ___uninstall() {<br />
parent::___uninstall(); // always remember to call parent method<br />
}<br />
</syntaxhighlight><br />
<br />
== Vererbung und Eigenschaften in Modulen ==<br />
Modules are not different from PHP classes.<br />
<br />
To change the properties of MyModule class from within MyOtherModule class, you can either:<br />
<br />
#Make MyOtherModule class extend MyModule. It will thus inherit MyModule's public and protected properties and methods<br />
#Make the properties firstName and lastName configurable by passing them as parameters/arguments in MyModule's constructor method.<br />
<br />
== Autoload Module und Hooks ==<br />
Autoload werden automatisch geladen müssen also nicht in einem Template o.ä. gestartet werden. Daher bieten sie sich an um die Funktionalität von ProcessWire zu erweitern. Als Werkzeug dafür dienen Hooks. Mit Hooks kann man an vielen Stellen den Rendering Process der Seiten beeinflussen. Außerdem kann man für eigene Module ebenfalls Hooks bereitstellen. <br />
<br />
=== Hooks ===<br />
https://processwire.com/docs/modules/hooks/<br />
Hooks sind ein mächtiges Werkzeug. Sie geben einem die Möglichkeit an vielen Stellen "einzuhaken" und Funktionalität einzubauen.<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
$this->addHookAfter('Page::render', function($event) {<br />
$event->return .= '<p>Hallo</p>';<br />
});<br />
}<br />
</syntaxhighlight><br />
Schreibt am Ende Jeder Seite ein "Hallo". Das $event Objekt ist ein [https://processwire.com/api/ref/hook-event/ HookEvent]. Im Beispiel fügen wir einfach etwas Markup hinzu. Über $event->arguments() kann man aber auf ale Argumente zugreifen.<br />
<br />
Das gleiche aber nicht mit anonymer Funktion:<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
// add hook after Page::render() and make it call the "test" method of $this module<br />
$this->addHookAfter('Page::render', $this, 'test');<br />
}<br />
<br />
public function test($event) {<br />
// modify the return value of Page::render() to include the following:<br />
$event->return .= '<p>Hallo</p>';<br />
}<br />
</syntaxhighlight><br />
<br />
=== Hooks zum erweitern von existierenden Klassen nutzen ===<br />
Mit Hooks kann man in vorhandene Klassen einhaken. Z.B. läßt sich das Page Objekt erweitern.<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
$this->addHook('Page::summarize', $this, 'summarize');<br />
}<br />
public function summarize($event) {<br />
$page = $event->object; // the $event->object represents the object hooked (Page)<br />
$maxlen = $event->arguments(0); // first argument is the optional max length<br />
if(!$maxlen) $maxlen = 200; // if no $maxlen was present, we'll use a default of 200<br />
$summary = $this->sanitizer->truncate($page->body, $maxlen); // use sanitizer truncate method to create a summary<br />
$event->return = $summary; // populate $summary to $event->return, the return value<br />
}<br />
</syntaxhighlight><br />
So kann man ganz einfach eine Zusammenfassung aller Kindseiten in einem Template rendern:<br />
<syntaxhighlight lang="php"><br />
foreach($page->children as $item) {<br />
$summary = $item->summarize(150);<br />
echo "<li><a href='$item->url'>$item->title</a><br>$summary";<br />
}<br />
</syntaxhighlight><br />
<br />
=== Hook Beispiele ===<br />
Hook am Ende des Renderings<br />
$this->addHookAfter('Page::render', function($event) {...});<br />
Füge eine Funktion "summarize" zum Page Objekt hinzu.<br />
$this->addHook('Page::summarize', $this, 'summarize');<br />
Hook auf eine einzelne Instanz (hier pages Objekt)<br />
$this->pages->addHookAfter('saved', function($event){...});<br />
$this->addHook('Page::method', ...) // Spricht ALLE Instanzen an - Regelfall<br />
$page->addHook('method', ...) // Spricht nur die EINE Instanz der Seite an.<br />
</pre><br />
<br />
=== Autoload Module nur im Admin Bereich laden ===<br />
'autoload' => 'template=admin' <br />
statt<br />
'autoload' => true<br />
<br />
== CSS und JavaScript in Modulen ==<br />
Bei Process Modulen möchte man für das Styling etc. im Backend oft CSS und JS Dateien hinzufügen.<br />
<br />
Einfach Eine Datei MeinModul.css und / oder MeinModul.js hinzufügen. JQuery ist im Admin bereits geladen daher kann eine MeinModul.js Starter Datei so aussehen:<br />
<br />
<pre><br />
<br />
/**<br />
* This JS file is only loaded when the ProcessHello module is run<br />
*<br />
* You should delete it if you have no javascript to add.<br />
*<br />
*/<br />
<br />
$(document).ready(function() {<br />
// do something<br />
}); <br />
</pre><br />
<br />
== Beispiele ==<br />
=== Frontend Rendering Module ===<br />
A bit old but working<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
/**<br />
* FrontEndRender<br />
*<br />
* Author: Ben Byford<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2010 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class FrontEndRender extends WireData implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'FrontEndRender',<br />
'version' => 0.1,<br />
'summary' => "Outputs html and static variables to frontend",<br />
'author' => 'Ben Byford',<br />
'singular' => true,<br />
'href' => 'https://github.com/benbyford/PW-starter-modules'<br />
);<br />
}<br />
<br />
// protected variable only accessable within module<br />
protected $name = 'Ben';<br />
<br />
/*<br />
* render function to be called in PW template like this:<br />
* $FrontEndRender = $modules->getModule('FrontEndRender');<br />
* echo '<h1>' . $FrontEndRender->render() . '</h1>';<br />
*<br />
*/<br />
public function render(){<br />
return "Hello " . $this->name;<br />
}<br />
}<br />
?><br />
</syntaxhighlight><br />
<br />
=== ProcessWire Hello World Modul ===<br />
Beispiel Modul mit Hooks (liegt immer in der Standardinstallation)<br />
<syntaxhighlight lang="php"><br />
<?php namespace ProcessWire;<br />
<br />
/**<br />
* ProcessWire 'Hello world' demonstration module<br />
*<br />
* Demonstrates the Module interface and how to add hooks.<br />
* <br />
* See README file for further links regarding module development.<br />
* <br />
* This file is licensed under the MIT license<br />
* https://processwire.com/about/license/mit/<br />
* <br />
* ProcessWire 3.x, Copyright 2016 by Ryan Cramer<br />
* https://processwire.com<br />
*<br />
*/<br />
<br />
class Helloworld extends WireData implements Module {<br />
<br />
/**<br />
* getModuleInfo is a module required by all modules to tell ProcessWire about them<br />
*<br />
* @return array<br />
*<br />
*/<br />
public static function getModuleInfo() {<br />
<br />
return array(<br />
<br />
// The module's title, typically a little more descriptive than the class name<br />
'title' => 'Hello World', <br />
<br />
// version number <br />
'version' => 3, <br />
<br />
// summary is brief description of what this module is<br />
'summary' => 'An example module used for demonstration purposes.',<br />
<br />
// Optional URL to more information about the module<br />
'href' => 'https://processwire.com',<br />
<br />
// singular=true: indicates that only one instance of the module is allowed.<br />
// This is usually what you want for modules that attach hooks. <br />
'singular' => true, <br />
<br />
// autoload=true: indicates the module should be started with ProcessWire.<br />
// This is necessary for any modules that attach runtime hooks, otherwise those<br />
// hooks won't get attached unless some other code calls the module on it's own.<br />
// Note that autoload modules are almost always also 'singular' (seen above).<br />
'autoload' => true, <br />
<br />
// Optional font-awesome icon name, minus the 'fa-' part<br />
'icon' => 'smile-o', <br />
);<br />
}<br />
<br />
/**<br />
* Initialize the module<br />
*<br />
* ProcessWire calls this when the module is loaded. For 'autoload' modules, this will be called<br />
* when ProcessWire's API is ready. As a result, this is a good place to attach hooks. <br />
*<br />
*/<br />
public function init() {<br />
<br />
// add a hook after the $pages->save, to issue a notice every time a page is saved<br />
$this->pages->addHookAfter('save', $this, 'example1'); <br />
<br />
// add a hook after each page is rendered and modify the output<br />
$this->addHookAfter('Page::render', $this, 'example2'); <br />
<br />
// add a 'hello' method to every page that returns "Hello World"<br />
// use "echo $page->hello();" in your template file to display output<br />
$this->addHook('Page::hello', $this, 'example3'); <br />
<br />
// add a 'hello_world' property to every page that returns "Hello [user]"<br />
// use "echo $page->hello_world;" in your template file to display output<br />
$this->addHookProperty('Page::hello_world', $this, 'example4'); <br />
}<br />
<br />
/**<br />
* Example1 hooks into the pages->save method and displays a notice every time a page is saved<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example1($event) {<br />
/** @var Page $page */<br />
$page = $event->arguments[0]; <br />
$this->message("Hello World! You saved {$page->path}."); <br />
}<br />
<br />
<br />
/**<br />
* Example2 hooks into every page after it's rendered and adds "Hello World" text at the bottom<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example2($event) {<br />
<br />
/** @var Page $page */<br />
$page = $event->object; <br />
<br />
// don't add this to the admin pages<br />
if($page->template == 'admin') return;<br />
<br />
// add a "Hello World" paragraph right before the closing body tag<br />
$event->return = str_replace("</body>", "<p>Hello World!</p></body>", $event->return); <br />
}<br />
<br />
/**<br />
* Example3 adds a 'hello' method (not property) to every page that simply returns "Hello World"<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example3($event) {<br />
$event->return = "Hello World";<br />
}<br />
<br />
/**<br />
* Example 4 adds a 'hello_world' property (not method) to every page that returns "Hello [user]"<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example4($event) {<br />
$event->return = "Hello " . $this->user->name; <br />
}<br />
<br />
}<br />
<br />
</syntaxhighlight><br />
<br />
=== ProcessWire Admin Bereich mit eigener Funktionalität erweitern (Modul)===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<syntaxhighlight lang="php"><br />
<br />
<?php<br />
/**<br />
* ProcessSimpleAdminPage<br />
*<br />
* @author Ben Byford<br />
* http://www.benbyford.com<br />
*<br />
* @see http://www.processwire.com<br />
*/<br />
<br />
class ProcessSimpleAdminPage extends Process {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'Process Simple Admin Page',<br />
'summary' => 'Simple Process module that adds new admin page with',<br />
'version' => 001,<br />
<br />
// Modules that extend Process may specify a 'page' attribute in the<br />
// getModuleInfo(), this page will automatically be given the module<br />
// process when added to teh pagetree.<br />
<br />
// I have exampled but commented out the 'page' settings below<br />
// so that I can show how one might add a page to install() and<br />
// uninstall() in this and other modules (that might not extend<br />
// Process)<br />
<br />
<br />
// 'page' => array(<br />
// 'name' => 'site-config',<br />
// 'parent' => 'admin',<br />
// 'title' => 'Site Config'<br />
// )<br />
);<br />
}<br />
<br />
public function execute() {<br />
return '<br />
<h2>Edit the text here in the module</h2><br />
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam mattis eros vitae metus sodales eget suscipit purus rhoncus. Proin ultrices gravida dolor, non porttitor enim interdum vitae. Integer feugiat lacinia tincidunt. Nulla laoreet tristique tristique. Sed elementum justo a nisl elementum sit amet accumsan nisi tempor. Nulla quis eros et massa dignissim imperdiet a vitae purus.</p><br />
<br />
<p>Donec scelerisque pulvinar sem eu lobortis. Maecenas turpis ipsum, tempus dictum pharetra eu, consectetur vitae arcu. Fusce orci mauris, semper at tempus quis, volutpat molestie tellus. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Sed quam tortor, tincidunt sed semper lacinia, scelerisque dapibus quam. Morbi at nisi luctus lacus auctor ultrices eu eu leo.</p><br />
<br />
<p>Praesent faucibus purus id felis tincidunt dignissim. Sed sit amet ligula mi, eget semper dui. Proin consectetur gravida massa, nec luctus purus hendrerit in. Etiam volutpat, elit non venenatis suscipit, libero neque consectetur diam, id rutrum magna odio ac ligula. Maecenas sollicitudin congue neque fermentum vestibulum. Morbi nec leo nisi. Donec at nisl odio, et porta ligula.</p><br />
<br />
<p>Sed quis arcu nisi, ac tempor augue. Praesent non elit libero, a ullamcorper lorem. Curabitur porta odio eu nunc ultricies interdum id nec risus. Donec nibh nibh, porta eget vehicula ac, aliquet eget ante. Phasellus eget lorem eu eros eleifend ultrices. Cras sit amet neque sit amet nibh fringilla cursus ut id mauris. Praesent quis nunc justo, sed suscipit lectus. Phasellus eget ultrices risus. Curabitur eu semper est. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Ut suscipit, nisl ut imperdiet eleifend, turpis arcu placerat tortor, nec laoreet lacus neque ac tellus. Aenean ac lacus justo, quis ultricies nisi.</p><br />
';<br />
}<br />
public function install(){<br />
<br />
// create new page to add to CMS<br />
$page = new Page();<br />
<br />
// add page attributes<br />
$page->template = "admin";<br />
$page->name = "cms-faq";<br />
$page->title = "CMS FAQ";<br />
$page->save();<br />
<br />
// set this module as the page process, this allows us to display the above<br />
$page->process = 'ProcessSimpleAdminPage';<br />
<br />
// get admin page and set as page parent<br />
$admin = $this->pages->get("id=2");<br />
$page->parent = $admin;<br />
<br />
// save page<br />
$page->save();<br />
}<br />
<br />
public function uninstall(){<br />
<br />
// delete created page<br />
$page = $this->pages->get("name=cms-faq");<br />
if(count($page)) $this->pages->delete($page, true);<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
=== ProcessWire Textformatter Modul ===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
/**<br />
* TextformatterFindReplace<br />
*<br />
* Author: Ben Byford<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2010 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class TextformatterFindReplace extends Textformatter implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'TextformatterFindReplace',<br />
'version' => 0.1,<br />
'summary' => "Finds and replaces any instance of config input to config output",<br />
'author' => 'Ben Byford',<br />
'singular' => true,<br />
'href' => 'https://github.com/benbyford/PW-starter-modules'<br />
);<br />
}<br />
<br />
<br />
/**<br />
* Find and Replace the input string<br />
*<br />
* @param string $str The block of text to parse<br />
*<br />
* The incoming string is replaced with the formatted version of itself.<br />
**/<br />
<br />
public function format(&$str) {<br />
$find = $this->findStr;<br />
$str = preg_replace_callback($find, array($this,"replace"), $str);<br />
<br />
}<br />
<br />
// adding three underscores to a function allows other modules to hook it<br />
public function ___replace($match) {<br />
return $this->replaceStr;<br />
}<br />
}<br />
?><br />
</syntaxhighlight><br />
<br />
=== Admin Funktionalität: Countdown zum Seitenveröffentlichen ===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<br />
The module PageDeferredPublish, on clicking one of the '''Publish Later buttons''', sets LazyCron to check that page’s countdown every minute and publishes the page when its countdown reaches 0. This means I can publish a page approximately 24 hours in advance (obviously the checking interval and delay time can be changed to your requirements).<br />
<br />
I did this by:<br />
<br />
'''Creating two fields''' within my install() function: a checkbox field to set to true when a button is checked to indicate the page should countdown, and a countdown field to store the count in seconds for that specific page.<br />
<br />
'''Adding hooks''' to both ''ProcessPageEdit::buildForm'' and ''ProcessPageListActions::getExtraActions'' enabling me to add the two buttons.<br />
<br />
Checking to see if one of the buttons was clicked with my '''ready() function''' then setting the corresponding page’s checkbox to true.<br />
<br />
Using a '''LazyCron hook function''' to check all pages that are unpublished for true checkboxes and then comparing the seconds field to see if the page needs publishing. If not then deduct the elapsed time in seconds.<br />
<br />
The result is a '''module that has settings''' (the time interval to check and publish at a later time), '''hooks into the admin''' using buttons and fields, and enables us to '''use other modules installe'''d in PW (i.e. LazyCron).<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
/**<br />
* DeferredPublish (0.0.1)<br />
* DeferredPublish publishes a page after a defined amount of time has elapsed using lazycron.<br />
*<br />
* @author Ben Byford<br />
* http://www.benbyford.com<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2011 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class PageDeferredPublish extends WireData implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => "PageDeferredPublish",<br />
'version' => "0.0.1",<br />
'summary' => "PageDeferredPublish",<br />
'author' => "Ben Byford",<br />
'href' => "https://github.com/benbyford/PW-intermediate-modules",<br />
'icon' => "clock-o",<br />
'autoload' => true,<br />
'singular' => true,<br />
'requires' => "LazyCron",<br />
);<br />
}<br />
<br />
private $postPubLater = null;<br />
private $pageID = null;<br />
private $pagePubLater = null;<br />
private $currentPage = null;<br />
<br />
private $submitName = 'pdp_pub_later_submit';<br />
private $listPageName = 'pdp_pub_later_list';<br />
private $fieldName = 'pdp_pub_later';<br />
private $checkboxName = 'pdp_pub_later_check';<br />
<br />
private $defaultInterval = 'everyMinute';<br />
private $defaultTime = 86400;<br />
<br />
<br />
public function install(){<br />
// add new fields needed for module<br />
$this->installFields();<br />
}<br />
public function uninstall(){<br />
// uninstall fields<br />
$this->uninstallFields();<br />
}<br />
<br />
// initialize the hook in your AutoLoad module<br />
public function init() {<br />
<br />
// get defaults from module setting in CMS<br />
$this->defaultTime = $this->pub_after;<br />
$this->defaultInterval = $this->cron_check;<br />
<br />
// get admin URL<br />
$this->adminUrl = $this->wire('config')->urls->admin;<br />
<br />
// add hooks to CRON, PageList, PageEdit<br />
$this->addHookAfter("LazyCron::{$this->defaultInterval}", $this, 'publishDefferedPages');<br />
$this->addHook("ProcessPageListActions::getExtraActions", $this, 'hookPageListActions');<br />
$this->addHookAfter("ProcessPageEdit::buildForm", $this, "editForm");<br />
}<br />
<br />
public function ready() {<br />
<br />
// if list button clicked then grab id<br />
$this->pagePubLater = $this->input->get($this->listPageName);<br />
$this->pageID = $this->input->id;<br />
<br />
// get page<br />
$this->currentPage = $this->pages->get($this->pageID);<br />
<br />
// if pagelist pub later submit button clicked<br />
if($this->pagePubLater){<br />
$this->message("Page {$this->currentPage->name} deffered for publish.");<br />
}<br />
<br />
// if page edit submit button clicked<br />
$this->postPubLater = $this->input->post($this->submitName);<br />
if($this->postPubLater){<br />
$this->message("Page {$this->currentPage->name} deffered for publish.");<br />
}<br />
<br />
// if either deffered publish sumbit found then publish page later<br />
if($this->pagePubLater || $this->postPubLater){<br />
$this->publishLater();<br />
}<br />
}<br />
<br />
/*<br />
* Hook: ProcessPageEdit::buildForm<br />
*<br />
* add Publish Later button to edit page if not yet published<br />
*/<br />
public function ___editForm(HookEvent $form) {<br />
<br />
// get the InputFieldForm object from the event (return value of buildForm())<br />
$form = $form->return;<br />
<br />
$page = $this->pages->get($this->input->get->id);<br />
$check = $page->get($this->checkboxName);<br />
<br />
// check if publish button available and therfore unpublished<br />
$target = $form->get('submit_publish');<br />
<br />
if($target && $check == false){<br />
<br />
// get InputfieldText module<br />
$submit2 = $this->modules->get('InputfieldSubmit');<br />
$submit2->attr('name', $this->submitName);<br />
$submit2->attr('id', 'publish_later');<br />
$submit2->attr('class', 'ui-button ui-widget ui-corner-all head_button_clone ui-state-default ui-priority-secondary');<br />
$submit2->attr('value', 'Publish Later'); // Button: save unpublished<br />
<br />
// get form element save and place before<br />
$target = $form->get('submit_save');<br />
$form->insertBefore($submit2, $target);<br />
<br />
$form->return = $form;<br />
}<br />
}<br />
<br />
public function ___hookPageListActions(HookEvent $event) {<br />
<br />
// get current page<br />
$page = $event->arguments[0];<br />
<br />
// check to see if page is published<br />
$pagePub = $page->is(Page::statusUnpublished);<br />
<br />
// check to see if page template has deffered field<br />
$pageHasDefferField = $page->get($this->fieldName);<br />
<br />
$actions = array();<br />
<br />
// don't get homepage or pages that are already published or are being deffered for publish<br />
if($page->id > 1 && $pagePub == "published" && !is_null($pageHasDefferField) && $page->get($this->checkboxName) == false) {<br />
<br />
$actions['publish_later'] = array(<br />
'cn' => 'PublishLater',<br />
'name' => 'pub later',<br />
'url' => "{$this->adminUrl}?{$this->listPageName}=1&id={$page->id}",<br />
);<br />
}<br />
if(count($actions)) $event->return = $actions + $event->return;<br />
}<br />
<br />
/*<br />
* Publish Page on cron job<br />
*<br />
* Gets deffered page and publishes<br />
*/<br />
public function ___publish($page) {<br />
$page->removeStatus(Page::statusUnpublished);<br />
$page->removeStatus(Page::statusHidden);<br />
$page->Save();<br />
}<br />
<br />
/*<br />
* Main publish later function<br />
*<br />
* Gets deffered page and sets fields to be checked be lazy cron<br />
*/<br />
private function ___publishLater() {<br />
<br />
// get page<br />
$page = $this->pages->get($this->pageID);<br />
<br />
// set output formatting to false<br />
$page->of(false);<br />
<br />
// set field time to settings default time and checkbox to true<br />
$page->set($this->checkboxName, true);<br />
$page->set($this->fieldName, $this->defaultTime);<br />
<br />
// save page<br />
$page->save();<br />
$page->of(true);<br />
}<br />
<br />
/*<br />
* Lazy Cron hook function<br />
*<br />
* Triggers every [set time interval] and checks pages<br />
* Publishes page if time runout<br />
*<br />
* Adds publish page log<br />
*/<br />
public function ___publishDefferedPages(HookEvent $e){<br />
<br />
// seconds since last lazycron<br />
$seconds = $e->arguments[0];<br />
<br />
// find all pages with deffered field<br />
$defferedPages = $this->pages->find("{$this->checkboxName}=1,include=unpublished");<br />
<br />
// for each page decrease time for deffered field<br />
foreach ($defferedPages as $page) {<br />
<br />
// get current page time<br />
$timeTillPublish = $page->get($this->fieldName);<br />
<br />
// set time to time minus time past<br />
$timeLeft = $timeTillPublish - $seconds;<br />
<br />
// if time passed 0 or less then publish page<br />
$page->of(false);<br />
if($timeLeft <= 0){<br />
// remove flags and save<br />
$this->publish($page);<br />
<br />
$page->set($this->fieldName, 0);<br />
$page->set($this->checkboxName, 0);<br />
<br />
// log a page has been published<br />
$log = wire('log');<br />
$log->message('CRON:'. $seconds .' Pages: '. $page->name .' published');<br />
}else{<br />
$page->set($this->fieldName, $timeLeft);<br />
}<br />
// save page time<br />
$page->Save();<br />
$page->of(true);<br />
}<br />
}<br />
<br />
/*<br />
* Install new module specific fields<br />
*/<br />
private function installFields(){<br />
<br />
// install pub later checkbox field<br />
// find installed fields<br />
$f = $this->fields->get($this->fieldName);<br />
if($f){<br />
<br />
// if field already found then don't try and make it<br />
$this->message($this->fieldName . ' field found');<br />
<br />
}else{<br />
<br />
// create new field object to store crontime<br />
$f = new Field();<br />
// get a field type<br />
$f->type = $this->modules->get("FieldtypeInteger");<br />
$f->name = $this->fieldName;<br />
$f->label = 'Publish Time Left';<br />
$f->defaultValue = $this->defaultTime;<br />
$f->icon = 'clock-o';<br />
$f->columnWidth = 50;<br />
$f->collapsed = 1;<br />
$f->flags = 4;<br />
<br />
$f->save(); // save the field<br />
<br />
// create new field object to store whether to publish or not<br />
$f = new Field();<br />
// get a field type<br />
$f->type = $this->modules->get("FieldtypeCheckbox");<br />
$f->name = $this->checkboxName;<br />
$f->label = 'Publish Page later';<br />
$f->defaultValue = false;<br />
$f->columnWidth = 50;<br />
$f->icon = 'clock-o';<br />
$f->collapsed = 1;<br />
$f->flags = 4;<br />
<br />
$f->save(); // save the field<br />
}<br />
}<br />
<br />
/*<br />
* Uninstall module specific fields<br />
*/<br />
private function uninstallFields(){<br />
<br />
// find installed fields<br />
$fInt = $this->fields->get($this->fieldName);<br />
$fCheck = $this->fields->get($this->checkboxName);<br />
<br />
if($fInt && $fCheck){<br />
$fieldIntUsed = $fInt->numFieldgroups();<br />
$fieldCheckUsed = $fCheck->numFieldgroups();<br />
<br />
if($fieldIntUsed){<br />
// field in use by template<br />
$this->message('Unable to uninstall field '.$fInt->name);<br />
}else{<br />
// delete installed fields<br />
$this->fields->delete($fInt);<br />
$this->fields->save;<br />
}<br />
<br />
if($fieldCheckUsed){<br />
// field in use by template<br />
$this->message('Unable to uninstall field '.$fCheck->name);<br />
}else{<br />
// delete installed fields<br />
$this->fields->delete($fCheck);<br />
$this->fields->save;<br />
}<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
=== Inputfield / Fieldtype ===<br />
[[ProcessWire - Fieldtype erstellen (Module)]]<br />
<br />
=== Konfigurationsdatei statt getModuleInfo ===<br />
Bei größeren Konfigruation (z.B. Admin Page Navigation) sinnvoll.<br />
<syntaxhighlight lang="php"><br />
<?php<br />
/**<br />
* ProcessHello.info.php<br />
* <br />
* Return information about this module.<br />
*<br />
* If preferred, you can use a getModuleInfo() method in your module file, <br />
* or you can use a ModuleName.info.json file (if you prefer JSON definition). <br />
*<br />
*/<br />
$info = array(<br />
// Your module's title<br />
'title' => 'Hello: Process Module Example', <br />
// A 1 sentence description of what your module does<br />
'summary' => 'A starting point module skeleton from which to build your own Process module.', <br />
// Module version number: use 1 for 0.0.1 or 100 for 1.0.0, and so on<br />
'version' => 1, <br />
// Name of person who created this module (change to your name)<br />
'author' => 'Ryan Cramer', <br />
// Icon to accompany this module (optional), uses font-awesome icon names, minus the "fa-" part<br />
'icon' => 'thumbs-up', <br />
// URL to more info: change to your full modules.processwire.com URL (if available), or something else if you prefer<br />
'href' => 'http://modules.processwire.com/', <br />
// name of permission required of users to execute this Process (optional)<br />
'permission' => 'helloworld', <br />
// permissions that you want automatically installed/uninstalled with this module (name => description)<br />
'permissions' => array(<br />
'helloworld' => 'Run the HelloWorld module'<br />
), <br />
<br />
// page that you want created to execute this module<br />
'page' => array(<br />
'name' => 'helloworld',<br />
'parent' => 'setup', <br />
'title' => 'Hello World'<br />
),<br />
// optional extra navigation that appears in admin<br />
// if you change this, you'll need to a Modules > Refresh to see changes<br />
'nav' => array(<br />
array(<br />
'url' => '', <br />
'label' => 'Hello', <br />
'icon' => 'smile-o', <br />
), <br />
array(<br />
'url' => 'something/', <br />
'label' => 'Something', <br />
'icon' => 'beer', <br />
),<br />
)<br />
// for more options that you may specify here, see the file: /wire/core/Process.php<br />
// and the file: /wire/core/Module.php<br />
);<br />
</syntaxhighlight></div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Module_schreiben&diff=24252ProcessWire - Module schreiben2020-01-06T10:17:48Z<p>84.136.104.26: /* Beispiele */</p>
<hr />
<div>== Links ==<br />
Wichtigste Resourcen<br />
https://processwire.com/docs/modules/development/ - Guter Ausgangspunkt<br />
https://processwire.com/api/ref/module/ - Module API<br />
https://processwire.com/api/ref/configurable-module/ - Klasse für Konfigurierbare Module<br />
https://processwire.com/docs/modules/types/ - Welche Modultypen gibt es ?<br />
https://github.com/ryancramerdesign/ProcessHello - Modul Skelett Beispiel für eigene Backend (Process) Module<br />
https://github.com/ryancramerdesign/FieldtypeMapMarker - Beispiel für ein Fieldtype und Inputfield Modul<br />
https://processwire.com/talk/topic/778-module-dependencies/ - Module die andere Module benötigen<br />
https://processwire.com/talk/forum/19-moduleplugin-development/ - Forum zum Thema Module entwickeln<br />
http://somatonic.github.io/Captain-Hook/ - Hook Cheatsheet<br />
https://processwire.com/blog/posts/new-module-configuration-options/ - Neuere Konfigurationsmöglichkeiten<br />
Weitere Links<br />
https://webdesign.tutsplus.com/tutorials/a-beginners-introduction-to-writing-modules-in-processwire--cms-26862<br />
https://processwire.com/docs/modules/ - Introduction, Development, Hooks, Types, Pro Modules, Third Party<br />
<br />
<br />
<br />
<br />
[[ProcessWire - Module Snippets]]<br />
<br />
== Wo - Was ? ==<br />
=== Welche Typen von Modulen gibt es ? ===<br />
https://processwire.com/docs/modules/types/<br />
* '''Fieldtype''': Repräsentiert einen Datentyp. Meistens keine Public API, Handelt Daten / Datenbank - https://processwire.com/api/ref/fieldtype/<br />
* '''Inputfield''': Sammelt User Eingaben über ein Formular im Admin Bereich. Im Gegensatz zum Fieldtype geht es hier um das UI im Backend. Das Handling der Daten liegt beim Fieldtype.<br />
* '''Process''' for creating admin processes/applications.<br />
* '''Textformatter''' for formatting text.<br />
* '''AdminTheme''' for creating themes in the admin.<br />
* '''WireMail''' for modules that send email and extend the WireMail class.<br />
* '''Tfa''' for implementing a specific kind of two-factor authentication.<br />
* '''ImageSizerEngine''' for modules that extend ImageSizerEngine for resizing images.<br />
* '''FileCompiler''' for modules that extend FileCompilerModule for compilation of files.<br />
* '''FileValidator''' for modules that extend FileValidatorModule for validation of files.<br />
<br />
=== Wie werden Felder in der Datenbank angelegt ? ===<br />
Dazu nutzt man den Typ "Fieldtype"<br />
<br />
=== Wo rendert man die Ausgabe ? ===<br />
Bei Ryan Cramers Event Beispiel legt er zwei Klassen Event und EventArray an, die auch die Render Funktionen enthalten.<br />
<br />
== Spezielle Funktionen in Modulen ==<br />
<br />
=== getModuleInfo ===<br />
Ist die einzige Pflichtfunktion in Modulen. Hier werden title, version, summary und weitere Daten hinterlegt. Hier kann man auch angeben ob ein Modul ein Autoload Modul ist.<br />
<br />
Statt einer getModuleInfo() Funktion kann man auch eine json Konfiguration als Datei hinterlegen<br />
<br />
Siehe Beispiel unten<br />
<br />
=== init ===<br />
public function init(){}<br />
Initialisiert das Modul. ProcessWire ruft diese Funktion auf, wenn das Modul geladen ist. Bei Autoload Modulen wird es aufgerufen wenn die ProcessWire API bereit ist. Daher ist es ein guter Ort um Hooks einzubinden.<br />
<br />
=== ready ===<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
if($this->page->template == 'admin') {<br />
$this->message($this->hi());<br />
}<br />
}<br />
</syntaxhighlight><br />
Wird in autoload Modulen aufgerufen wenn die API bereit ist. Nützlich für Hooks:<br />
<br />
=== execute ===<br />
<syntaxhighlight lang="php"><br />
/**<br />
* This function is executed when a page with your Process assigned is accessed. <br />
*<br />
* This can be seen as your main or index function. You'll probably want to replace<br />
* everything in this function. <br />
*<br />
*/<br />
public function ___execute() {<br />
// greetingType and greeting are automatically populated to this module<br />
// and they were defined in ProcessHello.config.php<br />
if($this->greetingType == 'message') {<br />
$this->message($this->greeting); <br />
} else if($this->greetingType == 'warning') {<br />
$this->warning($this->greeting); <br />
} else {<br />
$this->error($this->greeting); <br />
}<br />
// generate some navigation<br />
$out = "<br />
<h2>$this->greeting</h2><br />
<dl class='nav'><br />
<dt><a href='./something/'>Do Something</a></dt><br />
<dd>Runs the executeSomething() function.</dd><br />
</dl><br />
";<br />
return $out;<br />
} <br />
</syntaxhighlight><br />
<br />
=== executeSomething ===<br />
<syntaxhighlight lang="php"><br />
/**<br />
* Called when the URL is this module's page URL + "/something/"<br />
*<br />
*/<br />
public function ___executeSomething() {<br />
// set a new headline, replacing the one used by our page<br />
// this is optional as PW will auto-generate a headline <br />
$this->headline('This is something!'); <br />
// add a breadcrumb that returns to our main page <br />
// this is optional as PW will auto-generate breadcrumbs<br />
$this->breadcrumb('../', 'Hello'); <br />
$out = "<br />
<h2>Not much to to see here</h2><br />
<p><a href='../'>Go Back</a></p><br />
";<br />
return $out; <br />
}<br />
</syntaxhighlight><br />
<br />
=== install & uninstall ===<br />
<syntaxhighlight lang="php"><br />
<br />
/**<br />
* Called only when your module is installed<br />
*<br />
* If you don't need anything here, you can simply remove this method. <br />
*<br />
*/<br />
public function ___install() {<br />
parent::___install(); // always remember to call parent method<br />
}<br />
/**<br />
* Called only when your module is uninstalled<br />
*<br />
* This should return the site to the same state it was in before the module was installed. <br />
*<br />
* If you don't need anything here, you can simply remove this method. <br />
*<br />
*/<br />
public function ___uninstall() {<br />
parent::___uninstall(); // always remember to call parent method<br />
}<br />
</syntaxhighlight><br />
<br />
== Vererbung und Eigenschaften in Modulen ==<br />
Modules are not different from PHP classes.<br />
<br />
To change the properties of MyModule class from within MyOtherModule class, you can either:<br />
<br />
#Make MyOtherModule class extend MyModule. It will thus inherit MyModule's public and protected properties and methods<br />
#Make the properties firstName and lastName configurable by passing them as parameters/arguments in MyModule's constructor method.<br />
<br />
== Autoload Module und Hooks ==<br />
Autoload werden automatisch geladen müssen also nicht in einem Template o.ä. gestartet werden. Daher bieten sie sich an um die Funktionalität von ProcessWire zu erweitern. Als Werkzeug dafür dienen Hooks. Mit Hooks kann man an vielen Stellen den Rendering Process der Seiten beeinflussen. Außerdem kann man für eigene Module ebenfalls Hooks bereitstellen. <br />
<br />
=== Hooks ===<br />
https://processwire.com/docs/modules/hooks/<br />
Hooks sind ein mächtiges Werkzeug. Sie geben einem die Möglichkeit an vielen Stellen "einzuhaken" und Funktionalität einzubauen.<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
$this->addHookAfter('Page::render', function($event) {<br />
$event->return .= '<p>Hallo</p>';<br />
});<br />
}<br />
</syntaxhighlight><br />
Schreibt am Ende Jeder Seite ein "Hallo". Das $event Objekt ist ein [https://processwire.com/api/ref/hook-event/ HookEvent]. Im Beispiel fügen wir einfach etwas Markup hinzu. Über $event->arguments() kann man aber auf ale Argumente zugreifen.<br />
<br />
Das gleiche aber nicht mit anonymer Funktion:<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
// add hook after Page::render() and make it call the "test" method of $this module<br />
$this->addHookAfter('Page::render', $this, 'test');<br />
}<br />
<br />
public function test($event) {<br />
// modify the return value of Page::render() to include the following:<br />
$event->return .= '<p>Hallo</p>';<br />
}<br />
</syntaxhighlight><br />
<br />
=== Hooks zum erweitern von existierenden Klassen nutzen ===<br />
Mit Hooks kann man in vorhandene Klassen einhaken. Z.B. läßt sich das Page Objekt erweitern.<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
$this->addHook('Page::summarize', $this, 'summarize');<br />
}<br />
public function summarize($event) {<br />
$page = $event->object; // the $event->object represents the object hooked (Page)<br />
$maxlen = $event->arguments(0); // first argument is the optional max length<br />
if(!$maxlen) $maxlen = 200; // if no $maxlen was present, we'll use a default of 200<br />
$summary = $this->sanitizer->truncate($page->body, $maxlen); // use sanitizer truncate method to create a summary<br />
$event->return = $summary; // populate $summary to $event->return, the return value<br />
}<br />
</syntaxhighlight><br />
So kann man ganz einfach eine Zusammenfassung aller Kindseiten in einem Template rendern:<br />
<syntaxhighlight lang="php"><br />
foreach($page->children as $item) {<br />
$summary = $item->summarize(150);<br />
echo "<li><a href='$item->url'>$item->title</a><br>$summary";<br />
}<br />
</syntaxhighlight><br />
<br />
=== Hook Beispiele ===<br />
Hook am Ende des Renderings<br />
$this->addHookAfter('Page::render', function($event) {...});<br />
Füge eine Funktion "summarize" zum Page Objekt hinzu.<br />
$this->addHook('Page::summarize', $this, 'summarize');<br />
Hook auf eine einzelne Instanz (hier pages Objekt)<br />
$this->pages->addHookAfter('saved', function($event){...});<br />
$this->addHook('Page::method', ...) // Spricht ALLE Instanzen an - Regelfall<br />
$page->addHook('method', ...) // Spricht nur die EINE Instanz der Seite an.<br />
</pre><br />
<br />
=== Autoload Module nur im Admin Bereich laden ===<br />
'autoload' => 'template=admin' <br />
statt<br />
'autoload' => true<br />
<br />
== CSS und JavaScript in Modulen ==<br />
Bei Process Modulen möchte man für das Styling etc. im Backend oft CSS und JS Dateien hinzufügen.<br />
<br />
Einfach Eine Datei MeinModul.css und / oder MeinModul.js hinzufügen. JQuery ist im Admin bereits geladen daher kann eine MeinModul.js Starter Datei so aussehen:<br />
<br />
<pre><br />
<br />
/**<br />
* This JS file is only loaded when the ProcessHello module is run<br />
*<br />
* You should delete it if you have no javascript to add.<br />
*<br />
*/<br />
<br />
$(document).ready(function() {<br />
// do something<br />
}); <br />
</pre><br />
<br />
== Beispiele ==<br />
=== Frontend Rendering Module ===<br />
A bit old but working<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
/**<br />
* FrontEndRender<br />
*<br />
* Author: Ben Byford<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2010 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class FrontEndRender extends WireData implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'FrontEndRender',<br />
'version' => 0.1,<br />
'summary' => "Outputs html and static variables to frontend",<br />
'author' => 'Ben Byford',<br />
'singular' => true,<br />
'href' => 'https://github.com/benbyford/PW-starter-modules'<br />
);<br />
}<br />
<br />
// protected variable only accessable within module<br />
protected $name = 'Ben';<br />
<br />
/*<br />
* render function to be called in PW template like this:<br />
* $FrontEndRender = $modules->getModule('FrontEndRender');<br />
* echo '<h1>' . $FrontEndRender->render() . '</h1>';<br />
*<br />
*/<br />
public function render(){<br />
return "Hello " . $this->name;<br />
}<br />
}<br />
?><br />
</syntaxhighlight><br />
<br />
=== ProcessWire Hello World Modul ===<br />
Beispiel Modul mit Hooks (liegt immer in der Standardinstallation)<br />
<syntaxhighlight lang="php"><br />
<?php namespace ProcessWire;<br />
<br />
/**<br />
* ProcessWire 'Hello world' demonstration module<br />
*<br />
* Demonstrates the Module interface and how to add hooks.<br />
* <br />
* See README file for further links regarding module development.<br />
* <br />
* This file is licensed under the MIT license<br />
* https://processwire.com/about/license/mit/<br />
* <br />
* ProcessWire 3.x, Copyright 2016 by Ryan Cramer<br />
* https://processwire.com<br />
*<br />
*/<br />
<br />
class Helloworld extends WireData implements Module {<br />
<br />
/**<br />
* getModuleInfo is a module required by all modules to tell ProcessWire about them<br />
*<br />
* @return array<br />
*<br />
*/<br />
public static function getModuleInfo() {<br />
<br />
return array(<br />
<br />
// The module's title, typically a little more descriptive than the class name<br />
'title' => 'Hello World', <br />
<br />
// version number <br />
'version' => 3, <br />
<br />
// summary is brief description of what this module is<br />
'summary' => 'An example module used for demonstration purposes.',<br />
<br />
// Optional URL to more information about the module<br />
'href' => 'https://processwire.com',<br />
<br />
// singular=true: indicates that only one instance of the module is allowed.<br />
// This is usually what you want for modules that attach hooks. <br />
'singular' => true, <br />
<br />
// autoload=true: indicates the module should be started with ProcessWire.<br />
// This is necessary for any modules that attach runtime hooks, otherwise those<br />
// hooks won't get attached unless some other code calls the module on it's own.<br />
// Note that autoload modules are almost always also 'singular' (seen above).<br />
'autoload' => true, <br />
<br />
// Optional font-awesome icon name, minus the 'fa-' part<br />
'icon' => 'smile-o', <br />
);<br />
}<br />
<br />
/**<br />
* Initialize the module<br />
*<br />
* ProcessWire calls this when the module is loaded. For 'autoload' modules, this will be called<br />
* when ProcessWire's API is ready. As a result, this is a good place to attach hooks. <br />
*<br />
*/<br />
public function init() {<br />
<br />
// add a hook after the $pages->save, to issue a notice every time a page is saved<br />
$this->pages->addHookAfter('save', $this, 'example1'); <br />
<br />
// add a hook after each page is rendered and modify the output<br />
$this->addHookAfter('Page::render', $this, 'example2'); <br />
<br />
// add a 'hello' method to every page that returns "Hello World"<br />
// use "echo $page->hello();" in your template file to display output<br />
$this->addHook('Page::hello', $this, 'example3'); <br />
<br />
// add a 'hello_world' property to every page that returns "Hello [user]"<br />
// use "echo $page->hello_world;" in your template file to display output<br />
$this->addHookProperty('Page::hello_world', $this, 'example4'); <br />
}<br />
<br />
/**<br />
* Example1 hooks into the pages->save method and displays a notice every time a page is saved<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example1($event) {<br />
/** @var Page $page */<br />
$page = $event->arguments[0]; <br />
$this->message("Hello World! You saved {$page->path}."); <br />
}<br />
<br />
<br />
/**<br />
* Example2 hooks into every page after it's rendered and adds "Hello World" text at the bottom<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example2($event) {<br />
<br />
/** @var Page $page */<br />
$page = $event->object; <br />
<br />
// don't add this to the admin pages<br />
if($page->template == 'admin') return;<br />
<br />
// add a "Hello World" paragraph right before the closing body tag<br />
$event->return = str_replace("</body>", "<p>Hello World!</p></body>", $event->return); <br />
}<br />
<br />
/**<br />
* Example3 adds a 'hello' method (not property) to every page that simply returns "Hello World"<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example3($event) {<br />
$event->return = "Hello World";<br />
}<br />
<br />
/**<br />
* Example 4 adds a 'hello_world' property (not method) to every page that returns "Hello [user]"<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example4($event) {<br />
$event->return = "Hello " . $this->user->name; <br />
}<br />
<br />
}<br />
<br />
</syntaxhighlight><br />
<br />
=== ProcessWire Admin Bereich mit eigener Funktionalität erweitern (Modul)===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<syntaxhighlight lang="php"><br />
<br />
<?php<br />
/**<br />
* ProcessSimpleAdminPage<br />
*<br />
* @author Ben Byford<br />
* http://www.benbyford.com<br />
*<br />
* @see http://www.processwire.com<br />
*/<br />
<br />
class ProcessSimpleAdminPage extends Process {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'Process Simple Admin Page',<br />
'summary' => 'Simple Process module that adds new admin page with',<br />
'version' => 001,<br />
<br />
// Modules that extend Process may specify a 'page' attribute in the<br />
// getModuleInfo(), this page will automatically be given the module<br />
// process when added to teh pagetree.<br />
<br />
// I have exampled but commented out the 'page' settings below<br />
// so that I can show how one might add a page to install() and<br />
// uninstall() in this and other modules (that might not extend<br />
// Process)<br />
<br />
<br />
// 'page' => array(<br />
// 'name' => 'site-config',<br />
// 'parent' => 'admin',<br />
// 'title' => 'Site Config'<br />
// )<br />
);<br />
}<br />
<br />
public function execute() {<br />
return '<br />
<h2>Edit the text here in the module</h2><br />
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam mattis eros vitae metus sodales eget suscipit purus rhoncus. Proin ultrices gravida dolor, non porttitor enim interdum vitae. Integer feugiat lacinia tincidunt. Nulla laoreet tristique tristique. Sed elementum justo a nisl elementum sit amet accumsan nisi tempor. Nulla quis eros et massa dignissim imperdiet a vitae purus.</p><br />
<br />
<p>Donec scelerisque pulvinar sem eu lobortis. Maecenas turpis ipsum, tempus dictum pharetra eu, consectetur vitae arcu. Fusce orci mauris, semper at tempus quis, volutpat molestie tellus. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Sed quam tortor, tincidunt sed semper lacinia, scelerisque dapibus quam. Morbi at nisi luctus lacus auctor ultrices eu eu leo.</p><br />
<br />
<p>Praesent faucibus purus id felis tincidunt dignissim. Sed sit amet ligula mi, eget semper dui. Proin consectetur gravida massa, nec luctus purus hendrerit in. Etiam volutpat, elit non venenatis suscipit, libero neque consectetur diam, id rutrum magna odio ac ligula. Maecenas sollicitudin congue neque fermentum vestibulum. Morbi nec leo nisi. Donec at nisl odio, et porta ligula.</p><br />
<br />
<p>Sed quis arcu nisi, ac tempor augue. Praesent non elit libero, a ullamcorper lorem. Curabitur porta odio eu nunc ultricies interdum id nec risus. Donec nibh nibh, porta eget vehicula ac, aliquet eget ante. Phasellus eget lorem eu eros eleifend ultrices. Cras sit amet neque sit amet nibh fringilla cursus ut id mauris. Praesent quis nunc justo, sed suscipit lectus. Phasellus eget ultrices risus. Curabitur eu semper est. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Ut suscipit, nisl ut imperdiet eleifend, turpis arcu placerat tortor, nec laoreet lacus neque ac tellus. Aenean ac lacus justo, quis ultricies nisi.</p><br />
';<br />
}<br />
public function install(){<br />
<br />
// create new page to add to CMS<br />
$page = new Page();<br />
<br />
// add page attributes<br />
$page->template = "admin";<br />
$page->name = "cms-faq";<br />
$page->title = "CMS FAQ";<br />
$page->save();<br />
<br />
// set this module as the page process, this allows us to display the above<br />
$page->process = 'ProcessSimpleAdminPage';<br />
<br />
// get admin page and set as page parent<br />
$admin = $this->pages->get("id=2");<br />
$page->parent = $admin;<br />
<br />
// save page<br />
$page->save();<br />
}<br />
<br />
public function uninstall(){<br />
<br />
// delete created page<br />
$page = $this->pages->get("name=cms-faq");<br />
if(count($page)) $this->pages->delete($page, true);<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
=== ProcessWire Textformatter Modul ===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
/**<br />
* TextformatterFindReplace<br />
*<br />
* Author: Ben Byford<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2010 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class TextformatterFindReplace extends Textformatter implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'TextformatterFindReplace',<br />
'version' => 0.1,<br />
'summary' => "Finds and replaces any instance of config input to config output",<br />
'author' => 'Ben Byford',<br />
'singular' => true,<br />
'href' => 'https://github.com/benbyford/PW-starter-modules'<br />
);<br />
}<br />
<br />
<br />
/**<br />
* Find and Replace the input string<br />
*<br />
* @param string $str The block of text to parse<br />
*<br />
* The incoming string is replaced with the formatted version of itself.<br />
**/<br />
<br />
public function format(&$str) {<br />
$find = $this->findStr;<br />
$str = preg_replace_callback($find, array($this,"replace"), $str);<br />
<br />
}<br />
<br />
// adding three underscores to a function allows other modules to hook it<br />
public function ___replace($match) {<br />
return $this->replaceStr;<br />
}<br />
}<br />
?><br />
</syntaxhighlight><br />
<br />
=== Admin Funktionalität: Countdown zum Seitenveröffentlichen ===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<br />
The module PageDeferredPublish, on clicking one of the '''Publish Later buttons''', sets LazyCron to check that page’s countdown every minute and publishes the page when its countdown reaches 0. This means I can publish a page approximately 24 hours in advance (obviously the checking interval and delay time can be changed to your requirements).<br />
<br />
I did this by:<br />
<br />
'''Creating two fields''' within my install() function: a checkbox field to set to true when a button is checked to indicate the page should countdown, and a countdown field to store the count in seconds for that specific page.<br />
<br />
'''Adding hooks''' to both ''ProcessPageEdit::buildForm'' and ''ProcessPageListActions::getExtraActions'' enabling me to add the two buttons.<br />
<br />
Checking to see if one of the buttons was clicked with my '''ready() function''' then setting the corresponding page’s checkbox to true.<br />
<br />
Using a '''LazyCron hook function''' to check all pages that are unpublished for true checkboxes and then comparing the seconds field to see if the page needs publishing. If not then deduct the elapsed time in seconds.<br />
<br />
The result is a '''module that has settings''' (the time interval to check and publish at a later time), '''hooks into the admin''' using buttons and fields, and enables us to '''use other modules installe'''d in PW (i.e. LazyCron).<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
/**<br />
* DeferredPublish (0.0.1)<br />
* DeferredPublish publishes a page after a defined amount of time has elapsed using lazycron.<br />
*<br />
* @author Ben Byford<br />
* http://www.benbyford.com<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2011 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class PageDeferredPublish extends WireData implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => "PageDeferredPublish",<br />
'version' => "0.0.1",<br />
'summary' => "PageDeferredPublish",<br />
'author' => "Ben Byford",<br />
'href' => "https://github.com/benbyford/PW-intermediate-modules",<br />
'icon' => "clock-o",<br />
'autoload' => true,<br />
'singular' => true,<br />
'requires' => "LazyCron",<br />
);<br />
}<br />
<br />
private $postPubLater = null;<br />
private $pageID = null;<br />
private $pagePubLater = null;<br />
private $currentPage = null;<br />
<br />
private $submitName = 'pdp_pub_later_submit';<br />
private $listPageName = 'pdp_pub_later_list';<br />
private $fieldName = 'pdp_pub_later';<br />
private $checkboxName = 'pdp_pub_later_check';<br />
<br />
private $defaultInterval = 'everyMinute';<br />
private $defaultTime = 86400;<br />
<br />
<br />
public function install(){<br />
// add new fields needed for module<br />
$this->installFields();<br />
}<br />
public function uninstall(){<br />
// uninstall fields<br />
$this->uninstallFields();<br />
}<br />
<br />
// initialize the hook in your AutoLoad module<br />
public function init() {<br />
<br />
// get defaults from module setting in CMS<br />
$this->defaultTime = $this->pub_after;<br />
$this->defaultInterval = $this->cron_check;<br />
<br />
// get admin URL<br />
$this->adminUrl = $this->wire('config')->urls->admin;<br />
<br />
// add hooks to CRON, PageList, PageEdit<br />
$this->addHookAfter("LazyCron::{$this->defaultInterval}", $this, 'publishDefferedPages');<br />
$this->addHook("ProcessPageListActions::getExtraActions", $this, 'hookPageListActions');<br />
$this->addHookAfter("ProcessPageEdit::buildForm", $this, "editForm");<br />
}<br />
<br />
public function ready() {<br />
<br />
// if list button clicked then grab id<br />
$this->pagePubLater = $this->input->get($this->listPageName);<br />
$this->pageID = $this->input->id;<br />
<br />
// get page<br />
$this->currentPage = $this->pages->get($this->pageID);<br />
<br />
// if pagelist pub later submit button clicked<br />
if($this->pagePubLater){<br />
$this->message("Page {$this->currentPage->name} deffered for publish.");<br />
}<br />
<br />
// if page edit submit button clicked<br />
$this->postPubLater = $this->input->post($this->submitName);<br />
if($this->postPubLater){<br />
$this->message("Page {$this->currentPage->name} deffered for publish.");<br />
}<br />
<br />
// if either deffered publish sumbit found then publish page later<br />
if($this->pagePubLater || $this->postPubLater){<br />
$this->publishLater();<br />
}<br />
}<br />
<br />
/*<br />
* Hook: ProcessPageEdit::buildForm<br />
*<br />
* add Publish Later button to edit page if not yet published<br />
*/<br />
public function ___editForm(HookEvent $form) {<br />
<br />
// get the InputFieldForm object from the event (return value of buildForm())<br />
$form = $form->return;<br />
<br />
$page = $this->pages->get($this->input->get->id);<br />
$check = $page->get($this->checkboxName);<br />
<br />
// check if publish button available and therfore unpublished<br />
$target = $form->get('submit_publish');<br />
<br />
if($target && $check == false){<br />
<br />
// get InputfieldText module<br />
$submit2 = $this->modules->get('InputfieldSubmit');<br />
$submit2->attr('name', $this->submitName);<br />
$submit2->attr('id', 'publish_later');<br />
$submit2->attr('class', 'ui-button ui-widget ui-corner-all head_button_clone ui-state-default ui-priority-secondary');<br />
$submit2->attr('value', 'Publish Later'); // Button: save unpublished<br />
<br />
// get form element save and place before<br />
$target = $form->get('submit_save');<br />
$form->insertBefore($submit2, $target);<br />
<br />
$form->return = $form;<br />
}<br />
}<br />
<br />
public function ___hookPageListActions(HookEvent $event) {<br />
<br />
// get current page<br />
$page = $event->arguments[0];<br />
<br />
// check to see if page is published<br />
$pagePub = $page->is(Page::statusUnpublished);<br />
<br />
// check to see if page template has deffered field<br />
$pageHasDefferField = $page->get($this->fieldName);<br />
<br />
$actions = array();<br />
<br />
// don't get homepage or pages that are already published or are being deffered for publish<br />
if($page->id > 1 && $pagePub == "published" && !is_null($pageHasDefferField) && $page->get($this->checkboxName) == false) {<br />
<br />
$actions['publish_later'] = array(<br />
'cn' => 'PublishLater',<br />
'name' => 'pub later',<br />
'url' => "{$this->adminUrl}?{$this->listPageName}=1&id={$page->id}",<br />
);<br />
}<br />
if(count($actions)) $event->return = $actions + $event->return;<br />
}<br />
<br />
/*<br />
* Publish Page on cron job<br />
*<br />
* Gets deffered page and publishes<br />
*/<br />
public function ___publish($page) {<br />
$page->removeStatus(Page::statusUnpublished);<br />
$page->removeStatus(Page::statusHidden);<br />
$page->Save();<br />
}<br />
<br />
/*<br />
* Main publish later function<br />
*<br />
* Gets deffered page and sets fields to be checked be lazy cron<br />
*/<br />
private function ___publishLater() {<br />
<br />
// get page<br />
$page = $this->pages->get($this->pageID);<br />
<br />
// set output formatting to false<br />
$page->of(false);<br />
<br />
// set field time to settings default time and checkbox to true<br />
$page->set($this->checkboxName, true);<br />
$page->set($this->fieldName, $this->defaultTime);<br />
<br />
// save page<br />
$page->save();<br />
$page->of(true);<br />
}<br />
<br />
/*<br />
* Lazy Cron hook function<br />
*<br />
* Triggers every [set time interval] and checks pages<br />
* Publishes page if time runout<br />
*<br />
* Adds publish page log<br />
*/<br />
public function ___publishDefferedPages(HookEvent $e){<br />
<br />
// seconds since last lazycron<br />
$seconds = $e->arguments[0];<br />
<br />
// find all pages with deffered field<br />
$defferedPages = $this->pages->find("{$this->checkboxName}=1,include=unpublished");<br />
<br />
// for each page decrease time for deffered field<br />
foreach ($defferedPages as $page) {<br />
<br />
// get current page time<br />
$timeTillPublish = $page->get($this->fieldName);<br />
<br />
// set time to time minus time past<br />
$timeLeft = $timeTillPublish - $seconds;<br />
<br />
// if time passed 0 or less then publish page<br />
$page->of(false);<br />
if($timeLeft <= 0){<br />
// remove flags and save<br />
$this->publish($page);<br />
<br />
$page->set($this->fieldName, 0);<br />
$page->set($this->checkboxName, 0);<br />
<br />
// log a page has been published<br />
$log = wire('log');<br />
$log->message('CRON:'. $seconds .' Pages: '. $page->name .' published');<br />
}else{<br />
$page->set($this->fieldName, $timeLeft);<br />
}<br />
// save page time<br />
$page->Save();<br />
$page->of(true);<br />
}<br />
}<br />
<br />
/*<br />
* Install new module specific fields<br />
*/<br />
private function installFields(){<br />
<br />
// install pub later checkbox field<br />
// find installed fields<br />
$f = $this->fields->get($this->fieldName);<br />
if($f){<br />
<br />
// if field already found then don't try and make it<br />
$this->message($this->fieldName . ' field found');<br />
<br />
}else{<br />
<br />
// create new field object to store crontime<br />
$f = new Field();<br />
// get a field type<br />
$f->type = $this->modules->get("FieldtypeInteger");<br />
$f->name = $this->fieldName;<br />
$f->label = 'Publish Time Left';<br />
$f->defaultValue = $this->defaultTime;<br />
$f->icon = 'clock-o';<br />
$f->columnWidth = 50;<br />
$f->collapsed = 1;<br />
$f->flags = 4;<br />
<br />
$f->save(); // save the field<br />
<br />
// create new field object to store whether to publish or not<br />
$f = new Field();<br />
// get a field type<br />
$f->type = $this->modules->get("FieldtypeCheckbox");<br />
$f->name = $this->checkboxName;<br />
$f->label = 'Publish Page later';<br />
$f->defaultValue = false;<br />
$f->columnWidth = 50;<br />
$f->icon = 'clock-o';<br />
$f->collapsed = 1;<br />
$f->flags = 4;<br />
<br />
$f->save(); // save the field<br />
}<br />
}<br />
<br />
/*<br />
* Uninstall module specific fields<br />
*/<br />
private function uninstallFields(){<br />
<br />
// find installed fields<br />
$fInt = $this->fields->get($this->fieldName);<br />
$fCheck = $this->fields->get($this->checkboxName);<br />
<br />
if($fInt && $fCheck){<br />
$fieldIntUsed = $fInt->numFieldgroups();<br />
$fieldCheckUsed = $fCheck->numFieldgroups();<br />
<br />
if($fieldIntUsed){<br />
// field in use by template<br />
$this->message('Unable to uninstall field '.$fInt->name);<br />
}else{<br />
// delete installed fields<br />
$this->fields->delete($fInt);<br />
$this->fields->save;<br />
}<br />
<br />
if($fieldCheckUsed){<br />
// field in use by template<br />
$this->message('Unable to uninstall field '.$fCheck->name);<br />
}else{<br />
// delete installed fields<br />
$this->fields->delete($fCheck);<br />
$this->fields->save;<br />
}<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
=== Inputfield / Fieldtype ===<br />
[[ProcessWire - Fieldtype erstellen (Module)]]<br />
<br />
=== Konfigurationsdatei statt getModuleInfo ==<br />
<syntaxhighlight lang="php"><br />
<?php<br />
/**<br />
* ProcessHello.info.php<br />
* <br />
* Return information about this module.<br />
*<br />
* If preferred, you can use a getModuleInfo() method in your module file, <br />
* or you can use a ModuleName.info.json file (if you prefer JSON definition). <br />
*<br />
*/<br />
$info = array(<br />
// Your module's title<br />
'title' => 'Hello: Process Module Example', <br />
// A 1 sentence description of what your module does<br />
'summary' => 'A starting point module skeleton from which to build your own Process module.', <br />
// Module version number: use 1 for 0.0.1 or 100 for 1.0.0, and so on<br />
'version' => 1, <br />
// Name of person who created this module (change to your name)<br />
'author' => 'Ryan Cramer', <br />
// Icon to accompany this module (optional), uses font-awesome icon names, minus the "fa-" part<br />
'icon' => 'thumbs-up', <br />
// URL to more info: change to your full modules.processwire.com URL (if available), or something else if you prefer<br />
'href' => 'http://modules.processwire.com/', <br />
// name of permission required of users to execute this Process (optional)<br />
'permission' => 'helloworld', <br />
// permissions that you want automatically installed/uninstalled with this module (name => description)<br />
'permissions' => array(<br />
'helloworld' => 'Run the HelloWorld module'<br />
), <br />
<br />
// page that you want created to execute this module<br />
'page' => array(<br />
'name' => 'helloworld',<br />
'parent' => 'setup', <br />
'title' => 'Hello World'<br />
),<br />
// optional extra navigation that appears in admin<br />
// if you change this, you'll need to a Modules > Refresh to see changes<br />
'nav' => array(<br />
array(<br />
'url' => '', <br />
'label' => 'Hello', <br />
'icon' => 'smile-o', <br />
), <br />
array(<br />
'url' => 'something/', <br />
'label' => 'Something', <br />
'icon' => 'beer', <br />
),<br />
)<br />
// for more options that you may specify here, see the file: /wire/core/Process.php<br />
// and the file: /wire/core/Module.php<br />
);<br />
</syntaxhighlight></div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Module_schreiben&diff=24251ProcessWire - Module schreiben2020-01-06T10:16:59Z<p>84.136.104.26: /* getModuleInfo */</p>
<hr />
<div>== Links ==<br />
Wichtigste Resourcen<br />
https://processwire.com/docs/modules/development/ - Guter Ausgangspunkt<br />
https://processwire.com/api/ref/module/ - Module API<br />
https://processwire.com/api/ref/configurable-module/ - Klasse für Konfigurierbare Module<br />
https://processwire.com/docs/modules/types/ - Welche Modultypen gibt es ?<br />
https://github.com/ryancramerdesign/ProcessHello - Modul Skelett Beispiel für eigene Backend (Process) Module<br />
https://github.com/ryancramerdesign/FieldtypeMapMarker - Beispiel für ein Fieldtype und Inputfield Modul<br />
https://processwire.com/talk/topic/778-module-dependencies/ - Module die andere Module benötigen<br />
https://processwire.com/talk/forum/19-moduleplugin-development/ - Forum zum Thema Module entwickeln<br />
http://somatonic.github.io/Captain-Hook/ - Hook Cheatsheet<br />
https://processwire.com/blog/posts/new-module-configuration-options/ - Neuere Konfigurationsmöglichkeiten<br />
Weitere Links<br />
https://webdesign.tutsplus.com/tutorials/a-beginners-introduction-to-writing-modules-in-processwire--cms-26862<br />
https://processwire.com/docs/modules/ - Introduction, Development, Hooks, Types, Pro Modules, Third Party<br />
<br />
<br />
<br />
<br />
[[ProcessWire - Module Snippets]]<br />
<br />
== Wo - Was ? ==<br />
=== Welche Typen von Modulen gibt es ? ===<br />
https://processwire.com/docs/modules/types/<br />
* '''Fieldtype''': Repräsentiert einen Datentyp. Meistens keine Public API, Handelt Daten / Datenbank - https://processwire.com/api/ref/fieldtype/<br />
* '''Inputfield''': Sammelt User Eingaben über ein Formular im Admin Bereich. Im Gegensatz zum Fieldtype geht es hier um das UI im Backend. Das Handling der Daten liegt beim Fieldtype.<br />
* '''Process''' for creating admin processes/applications.<br />
* '''Textformatter''' for formatting text.<br />
* '''AdminTheme''' for creating themes in the admin.<br />
* '''WireMail''' for modules that send email and extend the WireMail class.<br />
* '''Tfa''' for implementing a specific kind of two-factor authentication.<br />
* '''ImageSizerEngine''' for modules that extend ImageSizerEngine for resizing images.<br />
* '''FileCompiler''' for modules that extend FileCompilerModule for compilation of files.<br />
* '''FileValidator''' for modules that extend FileValidatorModule for validation of files.<br />
<br />
=== Wie werden Felder in der Datenbank angelegt ? ===<br />
Dazu nutzt man den Typ "Fieldtype"<br />
<br />
=== Wo rendert man die Ausgabe ? ===<br />
Bei Ryan Cramers Event Beispiel legt er zwei Klassen Event und EventArray an, die auch die Render Funktionen enthalten.<br />
<br />
== Spezielle Funktionen in Modulen ==<br />
<br />
=== getModuleInfo ===<br />
Ist die einzige Pflichtfunktion in Modulen. Hier werden title, version, summary und weitere Daten hinterlegt. Hier kann man auch angeben ob ein Modul ein Autoload Modul ist.<br />
<br />
Statt einer getModuleInfo() Funktion kann man auch eine json Konfiguration als Datei hinterlegen<br />
<br />
Siehe Beispiel unten<br />
<br />
=== init ===<br />
public function init(){}<br />
Initialisiert das Modul. ProcessWire ruft diese Funktion auf, wenn das Modul geladen ist. Bei Autoload Modulen wird es aufgerufen wenn die ProcessWire API bereit ist. Daher ist es ein guter Ort um Hooks einzubinden.<br />
<br />
=== ready ===<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
if($this->page->template == 'admin') {<br />
$this->message($this->hi());<br />
}<br />
}<br />
</syntaxhighlight><br />
Wird in autoload Modulen aufgerufen wenn die API bereit ist. Nützlich für Hooks:<br />
<br />
=== execute ===<br />
<syntaxhighlight lang="php"><br />
/**<br />
* This function is executed when a page with your Process assigned is accessed. <br />
*<br />
* This can be seen as your main or index function. You'll probably want to replace<br />
* everything in this function. <br />
*<br />
*/<br />
public function ___execute() {<br />
// greetingType and greeting are automatically populated to this module<br />
// and they were defined in ProcessHello.config.php<br />
if($this->greetingType == 'message') {<br />
$this->message($this->greeting); <br />
} else if($this->greetingType == 'warning') {<br />
$this->warning($this->greeting); <br />
} else {<br />
$this->error($this->greeting); <br />
}<br />
// generate some navigation<br />
$out = "<br />
<h2>$this->greeting</h2><br />
<dl class='nav'><br />
<dt><a href='./something/'>Do Something</a></dt><br />
<dd>Runs the executeSomething() function.</dd><br />
</dl><br />
";<br />
return $out;<br />
} <br />
</syntaxhighlight><br />
<br />
=== executeSomething ===<br />
<syntaxhighlight lang="php"><br />
/**<br />
* Called when the URL is this module's page URL + "/something/"<br />
*<br />
*/<br />
public function ___executeSomething() {<br />
// set a new headline, replacing the one used by our page<br />
// this is optional as PW will auto-generate a headline <br />
$this->headline('This is something!'); <br />
// add a breadcrumb that returns to our main page <br />
// this is optional as PW will auto-generate breadcrumbs<br />
$this->breadcrumb('../', 'Hello'); <br />
$out = "<br />
<h2>Not much to to see here</h2><br />
<p><a href='../'>Go Back</a></p><br />
";<br />
return $out; <br />
}<br />
</syntaxhighlight><br />
<br />
=== install & uninstall ===<br />
<syntaxhighlight lang="php"><br />
<br />
/**<br />
* Called only when your module is installed<br />
*<br />
* If you don't need anything here, you can simply remove this method. <br />
*<br />
*/<br />
public function ___install() {<br />
parent::___install(); // always remember to call parent method<br />
}<br />
/**<br />
* Called only when your module is uninstalled<br />
*<br />
* This should return the site to the same state it was in before the module was installed. <br />
*<br />
* If you don't need anything here, you can simply remove this method. <br />
*<br />
*/<br />
public function ___uninstall() {<br />
parent::___uninstall(); // always remember to call parent method<br />
}<br />
</syntaxhighlight><br />
<br />
== Vererbung und Eigenschaften in Modulen ==<br />
Modules are not different from PHP classes.<br />
<br />
To change the properties of MyModule class from within MyOtherModule class, you can either:<br />
<br />
#Make MyOtherModule class extend MyModule. It will thus inherit MyModule's public and protected properties and methods<br />
#Make the properties firstName and lastName configurable by passing them as parameters/arguments in MyModule's constructor method.<br />
<br />
== Autoload Module und Hooks ==<br />
Autoload werden automatisch geladen müssen also nicht in einem Template o.ä. gestartet werden. Daher bieten sie sich an um die Funktionalität von ProcessWire zu erweitern. Als Werkzeug dafür dienen Hooks. Mit Hooks kann man an vielen Stellen den Rendering Process der Seiten beeinflussen. Außerdem kann man für eigene Module ebenfalls Hooks bereitstellen. <br />
<br />
=== Hooks ===<br />
https://processwire.com/docs/modules/hooks/<br />
Hooks sind ein mächtiges Werkzeug. Sie geben einem die Möglichkeit an vielen Stellen "einzuhaken" und Funktionalität einzubauen.<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
$this->addHookAfter('Page::render', function($event) {<br />
$event->return .= '<p>Hallo</p>';<br />
});<br />
}<br />
</syntaxhighlight><br />
Schreibt am Ende Jeder Seite ein "Hallo". Das $event Objekt ist ein [https://processwire.com/api/ref/hook-event/ HookEvent]. Im Beispiel fügen wir einfach etwas Markup hinzu. Über $event->arguments() kann man aber auf ale Argumente zugreifen.<br />
<br />
Das gleiche aber nicht mit anonymer Funktion:<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
// add hook after Page::render() and make it call the "test" method of $this module<br />
$this->addHookAfter('Page::render', $this, 'test');<br />
}<br />
<br />
public function test($event) {<br />
// modify the return value of Page::render() to include the following:<br />
$event->return .= '<p>Hallo</p>';<br />
}<br />
</syntaxhighlight><br />
<br />
=== Hooks zum erweitern von existierenden Klassen nutzen ===<br />
Mit Hooks kann man in vorhandene Klassen einhaken. Z.B. läßt sich das Page Objekt erweitern.<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
$this->addHook('Page::summarize', $this, 'summarize');<br />
}<br />
public function summarize($event) {<br />
$page = $event->object; // the $event->object represents the object hooked (Page)<br />
$maxlen = $event->arguments(0); // first argument is the optional max length<br />
if(!$maxlen) $maxlen = 200; // if no $maxlen was present, we'll use a default of 200<br />
$summary = $this->sanitizer->truncate($page->body, $maxlen); // use sanitizer truncate method to create a summary<br />
$event->return = $summary; // populate $summary to $event->return, the return value<br />
}<br />
</syntaxhighlight><br />
So kann man ganz einfach eine Zusammenfassung aller Kindseiten in einem Template rendern:<br />
<syntaxhighlight lang="php"><br />
foreach($page->children as $item) {<br />
$summary = $item->summarize(150);<br />
echo "<li><a href='$item->url'>$item->title</a><br>$summary";<br />
}<br />
</syntaxhighlight><br />
<br />
=== Hook Beispiele ===<br />
Hook am Ende des Renderings<br />
$this->addHookAfter('Page::render', function($event) {...});<br />
Füge eine Funktion "summarize" zum Page Objekt hinzu.<br />
$this->addHook('Page::summarize', $this, 'summarize');<br />
Hook auf eine einzelne Instanz (hier pages Objekt)<br />
$this->pages->addHookAfter('saved', function($event){...});<br />
$this->addHook('Page::method', ...) // Spricht ALLE Instanzen an - Regelfall<br />
$page->addHook('method', ...) // Spricht nur die EINE Instanz der Seite an.<br />
</pre><br />
<br />
=== Autoload Module nur im Admin Bereich laden ===<br />
'autoload' => 'template=admin' <br />
statt<br />
'autoload' => true<br />
<br />
== CSS und JavaScript in Modulen ==<br />
Bei Process Modulen möchte man für das Styling etc. im Backend oft CSS und JS Dateien hinzufügen.<br />
<br />
Einfach Eine Datei MeinModul.css und / oder MeinModul.js hinzufügen. JQuery ist im Admin bereits geladen daher kann eine MeinModul.js Starter Datei so aussehen:<br />
<br />
<pre><br />
<br />
/**<br />
* This JS file is only loaded when the ProcessHello module is run<br />
*<br />
* You should delete it if you have no javascript to add.<br />
*<br />
*/<br />
<br />
$(document).ready(function() {<br />
// do something<br />
}); <br />
</pre><br />
<br />
== Beispiele ==<br />
=== Frontend Rendering Module ===<br />
A bit old but working<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
/**<br />
* FrontEndRender<br />
*<br />
* Author: Ben Byford<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2010 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class FrontEndRender extends WireData implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'FrontEndRender',<br />
'version' => 0.1,<br />
'summary' => "Outputs html and static variables to frontend",<br />
'author' => 'Ben Byford',<br />
'singular' => true,<br />
'href' => 'https://github.com/benbyford/PW-starter-modules'<br />
);<br />
}<br />
<br />
// protected variable only accessable within module<br />
protected $name = 'Ben';<br />
<br />
/*<br />
* render function to be called in PW template like this:<br />
* $FrontEndRender = $modules->getModule('FrontEndRender');<br />
* echo '<h1>' . $FrontEndRender->render() . '</h1>';<br />
*<br />
*/<br />
public function render(){<br />
return "Hello " . $this->name;<br />
}<br />
}<br />
?><br />
</syntaxhighlight><br />
<br />
=== ProcessWire Hello World Modul ===<br />
Beispiel Modul mit Hooks (liegt immer in der Standardinstallation)<br />
<syntaxhighlight lang="php"><br />
<?php namespace ProcessWire;<br />
<br />
/**<br />
* ProcessWire 'Hello world' demonstration module<br />
*<br />
* Demonstrates the Module interface and how to add hooks.<br />
* <br />
* See README file for further links regarding module development.<br />
* <br />
* This file is licensed under the MIT license<br />
* https://processwire.com/about/license/mit/<br />
* <br />
* ProcessWire 3.x, Copyright 2016 by Ryan Cramer<br />
* https://processwire.com<br />
*<br />
*/<br />
<br />
class Helloworld extends WireData implements Module {<br />
<br />
/**<br />
* getModuleInfo is a module required by all modules to tell ProcessWire about them<br />
*<br />
* @return array<br />
*<br />
*/<br />
public static function getModuleInfo() {<br />
<br />
return array(<br />
<br />
// The module's title, typically a little more descriptive than the class name<br />
'title' => 'Hello World', <br />
<br />
// version number <br />
'version' => 3, <br />
<br />
// summary is brief description of what this module is<br />
'summary' => 'An example module used for demonstration purposes.',<br />
<br />
// Optional URL to more information about the module<br />
'href' => 'https://processwire.com',<br />
<br />
// singular=true: indicates that only one instance of the module is allowed.<br />
// This is usually what you want for modules that attach hooks. <br />
'singular' => true, <br />
<br />
// autoload=true: indicates the module should be started with ProcessWire.<br />
// This is necessary for any modules that attach runtime hooks, otherwise those<br />
// hooks won't get attached unless some other code calls the module on it's own.<br />
// Note that autoload modules are almost always also 'singular' (seen above).<br />
'autoload' => true, <br />
<br />
// Optional font-awesome icon name, minus the 'fa-' part<br />
'icon' => 'smile-o', <br />
);<br />
}<br />
<br />
/**<br />
* Initialize the module<br />
*<br />
* ProcessWire calls this when the module is loaded. For 'autoload' modules, this will be called<br />
* when ProcessWire's API is ready. As a result, this is a good place to attach hooks. <br />
*<br />
*/<br />
public function init() {<br />
<br />
// add a hook after the $pages->save, to issue a notice every time a page is saved<br />
$this->pages->addHookAfter('save', $this, 'example1'); <br />
<br />
// add a hook after each page is rendered and modify the output<br />
$this->addHookAfter('Page::render', $this, 'example2'); <br />
<br />
// add a 'hello' method to every page that returns "Hello World"<br />
// use "echo $page->hello();" in your template file to display output<br />
$this->addHook('Page::hello', $this, 'example3'); <br />
<br />
// add a 'hello_world' property to every page that returns "Hello [user]"<br />
// use "echo $page->hello_world;" in your template file to display output<br />
$this->addHookProperty('Page::hello_world', $this, 'example4'); <br />
}<br />
<br />
/**<br />
* Example1 hooks into the pages->save method and displays a notice every time a page is saved<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example1($event) {<br />
/** @var Page $page */<br />
$page = $event->arguments[0]; <br />
$this->message("Hello World! You saved {$page->path}."); <br />
}<br />
<br />
<br />
/**<br />
* Example2 hooks into every page after it's rendered and adds "Hello World" text at the bottom<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example2($event) {<br />
<br />
/** @var Page $page */<br />
$page = $event->object; <br />
<br />
// don't add this to the admin pages<br />
if($page->template == 'admin') return;<br />
<br />
// add a "Hello World" paragraph right before the closing body tag<br />
$event->return = str_replace("</body>", "<p>Hello World!</p></body>", $event->return); <br />
}<br />
<br />
/**<br />
* Example3 adds a 'hello' method (not property) to every page that simply returns "Hello World"<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example3($event) {<br />
$event->return = "Hello World";<br />
}<br />
<br />
/**<br />
* Example 4 adds a 'hello_world' property (not method) to every page that returns "Hello [user]"<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example4($event) {<br />
$event->return = "Hello " . $this->user->name; <br />
}<br />
<br />
}<br />
<br />
</syntaxhighlight><br />
<br />
=== ProcessWire Admin Bereich mit eigener Funktionalität erweitern (Modul)===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<syntaxhighlight lang="php"><br />
<br />
<?php<br />
/**<br />
* ProcessSimpleAdminPage<br />
*<br />
* @author Ben Byford<br />
* http://www.benbyford.com<br />
*<br />
* @see http://www.processwire.com<br />
*/<br />
<br />
class ProcessSimpleAdminPage extends Process {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'Process Simple Admin Page',<br />
'summary' => 'Simple Process module that adds new admin page with',<br />
'version' => 001,<br />
<br />
// Modules that extend Process may specify a 'page' attribute in the<br />
// getModuleInfo(), this page will automatically be given the module<br />
// process when added to teh pagetree.<br />
<br />
// I have exampled but commented out the 'page' settings below<br />
// so that I can show how one might add a page to install() and<br />
// uninstall() in this and other modules (that might not extend<br />
// Process)<br />
<br />
<br />
// 'page' => array(<br />
// 'name' => 'site-config',<br />
// 'parent' => 'admin',<br />
// 'title' => 'Site Config'<br />
// )<br />
);<br />
}<br />
<br />
public function execute() {<br />
return '<br />
<h2>Edit the text here in the module</h2><br />
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam mattis eros vitae metus sodales eget suscipit purus rhoncus. Proin ultrices gravida dolor, non porttitor enim interdum vitae. Integer feugiat lacinia tincidunt. Nulla laoreet tristique tristique. Sed elementum justo a nisl elementum sit amet accumsan nisi tempor. Nulla quis eros et massa dignissim imperdiet a vitae purus.</p><br />
<br />
<p>Donec scelerisque pulvinar sem eu lobortis. Maecenas turpis ipsum, tempus dictum pharetra eu, consectetur vitae arcu. Fusce orci mauris, semper at tempus quis, volutpat molestie tellus. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Sed quam tortor, tincidunt sed semper lacinia, scelerisque dapibus quam. Morbi at nisi luctus lacus auctor ultrices eu eu leo.</p><br />
<br />
<p>Praesent faucibus purus id felis tincidunt dignissim. Sed sit amet ligula mi, eget semper dui. Proin consectetur gravida massa, nec luctus purus hendrerit in. Etiam volutpat, elit non venenatis suscipit, libero neque consectetur diam, id rutrum magna odio ac ligula. Maecenas sollicitudin congue neque fermentum vestibulum. Morbi nec leo nisi. Donec at nisl odio, et porta ligula.</p><br />
<br />
<p>Sed quis arcu nisi, ac tempor augue. Praesent non elit libero, a ullamcorper lorem. Curabitur porta odio eu nunc ultricies interdum id nec risus. Donec nibh nibh, porta eget vehicula ac, aliquet eget ante. Phasellus eget lorem eu eros eleifend ultrices. Cras sit amet neque sit amet nibh fringilla cursus ut id mauris. Praesent quis nunc justo, sed suscipit lectus. Phasellus eget ultrices risus. Curabitur eu semper est. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Ut suscipit, nisl ut imperdiet eleifend, turpis arcu placerat tortor, nec laoreet lacus neque ac tellus. Aenean ac lacus justo, quis ultricies nisi.</p><br />
';<br />
}<br />
public function install(){<br />
<br />
// create new page to add to CMS<br />
$page = new Page();<br />
<br />
// add page attributes<br />
$page->template = "admin";<br />
$page->name = "cms-faq";<br />
$page->title = "CMS FAQ";<br />
$page->save();<br />
<br />
// set this module as the page process, this allows us to display the above<br />
$page->process = 'ProcessSimpleAdminPage';<br />
<br />
// get admin page and set as page parent<br />
$admin = $this->pages->get("id=2");<br />
$page->parent = $admin;<br />
<br />
// save page<br />
$page->save();<br />
}<br />
<br />
public function uninstall(){<br />
<br />
// delete created page<br />
$page = $this->pages->get("name=cms-faq");<br />
if(count($page)) $this->pages->delete($page, true);<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
=== ProcessWire Textformatter Modul ===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
/**<br />
* TextformatterFindReplace<br />
*<br />
* Author: Ben Byford<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2010 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class TextformatterFindReplace extends Textformatter implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'TextformatterFindReplace',<br />
'version' => 0.1,<br />
'summary' => "Finds and replaces any instance of config input to config output",<br />
'author' => 'Ben Byford',<br />
'singular' => true,<br />
'href' => 'https://github.com/benbyford/PW-starter-modules'<br />
);<br />
}<br />
<br />
<br />
/**<br />
* Find and Replace the input string<br />
*<br />
* @param string $str The block of text to parse<br />
*<br />
* The incoming string is replaced with the formatted version of itself.<br />
**/<br />
<br />
public function format(&$str) {<br />
$find = $this->findStr;<br />
$str = preg_replace_callback($find, array($this,"replace"), $str);<br />
<br />
}<br />
<br />
// adding three underscores to a function allows other modules to hook it<br />
public function ___replace($match) {<br />
return $this->replaceStr;<br />
}<br />
}<br />
?><br />
</syntaxhighlight><br />
<br />
=== Admin Funktionalität: Countdown zum Seitenveröffentlichen ===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<br />
The module PageDeferredPublish, on clicking one of the '''Publish Later buttons''', sets LazyCron to check that page’s countdown every minute and publishes the page when its countdown reaches 0. This means I can publish a page approximately 24 hours in advance (obviously the checking interval and delay time can be changed to your requirements).<br />
<br />
I did this by:<br />
<br />
'''Creating two fields''' within my install() function: a checkbox field to set to true when a button is checked to indicate the page should countdown, and a countdown field to store the count in seconds for that specific page.<br />
<br />
'''Adding hooks''' to both ''ProcessPageEdit::buildForm'' and ''ProcessPageListActions::getExtraActions'' enabling me to add the two buttons.<br />
<br />
Checking to see if one of the buttons was clicked with my '''ready() function''' then setting the corresponding page’s checkbox to true.<br />
<br />
Using a '''LazyCron hook function''' to check all pages that are unpublished for true checkboxes and then comparing the seconds field to see if the page needs publishing. If not then deduct the elapsed time in seconds.<br />
<br />
The result is a '''module that has settings''' (the time interval to check and publish at a later time), '''hooks into the admin''' using buttons and fields, and enables us to '''use other modules installe'''d in PW (i.e. LazyCron).<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
/**<br />
* DeferredPublish (0.0.1)<br />
* DeferredPublish publishes a page after a defined amount of time has elapsed using lazycron.<br />
*<br />
* @author Ben Byford<br />
* http://www.benbyford.com<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2011 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class PageDeferredPublish extends WireData implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => "PageDeferredPublish",<br />
'version' => "0.0.1",<br />
'summary' => "PageDeferredPublish",<br />
'author' => "Ben Byford",<br />
'href' => "https://github.com/benbyford/PW-intermediate-modules",<br />
'icon' => "clock-o",<br />
'autoload' => true,<br />
'singular' => true,<br />
'requires' => "LazyCron",<br />
);<br />
}<br />
<br />
private $postPubLater = null;<br />
private $pageID = null;<br />
private $pagePubLater = null;<br />
private $currentPage = null;<br />
<br />
private $submitName = 'pdp_pub_later_submit';<br />
private $listPageName = 'pdp_pub_later_list';<br />
private $fieldName = 'pdp_pub_later';<br />
private $checkboxName = 'pdp_pub_later_check';<br />
<br />
private $defaultInterval = 'everyMinute';<br />
private $defaultTime = 86400;<br />
<br />
<br />
public function install(){<br />
// add new fields needed for module<br />
$this->installFields();<br />
}<br />
public function uninstall(){<br />
// uninstall fields<br />
$this->uninstallFields();<br />
}<br />
<br />
// initialize the hook in your AutoLoad module<br />
public function init() {<br />
<br />
// get defaults from module setting in CMS<br />
$this->defaultTime = $this->pub_after;<br />
$this->defaultInterval = $this->cron_check;<br />
<br />
// get admin URL<br />
$this->adminUrl = $this->wire('config')->urls->admin;<br />
<br />
// add hooks to CRON, PageList, PageEdit<br />
$this->addHookAfter("LazyCron::{$this->defaultInterval}", $this, 'publishDefferedPages');<br />
$this->addHook("ProcessPageListActions::getExtraActions", $this, 'hookPageListActions');<br />
$this->addHookAfter("ProcessPageEdit::buildForm", $this, "editForm");<br />
}<br />
<br />
public function ready() {<br />
<br />
// if list button clicked then grab id<br />
$this->pagePubLater = $this->input->get($this->listPageName);<br />
$this->pageID = $this->input->id;<br />
<br />
// get page<br />
$this->currentPage = $this->pages->get($this->pageID);<br />
<br />
// if pagelist pub later submit button clicked<br />
if($this->pagePubLater){<br />
$this->message("Page {$this->currentPage->name} deffered for publish.");<br />
}<br />
<br />
// if page edit submit button clicked<br />
$this->postPubLater = $this->input->post($this->submitName);<br />
if($this->postPubLater){<br />
$this->message("Page {$this->currentPage->name} deffered for publish.");<br />
}<br />
<br />
// if either deffered publish sumbit found then publish page later<br />
if($this->pagePubLater || $this->postPubLater){<br />
$this->publishLater();<br />
}<br />
}<br />
<br />
/*<br />
* Hook: ProcessPageEdit::buildForm<br />
*<br />
* add Publish Later button to edit page if not yet published<br />
*/<br />
public function ___editForm(HookEvent $form) {<br />
<br />
// get the InputFieldForm object from the event (return value of buildForm())<br />
$form = $form->return;<br />
<br />
$page = $this->pages->get($this->input->get->id);<br />
$check = $page->get($this->checkboxName);<br />
<br />
// check if publish button available and therfore unpublished<br />
$target = $form->get('submit_publish');<br />
<br />
if($target && $check == false){<br />
<br />
// get InputfieldText module<br />
$submit2 = $this->modules->get('InputfieldSubmit');<br />
$submit2->attr('name', $this->submitName);<br />
$submit2->attr('id', 'publish_later');<br />
$submit2->attr('class', 'ui-button ui-widget ui-corner-all head_button_clone ui-state-default ui-priority-secondary');<br />
$submit2->attr('value', 'Publish Later'); // Button: save unpublished<br />
<br />
// get form element save and place before<br />
$target = $form->get('submit_save');<br />
$form->insertBefore($submit2, $target);<br />
<br />
$form->return = $form;<br />
}<br />
}<br />
<br />
public function ___hookPageListActions(HookEvent $event) {<br />
<br />
// get current page<br />
$page = $event->arguments[0];<br />
<br />
// check to see if page is published<br />
$pagePub = $page->is(Page::statusUnpublished);<br />
<br />
// check to see if page template has deffered field<br />
$pageHasDefferField = $page->get($this->fieldName);<br />
<br />
$actions = array();<br />
<br />
// don't get homepage or pages that are already published or are being deffered for publish<br />
if($page->id > 1 && $pagePub == "published" && !is_null($pageHasDefferField) && $page->get($this->checkboxName) == false) {<br />
<br />
$actions['publish_later'] = array(<br />
'cn' => 'PublishLater',<br />
'name' => 'pub later',<br />
'url' => "{$this->adminUrl}?{$this->listPageName}=1&id={$page->id}",<br />
);<br />
}<br />
if(count($actions)) $event->return = $actions + $event->return;<br />
}<br />
<br />
/*<br />
* Publish Page on cron job<br />
*<br />
* Gets deffered page and publishes<br />
*/<br />
public function ___publish($page) {<br />
$page->removeStatus(Page::statusUnpublished);<br />
$page->removeStatus(Page::statusHidden);<br />
$page->Save();<br />
}<br />
<br />
/*<br />
* Main publish later function<br />
*<br />
* Gets deffered page and sets fields to be checked be lazy cron<br />
*/<br />
private function ___publishLater() {<br />
<br />
// get page<br />
$page = $this->pages->get($this->pageID);<br />
<br />
// set output formatting to false<br />
$page->of(false);<br />
<br />
// set field time to settings default time and checkbox to true<br />
$page->set($this->checkboxName, true);<br />
$page->set($this->fieldName, $this->defaultTime);<br />
<br />
// save page<br />
$page->save();<br />
$page->of(true);<br />
}<br />
<br />
/*<br />
* Lazy Cron hook function<br />
*<br />
* Triggers every [set time interval] and checks pages<br />
* Publishes page if time runout<br />
*<br />
* Adds publish page log<br />
*/<br />
public function ___publishDefferedPages(HookEvent $e){<br />
<br />
// seconds since last lazycron<br />
$seconds = $e->arguments[0];<br />
<br />
// find all pages with deffered field<br />
$defferedPages = $this->pages->find("{$this->checkboxName}=1,include=unpublished");<br />
<br />
// for each page decrease time for deffered field<br />
foreach ($defferedPages as $page) {<br />
<br />
// get current page time<br />
$timeTillPublish = $page->get($this->fieldName);<br />
<br />
// set time to time minus time past<br />
$timeLeft = $timeTillPublish - $seconds;<br />
<br />
// if time passed 0 or less then publish page<br />
$page->of(false);<br />
if($timeLeft <= 0){<br />
// remove flags and save<br />
$this->publish($page);<br />
<br />
$page->set($this->fieldName, 0);<br />
$page->set($this->checkboxName, 0);<br />
<br />
// log a page has been published<br />
$log = wire('log');<br />
$log->message('CRON:'. $seconds .' Pages: '. $page->name .' published');<br />
}else{<br />
$page->set($this->fieldName, $timeLeft);<br />
}<br />
// save page time<br />
$page->Save();<br />
$page->of(true);<br />
}<br />
}<br />
<br />
/*<br />
* Install new module specific fields<br />
*/<br />
private function installFields(){<br />
<br />
// install pub later checkbox field<br />
// find installed fields<br />
$f = $this->fields->get($this->fieldName);<br />
if($f){<br />
<br />
// if field already found then don't try and make it<br />
$this->message($this->fieldName . ' field found');<br />
<br />
}else{<br />
<br />
// create new field object to store crontime<br />
$f = new Field();<br />
// get a field type<br />
$f->type = $this->modules->get("FieldtypeInteger");<br />
$f->name = $this->fieldName;<br />
$f->label = 'Publish Time Left';<br />
$f->defaultValue = $this->defaultTime;<br />
$f->icon = 'clock-o';<br />
$f->columnWidth = 50;<br />
$f->collapsed = 1;<br />
$f->flags = 4;<br />
<br />
$f->save(); // save the field<br />
<br />
// create new field object to store whether to publish or not<br />
$f = new Field();<br />
// get a field type<br />
$f->type = $this->modules->get("FieldtypeCheckbox");<br />
$f->name = $this->checkboxName;<br />
$f->label = 'Publish Page later';<br />
$f->defaultValue = false;<br />
$f->columnWidth = 50;<br />
$f->icon = 'clock-o';<br />
$f->collapsed = 1;<br />
$f->flags = 4;<br />
<br />
$f->save(); // save the field<br />
}<br />
}<br />
<br />
/*<br />
* Uninstall module specific fields<br />
*/<br />
private function uninstallFields(){<br />
<br />
// find installed fields<br />
$fInt = $this->fields->get($this->fieldName);<br />
$fCheck = $this->fields->get($this->checkboxName);<br />
<br />
if($fInt && $fCheck){<br />
$fieldIntUsed = $fInt->numFieldgroups();<br />
$fieldCheckUsed = $fCheck->numFieldgroups();<br />
<br />
if($fieldIntUsed){<br />
// field in use by template<br />
$this->message('Unable to uninstall field '.$fInt->name);<br />
}else{<br />
// delete installed fields<br />
$this->fields->delete($fInt);<br />
$this->fields->save;<br />
}<br />
<br />
if($fieldCheckUsed){<br />
// field in use by template<br />
$this->message('Unable to uninstall field '.$fCheck->name);<br />
}else{<br />
// delete installed fields<br />
$this->fields->delete($fCheck);<br />
$this->fields->save;<br />
}<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
=== Inputfield / Fieldtype ===<br />
[[ProcessWire - Fieldtype erstellen (Module)]]</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Module_schreiben&diff=24250ProcessWire - Module schreiben2020-01-06T10:14:26Z<p>84.136.104.26: /* Autoload Module und Hooks */</p>
<hr />
<div>== Links ==<br />
Wichtigste Resourcen<br />
https://processwire.com/docs/modules/development/ - Guter Ausgangspunkt<br />
https://processwire.com/api/ref/module/ - Module API<br />
https://processwire.com/api/ref/configurable-module/ - Klasse für Konfigurierbare Module<br />
https://processwire.com/docs/modules/types/ - Welche Modultypen gibt es ?<br />
https://github.com/ryancramerdesign/ProcessHello - Modul Skelett Beispiel für eigene Backend (Process) Module<br />
https://github.com/ryancramerdesign/FieldtypeMapMarker - Beispiel für ein Fieldtype und Inputfield Modul<br />
https://processwire.com/talk/topic/778-module-dependencies/ - Module die andere Module benötigen<br />
https://processwire.com/talk/forum/19-moduleplugin-development/ - Forum zum Thema Module entwickeln<br />
http://somatonic.github.io/Captain-Hook/ - Hook Cheatsheet<br />
https://processwire.com/blog/posts/new-module-configuration-options/ - Neuere Konfigurationsmöglichkeiten<br />
Weitere Links<br />
https://webdesign.tutsplus.com/tutorials/a-beginners-introduction-to-writing-modules-in-processwire--cms-26862<br />
https://processwire.com/docs/modules/ - Introduction, Development, Hooks, Types, Pro Modules, Third Party<br />
<br />
<br />
<br />
<br />
[[ProcessWire - Module Snippets]]<br />
<br />
== Wo - Was ? ==<br />
=== Welche Typen von Modulen gibt es ? ===<br />
https://processwire.com/docs/modules/types/<br />
* '''Fieldtype''': Repräsentiert einen Datentyp. Meistens keine Public API, Handelt Daten / Datenbank - https://processwire.com/api/ref/fieldtype/<br />
* '''Inputfield''': Sammelt User Eingaben über ein Formular im Admin Bereich. Im Gegensatz zum Fieldtype geht es hier um das UI im Backend. Das Handling der Daten liegt beim Fieldtype.<br />
* '''Process''' for creating admin processes/applications.<br />
* '''Textformatter''' for formatting text.<br />
* '''AdminTheme''' for creating themes in the admin.<br />
* '''WireMail''' for modules that send email and extend the WireMail class.<br />
* '''Tfa''' for implementing a specific kind of two-factor authentication.<br />
* '''ImageSizerEngine''' for modules that extend ImageSizerEngine for resizing images.<br />
* '''FileCompiler''' for modules that extend FileCompilerModule for compilation of files.<br />
* '''FileValidator''' for modules that extend FileValidatorModule for validation of files.<br />
<br />
=== Wie werden Felder in der Datenbank angelegt ? ===<br />
Dazu nutzt man den Typ "Fieldtype"<br />
<br />
=== Wo rendert man die Ausgabe ? ===<br />
Bei Ryan Cramers Event Beispiel legt er zwei Klassen Event und EventArray an, die auch die Render Funktionen enthalten.<br />
<br />
== Spezielle Funktionen in Modulen ==<br />
<br />
=== getModuleInfo ===<br />
Ist die einzige Pflichtfunktion in Modulen. Hier werden title, version, summary und weitere Daten hinterlegt. Hier kann man auch angeben ob ein Modul ein Autoload Modul ist.<br />
<br />
=== init ===<br />
public function init(){}<br />
Initialisiert das Modul. ProcessWire ruft diese Funktion auf, wenn das Modul geladen ist. Bei Autoload Modulen wird es aufgerufen wenn die ProcessWire API bereit ist. Daher ist es ein guter Ort um Hooks einzubinden.<br />
<br />
=== ready ===<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
if($this->page->template == 'admin') {<br />
$this->message($this->hi());<br />
}<br />
}<br />
</syntaxhighlight><br />
Wird in autoload Modulen aufgerufen wenn die API bereit ist. Nützlich für Hooks:<br />
<br />
=== execute ===<br />
<syntaxhighlight lang="php"><br />
/**<br />
* This function is executed when a page with your Process assigned is accessed. <br />
*<br />
* This can be seen as your main or index function. You'll probably want to replace<br />
* everything in this function. <br />
*<br />
*/<br />
public function ___execute() {<br />
// greetingType and greeting are automatically populated to this module<br />
// and they were defined in ProcessHello.config.php<br />
if($this->greetingType == 'message') {<br />
$this->message($this->greeting); <br />
} else if($this->greetingType == 'warning') {<br />
$this->warning($this->greeting); <br />
} else {<br />
$this->error($this->greeting); <br />
}<br />
// generate some navigation<br />
$out = "<br />
<h2>$this->greeting</h2><br />
<dl class='nav'><br />
<dt><a href='./something/'>Do Something</a></dt><br />
<dd>Runs the executeSomething() function.</dd><br />
</dl><br />
";<br />
return $out;<br />
} <br />
</syntaxhighlight><br />
<br />
=== executeSomething ===<br />
<syntaxhighlight lang="php"><br />
/**<br />
* Called when the URL is this module's page URL + "/something/"<br />
*<br />
*/<br />
public function ___executeSomething() {<br />
// set a new headline, replacing the one used by our page<br />
// this is optional as PW will auto-generate a headline <br />
$this->headline('This is something!'); <br />
// add a breadcrumb that returns to our main page <br />
// this is optional as PW will auto-generate breadcrumbs<br />
$this->breadcrumb('../', 'Hello'); <br />
$out = "<br />
<h2>Not much to to see here</h2><br />
<p><a href='../'>Go Back</a></p><br />
";<br />
return $out; <br />
}<br />
</syntaxhighlight><br />
<br />
=== install & uninstall ===<br />
<syntaxhighlight lang="php"><br />
<br />
/**<br />
* Called only when your module is installed<br />
*<br />
* If you don't need anything here, you can simply remove this method. <br />
*<br />
*/<br />
public function ___install() {<br />
parent::___install(); // always remember to call parent method<br />
}<br />
/**<br />
* Called only when your module is uninstalled<br />
*<br />
* This should return the site to the same state it was in before the module was installed. <br />
*<br />
* If you don't need anything here, you can simply remove this method. <br />
*<br />
*/<br />
public function ___uninstall() {<br />
parent::___uninstall(); // always remember to call parent method<br />
}<br />
</syntaxhighlight><br />
<br />
== Vererbung und Eigenschaften in Modulen ==<br />
Modules are not different from PHP classes.<br />
<br />
To change the properties of MyModule class from within MyOtherModule class, you can either:<br />
<br />
#Make MyOtherModule class extend MyModule. It will thus inherit MyModule's public and protected properties and methods<br />
#Make the properties firstName and lastName configurable by passing them as parameters/arguments in MyModule's constructor method.<br />
<br />
== Autoload Module und Hooks ==<br />
Autoload werden automatisch geladen müssen also nicht in einem Template o.ä. gestartet werden. Daher bieten sie sich an um die Funktionalität von ProcessWire zu erweitern. Als Werkzeug dafür dienen Hooks. Mit Hooks kann man an vielen Stellen den Rendering Process der Seiten beeinflussen. Außerdem kann man für eigene Module ebenfalls Hooks bereitstellen. <br />
<br />
=== Hooks ===<br />
https://processwire.com/docs/modules/hooks/<br />
Hooks sind ein mächtiges Werkzeug. Sie geben einem die Möglichkeit an vielen Stellen "einzuhaken" und Funktionalität einzubauen.<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
$this->addHookAfter('Page::render', function($event) {<br />
$event->return .= '<p>Hallo</p>';<br />
});<br />
}<br />
</syntaxhighlight><br />
Schreibt am Ende Jeder Seite ein "Hallo". Das $event Objekt ist ein [https://processwire.com/api/ref/hook-event/ HookEvent]. Im Beispiel fügen wir einfach etwas Markup hinzu. Über $event->arguments() kann man aber auf ale Argumente zugreifen.<br />
<br />
Das gleiche aber nicht mit anonymer Funktion:<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
// add hook after Page::render() and make it call the "test" method of $this module<br />
$this->addHookAfter('Page::render', $this, 'test');<br />
}<br />
<br />
public function test($event) {<br />
// modify the return value of Page::render() to include the following:<br />
$event->return .= '<p>Hallo</p>';<br />
}<br />
</syntaxhighlight><br />
<br />
=== Hooks zum erweitern von existierenden Klassen nutzen ===<br />
Mit Hooks kann man in vorhandene Klassen einhaken. Z.B. läßt sich das Page Objekt erweitern.<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
$this->addHook('Page::summarize', $this, 'summarize');<br />
}<br />
public function summarize($event) {<br />
$page = $event->object; // the $event->object represents the object hooked (Page)<br />
$maxlen = $event->arguments(0); // first argument is the optional max length<br />
if(!$maxlen) $maxlen = 200; // if no $maxlen was present, we'll use a default of 200<br />
$summary = $this->sanitizer->truncate($page->body, $maxlen); // use sanitizer truncate method to create a summary<br />
$event->return = $summary; // populate $summary to $event->return, the return value<br />
}<br />
</syntaxhighlight><br />
So kann man ganz einfach eine Zusammenfassung aller Kindseiten in einem Template rendern:<br />
<syntaxhighlight lang="php"><br />
foreach($page->children as $item) {<br />
$summary = $item->summarize(150);<br />
echo "<li><a href='$item->url'>$item->title</a><br>$summary";<br />
}<br />
</syntaxhighlight><br />
<br />
=== Hook Beispiele ===<br />
Hook am Ende des Renderings<br />
$this->addHookAfter('Page::render', function($event) {...});<br />
Füge eine Funktion "summarize" zum Page Objekt hinzu.<br />
$this->addHook('Page::summarize', $this, 'summarize');<br />
Hook auf eine einzelne Instanz (hier pages Objekt)<br />
$this->pages->addHookAfter('saved', function($event){...});<br />
$this->addHook('Page::method', ...) // Spricht ALLE Instanzen an - Regelfall<br />
$page->addHook('method', ...) // Spricht nur die EINE Instanz der Seite an.<br />
</pre><br />
<br />
=== Autoload Module nur im Admin Bereich laden ===<br />
'autoload' => 'template=admin' <br />
statt<br />
'autoload' => true<br />
<br />
== CSS und JavaScript in Modulen ==<br />
Bei Process Modulen möchte man für das Styling etc. im Backend oft CSS und JS Dateien hinzufügen.<br />
<br />
Einfach Eine Datei MeinModul.css und / oder MeinModul.js hinzufügen. JQuery ist im Admin bereits geladen daher kann eine MeinModul.js Starter Datei so aussehen:<br />
<br />
<pre><br />
<br />
/**<br />
* This JS file is only loaded when the ProcessHello module is run<br />
*<br />
* You should delete it if you have no javascript to add.<br />
*<br />
*/<br />
<br />
$(document).ready(function() {<br />
// do something<br />
}); <br />
</pre><br />
<br />
== Beispiele ==<br />
=== Frontend Rendering Module ===<br />
A bit old but working<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
/**<br />
* FrontEndRender<br />
*<br />
* Author: Ben Byford<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2010 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class FrontEndRender extends WireData implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'FrontEndRender',<br />
'version' => 0.1,<br />
'summary' => "Outputs html and static variables to frontend",<br />
'author' => 'Ben Byford',<br />
'singular' => true,<br />
'href' => 'https://github.com/benbyford/PW-starter-modules'<br />
);<br />
}<br />
<br />
// protected variable only accessable within module<br />
protected $name = 'Ben';<br />
<br />
/*<br />
* render function to be called in PW template like this:<br />
* $FrontEndRender = $modules->getModule('FrontEndRender');<br />
* echo '<h1>' . $FrontEndRender->render() . '</h1>';<br />
*<br />
*/<br />
public function render(){<br />
return "Hello " . $this->name;<br />
}<br />
}<br />
?><br />
</syntaxhighlight><br />
<br />
=== ProcessWire Hello World Modul ===<br />
Beispiel Modul mit Hooks (liegt immer in der Standardinstallation)<br />
<syntaxhighlight lang="php"><br />
<?php namespace ProcessWire;<br />
<br />
/**<br />
* ProcessWire 'Hello world' demonstration module<br />
*<br />
* Demonstrates the Module interface and how to add hooks.<br />
* <br />
* See README file for further links regarding module development.<br />
* <br />
* This file is licensed under the MIT license<br />
* https://processwire.com/about/license/mit/<br />
* <br />
* ProcessWire 3.x, Copyright 2016 by Ryan Cramer<br />
* https://processwire.com<br />
*<br />
*/<br />
<br />
class Helloworld extends WireData implements Module {<br />
<br />
/**<br />
* getModuleInfo is a module required by all modules to tell ProcessWire about them<br />
*<br />
* @return array<br />
*<br />
*/<br />
public static function getModuleInfo() {<br />
<br />
return array(<br />
<br />
// The module's title, typically a little more descriptive than the class name<br />
'title' => 'Hello World', <br />
<br />
// version number <br />
'version' => 3, <br />
<br />
// summary is brief description of what this module is<br />
'summary' => 'An example module used for demonstration purposes.',<br />
<br />
// Optional URL to more information about the module<br />
'href' => 'https://processwire.com',<br />
<br />
// singular=true: indicates that only one instance of the module is allowed.<br />
// This is usually what you want for modules that attach hooks. <br />
'singular' => true, <br />
<br />
// autoload=true: indicates the module should be started with ProcessWire.<br />
// This is necessary for any modules that attach runtime hooks, otherwise those<br />
// hooks won't get attached unless some other code calls the module on it's own.<br />
// Note that autoload modules are almost always also 'singular' (seen above).<br />
'autoload' => true, <br />
<br />
// Optional font-awesome icon name, minus the 'fa-' part<br />
'icon' => 'smile-o', <br />
);<br />
}<br />
<br />
/**<br />
* Initialize the module<br />
*<br />
* ProcessWire calls this when the module is loaded. For 'autoload' modules, this will be called<br />
* when ProcessWire's API is ready. As a result, this is a good place to attach hooks. <br />
*<br />
*/<br />
public function init() {<br />
<br />
// add a hook after the $pages->save, to issue a notice every time a page is saved<br />
$this->pages->addHookAfter('save', $this, 'example1'); <br />
<br />
// add a hook after each page is rendered and modify the output<br />
$this->addHookAfter('Page::render', $this, 'example2'); <br />
<br />
// add a 'hello' method to every page that returns "Hello World"<br />
// use "echo $page->hello();" in your template file to display output<br />
$this->addHook('Page::hello', $this, 'example3'); <br />
<br />
// add a 'hello_world' property to every page that returns "Hello [user]"<br />
// use "echo $page->hello_world;" in your template file to display output<br />
$this->addHookProperty('Page::hello_world', $this, 'example4'); <br />
}<br />
<br />
/**<br />
* Example1 hooks into the pages->save method and displays a notice every time a page is saved<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example1($event) {<br />
/** @var Page $page */<br />
$page = $event->arguments[0]; <br />
$this->message("Hello World! You saved {$page->path}."); <br />
}<br />
<br />
<br />
/**<br />
* Example2 hooks into every page after it's rendered and adds "Hello World" text at the bottom<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example2($event) {<br />
<br />
/** @var Page $page */<br />
$page = $event->object; <br />
<br />
// don't add this to the admin pages<br />
if($page->template == 'admin') return;<br />
<br />
// add a "Hello World" paragraph right before the closing body tag<br />
$event->return = str_replace("</body>", "<p>Hello World!</p></body>", $event->return); <br />
}<br />
<br />
/**<br />
* Example3 adds a 'hello' method (not property) to every page that simply returns "Hello World"<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example3($event) {<br />
$event->return = "Hello World";<br />
}<br />
<br />
/**<br />
* Example 4 adds a 'hello_world' property (not method) to every page that returns "Hello [user]"<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example4($event) {<br />
$event->return = "Hello " . $this->user->name; <br />
}<br />
<br />
}<br />
<br />
</syntaxhighlight><br />
<br />
=== ProcessWire Admin Bereich mit eigener Funktionalität erweitern (Modul)===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<syntaxhighlight lang="php"><br />
<br />
<?php<br />
/**<br />
* ProcessSimpleAdminPage<br />
*<br />
* @author Ben Byford<br />
* http://www.benbyford.com<br />
*<br />
* @see http://www.processwire.com<br />
*/<br />
<br />
class ProcessSimpleAdminPage extends Process {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'Process Simple Admin Page',<br />
'summary' => 'Simple Process module that adds new admin page with',<br />
'version' => 001,<br />
<br />
// Modules that extend Process may specify a 'page' attribute in the<br />
// getModuleInfo(), this page will automatically be given the module<br />
// process when added to teh pagetree.<br />
<br />
// I have exampled but commented out the 'page' settings below<br />
// so that I can show how one might add a page to install() and<br />
// uninstall() in this and other modules (that might not extend<br />
// Process)<br />
<br />
<br />
// 'page' => array(<br />
// 'name' => 'site-config',<br />
// 'parent' => 'admin',<br />
// 'title' => 'Site Config'<br />
// )<br />
);<br />
}<br />
<br />
public function execute() {<br />
return '<br />
<h2>Edit the text here in the module</h2><br />
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam mattis eros vitae metus sodales eget suscipit purus rhoncus. Proin ultrices gravida dolor, non porttitor enim interdum vitae. Integer feugiat lacinia tincidunt. Nulla laoreet tristique tristique. Sed elementum justo a nisl elementum sit amet accumsan nisi tempor. Nulla quis eros et massa dignissim imperdiet a vitae purus.</p><br />
<br />
<p>Donec scelerisque pulvinar sem eu lobortis. Maecenas turpis ipsum, tempus dictum pharetra eu, consectetur vitae arcu. Fusce orci mauris, semper at tempus quis, volutpat molestie tellus. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Sed quam tortor, tincidunt sed semper lacinia, scelerisque dapibus quam. Morbi at nisi luctus lacus auctor ultrices eu eu leo.</p><br />
<br />
<p>Praesent faucibus purus id felis tincidunt dignissim. Sed sit amet ligula mi, eget semper dui. Proin consectetur gravida massa, nec luctus purus hendrerit in. Etiam volutpat, elit non venenatis suscipit, libero neque consectetur diam, id rutrum magna odio ac ligula. Maecenas sollicitudin congue neque fermentum vestibulum. Morbi nec leo nisi. Donec at nisl odio, et porta ligula.</p><br />
<br />
<p>Sed quis arcu nisi, ac tempor augue. Praesent non elit libero, a ullamcorper lorem. Curabitur porta odio eu nunc ultricies interdum id nec risus. Donec nibh nibh, porta eget vehicula ac, aliquet eget ante. Phasellus eget lorem eu eros eleifend ultrices. Cras sit amet neque sit amet nibh fringilla cursus ut id mauris. Praesent quis nunc justo, sed suscipit lectus. Phasellus eget ultrices risus. Curabitur eu semper est. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Ut suscipit, nisl ut imperdiet eleifend, turpis arcu placerat tortor, nec laoreet lacus neque ac tellus. Aenean ac lacus justo, quis ultricies nisi.</p><br />
';<br />
}<br />
public function install(){<br />
<br />
// create new page to add to CMS<br />
$page = new Page();<br />
<br />
// add page attributes<br />
$page->template = "admin";<br />
$page->name = "cms-faq";<br />
$page->title = "CMS FAQ";<br />
$page->save();<br />
<br />
// set this module as the page process, this allows us to display the above<br />
$page->process = 'ProcessSimpleAdminPage';<br />
<br />
// get admin page and set as page parent<br />
$admin = $this->pages->get("id=2");<br />
$page->parent = $admin;<br />
<br />
// save page<br />
$page->save();<br />
}<br />
<br />
public function uninstall(){<br />
<br />
// delete created page<br />
$page = $this->pages->get("name=cms-faq");<br />
if(count($page)) $this->pages->delete($page, true);<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
=== ProcessWire Textformatter Modul ===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
/**<br />
* TextformatterFindReplace<br />
*<br />
* Author: Ben Byford<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2010 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class TextformatterFindReplace extends Textformatter implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'TextformatterFindReplace',<br />
'version' => 0.1,<br />
'summary' => "Finds and replaces any instance of config input to config output",<br />
'author' => 'Ben Byford',<br />
'singular' => true,<br />
'href' => 'https://github.com/benbyford/PW-starter-modules'<br />
);<br />
}<br />
<br />
<br />
/**<br />
* Find and Replace the input string<br />
*<br />
* @param string $str The block of text to parse<br />
*<br />
* The incoming string is replaced with the formatted version of itself.<br />
**/<br />
<br />
public function format(&$str) {<br />
$find = $this->findStr;<br />
$str = preg_replace_callback($find, array($this,"replace"), $str);<br />
<br />
}<br />
<br />
// adding three underscores to a function allows other modules to hook it<br />
public function ___replace($match) {<br />
return $this->replaceStr;<br />
}<br />
}<br />
?><br />
</syntaxhighlight><br />
<br />
=== Admin Funktionalität: Countdown zum Seitenveröffentlichen ===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<br />
The module PageDeferredPublish, on clicking one of the '''Publish Later buttons''', sets LazyCron to check that page’s countdown every minute and publishes the page when its countdown reaches 0. This means I can publish a page approximately 24 hours in advance (obviously the checking interval and delay time can be changed to your requirements).<br />
<br />
I did this by:<br />
<br />
'''Creating two fields''' within my install() function: a checkbox field to set to true when a button is checked to indicate the page should countdown, and a countdown field to store the count in seconds for that specific page.<br />
<br />
'''Adding hooks''' to both ''ProcessPageEdit::buildForm'' and ''ProcessPageListActions::getExtraActions'' enabling me to add the two buttons.<br />
<br />
Checking to see if one of the buttons was clicked with my '''ready() function''' then setting the corresponding page’s checkbox to true.<br />
<br />
Using a '''LazyCron hook function''' to check all pages that are unpublished for true checkboxes and then comparing the seconds field to see if the page needs publishing. If not then deduct the elapsed time in seconds.<br />
<br />
The result is a '''module that has settings''' (the time interval to check and publish at a later time), '''hooks into the admin''' using buttons and fields, and enables us to '''use other modules installe'''d in PW (i.e. LazyCron).<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
/**<br />
* DeferredPublish (0.0.1)<br />
* DeferredPublish publishes a page after a defined amount of time has elapsed using lazycron.<br />
*<br />
* @author Ben Byford<br />
* http://www.benbyford.com<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2011 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class PageDeferredPublish extends WireData implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => "PageDeferredPublish",<br />
'version' => "0.0.1",<br />
'summary' => "PageDeferredPublish",<br />
'author' => "Ben Byford",<br />
'href' => "https://github.com/benbyford/PW-intermediate-modules",<br />
'icon' => "clock-o",<br />
'autoload' => true,<br />
'singular' => true,<br />
'requires' => "LazyCron",<br />
);<br />
}<br />
<br />
private $postPubLater = null;<br />
private $pageID = null;<br />
private $pagePubLater = null;<br />
private $currentPage = null;<br />
<br />
private $submitName = 'pdp_pub_later_submit';<br />
private $listPageName = 'pdp_pub_later_list';<br />
private $fieldName = 'pdp_pub_later';<br />
private $checkboxName = 'pdp_pub_later_check';<br />
<br />
private $defaultInterval = 'everyMinute';<br />
private $defaultTime = 86400;<br />
<br />
<br />
public function install(){<br />
// add new fields needed for module<br />
$this->installFields();<br />
}<br />
public function uninstall(){<br />
// uninstall fields<br />
$this->uninstallFields();<br />
}<br />
<br />
// initialize the hook in your AutoLoad module<br />
public function init() {<br />
<br />
// get defaults from module setting in CMS<br />
$this->defaultTime = $this->pub_after;<br />
$this->defaultInterval = $this->cron_check;<br />
<br />
// get admin URL<br />
$this->adminUrl = $this->wire('config')->urls->admin;<br />
<br />
// add hooks to CRON, PageList, PageEdit<br />
$this->addHookAfter("LazyCron::{$this->defaultInterval}", $this, 'publishDefferedPages');<br />
$this->addHook("ProcessPageListActions::getExtraActions", $this, 'hookPageListActions');<br />
$this->addHookAfter("ProcessPageEdit::buildForm", $this, "editForm");<br />
}<br />
<br />
public function ready() {<br />
<br />
// if list button clicked then grab id<br />
$this->pagePubLater = $this->input->get($this->listPageName);<br />
$this->pageID = $this->input->id;<br />
<br />
// get page<br />
$this->currentPage = $this->pages->get($this->pageID);<br />
<br />
// if pagelist pub later submit button clicked<br />
if($this->pagePubLater){<br />
$this->message("Page {$this->currentPage->name} deffered for publish.");<br />
}<br />
<br />
// if page edit submit button clicked<br />
$this->postPubLater = $this->input->post($this->submitName);<br />
if($this->postPubLater){<br />
$this->message("Page {$this->currentPage->name} deffered for publish.");<br />
}<br />
<br />
// if either deffered publish sumbit found then publish page later<br />
if($this->pagePubLater || $this->postPubLater){<br />
$this->publishLater();<br />
}<br />
}<br />
<br />
/*<br />
* Hook: ProcessPageEdit::buildForm<br />
*<br />
* add Publish Later button to edit page if not yet published<br />
*/<br />
public function ___editForm(HookEvent $form) {<br />
<br />
// get the InputFieldForm object from the event (return value of buildForm())<br />
$form = $form->return;<br />
<br />
$page = $this->pages->get($this->input->get->id);<br />
$check = $page->get($this->checkboxName);<br />
<br />
// check if publish button available and therfore unpublished<br />
$target = $form->get('submit_publish');<br />
<br />
if($target && $check == false){<br />
<br />
// get InputfieldText module<br />
$submit2 = $this->modules->get('InputfieldSubmit');<br />
$submit2->attr('name', $this->submitName);<br />
$submit2->attr('id', 'publish_later');<br />
$submit2->attr('class', 'ui-button ui-widget ui-corner-all head_button_clone ui-state-default ui-priority-secondary');<br />
$submit2->attr('value', 'Publish Later'); // Button: save unpublished<br />
<br />
// get form element save and place before<br />
$target = $form->get('submit_save');<br />
$form->insertBefore($submit2, $target);<br />
<br />
$form->return = $form;<br />
}<br />
}<br />
<br />
public function ___hookPageListActions(HookEvent $event) {<br />
<br />
// get current page<br />
$page = $event->arguments[0];<br />
<br />
// check to see if page is published<br />
$pagePub = $page->is(Page::statusUnpublished);<br />
<br />
// check to see if page template has deffered field<br />
$pageHasDefferField = $page->get($this->fieldName);<br />
<br />
$actions = array();<br />
<br />
// don't get homepage or pages that are already published or are being deffered for publish<br />
if($page->id > 1 && $pagePub == "published" && !is_null($pageHasDefferField) && $page->get($this->checkboxName) == false) {<br />
<br />
$actions['publish_later'] = array(<br />
'cn' => 'PublishLater',<br />
'name' => 'pub later',<br />
'url' => "{$this->adminUrl}?{$this->listPageName}=1&id={$page->id}",<br />
);<br />
}<br />
if(count($actions)) $event->return = $actions + $event->return;<br />
}<br />
<br />
/*<br />
* Publish Page on cron job<br />
*<br />
* Gets deffered page and publishes<br />
*/<br />
public function ___publish($page) {<br />
$page->removeStatus(Page::statusUnpublished);<br />
$page->removeStatus(Page::statusHidden);<br />
$page->Save();<br />
}<br />
<br />
/*<br />
* Main publish later function<br />
*<br />
* Gets deffered page and sets fields to be checked be lazy cron<br />
*/<br />
private function ___publishLater() {<br />
<br />
// get page<br />
$page = $this->pages->get($this->pageID);<br />
<br />
// set output formatting to false<br />
$page->of(false);<br />
<br />
// set field time to settings default time and checkbox to true<br />
$page->set($this->checkboxName, true);<br />
$page->set($this->fieldName, $this->defaultTime);<br />
<br />
// save page<br />
$page->save();<br />
$page->of(true);<br />
}<br />
<br />
/*<br />
* Lazy Cron hook function<br />
*<br />
* Triggers every [set time interval] and checks pages<br />
* Publishes page if time runout<br />
*<br />
* Adds publish page log<br />
*/<br />
public function ___publishDefferedPages(HookEvent $e){<br />
<br />
// seconds since last lazycron<br />
$seconds = $e->arguments[0];<br />
<br />
// find all pages with deffered field<br />
$defferedPages = $this->pages->find("{$this->checkboxName}=1,include=unpublished");<br />
<br />
// for each page decrease time for deffered field<br />
foreach ($defferedPages as $page) {<br />
<br />
// get current page time<br />
$timeTillPublish = $page->get($this->fieldName);<br />
<br />
// set time to time minus time past<br />
$timeLeft = $timeTillPublish - $seconds;<br />
<br />
// if time passed 0 or less then publish page<br />
$page->of(false);<br />
if($timeLeft <= 0){<br />
// remove flags and save<br />
$this->publish($page);<br />
<br />
$page->set($this->fieldName, 0);<br />
$page->set($this->checkboxName, 0);<br />
<br />
// log a page has been published<br />
$log = wire('log');<br />
$log->message('CRON:'. $seconds .' Pages: '. $page->name .' published');<br />
}else{<br />
$page->set($this->fieldName, $timeLeft);<br />
}<br />
// save page time<br />
$page->Save();<br />
$page->of(true);<br />
}<br />
}<br />
<br />
/*<br />
* Install new module specific fields<br />
*/<br />
private function installFields(){<br />
<br />
// install pub later checkbox field<br />
// find installed fields<br />
$f = $this->fields->get($this->fieldName);<br />
if($f){<br />
<br />
// if field already found then don't try and make it<br />
$this->message($this->fieldName . ' field found');<br />
<br />
}else{<br />
<br />
// create new field object to store crontime<br />
$f = new Field();<br />
// get a field type<br />
$f->type = $this->modules->get("FieldtypeInteger");<br />
$f->name = $this->fieldName;<br />
$f->label = 'Publish Time Left';<br />
$f->defaultValue = $this->defaultTime;<br />
$f->icon = 'clock-o';<br />
$f->columnWidth = 50;<br />
$f->collapsed = 1;<br />
$f->flags = 4;<br />
<br />
$f->save(); // save the field<br />
<br />
// create new field object to store whether to publish or not<br />
$f = new Field();<br />
// get a field type<br />
$f->type = $this->modules->get("FieldtypeCheckbox");<br />
$f->name = $this->checkboxName;<br />
$f->label = 'Publish Page later';<br />
$f->defaultValue = false;<br />
$f->columnWidth = 50;<br />
$f->icon = 'clock-o';<br />
$f->collapsed = 1;<br />
$f->flags = 4;<br />
<br />
$f->save(); // save the field<br />
}<br />
}<br />
<br />
/*<br />
* Uninstall module specific fields<br />
*/<br />
private function uninstallFields(){<br />
<br />
// find installed fields<br />
$fInt = $this->fields->get($this->fieldName);<br />
$fCheck = $this->fields->get($this->checkboxName);<br />
<br />
if($fInt && $fCheck){<br />
$fieldIntUsed = $fInt->numFieldgroups();<br />
$fieldCheckUsed = $fCheck->numFieldgroups();<br />
<br />
if($fieldIntUsed){<br />
// field in use by template<br />
$this->message('Unable to uninstall field '.$fInt->name);<br />
}else{<br />
// delete installed fields<br />
$this->fields->delete($fInt);<br />
$this->fields->save;<br />
}<br />
<br />
if($fieldCheckUsed){<br />
// field in use by template<br />
$this->message('Unable to uninstall field '.$fCheck->name);<br />
}else{<br />
// delete installed fields<br />
$this->fields->delete($fCheck);<br />
$this->fields->save;<br />
}<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
=== Inputfield / Fieldtype ===<br />
[[ProcessWire - Fieldtype erstellen (Module)]]</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Module_schreiben&diff=24249ProcessWire - Module schreiben2020-01-06T10:06:06Z<p>84.136.104.26: /* = executeSomething */</p>
<hr />
<div>== Links ==<br />
Wichtigste Resourcen<br />
https://processwire.com/docs/modules/development/ - Guter Ausgangspunkt<br />
https://processwire.com/api/ref/module/ - Module API<br />
https://processwire.com/api/ref/configurable-module/ - Klasse für Konfigurierbare Module<br />
https://processwire.com/docs/modules/types/ - Welche Modultypen gibt es ?<br />
https://github.com/ryancramerdesign/ProcessHello - Modul Skelett Beispiel für eigene Backend (Process) Module<br />
https://github.com/ryancramerdesign/FieldtypeMapMarker - Beispiel für ein Fieldtype und Inputfield Modul<br />
https://processwire.com/talk/topic/778-module-dependencies/ - Module die andere Module benötigen<br />
https://processwire.com/talk/forum/19-moduleplugin-development/ - Forum zum Thema Module entwickeln<br />
http://somatonic.github.io/Captain-Hook/ - Hook Cheatsheet<br />
https://processwire.com/blog/posts/new-module-configuration-options/ - Neuere Konfigurationsmöglichkeiten<br />
Weitere Links<br />
https://webdesign.tutsplus.com/tutorials/a-beginners-introduction-to-writing-modules-in-processwire--cms-26862<br />
https://processwire.com/docs/modules/ - Introduction, Development, Hooks, Types, Pro Modules, Third Party<br />
<br />
<br />
<br />
<br />
[[ProcessWire - Module Snippets]]<br />
<br />
== Wo - Was ? ==<br />
=== Welche Typen von Modulen gibt es ? ===<br />
https://processwire.com/docs/modules/types/<br />
* '''Fieldtype''': Repräsentiert einen Datentyp. Meistens keine Public API, Handelt Daten / Datenbank - https://processwire.com/api/ref/fieldtype/<br />
* '''Inputfield''': Sammelt User Eingaben über ein Formular im Admin Bereich. Im Gegensatz zum Fieldtype geht es hier um das UI im Backend. Das Handling der Daten liegt beim Fieldtype.<br />
* '''Process''' for creating admin processes/applications.<br />
* '''Textformatter''' for formatting text.<br />
* '''AdminTheme''' for creating themes in the admin.<br />
* '''WireMail''' for modules that send email and extend the WireMail class.<br />
* '''Tfa''' for implementing a specific kind of two-factor authentication.<br />
* '''ImageSizerEngine''' for modules that extend ImageSizerEngine for resizing images.<br />
* '''FileCompiler''' for modules that extend FileCompilerModule for compilation of files.<br />
* '''FileValidator''' for modules that extend FileValidatorModule for validation of files.<br />
<br />
=== Wie werden Felder in der Datenbank angelegt ? ===<br />
Dazu nutzt man den Typ "Fieldtype"<br />
<br />
=== Wo rendert man die Ausgabe ? ===<br />
Bei Ryan Cramers Event Beispiel legt er zwei Klassen Event und EventArray an, die auch die Render Funktionen enthalten.<br />
<br />
== Spezielle Funktionen in Modulen ==<br />
<br />
=== getModuleInfo ===<br />
Ist die einzige Pflichtfunktion in Modulen. Hier werden title, version, summary und weitere Daten hinterlegt. Hier kann man auch angeben ob ein Modul ein Autoload Modul ist.<br />
<br />
=== init ===<br />
public function init(){}<br />
Initialisiert das Modul. ProcessWire ruft diese Funktion auf, wenn das Modul geladen ist. Bei Autoload Modulen wird es aufgerufen wenn die ProcessWire API bereit ist. Daher ist es ein guter Ort um Hooks einzubinden.<br />
<br />
=== ready ===<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
if($this->page->template == 'admin') {<br />
$this->message($this->hi());<br />
}<br />
}<br />
</syntaxhighlight><br />
Wird in autoload Modulen aufgerufen wenn die API bereit ist. Nützlich für Hooks:<br />
<br />
=== execute ===<br />
<syntaxhighlight lang="php"><br />
/**<br />
* This function is executed when a page with your Process assigned is accessed. <br />
*<br />
* This can be seen as your main or index function. You'll probably want to replace<br />
* everything in this function. <br />
*<br />
*/<br />
public function ___execute() {<br />
// greetingType and greeting are automatically populated to this module<br />
// and they were defined in ProcessHello.config.php<br />
if($this->greetingType == 'message') {<br />
$this->message($this->greeting); <br />
} else if($this->greetingType == 'warning') {<br />
$this->warning($this->greeting); <br />
} else {<br />
$this->error($this->greeting); <br />
}<br />
// generate some navigation<br />
$out = "<br />
<h2>$this->greeting</h2><br />
<dl class='nav'><br />
<dt><a href='./something/'>Do Something</a></dt><br />
<dd>Runs the executeSomething() function.</dd><br />
</dl><br />
";<br />
return $out;<br />
} <br />
</syntaxhighlight><br />
<br />
=== executeSomething ===<br />
<syntaxhighlight lang="php"><br />
/**<br />
* Called when the URL is this module's page URL + "/something/"<br />
*<br />
*/<br />
public function ___executeSomething() {<br />
// set a new headline, replacing the one used by our page<br />
// this is optional as PW will auto-generate a headline <br />
$this->headline('This is something!'); <br />
// add a breadcrumb that returns to our main page <br />
// this is optional as PW will auto-generate breadcrumbs<br />
$this->breadcrumb('../', 'Hello'); <br />
$out = "<br />
<h2>Not much to to see here</h2><br />
<p><a href='../'>Go Back</a></p><br />
";<br />
return $out; <br />
}<br />
</syntaxhighlight><br />
<br />
=== install & uninstall ===<br />
<syntaxhighlight lang="php"><br />
<br />
/**<br />
* Called only when your module is installed<br />
*<br />
* If you don't need anything here, you can simply remove this method. <br />
*<br />
*/<br />
public function ___install() {<br />
parent::___install(); // always remember to call parent method<br />
}<br />
/**<br />
* Called only when your module is uninstalled<br />
*<br />
* This should return the site to the same state it was in before the module was installed. <br />
*<br />
* If you don't need anything here, you can simply remove this method. <br />
*<br />
*/<br />
public function ___uninstall() {<br />
parent::___uninstall(); // always remember to call parent method<br />
}<br />
</syntaxhighlight><br />
<br />
== Vererbung und Eigenschaften in Modulen ==<br />
Modules are not different from PHP classes.<br />
<br />
To change the properties of MyModule class from within MyOtherModule class, you can either:<br />
<br />
#Make MyOtherModule class extend MyModule. It will thus inherit MyModule's public and protected properties and methods<br />
#Make the properties firstName and lastName configurable by passing them as parameters/arguments in MyModule's constructor method.<br />
<br />
== Autoload Module und Hooks ==<br />
Autoload werden automatisch geladen müssen also nicht in einem Template o.ä. gestartet werden. Daher bieten sie sich an um die Funktionalität von ProcessWire zu erweitern. Als Werkzeug dafür dienen Hooks. Mit Hooks kann man an vielen Stellen den Rendering Process der Seiten beeinflussen. Außerdem kann man für eigene Module ebenfalls Hooks bereitstellen. <br />
<br />
=== Hooks ===<br />
https://processwire.com/docs/modules/hooks/<br />
Hooks sind ein mächtiges Werkzeug. Sie geben einem die Möglichkeit an vielen Stellen "einzuhaken" und Funktionalität einzubauen.<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
$this->addHookAfter('Page::render', function($event) {<br />
$event->return .= '<p>Hallo</p>';<br />
});<br />
}<br />
</syntaxhighlight><br />
Schreibt am Ende Jeder Seite ein "Hallo". Das $event Objekt ist ein [https://processwire.com/api/ref/hook-event/ HookEvent]. Im Beispiel fügen wir einfach etwas Markup hinzu. Über $event->arguments() kann man aber auf ale Argumente zugreifen.<br />
<br />
Das gleiche aber nicht mit anonymer Funktion:<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
// add hook after Page::render() and make it call the "test" method of $this module<br />
$this->addHookAfter('Page::render', $this, 'test');<br />
}<br />
<br />
public function test($event) {<br />
// modify the return value of Page::render() to include the following:<br />
$event->return .= '<p>Hallo</p>';<br />
}<br />
</syntaxhighlight><br />
<br />
=== Hooks zum erweitern von existierenden Klassen nutzen ===<br />
Mit Hooks kann man in vorhandene Klassen einhaken. Z.B. läßt sich das Page Objekt erweitern.<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
$this->addHook('Page::summarize', $this, 'summarize');<br />
}<br />
public function summarize($event) {<br />
$page = $event->object; // the $event->object represents the object hooked (Page)<br />
$maxlen = $event->arguments(0); // first argument is the optional max length<br />
if(!$maxlen) $maxlen = 200; // if no $maxlen was present, we'll use a default of 200<br />
$summary = $this->sanitizer->truncate($page->body, $maxlen); // use sanitizer truncate method to create a summary<br />
$event->return = $summary; // populate $summary to $event->return, the return value<br />
}<br />
</syntaxhighlight><br />
So kann man ganz einfach eine Zusammenfassung aller Kindseiten in einem Template rendern:<br />
<syntaxhighlight lang="php"><br />
foreach($page->children as $item) {<br />
$summary = $item->summarize(150);<br />
echo "<li><a href='$item->url'>$item->title</a><br>$summary";<br />
}<br />
</syntaxhighlight><br />
<br />
=== Hook Beispiele ===<br />
Hook am Ende des Renderings<br />
$this->addHookAfter('Page::render', function($event) {...});<br />
Füge eine Funktion "summarize" zum Page Objekt hinzu.<br />
$this->addHook('Page::summarize', $this, 'summarize');<br />
Hook auf eine einzelne Instanz (hier pages Objekt)<br />
$this->pages->addHookAfter('saved', function($event){...});<br />
$this->addHook('Page::method', ...) // Spricht ALLE Instanzen an - Regelfall<br />
$page->addHook('method', ...) // Spricht nur die EINE Instanz der Seite an.<br />
</pre><br />
<br />
=== Autoload Module nur im Admin Bereich laden ===<br />
'autoload' => 'template=admin' <br />
statt<br />
'autoload' => true<br />
<br />
== Beispiele ==<br />
=== Frontend Rendering Module ===<br />
A bit old but working<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
/**<br />
* FrontEndRender<br />
*<br />
* Author: Ben Byford<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2010 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class FrontEndRender extends WireData implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'FrontEndRender',<br />
'version' => 0.1,<br />
'summary' => "Outputs html and static variables to frontend",<br />
'author' => 'Ben Byford',<br />
'singular' => true,<br />
'href' => 'https://github.com/benbyford/PW-starter-modules'<br />
);<br />
}<br />
<br />
// protected variable only accessable within module<br />
protected $name = 'Ben';<br />
<br />
/*<br />
* render function to be called in PW template like this:<br />
* $FrontEndRender = $modules->getModule('FrontEndRender');<br />
* echo '<h1>' . $FrontEndRender->render() . '</h1>';<br />
*<br />
*/<br />
public function render(){<br />
return "Hello " . $this->name;<br />
}<br />
}<br />
?><br />
</syntaxhighlight><br />
<br />
=== ProcessWire Hello World Modul ===<br />
Beispiel Modul mit Hooks (liegt immer in der Standardinstallation)<br />
<syntaxhighlight lang="php"><br />
<?php namespace ProcessWire;<br />
<br />
/**<br />
* ProcessWire 'Hello world' demonstration module<br />
*<br />
* Demonstrates the Module interface and how to add hooks.<br />
* <br />
* See README file for further links regarding module development.<br />
* <br />
* This file is licensed under the MIT license<br />
* https://processwire.com/about/license/mit/<br />
* <br />
* ProcessWire 3.x, Copyright 2016 by Ryan Cramer<br />
* https://processwire.com<br />
*<br />
*/<br />
<br />
class Helloworld extends WireData implements Module {<br />
<br />
/**<br />
* getModuleInfo is a module required by all modules to tell ProcessWire about them<br />
*<br />
* @return array<br />
*<br />
*/<br />
public static function getModuleInfo() {<br />
<br />
return array(<br />
<br />
// The module's title, typically a little more descriptive than the class name<br />
'title' => 'Hello World', <br />
<br />
// version number <br />
'version' => 3, <br />
<br />
// summary is brief description of what this module is<br />
'summary' => 'An example module used for demonstration purposes.',<br />
<br />
// Optional URL to more information about the module<br />
'href' => 'https://processwire.com',<br />
<br />
// singular=true: indicates that only one instance of the module is allowed.<br />
// This is usually what you want for modules that attach hooks. <br />
'singular' => true, <br />
<br />
// autoload=true: indicates the module should be started with ProcessWire.<br />
// This is necessary for any modules that attach runtime hooks, otherwise those<br />
// hooks won't get attached unless some other code calls the module on it's own.<br />
// Note that autoload modules are almost always also 'singular' (seen above).<br />
'autoload' => true, <br />
<br />
// Optional font-awesome icon name, minus the 'fa-' part<br />
'icon' => 'smile-o', <br />
);<br />
}<br />
<br />
/**<br />
* Initialize the module<br />
*<br />
* ProcessWire calls this when the module is loaded. For 'autoload' modules, this will be called<br />
* when ProcessWire's API is ready. As a result, this is a good place to attach hooks. <br />
*<br />
*/<br />
public function init() {<br />
<br />
// add a hook after the $pages->save, to issue a notice every time a page is saved<br />
$this->pages->addHookAfter('save', $this, 'example1'); <br />
<br />
// add a hook after each page is rendered and modify the output<br />
$this->addHookAfter('Page::render', $this, 'example2'); <br />
<br />
// add a 'hello' method to every page that returns "Hello World"<br />
// use "echo $page->hello();" in your template file to display output<br />
$this->addHook('Page::hello', $this, 'example3'); <br />
<br />
// add a 'hello_world' property to every page that returns "Hello [user]"<br />
// use "echo $page->hello_world;" in your template file to display output<br />
$this->addHookProperty('Page::hello_world', $this, 'example4'); <br />
}<br />
<br />
/**<br />
* Example1 hooks into the pages->save method and displays a notice every time a page is saved<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example1($event) {<br />
/** @var Page $page */<br />
$page = $event->arguments[0]; <br />
$this->message("Hello World! You saved {$page->path}."); <br />
}<br />
<br />
<br />
/**<br />
* Example2 hooks into every page after it's rendered and adds "Hello World" text at the bottom<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example2($event) {<br />
<br />
/** @var Page $page */<br />
$page = $event->object; <br />
<br />
// don't add this to the admin pages<br />
if($page->template == 'admin') return;<br />
<br />
// add a "Hello World" paragraph right before the closing body tag<br />
$event->return = str_replace("</body>", "<p>Hello World!</p></body>", $event->return); <br />
}<br />
<br />
/**<br />
* Example3 adds a 'hello' method (not property) to every page that simply returns "Hello World"<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example3($event) {<br />
$event->return = "Hello World";<br />
}<br />
<br />
/**<br />
* Example 4 adds a 'hello_world' property (not method) to every page that returns "Hello [user]"<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example4($event) {<br />
$event->return = "Hello " . $this->user->name; <br />
}<br />
<br />
}<br />
<br />
</syntaxhighlight><br />
<br />
=== ProcessWire Admin Bereich mit eigener Funktionalität erweitern (Modul)===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<syntaxhighlight lang="php"><br />
<br />
<?php<br />
/**<br />
* ProcessSimpleAdminPage<br />
*<br />
* @author Ben Byford<br />
* http://www.benbyford.com<br />
*<br />
* @see http://www.processwire.com<br />
*/<br />
<br />
class ProcessSimpleAdminPage extends Process {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'Process Simple Admin Page',<br />
'summary' => 'Simple Process module that adds new admin page with',<br />
'version' => 001,<br />
<br />
// Modules that extend Process may specify a 'page' attribute in the<br />
// getModuleInfo(), this page will automatically be given the module<br />
// process when added to teh pagetree.<br />
<br />
// I have exampled but commented out the 'page' settings below<br />
// so that I can show how one might add a page to install() and<br />
// uninstall() in this and other modules (that might not extend<br />
// Process)<br />
<br />
<br />
// 'page' => array(<br />
// 'name' => 'site-config',<br />
// 'parent' => 'admin',<br />
// 'title' => 'Site Config'<br />
// )<br />
);<br />
}<br />
<br />
public function execute() {<br />
return '<br />
<h2>Edit the text here in the module</h2><br />
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam mattis eros vitae metus sodales eget suscipit purus rhoncus. Proin ultrices gravida dolor, non porttitor enim interdum vitae. Integer feugiat lacinia tincidunt. Nulla laoreet tristique tristique. Sed elementum justo a nisl elementum sit amet accumsan nisi tempor. Nulla quis eros et massa dignissim imperdiet a vitae purus.</p><br />
<br />
<p>Donec scelerisque pulvinar sem eu lobortis. Maecenas turpis ipsum, tempus dictum pharetra eu, consectetur vitae arcu. Fusce orci mauris, semper at tempus quis, volutpat molestie tellus. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Sed quam tortor, tincidunt sed semper lacinia, scelerisque dapibus quam. Morbi at nisi luctus lacus auctor ultrices eu eu leo.</p><br />
<br />
<p>Praesent faucibus purus id felis tincidunt dignissim. Sed sit amet ligula mi, eget semper dui. Proin consectetur gravida massa, nec luctus purus hendrerit in. Etiam volutpat, elit non venenatis suscipit, libero neque consectetur diam, id rutrum magna odio ac ligula. Maecenas sollicitudin congue neque fermentum vestibulum. Morbi nec leo nisi. Donec at nisl odio, et porta ligula.</p><br />
<br />
<p>Sed quis arcu nisi, ac tempor augue. Praesent non elit libero, a ullamcorper lorem. Curabitur porta odio eu nunc ultricies interdum id nec risus. Donec nibh nibh, porta eget vehicula ac, aliquet eget ante. Phasellus eget lorem eu eros eleifend ultrices. Cras sit amet neque sit amet nibh fringilla cursus ut id mauris. Praesent quis nunc justo, sed suscipit lectus. Phasellus eget ultrices risus. Curabitur eu semper est. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Ut suscipit, nisl ut imperdiet eleifend, turpis arcu placerat tortor, nec laoreet lacus neque ac tellus. Aenean ac lacus justo, quis ultricies nisi.</p><br />
';<br />
}<br />
public function install(){<br />
<br />
// create new page to add to CMS<br />
$page = new Page();<br />
<br />
// add page attributes<br />
$page->template = "admin";<br />
$page->name = "cms-faq";<br />
$page->title = "CMS FAQ";<br />
$page->save();<br />
<br />
// set this module as the page process, this allows us to display the above<br />
$page->process = 'ProcessSimpleAdminPage';<br />
<br />
// get admin page and set as page parent<br />
$admin = $this->pages->get("id=2");<br />
$page->parent = $admin;<br />
<br />
// save page<br />
$page->save();<br />
}<br />
<br />
public function uninstall(){<br />
<br />
// delete created page<br />
$page = $this->pages->get("name=cms-faq");<br />
if(count($page)) $this->pages->delete($page, true);<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
=== ProcessWire Textformatter Modul ===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
/**<br />
* TextformatterFindReplace<br />
*<br />
* Author: Ben Byford<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2010 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class TextformatterFindReplace extends Textformatter implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'TextformatterFindReplace',<br />
'version' => 0.1,<br />
'summary' => "Finds and replaces any instance of config input to config output",<br />
'author' => 'Ben Byford',<br />
'singular' => true,<br />
'href' => 'https://github.com/benbyford/PW-starter-modules'<br />
);<br />
}<br />
<br />
<br />
/**<br />
* Find and Replace the input string<br />
*<br />
* @param string $str The block of text to parse<br />
*<br />
* The incoming string is replaced with the formatted version of itself.<br />
**/<br />
<br />
public function format(&$str) {<br />
$find = $this->findStr;<br />
$str = preg_replace_callback($find, array($this,"replace"), $str);<br />
<br />
}<br />
<br />
// adding three underscores to a function allows other modules to hook it<br />
public function ___replace($match) {<br />
return $this->replaceStr;<br />
}<br />
}<br />
?><br />
</syntaxhighlight><br />
<br />
=== Admin Funktionalität: Countdown zum Seitenveröffentlichen ===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<br />
The module PageDeferredPublish, on clicking one of the '''Publish Later buttons''', sets LazyCron to check that page’s countdown every minute and publishes the page when its countdown reaches 0. This means I can publish a page approximately 24 hours in advance (obviously the checking interval and delay time can be changed to your requirements).<br />
<br />
I did this by:<br />
<br />
'''Creating two fields''' within my install() function: a checkbox field to set to true when a button is checked to indicate the page should countdown, and a countdown field to store the count in seconds for that specific page.<br />
<br />
'''Adding hooks''' to both ''ProcessPageEdit::buildForm'' and ''ProcessPageListActions::getExtraActions'' enabling me to add the two buttons.<br />
<br />
Checking to see if one of the buttons was clicked with my '''ready() function''' then setting the corresponding page’s checkbox to true.<br />
<br />
Using a '''LazyCron hook function''' to check all pages that are unpublished for true checkboxes and then comparing the seconds field to see if the page needs publishing. If not then deduct the elapsed time in seconds.<br />
<br />
The result is a '''module that has settings''' (the time interval to check and publish at a later time), '''hooks into the admin''' using buttons and fields, and enables us to '''use other modules installe'''d in PW (i.e. LazyCron).<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
/**<br />
* DeferredPublish (0.0.1)<br />
* DeferredPublish publishes a page after a defined amount of time has elapsed using lazycron.<br />
*<br />
* @author Ben Byford<br />
* http://www.benbyford.com<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2011 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class PageDeferredPublish extends WireData implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => "PageDeferredPublish",<br />
'version' => "0.0.1",<br />
'summary' => "PageDeferredPublish",<br />
'author' => "Ben Byford",<br />
'href' => "https://github.com/benbyford/PW-intermediate-modules",<br />
'icon' => "clock-o",<br />
'autoload' => true,<br />
'singular' => true,<br />
'requires' => "LazyCron",<br />
);<br />
}<br />
<br />
private $postPubLater = null;<br />
private $pageID = null;<br />
private $pagePubLater = null;<br />
private $currentPage = null;<br />
<br />
private $submitName = 'pdp_pub_later_submit';<br />
private $listPageName = 'pdp_pub_later_list';<br />
private $fieldName = 'pdp_pub_later';<br />
private $checkboxName = 'pdp_pub_later_check';<br />
<br />
private $defaultInterval = 'everyMinute';<br />
private $defaultTime = 86400;<br />
<br />
<br />
public function install(){<br />
// add new fields needed for module<br />
$this->installFields();<br />
}<br />
public function uninstall(){<br />
// uninstall fields<br />
$this->uninstallFields();<br />
}<br />
<br />
// initialize the hook in your AutoLoad module<br />
public function init() {<br />
<br />
// get defaults from module setting in CMS<br />
$this->defaultTime = $this->pub_after;<br />
$this->defaultInterval = $this->cron_check;<br />
<br />
// get admin URL<br />
$this->adminUrl = $this->wire('config')->urls->admin;<br />
<br />
// add hooks to CRON, PageList, PageEdit<br />
$this->addHookAfter("LazyCron::{$this->defaultInterval}", $this, 'publishDefferedPages');<br />
$this->addHook("ProcessPageListActions::getExtraActions", $this, 'hookPageListActions');<br />
$this->addHookAfter("ProcessPageEdit::buildForm", $this, "editForm");<br />
}<br />
<br />
public function ready() {<br />
<br />
// if list button clicked then grab id<br />
$this->pagePubLater = $this->input->get($this->listPageName);<br />
$this->pageID = $this->input->id;<br />
<br />
// get page<br />
$this->currentPage = $this->pages->get($this->pageID);<br />
<br />
// if pagelist pub later submit button clicked<br />
if($this->pagePubLater){<br />
$this->message("Page {$this->currentPage->name} deffered for publish.");<br />
}<br />
<br />
// if page edit submit button clicked<br />
$this->postPubLater = $this->input->post($this->submitName);<br />
if($this->postPubLater){<br />
$this->message("Page {$this->currentPage->name} deffered for publish.");<br />
}<br />
<br />
// if either deffered publish sumbit found then publish page later<br />
if($this->pagePubLater || $this->postPubLater){<br />
$this->publishLater();<br />
}<br />
}<br />
<br />
/*<br />
* Hook: ProcessPageEdit::buildForm<br />
*<br />
* add Publish Later button to edit page if not yet published<br />
*/<br />
public function ___editForm(HookEvent $form) {<br />
<br />
// get the InputFieldForm object from the event (return value of buildForm())<br />
$form = $form->return;<br />
<br />
$page = $this->pages->get($this->input->get->id);<br />
$check = $page->get($this->checkboxName);<br />
<br />
// check if publish button available and therfore unpublished<br />
$target = $form->get('submit_publish');<br />
<br />
if($target && $check == false){<br />
<br />
// get InputfieldText module<br />
$submit2 = $this->modules->get('InputfieldSubmit');<br />
$submit2->attr('name', $this->submitName);<br />
$submit2->attr('id', 'publish_later');<br />
$submit2->attr('class', 'ui-button ui-widget ui-corner-all head_button_clone ui-state-default ui-priority-secondary');<br />
$submit2->attr('value', 'Publish Later'); // Button: save unpublished<br />
<br />
// get form element save and place before<br />
$target = $form->get('submit_save');<br />
$form->insertBefore($submit2, $target);<br />
<br />
$form->return = $form;<br />
}<br />
}<br />
<br />
public function ___hookPageListActions(HookEvent $event) {<br />
<br />
// get current page<br />
$page = $event->arguments[0];<br />
<br />
// check to see if page is published<br />
$pagePub = $page->is(Page::statusUnpublished);<br />
<br />
// check to see if page template has deffered field<br />
$pageHasDefferField = $page->get($this->fieldName);<br />
<br />
$actions = array();<br />
<br />
// don't get homepage or pages that are already published or are being deffered for publish<br />
if($page->id > 1 && $pagePub == "published" && !is_null($pageHasDefferField) && $page->get($this->checkboxName) == false) {<br />
<br />
$actions['publish_later'] = array(<br />
'cn' => 'PublishLater',<br />
'name' => 'pub later',<br />
'url' => "{$this->adminUrl}?{$this->listPageName}=1&id={$page->id}",<br />
);<br />
}<br />
if(count($actions)) $event->return = $actions + $event->return;<br />
}<br />
<br />
/*<br />
* Publish Page on cron job<br />
*<br />
* Gets deffered page and publishes<br />
*/<br />
public function ___publish($page) {<br />
$page->removeStatus(Page::statusUnpublished);<br />
$page->removeStatus(Page::statusHidden);<br />
$page->Save();<br />
}<br />
<br />
/*<br />
* Main publish later function<br />
*<br />
* Gets deffered page and sets fields to be checked be lazy cron<br />
*/<br />
private function ___publishLater() {<br />
<br />
// get page<br />
$page = $this->pages->get($this->pageID);<br />
<br />
// set output formatting to false<br />
$page->of(false);<br />
<br />
// set field time to settings default time and checkbox to true<br />
$page->set($this->checkboxName, true);<br />
$page->set($this->fieldName, $this->defaultTime);<br />
<br />
// save page<br />
$page->save();<br />
$page->of(true);<br />
}<br />
<br />
/*<br />
* Lazy Cron hook function<br />
*<br />
* Triggers every [set time interval] and checks pages<br />
* Publishes page if time runout<br />
*<br />
* Adds publish page log<br />
*/<br />
public function ___publishDefferedPages(HookEvent $e){<br />
<br />
// seconds since last lazycron<br />
$seconds = $e->arguments[0];<br />
<br />
// find all pages with deffered field<br />
$defferedPages = $this->pages->find("{$this->checkboxName}=1,include=unpublished");<br />
<br />
// for each page decrease time for deffered field<br />
foreach ($defferedPages as $page) {<br />
<br />
// get current page time<br />
$timeTillPublish = $page->get($this->fieldName);<br />
<br />
// set time to time minus time past<br />
$timeLeft = $timeTillPublish - $seconds;<br />
<br />
// if time passed 0 or less then publish page<br />
$page->of(false);<br />
if($timeLeft <= 0){<br />
// remove flags and save<br />
$this->publish($page);<br />
<br />
$page->set($this->fieldName, 0);<br />
$page->set($this->checkboxName, 0);<br />
<br />
// log a page has been published<br />
$log = wire('log');<br />
$log->message('CRON:'. $seconds .' Pages: '. $page->name .' published');<br />
}else{<br />
$page->set($this->fieldName, $timeLeft);<br />
}<br />
// save page time<br />
$page->Save();<br />
$page->of(true);<br />
}<br />
}<br />
<br />
/*<br />
* Install new module specific fields<br />
*/<br />
private function installFields(){<br />
<br />
// install pub later checkbox field<br />
// find installed fields<br />
$f = $this->fields->get($this->fieldName);<br />
if($f){<br />
<br />
// if field already found then don't try and make it<br />
$this->message($this->fieldName . ' field found');<br />
<br />
}else{<br />
<br />
// create new field object to store crontime<br />
$f = new Field();<br />
// get a field type<br />
$f->type = $this->modules->get("FieldtypeInteger");<br />
$f->name = $this->fieldName;<br />
$f->label = 'Publish Time Left';<br />
$f->defaultValue = $this->defaultTime;<br />
$f->icon = 'clock-o';<br />
$f->columnWidth = 50;<br />
$f->collapsed = 1;<br />
$f->flags = 4;<br />
<br />
$f->save(); // save the field<br />
<br />
// create new field object to store whether to publish or not<br />
$f = new Field();<br />
// get a field type<br />
$f->type = $this->modules->get("FieldtypeCheckbox");<br />
$f->name = $this->checkboxName;<br />
$f->label = 'Publish Page later';<br />
$f->defaultValue = false;<br />
$f->columnWidth = 50;<br />
$f->icon = 'clock-o';<br />
$f->collapsed = 1;<br />
$f->flags = 4;<br />
<br />
$f->save(); // save the field<br />
}<br />
}<br />
<br />
/*<br />
* Uninstall module specific fields<br />
*/<br />
private function uninstallFields(){<br />
<br />
// find installed fields<br />
$fInt = $this->fields->get($this->fieldName);<br />
$fCheck = $this->fields->get($this->checkboxName);<br />
<br />
if($fInt && $fCheck){<br />
$fieldIntUsed = $fInt->numFieldgroups();<br />
$fieldCheckUsed = $fCheck->numFieldgroups();<br />
<br />
if($fieldIntUsed){<br />
// field in use by template<br />
$this->message('Unable to uninstall field '.$fInt->name);<br />
}else{<br />
// delete installed fields<br />
$this->fields->delete($fInt);<br />
$this->fields->save;<br />
}<br />
<br />
if($fieldCheckUsed){<br />
// field in use by template<br />
$this->message('Unable to uninstall field '.$fCheck->name);<br />
}else{<br />
// delete installed fields<br />
$this->fields->delete($fCheck);<br />
$this->fields->save;<br />
}<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
=== Inputfield / Fieldtype ===<br />
[[ProcessWire - Fieldtype erstellen (Module)]]</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Module_schreiben&diff=24248ProcessWire - Module schreiben2020-01-06T10:05:53Z<p>84.136.104.26: /* execute */</p>
<hr />
<div>== Links ==<br />
Wichtigste Resourcen<br />
https://processwire.com/docs/modules/development/ - Guter Ausgangspunkt<br />
https://processwire.com/api/ref/module/ - Module API<br />
https://processwire.com/api/ref/configurable-module/ - Klasse für Konfigurierbare Module<br />
https://processwire.com/docs/modules/types/ - Welche Modultypen gibt es ?<br />
https://github.com/ryancramerdesign/ProcessHello - Modul Skelett Beispiel für eigene Backend (Process) Module<br />
https://github.com/ryancramerdesign/FieldtypeMapMarker - Beispiel für ein Fieldtype und Inputfield Modul<br />
https://processwire.com/talk/topic/778-module-dependencies/ - Module die andere Module benötigen<br />
https://processwire.com/talk/forum/19-moduleplugin-development/ - Forum zum Thema Module entwickeln<br />
http://somatonic.github.io/Captain-Hook/ - Hook Cheatsheet<br />
https://processwire.com/blog/posts/new-module-configuration-options/ - Neuere Konfigurationsmöglichkeiten<br />
Weitere Links<br />
https://webdesign.tutsplus.com/tutorials/a-beginners-introduction-to-writing-modules-in-processwire--cms-26862<br />
https://processwire.com/docs/modules/ - Introduction, Development, Hooks, Types, Pro Modules, Third Party<br />
<br />
<br />
<br />
<br />
[[ProcessWire - Module Snippets]]<br />
<br />
== Wo - Was ? ==<br />
=== Welche Typen von Modulen gibt es ? ===<br />
https://processwire.com/docs/modules/types/<br />
* '''Fieldtype''': Repräsentiert einen Datentyp. Meistens keine Public API, Handelt Daten / Datenbank - https://processwire.com/api/ref/fieldtype/<br />
* '''Inputfield''': Sammelt User Eingaben über ein Formular im Admin Bereich. Im Gegensatz zum Fieldtype geht es hier um das UI im Backend. Das Handling der Daten liegt beim Fieldtype.<br />
* '''Process''' for creating admin processes/applications.<br />
* '''Textformatter''' for formatting text.<br />
* '''AdminTheme''' for creating themes in the admin.<br />
* '''WireMail''' for modules that send email and extend the WireMail class.<br />
* '''Tfa''' for implementing a specific kind of two-factor authentication.<br />
* '''ImageSizerEngine''' for modules that extend ImageSizerEngine for resizing images.<br />
* '''FileCompiler''' for modules that extend FileCompilerModule for compilation of files.<br />
* '''FileValidator''' for modules that extend FileValidatorModule for validation of files.<br />
<br />
=== Wie werden Felder in der Datenbank angelegt ? ===<br />
Dazu nutzt man den Typ "Fieldtype"<br />
<br />
=== Wo rendert man die Ausgabe ? ===<br />
Bei Ryan Cramers Event Beispiel legt er zwei Klassen Event und EventArray an, die auch die Render Funktionen enthalten.<br />
<br />
== Spezielle Funktionen in Modulen ==<br />
<br />
=== getModuleInfo ===<br />
Ist die einzige Pflichtfunktion in Modulen. Hier werden title, version, summary und weitere Daten hinterlegt. Hier kann man auch angeben ob ein Modul ein Autoload Modul ist.<br />
<br />
=== init ===<br />
public function init(){}<br />
Initialisiert das Modul. ProcessWire ruft diese Funktion auf, wenn das Modul geladen ist. Bei Autoload Modulen wird es aufgerufen wenn die ProcessWire API bereit ist. Daher ist es ein guter Ort um Hooks einzubinden.<br />
<br />
=== ready ===<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
if($this->page->template == 'admin') {<br />
$this->message($this->hi());<br />
}<br />
}<br />
</syntaxhighlight><br />
Wird in autoload Modulen aufgerufen wenn die API bereit ist. Nützlich für Hooks:<br />
<br />
=== execute ===<br />
<syntaxhighlight lang="php"><br />
/**<br />
* This function is executed when a page with your Process assigned is accessed. <br />
*<br />
* This can be seen as your main or index function. You'll probably want to replace<br />
* everything in this function. <br />
*<br />
*/<br />
public function ___execute() {<br />
// greetingType and greeting are automatically populated to this module<br />
// and they were defined in ProcessHello.config.php<br />
if($this->greetingType == 'message') {<br />
$this->message($this->greeting); <br />
} else if($this->greetingType == 'warning') {<br />
$this->warning($this->greeting); <br />
} else {<br />
$this->error($this->greeting); <br />
}<br />
// generate some navigation<br />
$out = "<br />
<h2>$this->greeting</h2><br />
<dl class='nav'><br />
<dt><a href='./something/'>Do Something</a></dt><br />
<dd>Runs the executeSomething() function.</dd><br />
</dl><br />
";<br />
return $out;<br />
} <br />
</syntaxhighlight><br />
<br />
=== executeSomething ==<br />
<syntaxhighlight lang="php"><br />
/**<br />
* Called when the URL is this module's page URL + "/something/"<br />
*<br />
*/<br />
public function ___executeSomething() {<br />
// set a new headline, replacing the one used by our page<br />
// this is optional as PW will auto-generate a headline <br />
$this->headline('This is something!'); <br />
// add a breadcrumb that returns to our main page <br />
// this is optional as PW will auto-generate breadcrumbs<br />
$this->breadcrumb('../', 'Hello'); <br />
$out = "<br />
<h2>Not much to to see here</h2><br />
<p><a href='../'>Go Back</a></p><br />
";<br />
return $out; <br />
}<br />
</syntaxhighlight><br />
<br />
=== install & uninstall ===<br />
<syntaxhighlight lang="php"><br />
<br />
/**<br />
* Called only when your module is installed<br />
*<br />
* If you don't need anything here, you can simply remove this method. <br />
*<br />
*/<br />
public function ___install() {<br />
parent::___install(); // always remember to call parent method<br />
}<br />
/**<br />
* Called only when your module is uninstalled<br />
*<br />
* This should return the site to the same state it was in before the module was installed. <br />
*<br />
* If you don't need anything here, you can simply remove this method. <br />
*<br />
*/<br />
public function ___uninstall() {<br />
parent::___uninstall(); // always remember to call parent method<br />
}<br />
</syntaxhighlight><br />
<br />
== Vererbung und Eigenschaften in Modulen ==<br />
Modules are not different from PHP classes.<br />
<br />
To change the properties of MyModule class from within MyOtherModule class, you can either:<br />
<br />
#Make MyOtherModule class extend MyModule. It will thus inherit MyModule's public and protected properties and methods<br />
#Make the properties firstName and lastName configurable by passing them as parameters/arguments in MyModule's constructor method.<br />
<br />
== Autoload Module und Hooks ==<br />
Autoload werden automatisch geladen müssen also nicht in einem Template o.ä. gestartet werden. Daher bieten sie sich an um die Funktionalität von ProcessWire zu erweitern. Als Werkzeug dafür dienen Hooks. Mit Hooks kann man an vielen Stellen den Rendering Process der Seiten beeinflussen. Außerdem kann man für eigene Module ebenfalls Hooks bereitstellen. <br />
<br />
=== Hooks ===<br />
https://processwire.com/docs/modules/hooks/<br />
Hooks sind ein mächtiges Werkzeug. Sie geben einem die Möglichkeit an vielen Stellen "einzuhaken" und Funktionalität einzubauen.<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
$this->addHookAfter('Page::render', function($event) {<br />
$event->return .= '<p>Hallo</p>';<br />
});<br />
}<br />
</syntaxhighlight><br />
Schreibt am Ende Jeder Seite ein "Hallo". Das $event Objekt ist ein [https://processwire.com/api/ref/hook-event/ HookEvent]. Im Beispiel fügen wir einfach etwas Markup hinzu. Über $event->arguments() kann man aber auf ale Argumente zugreifen.<br />
<br />
Das gleiche aber nicht mit anonymer Funktion:<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
// add hook after Page::render() and make it call the "test" method of $this module<br />
$this->addHookAfter('Page::render', $this, 'test');<br />
}<br />
<br />
public function test($event) {<br />
// modify the return value of Page::render() to include the following:<br />
$event->return .= '<p>Hallo</p>';<br />
}<br />
</syntaxhighlight><br />
<br />
=== Hooks zum erweitern von existierenden Klassen nutzen ===<br />
Mit Hooks kann man in vorhandene Klassen einhaken. Z.B. läßt sich das Page Objekt erweitern.<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
$this->addHook('Page::summarize', $this, 'summarize');<br />
}<br />
public function summarize($event) {<br />
$page = $event->object; // the $event->object represents the object hooked (Page)<br />
$maxlen = $event->arguments(0); // first argument is the optional max length<br />
if(!$maxlen) $maxlen = 200; // if no $maxlen was present, we'll use a default of 200<br />
$summary = $this->sanitizer->truncate($page->body, $maxlen); // use sanitizer truncate method to create a summary<br />
$event->return = $summary; // populate $summary to $event->return, the return value<br />
}<br />
</syntaxhighlight><br />
So kann man ganz einfach eine Zusammenfassung aller Kindseiten in einem Template rendern:<br />
<syntaxhighlight lang="php"><br />
foreach($page->children as $item) {<br />
$summary = $item->summarize(150);<br />
echo "<li><a href='$item->url'>$item->title</a><br>$summary";<br />
}<br />
</syntaxhighlight><br />
<br />
=== Hook Beispiele ===<br />
Hook am Ende des Renderings<br />
$this->addHookAfter('Page::render', function($event) {...});<br />
Füge eine Funktion "summarize" zum Page Objekt hinzu.<br />
$this->addHook('Page::summarize', $this, 'summarize');<br />
Hook auf eine einzelne Instanz (hier pages Objekt)<br />
$this->pages->addHookAfter('saved', function($event){...});<br />
$this->addHook('Page::method', ...) // Spricht ALLE Instanzen an - Regelfall<br />
$page->addHook('method', ...) // Spricht nur die EINE Instanz der Seite an.<br />
</pre><br />
<br />
=== Autoload Module nur im Admin Bereich laden ===<br />
'autoload' => 'template=admin' <br />
statt<br />
'autoload' => true<br />
<br />
== Beispiele ==<br />
=== Frontend Rendering Module ===<br />
A bit old but working<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
/**<br />
* FrontEndRender<br />
*<br />
* Author: Ben Byford<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2010 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class FrontEndRender extends WireData implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'FrontEndRender',<br />
'version' => 0.1,<br />
'summary' => "Outputs html and static variables to frontend",<br />
'author' => 'Ben Byford',<br />
'singular' => true,<br />
'href' => 'https://github.com/benbyford/PW-starter-modules'<br />
);<br />
}<br />
<br />
// protected variable only accessable within module<br />
protected $name = 'Ben';<br />
<br />
/*<br />
* render function to be called in PW template like this:<br />
* $FrontEndRender = $modules->getModule('FrontEndRender');<br />
* echo '<h1>' . $FrontEndRender->render() . '</h1>';<br />
*<br />
*/<br />
public function render(){<br />
return "Hello " . $this->name;<br />
}<br />
}<br />
?><br />
</syntaxhighlight><br />
<br />
=== ProcessWire Hello World Modul ===<br />
Beispiel Modul mit Hooks (liegt immer in der Standardinstallation)<br />
<syntaxhighlight lang="php"><br />
<?php namespace ProcessWire;<br />
<br />
/**<br />
* ProcessWire 'Hello world' demonstration module<br />
*<br />
* Demonstrates the Module interface and how to add hooks.<br />
* <br />
* See README file for further links regarding module development.<br />
* <br />
* This file is licensed under the MIT license<br />
* https://processwire.com/about/license/mit/<br />
* <br />
* ProcessWire 3.x, Copyright 2016 by Ryan Cramer<br />
* https://processwire.com<br />
*<br />
*/<br />
<br />
class Helloworld extends WireData implements Module {<br />
<br />
/**<br />
* getModuleInfo is a module required by all modules to tell ProcessWire about them<br />
*<br />
* @return array<br />
*<br />
*/<br />
public static function getModuleInfo() {<br />
<br />
return array(<br />
<br />
// The module's title, typically a little more descriptive than the class name<br />
'title' => 'Hello World', <br />
<br />
// version number <br />
'version' => 3, <br />
<br />
// summary is brief description of what this module is<br />
'summary' => 'An example module used for demonstration purposes.',<br />
<br />
// Optional URL to more information about the module<br />
'href' => 'https://processwire.com',<br />
<br />
// singular=true: indicates that only one instance of the module is allowed.<br />
// This is usually what you want for modules that attach hooks. <br />
'singular' => true, <br />
<br />
// autoload=true: indicates the module should be started with ProcessWire.<br />
// This is necessary for any modules that attach runtime hooks, otherwise those<br />
// hooks won't get attached unless some other code calls the module on it's own.<br />
// Note that autoload modules are almost always also 'singular' (seen above).<br />
'autoload' => true, <br />
<br />
// Optional font-awesome icon name, minus the 'fa-' part<br />
'icon' => 'smile-o', <br />
);<br />
}<br />
<br />
/**<br />
* Initialize the module<br />
*<br />
* ProcessWire calls this when the module is loaded. For 'autoload' modules, this will be called<br />
* when ProcessWire's API is ready. As a result, this is a good place to attach hooks. <br />
*<br />
*/<br />
public function init() {<br />
<br />
// add a hook after the $pages->save, to issue a notice every time a page is saved<br />
$this->pages->addHookAfter('save', $this, 'example1'); <br />
<br />
// add a hook after each page is rendered and modify the output<br />
$this->addHookAfter('Page::render', $this, 'example2'); <br />
<br />
// add a 'hello' method to every page that returns "Hello World"<br />
// use "echo $page->hello();" in your template file to display output<br />
$this->addHook('Page::hello', $this, 'example3'); <br />
<br />
// add a 'hello_world' property to every page that returns "Hello [user]"<br />
// use "echo $page->hello_world;" in your template file to display output<br />
$this->addHookProperty('Page::hello_world', $this, 'example4'); <br />
}<br />
<br />
/**<br />
* Example1 hooks into the pages->save method and displays a notice every time a page is saved<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example1($event) {<br />
/** @var Page $page */<br />
$page = $event->arguments[0]; <br />
$this->message("Hello World! You saved {$page->path}."); <br />
}<br />
<br />
<br />
/**<br />
* Example2 hooks into every page after it's rendered and adds "Hello World" text at the bottom<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example2($event) {<br />
<br />
/** @var Page $page */<br />
$page = $event->object; <br />
<br />
// don't add this to the admin pages<br />
if($page->template == 'admin') return;<br />
<br />
// add a "Hello World" paragraph right before the closing body tag<br />
$event->return = str_replace("</body>", "<p>Hello World!</p></body>", $event->return); <br />
}<br />
<br />
/**<br />
* Example3 adds a 'hello' method (not property) to every page that simply returns "Hello World"<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example3($event) {<br />
$event->return = "Hello World";<br />
}<br />
<br />
/**<br />
* Example 4 adds a 'hello_world' property (not method) to every page that returns "Hello [user]"<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example4($event) {<br />
$event->return = "Hello " . $this->user->name; <br />
}<br />
<br />
}<br />
<br />
</syntaxhighlight><br />
<br />
=== ProcessWire Admin Bereich mit eigener Funktionalität erweitern (Modul)===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<syntaxhighlight lang="php"><br />
<br />
<?php<br />
/**<br />
* ProcessSimpleAdminPage<br />
*<br />
* @author Ben Byford<br />
* http://www.benbyford.com<br />
*<br />
* @see http://www.processwire.com<br />
*/<br />
<br />
class ProcessSimpleAdminPage extends Process {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'Process Simple Admin Page',<br />
'summary' => 'Simple Process module that adds new admin page with',<br />
'version' => 001,<br />
<br />
// Modules that extend Process may specify a 'page' attribute in the<br />
// getModuleInfo(), this page will automatically be given the module<br />
// process when added to teh pagetree.<br />
<br />
// I have exampled but commented out the 'page' settings below<br />
// so that I can show how one might add a page to install() and<br />
// uninstall() in this and other modules (that might not extend<br />
// Process)<br />
<br />
<br />
// 'page' => array(<br />
// 'name' => 'site-config',<br />
// 'parent' => 'admin',<br />
// 'title' => 'Site Config'<br />
// )<br />
);<br />
}<br />
<br />
public function execute() {<br />
return '<br />
<h2>Edit the text here in the module</h2><br />
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam mattis eros vitae metus sodales eget suscipit purus rhoncus. Proin ultrices gravida dolor, non porttitor enim interdum vitae. Integer feugiat lacinia tincidunt. Nulla laoreet tristique tristique. Sed elementum justo a nisl elementum sit amet accumsan nisi tempor. Nulla quis eros et massa dignissim imperdiet a vitae purus.</p><br />
<br />
<p>Donec scelerisque pulvinar sem eu lobortis. Maecenas turpis ipsum, tempus dictum pharetra eu, consectetur vitae arcu. Fusce orci mauris, semper at tempus quis, volutpat molestie tellus. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Sed quam tortor, tincidunt sed semper lacinia, scelerisque dapibus quam. Morbi at nisi luctus lacus auctor ultrices eu eu leo.</p><br />
<br />
<p>Praesent faucibus purus id felis tincidunt dignissim. Sed sit amet ligula mi, eget semper dui. Proin consectetur gravida massa, nec luctus purus hendrerit in. Etiam volutpat, elit non venenatis suscipit, libero neque consectetur diam, id rutrum magna odio ac ligula. Maecenas sollicitudin congue neque fermentum vestibulum. Morbi nec leo nisi. Donec at nisl odio, et porta ligula.</p><br />
<br />
<p>Sed quis arcu nisi, ac tempor augue. Praesent non elit libero, a ullamcorper lorem. Curabitur porta odio eu nunc ultricies interdum id nec risus. Donec nibh nibh, porta eget vehicula ac, aliquet eget ante. Phasellus eget lorem eu eros eleifend ultrices. Cras sit amet neque sit amet nibh fringilla cursus ut id mauris. Praesent quis nunc justo, sed suscipit lectus. Phasellus eget ultrices risus. Curabitur eu semper est. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Ut suscipit, nisl ut imperdiet eleifend, turpis arcu placerat tortor, nec laoreet lacus neque ac tellus. Aenean ac lacus justo, quis ultricies nisi.</p><br />
';<br />
}<br />
public function install(){<br />
<br />
// create new page to add to CMS<br />
$page = new Page();<br />
<br />
// add page attributes<br />
$page->template = "admin";<br />
$page->name = "cms-faq";<br />
$page->title = "CMS FAQ";<br />
$page->save();<br />
<br />
// set this module as the page process, this allows us to display the above<br />
$page->process = 'ProcessSimpleAdminPage';<br />
<br />
// get admin page and set as page parent<br />
$admin = $this->pages->get("id=2");<br />
$page->parent = $admin;<br />
<br />
// save page<br />
$page->save();<br />
}<br />
<br />
public function uninstall(){<br />
<br />
// delete created page<br />
$page = $this->pages->get("name=cms-faq");<br />
if(count($page)) $this->pages->delete($page, true);<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
=== ProcessWire Textformatter Modul ===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
/**<br />
* TextformatterFindReplace<br />
*<br />
* Author: Ben Byford<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2010 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class TextformatterFindReplace extends Textformatter implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'TextformatterFindReplace',<br />
'version' => 0.1,<br />
'summary' => "Finds and replaces any instance of config input to config output",<br />
'author' => 'Ben Byford',<br />
'singular' => true,<br />
'href' => 'https://github.com/benbyford/PW-starter-modules'<br />
);<br />
}<br />
<br />
<br />
/**<br />
* Find and Replace the input string<br />
*<br />
* @param string $str The block of text to parse<br />
*<br />
* The incoming string is replaced with the formatted version of itself.<br />
**/<br />
<br />
public function format(&$str) {<br />
$find = $this->findStr;<br />
$str = preg_replace_callback($find, array($this,"replace"), $str);<br />
<br />
}<br />
<br />
// adding three underscores to a function allows other modules to hook it<br />
public function ___replace($match) {<br />
return $this->replaceStr;<br />
}<br />
}<br />
?><br />
</syntaxhighlight><br />
<br />
=== Admin Funktionalität: Countdown zum Seitenveröffentlichen ===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<br />
The module PageDeferredPublish, on clicking one of the '''Publish Later buttons''', sets LazyCron to check that page’s countdown every minute and publishes the page when its countdown reaches 0. This means I can publish a page approximately 24 hours in advance (obviously the checking interval and delay time can be changed to your requirements).<br />
<br />
I did this by:<br />
<br />
'''Creating two fields''' within my install() function: a checkbox field to set to true when a button is checked to indicate the page should countdown, and a countdown field to store the count in seconds for that specific page.<br />
<br />
'''Adding hooks''' to both ''ProcessPageEdit::buildForm'' and ''ProcessPageListActions::getExtraActions'' enabling me to add the two buttons.<br />
<br />
Checking to see if one of the buttons was clicked with my '''ready() function''' then setting the corresponding page’s checkbox to true.<br />
<br />
Using a '''LazyCron hook function''' to check all pages that are unpublished for true checkboxes and then comparing the seconds field to see if the page needs publishing. If not then deduct the elapsed time in seconds.<br />
<br />
The result is a '''module that has settings''' (the time interval to check and publish at a later time), '''hooks into the admin''' using buttons and fields, and enables us to '''use other modules installe'''d in PW (i.e. LazyCron).<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
/**<br />
* DeferredPublish (0.0.1)<br />
* DeferredPublish publishes a page after a defined amount of time has elapsed using lazycron.<br />
*<br />
* @author Ben Byford<br />
* http://www.benbyford.com<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2011 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class PageDeferredPublish extends WireData implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => "PageDeferredPublish",<br />
'version' => "0.0.1",<br />
'summary' => "PageDeferredPublish",<br />
'author' => "Ben Byford",<br />
'href' => "https://github.com/benbyford/PW-intermediate-modules",<br />
'icon' => "clock-o",<br />
'autoload' => true,<br />
'singular' => true,<br />
'requires' => "LazyCron",<br />
);<br />
}<br />
<br />
private $postPubLater = null;<br />
private $pageID = null;<br />
private $pagePubLater = null;<br />
private $currentPage = null;<br />
<br />
private $submitName = 'pdp_pub_later_submit';<br />
private $listPageName = 'pdp_pub_later_list';<br />
private $fieldName = 'pdp_pub_later';<br />
private $checkboxName = 'pdp_pub_later_check';<br />
<br />
private $defaultInterval = 'everyMinute';<br />
private $defaultTime = 86400;<br />
<br />
<br />
public function install(){<br />
// add new fields needed for module<br />
$this->installFields();<br />
}<br />
public function uninstall(){<br />
// uninstall fields<br />
$this->uninstallFields();<br />
}<br />
<br />
// initialize the hook in your AutoLoad module<br />
public function init() {<br />
<br />
// get defaults from module setting in CMS<br />
$this->defaultTime = $this->pub_after;<br />
$this->defaultInterval = $this->cron_check;<br />
<br />
// get admin URL<br />
$this->adminUrl = $this->wire('config')->urls->admin;<br />
<br />
// add hooks to CRON, PageList, PageEdit<br />
$this->addHookAfter("LazyCron::{$this->defaultInterval}", $this, 'publishDefferedPages');<br />
$this->addHook("ProcessPageListActions::getExtraActions", $this, 'hookPageListActions');<br />
$this->addHookAfter("ProcessPageEdit::buildForm", $this, "editForm");<br />
}<br />
<br />
public function ready() {<br />
<br />
// if list button clicked then grab id<br />
$this->pagePubLater = $this->input->get($this->listPageName);<br />
$this->pageID = $this->input->id;<br />
<br />
// get page<br />
$this->currentPage = $this->pages->get($this->pageID);<br />
<br />
// if pagelist pub later submit button clicked<br />
if($this->pagePubLater){<br />
$this->message("Page {$this->currentPage->name} deffered for publish.");<br />
}<br />
<br />
// if page edit submit button clicked<br />
$this->postPubLater = $this->input->post($this->submitName);<br />
if($this->postPubLater){<br />
$this->message("Page {$this->currentPage->name} deffered for publish.");<br />
}<br />
<br />
// if either deffered publish sumbit found then publish page later<br />
if($this->pagePubLater || $this->postPubLater){<br />
$this->publishLater();<br />
}<br />
}<br />
<br />
/*<br />
* Hook: ProcessPageEdit::buildForm<br />
*<br />
* add Publish Later button to edit page if not yet published<br />
*/<br />
public function ___editForm(HookEvent $form) {<br />
<br />
// get the InputFieldForm object from the event (return value of buildForm())<br />
$form = $form->return;<br />
<br />
$page = $this->pages->get($this->input->get->id);<br />
$check = $page->get($this->checkboxName);<br />
<br />
// check if publish button available and therfore unpublished<br />
$target = $form->get('submit_publish');<br />
<br />
if($target && $check == false){<br />
<br />
// get InputfieldText module<br />
$submit2 = $this->modules->get('InputfieldSubmit');<br />
$submit2->attr('name', $this->submitName);<br />
$submit2->attr('id', 'publish_later');<br />
$submit2->attr('class', 'ui-button ui-widget ui-corner-all head_button_clone ui-state-default ui-priority-secondary');<br />
$submit2->attr('value', 'Publish Later'); // Button: save unpublished<br />
<br />
// get form element save and place before<br />
$target = $form->get('submit_save');<br />
$form->insertBefore($submit2, $target);<br />
<br />
$form->return = $form;<br />
}<br />
}<br />
<br />
public function ___hookPageListActions(HookEvent $event) {<br />
<br />
// get current page<br />
$page = $event->arguments[0];<br />
<br />
// check to see if page is published<br />
$pagePub = $page->is(Page::statusUnpublished);<br />
<br />
// check to see if page template has deffered field<br />
$pageHasDefferField = $page->get($this->fieldName);<br />
<br />
$actions = array();<br />
<br />
// don't get homepage or pages that are already published or are being deffered for publish<br />
if($page->id > 1 && $pagePub == "published" && !is_null($pageHasDefferField) && $page->get($this->checkboxName) == false) {<br />
<br />
$actions['publish_later'] = array(<br />
'cn' => 'PublishLater',<br />
'name' => 'pub later',<br />
'url' => "{$this->adminUrl}?{$this->listPageName}=1&id={$page->id}",<br />
);<br />
}<br />
if(count($actions)) $event->return = $actions + $event->return;<br />
}<br />
<br />
/*<br />
* Publish Page on cron job<br />
*<br />
* Gets deffered page and publishes<br />
*/<br />
public function ___publish($page) {<br />
$page->removeStatus(Page::statusUnpublished);<br />
$page->removeStatus(Page::statusHidden);<br />
$page->Save();<br />
}<br />
<br />
/*<br />
* Main publish later function<br />
*<br />
* Gets deffered page and sets fields to be checked be lazy cron<br />
*/<br />
private function ___publishLater() {<br />
<br />
// get page<br />
$page = $this->pages->get($this->pageID);<br />
<br />
// set output formatting to false<br />
$page->of(false);<br />
<br />
// set field time to settings default time and checkbox to true<br />
$page->set($this->checkboxName, true);<br />
$page->set($this->fieldName, $this->defaultTime);<br />
<br />
// save page<br />
$page->save();<br />
$page->of(true);<br />
}<br />
<br />
/*<br />
* Lazy Cron hook function<br />
*<br />
* Triggers every [set time interval] and checks pages<br />
* Publishes page if time runout<br />
*<br />
* Adds publish page log<br />
*/<br />
public function ___publishDefferedPages(HookEvent $e){<br />
<br />
// seconds since last lazycron<br />
$seconds = $e->arguments[0];<br />
<br />
// find all pages with deffered field<br />
$defferedPages = $this->pages->find("{$this->checkboxName}=1,include=unpublished");<br />
<br />
// for each page decrease time for deffered field<br />
foreach ($defferedPages as $page) {<br />
<br />
// get current page time<br />
$timeTillPublish = $page->get($this->fieldName);<br />
<br />
// set time to time minus time past<br />
$timeLeft = $timeTillPublish - $seconds;<br />
<br />
// if time passed 0 or less then publish page<br />
$page->of(false);<br />
if($timeLeft <= 0){<br />
// remove flags and save<br />
$this->publish($page);<br />
<br />
$page->set($this->fieldName, 0);<br />
$page->set($this->checkboxName, 0);<br />
<br />
// log a page has been published<br />
$log = wire('log');<br />
$log->message('CRON:'. $seconds .' Pages: '. $page->name .' published');<br />
}else{<br />
$page->set($this->fieldName, $timeLeft);<br />
}<br />
// save page time<br />
$page->Save();<br />
$page->of(true);<br />
}<br />
}<br />
<br />
/*<br />
* Install new module specific fields<br />
*/<br />
private function installFields(){<br />
<br />
// install pub later checkbox field<br />
// find installed fields<br />
$f = $this->fields->get($this->fieldName);<br />
if($f){<br />
<br />
// if field already found then don't try and make it<br />
$this->message($this->fieldName . ' field found');<br />
<br />
}else{<br />
<br />
// create new field object to store crontime<br />
$f = new Field();<br />
// get a field type<br />
$f->type = $this->modules->get("FieldtypeInteger");<br />
$f->name = $this->fieldName;<br />
$f->label = 'Publish Time Left';<br />
$f->defaultValue = $this->defaultTime;<br />
$f->icon = 'clock-o';<br />
$f->columnWidth = 50;<br />
$f->collapsed = 1;<br />
$f->flags = 4;<br />
<br />
$f->save(); // save the field<br />
<br />
// create new field object to store whether to publish or not<br />
$f = new Field();<br />
// get a field type<br />
$f->type = $this->modules->get("FieldtypeCheckbox");<br />
$f->name = $this->checkboxName;<br />
$f->label = 'Publish Page later';<br />
$f->defaultValue = false;<br />
$f->columnWidth = 50;<br />
$f->icon = 'clock-o';<br />
$f->collapsed = 1;<br />
$f->flags = 4;<br />
<br />
$f->save(); // save the field<br />
}<br />
}<br />
<br />
/*<br />
* Uninstall module specific fields<br />
*/<br />
private function uninstallFields(){<br />
<br />
// find installed fields<br />
$fInt = $this->fields->get($this->fieldName);<br />
$fCheck = $this->fields->get($this->checkboxName);<br />
<br />
if($fInt && $fCheck){<br />
$fieldIntUsed = $fInt->numFieldgroups();<br />
$fieldCheckUsed = $fCheck->numFieldgroups();<br />
<br />
if($fieldIntUsed){<br />
// field in use by template<br />
$this->message('Unable to uninstall field '.$fInt->name);<br />
}else{<br />
// delete installed fields<br />
$this->fields->delete($fInt);<br />
$this->fields->save;<br />
}<br />
<br />
if($fieldCheckUsed){<br />
// field in use by template<br />
$this->message('Unable to uninstall field '.$fCheck->name);<br />
}else{<br />
// delete installed fields<br />
$this->fields->delete($fCheck);<br />
$this->fields->save;<br />
}<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
=== Inputfield / Fieldtype ===<br />
[[ProcessWire - Fieldtype erstellen (Module)]]</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Module_schreiben&diff=24247ProcessWire - Module schreiben2020-01-06T10:05:33Z<p>84.136.104.26: /* execute */</p>
<hr />
<div>== Links ==<br />
Wichtigste Resourcen<br />
https://processwire.com/docs/modules/development/ - Guter Ausgangspunkt<br />
https://processwire.com/api/ref/module/ - Module API<br />
https://processwire.com/api/ref/configurable-module/ - Klasse für Konfigurierbare Module<br />
https://processwire.com/docs/modules/types/ - Welche Modultypen gibt es ?<br />
https://github.com/ryancramerdesign/ProcessHello - Modul Skelett Beispiel für eigene Backend (Process) Module<br />
https://github.com/ryancramerdesign/FieldtypeMapMarker - Beispiel für ein Fieldtype und Inputfield Modul<br />
https://processwire.com/talk/topic/778-module-dependencies/ - Module die andere Module benötigen<br />
https://processwire.com/talk/forum/19-moduleplugin-development/ - Forum zum Thema Module entwickeln<br />
http://somatonic.github.io/Captain-Hook/ - Hook Cheatsheet<br />
https://processwire.com/blog/posts/new-module-configuration-options/ - Neuere Konfigurationsmöglichkeiten<br />
Weitere Links<br />
https://webdesign.tutsplus.com/tutorials/a-beginners-introduction-to-writing-modules-in-processwire--cms-26862<br />
https://processwire.com/docs/modules/ - Introduction, Development, Hooks, Types, Pro Modules, Third Party<br />
<br />
<br />
<br />
<br />
[[ProcessWire - Module Snippets]]<br />
<br />
== Wo - Was ? ==<br />
=== Welche Typen von Modulen gibt es ? ===<br />
https://processwire.com/docs/modules/types/<br />
* '''Fieldtype''': Repräsentiert einen Datentyp. Meistens keine Public API, Handelt Daten / Datenbank - https://processwire.com/api/ref/fieldtype/<br />
* '''Inputfield''': Sammelt User Eingaben über ein Formular im Admin Bereich. Im Gegensatz zum Fieldtype geht es hier um das UI im Backend. Das Handling der Daten liegt beim Fieldtype.<br />
* '''Process''' for creating admin processes/applications.<br />
* '''Textformatter''' for formatting text.<br />
* '''AdminTheme''' for creating themes in the admin.<br />
* '''WireMail''' for modules that send email and extend the WireMail class.<br />
* '''Tfa''' for implementing a specific kind of two-factor authentication.<br />
* '''ImageSizerEngine''' for modules that extend ImageSizerEngine for resizing images.<br />
* '''FileCompiler''' for modules that extend FileCompilerModule for compilation of files.<br />
* '''FileValidator''' for modules that extend FileValidatorModule for validation of files.<br />
<br />
=== Wie werden Felder in der Datenbank angelegt ? ===<br />
Dazu nutzt man den Typ "Fieldtype"<br />
<br />
=== Wo rendert man die Ausgabe ? ===<br />
Bei Ryan Cramers Event Beispiel legt er zwei Klassen Event und EventArray an, die auch die Render Funktionen enthalten.<br />
<br />
== Spezielle Funktionen in Modulen ==<br />
<br />
=== getModuleInfo ===<br />
Ist die einzige Pflichtfunktion in Modulen. Hier werden title, version, summary und weitere Daten hinterlegt. Hier kann man auch angeben ob ein Modul ein Autoload Modul ist.<br />
<br />
=== init ===<br />
public function init(){}<br />
Initialisiert das Modul. ProcessWire ruft diese Funktion auf, wenn das Modul geladen ist. Bei Autoload Modulen wird es aufgerufen wenn die ProcessWire API bereit ist. Daher ist es ein guter Ort um Hooks einzubinden.<br />
<br />
=== ready ===<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
if($this->page->template == 'admin') {<br />
$this->message($this->hi());<br />
}<br />
}<br />
</syntaxhighlight><br />
Wird in autoload Modulen aufgerufen wenn die API bereit ist. Nützlich für Hooks:<br />
<br />
=== execute ===<br />
<syntaxhighlight lang="php"><br />
</syntaxhighlight><br />
/**<br />
* This function is executed when a page with your Process assigned is accessed. <br />
*<br />
* This can be seen as your main or index function. You'll probably want to replace<br />
* everything in this function. <br />
*<br />
*/<br />
public function ___execute() {<br />
// greetingType and greeting are automatically populated to this module<br />
// and they were defined in ProcessHello.config.php<br />
if($this->greetingType == 'message') {<br />
$this->message($this->greeting); <br />
} else if($this->greetingType == 'warning') {<br />
$this->warning($this->greeting); <br />
} else {<br />
$this->error($this->greeting); <br />
}<br />
// generate some navigation<br />
$out = "<br />
<h2>$this->greeting</h2><br />
<dl class='nav'><br />
<dt><a href='./something/'>Do Something</a></dt><br />
<dd>Runs the executeSomething() function.</dd><br />
</dl><br />
";<br />
return $out;<br />
} <br />
</syntaxhighlight><br />
<br />
=== executeSomething ==<br />
<syntaxhighlight lang="php"><br />
/**<br />
* Called when the URL is this module's page URL + "/something/"<br />
*<br />
*/<br />
public function ___executeSomething() {<br />
// set a new headline, replacing the one used by our page<br />
// this is optional as PW will auto-generate a headline <br />
$this->headline('This is something!'); <br />
// add a breadcrumb that returns to our main page <br />
// this is optional as PW will auto-generate breadcrumbs<br />
$this->breadcrumb('../', 'Hello'); <br />
$out = "<br />
<h2>Not much to to see here</h2><br />
<p><a href='../'>Go Back</a></p><br />
";<br />
return $out; <br />
}<br />
</syntaxhighlight><br />
<br />
=== install & uninstall ===<br />
<syntaxhighlight lang="php"><br />
<br />
/**<br />
* Called only when your module is installed<br />
*<br />
* If you don't need anything here, you can simply remove this method. <br />
*<br />
*/<br />
public function ___install() {<br />
parent::___install(); // always remember to call parent method<br />
}<br />
/**<br />
* Called only when your module is uninstalled<br />
*<br />
* This should return the site to the same state it was in before the module was installed. <br />
*<br />
* If you don't need anything here, you can simply remove this method. <br />
*<br />
*/<br />
public function ___uninstall() {<br />
parent::___uninstall(); // always remember to call parent method<br />
}<br />
</syntaxhighlight><br />
<br />
== Vererbung und Eigenschaften in Modulen ==<br />
Modules are not different from PHP classes.<br />
<br />
To change the properties of MyModule class from within MyOtherModule class, you can either:<br />
<br />
#Make MyOtherModule class extend MyModule. It will thus inherit MyModule's public and protected properties and methods<br />
#Make the properties firstName and lastName configurable by passing them as parameters/arguments in MyModule's constructor method.<br />
<br />
== Autoload Module und Hooks ==<br />
Autoload werden automatisch geladen müssen also nicht in einem Template o.ä. gestartet werden. Daher bieten sie sich an um die Funktionalität von ProcessWire zu erweitern. Als Werkzeug dafür dienen Hooks. Mit Hooks kann man an vielen Stellen den Rendering Process der Seiten beeinflussen. Außerdem kann man für eigene Module ebenfalls Hooks bereitstellen. <br />
<br />
=== Hooks ===<br />
https://processwire.com/docs/modules/hooks/<br />
Hooks sind ein mächtiges Werkzeug. Sie geben einem die Möglichkeit an vielen Stellen "einzuhaken" und Funktionalität einzubauen.<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
$this->addHookAfter('Page::render', function($event) {<br />
$event->return .= '<p>Hallo</p>';<br />
});<br />
}<br />
</syntaxhighlight><br />
Schreibt am Ende Jeder Seite ein "Hallo". Das $event Objekt ist ein [https://processwire.com/api/ref/hook-event/ HookEvent]. Im Beispiel fügen wir einfach etwas Markup hinzu. Über $event->arguments() kann man aber auf ale Argumente zugreifen.<br />
<br />
Das gleiche aber nicht mit anonymer Funktion:<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
// add hook after Page::render() and make it call the "test" method of $this module<br />
$this->addHookAfter('Page::render', $this, 'test');<br />
}<br />
<br />
public function test($event) {<br />
// modify the return value of Page::render() to include the following:<br />
$event->return .= '<p>Hallo</p>';<br />
}<br />
</syntaxhighlight><br />
<br />
=== Hooks zum erweitern von existierenden Klassen nutzen ===<br />
Mit Hooks kann man in vorhandene Klassen einhaken. Z.B. läßt sich das Page Objekt erweitern.<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
$this->addHook('Page::summarize', $this, 'summarize');<br />
}<br />
public function summarize($event) {<br />
$page = $event->object; // the $event->object represents the object hooked (Page)<br />
$maxlen = $event->arguments(0); // first argument is the optional max length<br />
if(!$maxlen) $maxlen = 200; // if no $maxlen was present, we'll use a default of 200<br />
$summary = $this->sanitizer->truncate($page->body, $maxlen); // use sanitizer truncate method to create a summary<br />
$event->return = $summary; // populate $summary to $event->return, the return value<br />
}<br />
</syntaxhighlight><br />
So kann man ganz einfach eine Zusammenfassung aller Kindseiten in einem Template rendern:<br />
<syntaxhighlight lang="php"><br />
foreach($page->children as $item) {<br />
$summary = $item->summarize(150);<br />
echo "<li><a href='$item->url'>$item->title</a><br>$summary";<br />
}<br />
</syntaxhighlight><br />
<br />
=== Hook Beispiele ===<br />
Hook am Ende des Renderings<br />
$this->addHookAfter('Page::render', function($event) {...});<br />
Füge eine Funktion "summarize" zum Page Objekt hinzu.<br />
$this->addHook('Page::summarize', $this, 'summarize');<br />
Hook auf eine einzelne Instanz (hier pages Objekt)<br />
$this->pages->addHookAfter('saved', function($event){...});<br />
$this->addHook('Page::method', ...) // Spricht ALLE Instanzen an - Regelfall<br />
$page->addHook('method', ...) // Spricht nur die EINE Instanz der Seite an.<br />
</pre><br />
<br />
=== Autoload Module nur im Admin Bereich laden ===<br />
'autoload' => 'template=admin' <br />
statt<br />
'autoload' => true<br />
<br />
== Beispiele ==<br />
=== Frontend Rendering Module ===<br />
A bit old but working<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
/**<br />
* FrontEndRender<br />
*<br />
* Author: Ben Byford<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2010 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class FrontEndRender extends WireData implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'FrontEndRender',<br />
'version' => 0.1,<br />
'summary' => "Outputs html and static variables to frontend",<br />
'author' => 'Ben Byford',<br />
'singular' => true,<br />
'href' => 'https://github.com/benbyford/PW-starter-modules'<br />
);<br />
}<br />
<br />
// protected variable only accessable within module<br />
protected $name = 'Ben';<br />
<br />
/*<br />
* render function to be called in PW template like this:<br />
* $FrontEndRender = $modules->getModule('FrontEndRender');<br />
* echo '<h1>' . $FrontEndRender->render() . '</h1>';<br />
*<br />
*/<br />
public function render(){<br />
return "Hello " . $this->name;<br />
}<br />
}<br />
?><br />
</syntaxhighlight><br />
<br />
=== ProcessWire Hello World Modul ===<br />
Beispiel Modul mit Hooks (liegt immer in der Standardinstallation)<br />
<syntaxhighlight lang="php"><br />
<?php namespace ProcessWire;<br />
<br />
/**<br />
* ProcessWire 'Hello world' demonstration module<br />
*<br />
* Demonstrates the Module interface and how to add hooks.<br />
* <br />
* See README file for further links regarding module development.<br />
* <br />
* This file is licensed under the MIT license<br />
* https://processwire.com/about/license/mit/<br />
* <br />
* ProcessWire 3.x, Copyright 2016 by Ryan Cramer<br />
* https://processwire.com<br />
*<br />
*/<br />
<br />
class Helloworld extends WireData implements Module {<br />
<br />
/**<br />
* getModuleInfo is a module required by all modules to tell ProcessWire about them<br />
*<br />
* @return array<br />
*<br />
*/<br />
public static function getModuleInfo() {<br />
<br />
return array(<br />
<br />
// The module's title, typically a little more descriptive than the class name<br />
'title' => 'Hello World', <br />
<br />
// version number <br />
'version' => 3, <br />
<br />
// summary is brief description of what this module is<br />
'summary' => 'An example module used for demonstration purposes.',<br />
<br />
// Optional URL to more information about the module<br />
'href' => 'https://processwire.com',<br />
<br />
// singular=true: indicates that only one instance of the module is allowed.<br />
// This is usually what you want for modules that attach hooks. <br />
'singular' => true, <br />
<br />
// autoload=true: indicates the module should be started with ProcessWire.<br />
// This is necessary for any modules that attach runtime hooks, otherwise those<br />
// hooks won't get attached unless some other code calls the module on it's own.<br />
// Note that autoload modules are almost always also 'singular' (seen above).<br />
'autoload' => true, <br />
<br />
// Optional font-awesome icon name, minus the 'fa-' part<br />
'icon' => 'smile-o', <br />
);<br />
}<br />
<br />
/**<br />
* Initialize the module<br />
*<br />
* ProcessWire calls this when the module is loaded. For 'autoload' modules, this will be called<br />
* when ProcessWire's API is ready. As a result, this is a good place to attach hooks. <br />
*<br />
*/<br />
public function init() {<br />
<br />
// add a hook after the $pages->save, to issue a notice every time a page is saved<br />
$this->pages->addHookAfter('save', $this, 'example1'); <br />
<br />
// add a hook after each page is rendered and modify the output<br />
$this->addHookAfter('Page::render', $this, 'example2'); <br />
<br />
// add a 'hello' method to every page that returns "Hello World"<br />
// use "echo $page->hello();" in your template file to display output<br />
$this->addHook('Page::hello', $this, 'example3'); <br />
<br />
// add a 'hello_world' property to every page that returns "Hello [user]"<br />
// use "echo $page->hello_world;" in your template file to display output<br />
$this->addHookProperty('Page::hello_world', $this, 'example4'); <br />
}<br />
<br />
/**<br />
* Example1 hooks into the pages->save method and displays a notice every time a page is saved<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example1($event) {<br />
/** @var Page $page */<br />
$page = $event->arguments[0]; <br />
$this->message("Hello World! You saved {$page->path}."); <br />
}<br />
<br />
<br />
/**<br />
* Example2 hooks into every page after it's rendered and adds "Hello World" text at the bottom<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example2($event) {<br />
<br />
/** @var Page $page */<br />
$page = $event->object; <br />
<br />
// don't add this to the admin pages<br />
if($page->template == 'admin') return;<br />
<br />
// add a "Hello World" paragraph right before the closing body tag<br />
$event->return = str_replace("</body>", "<p>Hello World!</p></body>", $event->return); <br />
}<br />
<br />
/**<br />
* Example3 adds a 'hello' method (not property) to every page that simply returns "Hello World"<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example3($event) {<br />
$event->return = "Hello World";<br />
}<br />
<br />
/**<br />
* Example 4 adds a 'hello_world' property (not method) to every page that returns "Hello [user]"<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example4($event) {<br />
$event->return = "Hello " . $this->user->name; <br />
}<br />
<br />
}<br />
<br />
</syntaxhighlight><br />
<br />
=== ProcessWire Admin Bereich mit eigener Funktionalität erweitern (Modul)===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<syntaxhighlight lang="php"><br />
<br />
<?php<br />
/**<br />
* ProcessSimpleAdminPage<br />
*<br />
* @author Ben Byford<br />
* http://www.benbyford.com<br />
*<br />
* @see http://www.processwire.com<br />
*/<br />
<br />
class ProcessSimpleAdminPage extends Process {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'Process Simple Admin Page',<br />
'summary' => 'Simple Process module that adds new admin page with',<br />
'version' => 001,<br />
<br />
// Modules that extend Process may specify a 'page' attribute in the<br />
// getModuleInfo(), this page will automatically be given the module<br />
// process when added to teh pagetree.<br />
<br />
// I have exampled but commented out the 'page' settings below<br />
// so that I can show how one might add a page to install() and<br />
// uninstall() in this and other modules (that might not extend<br />
// Process)<br />
<br />
<br />
// 'page' => array(<br />
// 'name' => 'site-config',<br />
// 'parent' => 'admin',<br />
// 'title' => 'Site Config'<br />
// )<br />
);<br />
}<br />
<br />
public function execute() {<br />
return '<br />
<h2>Edit the text here in the module</h2><br />
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam mattis eros vitae metus sodales eget suscipit purus rhoncus. Proin ultrices gravida dolor, non porttitor enim interdum vitae. Integer feugiat lacinia tincidunt. Nulla laoreet tristique tristique. Sed elementum justo a nisl elementum sit amet accumsan nisi tempor. Nulla quis eros et massa dignissim imperdiet a vitae purus.</p><br />
<br />
<p>Donec scelerisque pulvinar sem eu lobortis. Maecenas turpis ipsum, tempus dictum pharetra eu, consectetur vitae arcu. Fusce orci mauris, semper at tempus quis, volutpat molestie tellus. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Sed quam tortor, tincidunt sed semper lacinia, scelerisque dapibus quam. Morbi at nisi luctus lacus auctor ultrices eu eu leo.</p><br />
<br />
<p>Praesent faucibus purus id felis tincidunt dignissim. Sed sit amet ligula mi, eget semper dui. Proin consectetur gravida massa, nec luctus purus hendrerit in. Etiam volutpat, elit non venenatis suscipit, libero neque consectetur diam, id rutrum magna odio ac ligula. Maecenas sollicitudin congue neque fermentum vestibulum. Morbi nec leo nisi. Donec at nisl odio, et porta ligula.</p><br />
<br />
<p>Sed quis arcu nisi, ac tempor augue. Praesent non elit libero, a ullamcorper lorem. Curabitur porta odio eu nunc ultricies interdum id nec risus. Donec nibh nibh, porta eget vehicula ac, aliquet eget ante. Phasellus eget lorem eu eros eleifend ultrices. Cras sit amet neque sit amet nibh fringilla cursus ut id mauris. Praesent quis nunc justo, sed suscipit lectus. Phasellus eget ultrices risus. Curabitur eu semper est. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Ut suscipit, nisl ut imperdiet eleifend, turpis arcu placerat tortor, nec laoreet lacus neque ac tellus. Aenean ac lacus justo, quis ultricies nisi.</p><br />
';<br />
}<br />
public function install(){<br />
<br />
// create new page to add to CMS<br />
$page = new Page();<br />
<br />
// add page attributes<br />
$page->template = "admin";<br />
$page->name = "cms-faq";<br />
$page->title = "CMS FAQ";<br />
$page->save();<br />
<br />
// set this module as the page process, this allows us to display the above<br />
$page->process = 'ProcessSimpleAdminPage';<br />
<br />
// get admin page and set as page parent<br />
$admin = $this->pages->get("id=2");<br />
$page->parent = $admin;<br />
<br />
// save page<br />
$page->save();<br />
}<br />
<br />
public function uninstall(){<br />
<br />
// delete created page<br />
$page = $this->pages->get("name=cms-faq");<br />
if(count($page)) $this->pages->delete($page, true);<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
=== ProcessWire Textformatter Modul ===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
/**<br />
* TextformatterFindReplace<br />
*<br />
* Author: Ben Byford<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2010 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class TextformatterFindReplace extends Textformatter implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'TextformatterFindReplace',<br />
'version' => 0.1,<br />
'summary' => "Finds and replaces any instance of config input to config output",<br />
'author' => 'Ben Byford',<br />
'singular' => true,<br />
'href' => 'https://github.com/benbyford/PW-starter-modules'<br />
);<br />
}<br />
<br />
<br />
/**<br />
* Find and Replace the input string<br />
*<br />
* @param string $str The block of text to parse<br />
*<br />
* The incoming string is replaced with the formatted version of itself.<br />
**/<br />
<br />
public function format(&$str) {<br />
$find = $this->findStr;<br />
$str = preg_replace_callback($find, array($this,"replace"), $str);<br />
<br />
}<br />
<br />
// adding three underscores to a function allows other modules to hook it<br />
public function ___replace($match) {<br />
return $this->replaceStr;<br />
}<br />
}<br />
?><br />
</syntaxhighlight><br />
<br />
=== Admin Funktionalität: Countdown zum Seitenveröffentlichen ===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<br />
The module PageDeferredPublish, on clicking one of the '''Publish Later buttons''', sets LazyCron to check that page’s countdown every minute and publishes the page when its countdown reaches 0. This means I can publish a page approximately 24 hours in advance (obviously the checking interval and delay time can be changed to your requirements).<br />
<br />
I did this by:<br />
<br />
'''Creating two fields''' within my install() function: a checkbox field to set to true when a button is checked to indicate the page should countdown, and a countdown field to store the count in seconds for that specific page.<br />
<br />
'''Adding hooks''' to both ''ProcessPageEdit::buildForm'' and ''ProcessPageListActions::getExtraActions'' enabling me to add the two buttons.<br />
<br />
Checking to see if one of the buttons was clicked with my '''ready() function''' then setting the corresponding page’s checkbox to true.<br />
<br />
Using a '''LazyCron hook function''' to check all pages that are unpublished for true checkboxes and then comparing the seconds field to see if the page needs publishing. If not then deduct the elapsed time in seconds.<br />
<br />
The result is a '''module that has settings''' (the time interval to check and publish at a later time), '''hooks into the admin''' using buttons and fields, and enables us to '''use other modules installe'''d in PW (i.e. LazyCron).<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
/**<br />
* DeferredPublish (0.0.1)<br />
* DeferredPublish publishes a page after a defined amount of time has elapsed using lazycron.<br />
*<br />
* @author Ben Byford<br />
* http://www.benbyford.com<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2011 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class PageDeferredPublish extends WireData implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => "PageDeferredPublish",<br />
'version' => "0.0.1",<br />
'summary' => "PageDeferredPublish",<br />
'author' => "Ben Byford",<br />
'href' => "https://github.com/benbyford/PW-intermediate-modules",<br />
'icon' => "clock-o",<br />
'autoload' => true,<br />
'singular' => true,<br />
'requires' => "LazyCron",<br />
);<br />
}<br />
<br />
private $postPubLater = null;<br />
private $pageID = null;<br />
private $pagePubLater = null;<br />
private $currentPage = null;<br />
<br />
private $submitName = 'pdp_pub_later_submit';<br />
private $listPageName = 'pdp_pub_later_list';<br />
private $fieldName = 'pdp_pub_later';<br />
private $checkboxName = 'pdp_pub_later_check';<br />
<br />
private $defaultInterval = 'everyMinute';<br />
private $defaultTime = 86400;<br />
<br />
<br />
public function install(){<br />
// add new fields needed for module<br />
$this->installFields();<br />
}<br />
public function uninstall(){<br />
// uninstall fields<br />
$this->uninstallFields();<br />
}<br />
<br />
// initialize the hook in your AutoLoad module<br />
public function init() {<br />
<br />
// get defaults from module setting in CMS<br />
$this->defaultTime = $this->pub_after;<br />
$this->defaultInterval = $this->cron_check;<br />
<br />
// get admin URL<br />
$this->adminUrl = $this->wire('config')->urls->admin;<br />
<br />
// add hooks to CRON, PageList, PageEdit<br />
$this->addHookAfter("LazyCron::{$this->defaultInterval}", $this, 'publishDefferedPages');<br />
$this->addHook("ProcessPageListActions::getExtraActions", $this, 'hookPageListActions');<br />
$this->addHookAfter("ProcessPageEdit::buildForm", $this, "editForm");<br />
}<br />
<br />
public function ready() {<br />
<br />
// if list button clicked then grab id<br />
$this->pagePubLater = $this->input->get($this->listPageName);<br />
$this->pageID = $this->input->id;<br />
<br />
// get page<br />
$this->currentPage = $this->pages->get($this->pageID);<br />
<br />
// if pagelist pub later submit button clicked<br />
if($this->pagePubLater){<br />
$this->message("Page {$this->currentPage->name} deffered for publish.");<br />
}<br />
<br />
// if page edit submit button clicked<br />
$this->postPubLater = $this->input->post($this->submitName);<br />
if($this->postPubLater){<br />
$this->message("Page {$this->currentPage->name} deffered for publish.");<br />
}<br />
<br />
// if either deffered publish sumbit found then publish page later<br />
if($this->pagePubLater || $this->postPubLater){<br />
$this->publishLater();<br />
}<br />
}<br />
<br />
/*<br />
* Hook: ProcessPageEdit::buildForm<br />
*<br />
* add Publish Later button to edit page if not yet published<br />
*/<br />
public function ___editForm(HookEvent $form) {<br />
<br />
// get the InputFieldForm object from the event (return value of buildForm())<br />
$form = $form->return;<br />
<br />
$page = $this->pages->get($this->input->get->id);<br />
$check = $page->get($this->checkboxName);<br />
<br />
// check if publish button available and therfore unpublished<br />
$target = $form->get('submit_publish');<br />
<br />
if($target && $check == false){<br />
<br />
// get InputfieldText module<br />
$submit2 = $this->modules->get('InputfieldSubmit');<br />
$submit2->attr('name', $this->submitName);<br />
$submit2->attr('id', 'publish_later');<br />
$submit2->attr('class', 'ui-button ui-widget ui-corner-all head_button_clone ui-state-default ui-priority-secondary');<br />
$submit2->attr('value', 'Publish Later'); // Button: save unpublished<br />
<br />
// get form element save and place before<br />
$target = $form->get('submit_save');<br />
$form->insertBefore($submit2, $target);<br />
<br />
$form->return = $form;<br />
}<br />
}<br />
<br />
public function ___hookPageListActions(HookEvent $event) {<br />
<br />
// get current page<br />
$page = $event->arguments[0];<br />
<br />
// check to see if page is published<br />
$pagePub = $page->is(Page::statusUnpublished);<br />
<br />
// check to see if page template has deffered field<br />
$pageHasDefferField = $page->get($this->fieldName);<br />
<br />
$actions = array();<br />
<br />
// don't get homepage or pages that are already published or are being deffered for publish<br />
if($page->id > 1 && $pagePub == "published" && !is_null($pageHasDefferField) && $page->get($this->checkboxName) == false) {<br />
<br />
$actions['publish_later'] = array(<br />
'cn' => 'PublishLater',<br />
'name' => 'pub later',<br />
'url' => "{$this->adminUrl}?{$this->listPageName}=1&id={$page->id}",<br />
);<br />
}<br />
if(count($actions)) $event->return = $actions + $event->return;<br />
}<br />
<br />
/*<br />
* Publish Page on cron job<br />
*<br />
* Gets deffered page and publishes<br />
*/<br />
public function ___publish($page) {<br />
$page->removeStatus(Page::statusUnpublished);<br />
$page->removeStatus(Page::statusHidden);<br />
$page->Save();<br />
}<br />
<br />
/*<br />
* Main publish later function<br />
*<br />
* Gets deffered page and sets fields to be checked be lazy cron<br />
*/<br />
private function ___publishLater() {<br />
<br />
// get page<br />
$page = $this->pages->get($this->pageID);<br />
<br />
// set output formatting to false<br />
$page->of(false);<br />
<br />
// set field time to settings default time and checkbox to true<br />
$page->set($this->checkboxName, true);<br />
$page->set($this->fieldName, $this->defaultTime);<br />
<br />
// save page<br />
$page->save();<br />
$page->of(true);<br />
}<br />
<br />
/*<br />
* Lazy Cron hook function<br />
*<br />
* Triggers every [set time interval] and checks pages<br />
* Publishes page if time runout<br />
*<br />
* Adds publish page log<br />
*/<br />
public function ___publishDefferedPages(HookEvent $e){<br />
<br />
// seconds since last lazycron<br />
$seconds = $e->arguments[0];<br />
<br />
// find all pages with deffered field<br />
$defferedPages = $this->pages->find("{$this->checkboxName}=1,include=unpublished");<br />
<br />
// for each page decrease time for deffered field<br />
foreach ($defferedPages as $page) {<br />
<br />
// get current page time<br />
$timeTillPublish = $page->get($this->fieldName);<br />
<br />
// set time to time minus time past<br />
$timeLeft = $timeTillPublish - $seconds;<br />
<br />
// if time passed 0 or less then publish page<br />
$page->of(false);<br />
if($timeLeft <= 0){<br />
// remove flags and save<br />
$this->publish($page);<br />
<br />
$page->set($this->fieldName, 0);<br />
$page->set($this->checkboxName, 0);<br />
<br />
// log a page has been published<br />
$log = wire('log');<br />
$log->message('CRON:'. $seconds .' Pages: '. $page->name .' published');<br />
}else{<br />
$page->set($this->fieldName, $timeLeft);<br />
}<br />
// save page time<br />
$page->Save();<br />
$page->of(true);<br />
}<br />
}<br />
<br />
/*<br />
* Install new module specific fields<br />
*/<br />
private function installFields(){<br />
<br />
// install pub later checkbox field<br />
// find installed fields<br />
$f = $this->fields->get($this->fieldName);<br />
if($f){<br />
<br />
// if field already found then don't try and make it<br />
$this->message($this->fieldName . ' field found');<br />
<br />
}else{<br />
<br />
// create new field object to store crontime<br />
$f = new Field();<br />
// get a field type<br />
$f->type = $this->modules->get("FieldtypeInteger");<br />
$f->name = $this->fieldName;<br />
$f->label = 'Publish Time Left';<br />
$f->defaultValue = $this->defaultTime;<br />
$f->icon = 'clock-o';<br />
$f->columnWidth = 50;<br />
$f->collapsed = 1;<br />
$f->flags = 4;<br />
<br />
$f->save(); // save the field<br />
<br />
// create new field object to store whether to publish or not<br />
$f = new Field();<br />
// get a field type<br />
$f->type = $this->modules->get("FieldtypeCheckbox");<br />
$f->name = $this->checkboxName;<br />
$f->label = 'Publish Page later';<br />
$f->defaultValue = false;<br />
$f->columnWidth = 50;<br />
$f->icon = 'clock-o';<br />
$f->collapsed = 1;<br />
$f->flags = 4;<br />
<br />
$f->save(); // save the field<br />
}<br />
}<br />
<br />
/*<br />
* Uninstall module specific fields<br />
*/<br />
private function uninstallFields(){<br />
<br />
// find installed fields<br />
$fInt = $this->fields->get($this->fieldName);<br />
$fCheck = $this->fields->get($this->checkboxName);<br />
<br />
if($fInt && $fCheck){<br />
$fieldIntUsed = $fInt->numFieldgroups();<br />
$fieldCheckUsed = $fCheck->numFieldgroups();<br />
<br />
if($fieldIntUsed){<br />
// field in use by template<br />
$this->message('Unable to uninstall field '.$fInt->name);<br />
}else{<br />
// delete installed fields<br />
$this->fields->delete($fInt);<br />
$this->fields->save;<br />
}<br />
<br />
if($fieldCheckUsed){<br />
// field in use by template<br />
$this->message('Unable to uninstall field '.$fCheck->name);<br />
}else{<br />
// delete installed fields<br />
$this->fields->delete($fCheck);<br />
$this->fields->save;<br />
}<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
=== Inputfield / Fieldtype ===<br />
[[ProcessWire - Fieldtype erstellen (Module)]]</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Module_schreiben&diff=24246ProcessWire - Module schreiben2020-01-06T09:58:39Z<p>84.136.104.26: /* Spezielle Funktionen in Modulen */</p>
<hr />
<div>== Links ==<br />
Wichtigste Resourcen<br />
https://processwire.com/docs/modules/development/ - Guter Ausgangspunkt<br />
https://processwire.com/api/ref/module/ - Module API<br />
https://processwire.com/api/ref/configurable-module/ - Klasse für Konfigurierbare Module<br />
https://processwire.com/docs/modules/types/ - Welche Modultypen gibt es ?<br />
https://github.com/ryancramerdesign/ProcessHello - Modul Skelett Beispiel für eigene Backend (Process) Module<br />
https://github.com/ryancramerdesign/FieldtypeMapMarker - Beispiel für ein Fieldtype und Inputfield Modul<br />
https://processwire.com/talk/topic/778-module-dependencies/ - Module die andere Module benötigen<br />
https://processwire.com/talk/forum/19-moduleplugin-development/ - Forum zum Thema Module entwickeln<br />
http://somatonic.github.io/Captain-Hook/ - Hook Cheatsheet<br />
https://processwire.com/blog/posts/new-module-configuration-options/ - Neuere Konfigurationsmöglichkeiten<br />
Weitere Links<br />
https://webdesign.tutsplus.com/tutorials/a-beginners-introduction-to-writing-modules-in-processwire--cms-26862<br />
https://processwire.com/docs/modules/ - Introduction, Development, Hooks, Types, Pro Modules, Third Party<br />
<br />
<br />
<br />
<br />
[[ProcessWire - Module Snippets]]<br />
<br />
== Wo - Was ? ==<br />
=== Welche Typen von Modulen gibt es ? ===<br />
https://processwire.com/docs/modules/types/<br />
* '''Fieldtype''': Repräsentiert einen Datentyp. Meistens keine Public API, Handelt Daten / Datenbank - https://processwire.com/api/ref/fieldtype/<br />
* '''Inputfield''': Sammelt User Eingaben über ein Formular im Admin Bereich. Im Gegensatz zum Fieldtype geht es hier um das UI im Backend. Das Handling der Daten liegt beim Fieldtype.<br />
* '''Process''' for creating admin processes/applications.<br />
* '''Textformatter''' for formatting text.<br />
* '''AdminTheme''' for creating themes in the admin.<br />
* '''WireMail''' for modules that send email and extend the WireMail class.<br />
* '''Tfa''' for implementing a specific kind of two-factor authentication.<br />
* '''ImageSizerEngine''' for modules that extend ImageSizerEngine for resizing images.<br />
* '''FileCompiler''' for modules that extend FileCompilerModule for compilation of files.<br />
* '''FileValidator''' for modules that extend FileValidatorModule for validation of files.<br />
<br />
=== Wie werden Felder in der Datenbank angelegt ? ===<br />
Dazu nutzt man den Typ "Fieldtype"<br />
<br />
=== Wo rendert man die Ausgabe ? ===<br />
Bei Ryan Cramers Event Beispiel legt er zwei Klassen Event und EventArray an, die auch die Render Funktionen enthalten.<br />
<br />
== Spezielle Funktionen in Modulen ==<br />
<br />
=== getModuleInfo ===<br />
Ist die einzige Pflichtfunktion in Modulen. Hier werden title, version, summary und weitere Daten hinterlegt. Hier kann man auch angeben ob ein Modul ein Autoload Modul ist.<br />
<br />
=== init ===<br />
public function init(){}<br />
Initialisiert das Modul. ProcessWire ruft diese Funktion auf, wenn das Modul geladen ist. Bei Autoload Modulen wird es aufgerufen wenn die ProcessWire API bereit ist. Daher ist es ein guter Ort um Hooks einzubinden.<br />
<br />
=== ready ===<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
if($this->page->template == 'admin') {<br />
$this->message($this->hi());<br />
}<br />
}<br />
</syntaxhighlight><br />
Wird in autoload Modulen aufgerufen wenn die API bereit ist. Nützlich für Hooks:<br />
<br />
=== execute ===<br />
<br />
== Vererbung und Eigenschaften in Modulen ==<br />
Modules are not different from PHP classes.<br />
<br />
To change the properties of MyModule class from within MyOtherModule class, you can either:<br />
<br />
#Make MyOtherModule class extend MyModule. It will thus inherit MyModule's public and protected properties and methods<br />
#Make the properties firstName and lastName configurable by passing them as parameters/arguments in MyModule's constructor method.<br />
<br />
== Autoload Module und Hooks ==<br />
Autoload werden automatisch geladen müssen also nicht in einem Template o.ä. gestartet werden. Daher bieten sie sich an um die Funktionalität von ProcessWire zu erweitern. Als Werkzeug dafür dienen Hooks. Mit Hooks kann man an vielen Stellen den Rendering Process der Seiten beeinflussen. Außerdem kann man für eigene Module ebenfalls Hooks bereitstellen. <br />
<br />
=== Hooks ===<br />
https://processwire.com/docs/modules/hooks/<br />
Hooks sind ein mächtiges Werkzeug. Sie geben einem die Möglichkeit an vielen Stellen "einzuhaken" und Funktionalität einzubauen.<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
$this->addHookAfter('Page::render', function($event) {<br />
$event->return .= '<p>Hallo</p>';<br />
});<br />
}<br />
</syntaxhighlight><br />
Schreibt am Ende Jeder Seite ein "Hallo". Das $event Objekt ist ein [https://processwire.com/api/ref/hook-event/ HookEvent]. Im Beispiel fügen wir einfach etwas Markup hinzu. Über $event->arguments() kann man aber auf ale Argumente zugreifen.<br />
<br />
Das gleiche aber nicht mit anonymer Funktion:<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
// add hook after Page::render() and make it call the "test" method of $this module<br />
$this->addHookAfter('Page::render', $this, 'test');<br />
}<br />
<br />
public function test($event) {<br />
// modify the return value of Page::render() to include the following:<br />
$event->return .= '<p>Hallo</p>';<br />
}<br />
</syntaxhighlight><br />
<br />
=== Hooks zum erweitern von existierenden Klassen nutzen ===<br />
Mit Hooks kann man in vorhandene Klassen einhaken. Z.B. läßt sich das Page Objekt erweitern.<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
$this->addHook('Page::summarize', $this, 'summarize');<br />
}<br />
public function summarize($event) {<br />
$page = $event->object; // the $event->object represents the object hooked (Page)<br />
$maxlen = $event->arguments(0); // first argument is the optional max length<br />
if(!$maxlen) $maxlen = 200; // if no $maxlen was present, we'll use a default of 200<br />
$summary = $this->sanitizer->truncate($page->body, $maxlen); // use sanitizer truncate method to create a summary<br />
$event->return = $summary; // populate $summary to $event->return, the return value<br />
}<br />
</syntaxhighlight><br />
So kann man ganz einfach eine Zusammenfassung aller Kindseiten in einem Template rendern:<br />
<syntaxhighlight lang="php"><br />
foreach($page->children as $item) {<br />
$summary = $item->summarize(150);<br />
echo "<li><a href='$item->url'>$item->title</a><br>$summary";<br />
}<br />
</syntaxhighlight><br />
<br />
=== Hook Beispiele ===<br />
Hook am Ende des Renderings<br />
$this->addHookAfter('Page::render', function($event) {...});<br />
Füge eine Funktion "summarize" zum Page Objekt hinzu.<br />
$this->addHook('Page::summarize', $this, 'summarize');<br />
Hook auf eine einzelne Instanz (hier pages Objekt)<br />
$this->pages->addHookAfter('saved', function($event){...});<br />
$this->addHook('Page::method', ...) // Spricht ALLE Instanzen an - Regelfall<br />
$page->addHook('method', ...) // Spricht nur die EINE Instanz der Seite an.<br />
</pre><br />
<br />
=== Autoload Module nur im Admin Bereich laden ===<br />
'autoload' => 'template=admin' <br />
statt<br />
'autoload' => true<br />
<br />
== Beispiele ==<br />
=== Frontend Rendering Module ===<br />
A bit old but working<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
/**<br />
* FrontEndRender<br />
*<br />
* Author: Ben Byford<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2010 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class FrontEndRender extends WireData implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'FrontEndRender',<br />
'version' => 0.1,<br />
'summary' => "Outputs html and static variables to frontend",<br />
'author' => 'Ben Byford',<br />
'singular' => true,<br />
'href' => 'https://github.com/benbyford/PW-starter-modules'<br />
);<br />
}<br />
<br />
// protected variable only accessable within module<br />
protected $name = 'Ben';<br />
<br />
/*<br />
* render function to be called in PW template like this:<br />
* $FrontEndRender = $modules->getModule('FrontEndRender');<br />
* echo '<h1>' . $FrontEndRender->render() . '</h1>';<br />
*<br />
*/<br />
public function render(){<br />
return "Hello " . $this->name;<br />
}<br />
}<br />
?><br />
</syntaxhighlight><br />
<br />
=== ProcessWire Hello World Modul ===<br />
Beispiel Modul mit Hooks (liegt immer in der Standardinstallation)<br />
<syntaxhighlight lang="php"><br />
<?php namespace ProcessWire;<br />
<br />
/**<br />
* ProcessWire 'Hello world' demonstration module<br />
*<br />
* Demonstrates the Module interface and how to add hooks.<br />
* <br />
* See README file for further links regarding module development.<br />
* <br />
* This file is licensed under the MIT license<br />
* https://processwire.com/about/license/mit/<br />
* <br />
* ProcessWire 3.x, Copyright 2016 by Ryan Cramer<br />
* https://processwire.com<br />
*<br />
*/<br />
<br />
class Helloworld extends WireData implements Module {<br />
<br />
/**<br />
* getModuleInfo is a module required by all modules to tell ProcessWire about them<br />
*<br />
* @return array<br />
*<br />
*/<br />
public static function getModuleInfo() {<br />
<br />
return array(<br />
<br />
// The module's title, typically a little more descriptive than the class name<br />
'title' => 'Hello World', <br />
<br />
// version number <br />
'version' => 3, <br />
<br />
// summary is brief description of what this module is<br />
'summary' => 'An example module used for demonstration purposes.',<br />
<br />
// Optional URL to more information about the module<br />
'href' => 'https://processwire.com',<br />
<br />
// singular=true: indicates that only one instance of the module is allowed.<br />
// This is usually what you want for modules that attach hooks. <br />
'singular' => true, <br />
<br />
// autoload=true: indicates the module should be started with ProcessWire.<br />
// This is necessary for any modules that attach runtime hooks, otherwise those<br />
// hooks won't get attached unless some other code calls the module on it's own.<br />
// Note that autoload modules are almost always also 'singular' (seen above).<br />
'autoload' => true, <br />
<br />
// Optional font-awesome icon name, minus the 'fa-' part<br />
'icon' => 'smile-o', <br />
);<br />
}<br />
<br />
/**<br />
* Initialize the module<br />
*<br />
* ProcessWire calls this when the module is loaded. For 'autoload' modules, this will be called<br />
* when ProcessWire's API is ready. As a result, this is a good place to attach hooks. <br />
*<br />
*/<br />
public function init() {<br />
<br />
// add a hook after the $pages->save, to issue a notice every time a page is saved<br />
$this->pages->addHookAfter('save', $this, 'example1'); <br />
<br />
// add a hook after each page is rendered and modify the output<br />
$this->addHookAfter('Page::render', $this, 'example2'); <br />
<br />
// add a 'hello' method to every page that returns "Hello World"<br />
// use "echo $page->hello();" in your template file to display output<br />
$this->addHook('Page::hello', $this, 'example3'); <br />
<br />
// add a 'hello_world' property to every page that returns "Hello [user]"<br />
// use "echo $page->hello_world;" in your template file to display output<br />
$this->addHookProperty('Page::hello_world', $this, 'example4'); <br />
}<br />
<br />
/**<br />
* Example1 hooks into the pages->save method and displays a notice every time a page is saved<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example1($event) {<br />
/** @var Page $page */<br />
$page = $event->arguments[0]; <br />
$this->message("Hello World! You saved {$page->path}."); <br />
}<br />
<br />
<br />
/**<br />
* Example2 hooks into every page after it's rendered and adds "Hello World" text at the bottom<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example2($event) {<br />
<br />
/** @var Page $page */<br />
$page = $event->object; <br />
<br />
// don't add this to the admin pages<br />
if($page->template == 'admin') return;<br />
<br />
// add a "Hello World" paragraph right before the closing body tag<br />
$event->return = str_replace("</body>", "<p>Hello World!</p></body>", $event->return); <br />
}<br />
<br />
/**<br />
* Example3 adds a 'hello' method (not property) to every page that simply returns "Hello World"<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example3($event) {<br />
$event->return = "Hello World";<br />
}<br />
<br />
/**<br />
* Example 4 adds a 'hello_world' property (not method) to every page that returns "Hello [user]"<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example4($event) {<br />
$event->return = "Hello " . $this->user->name; <br />
}<br />
<br />
}<br />
<br />
</syntaxhighlight><br />
<br />
=== ProcessWire Admin Bereich mit eigener Funktionalität erweitern (Modul)===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<syntaxhighlight lang="php"><br />
<br />
<?php<br />
/**<br />
* ProcessSimpleAdminPage<br />
*<br />
* @author Ben Byford<br />
* http://www.benbyford.com<br />
*<br />
* @see http://www.processwire.com<br />
*/<br />
<br />
class ProcessSimpleAdminPage extends Process {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'Process Simple Admin Page',<br />
'summary' => 'Simple Process module that adds new admin page with',<br />
'version' => 001,<br />
<br />
// Modules that extend Process may specify a 'page' attribute in the<br />
// getModuleInfo(), this page will automatically be given the module<br />
// process when added to teh pagetree.<br />
<br />
// I have exampled but commented out the 'page' settings below<br />
// so that I can show how one might add a page to install() and<br />
// uninstall() in this and other modules (that might not extend<br />
// Process)<br />
<br />
<br />
// 'page' => array(<br />
// 'name' => 'site-config',<br />
// 'parent' => 'admin',<br />
// 'title' => 'Site Config'<br />
// )<br />
);<br />
}<br />
<br />
public function execute() {<br />
return '<br />
<h2>Edit the text here in the module</h2><br />
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam mattis eros vitae metus sodales eget suscipit purus rhoncus. Proin ultrices gravida dolor, non porttitor enim interdum vitae. Integer feugiat lacinia tincidunt. Nulla laoreet tristique tristique. Sed elementum justo a nisl elementum sit amet accumsan nisi tempor. Nulla quis eros et massa dignissim imperdiet a vitae purus.</p><br />
<br />
<p>Donec scelerisque pulvinar sem eu lobortis. Maecenas turpis ipsum, tempus dictum pharetra eu, consectetur vitae arcu. Fusce orci mauris, semper at tempus quis, volutpat molestie tellus. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Sed quam tortor, tincidunt sed semper lacinia, scelerisque dapibus quam. Morbi at nisi luctus lacus auctor ultrices eu eu leo.</p><br />
<br />
<p>Praesent faucibus purus id felis tincidunt dignissim. Sed sit amet ligula mi, eget semper dui. Proin consectetur gravida massa, nec luctus purus hendrerit in. Etiam volutpat, elit non venenatis suscipit, libero neque consectetur diam, id rutrum magna odio ac ligula. Maecenas sollicitudin congue neque fermentum vestibulum. Morbi nec leo nisi. Donec at nisl odio, et porta ligula.</p><br />
<br />
<p>Sed quis arcu nisi, ac tempor augue. Praesent non elit libero, a ullamcorper lorem. Curabitur porta odio eu nunc ultricies interdum id nec risus. Donec nibh nibh, porta eget vehicula ac, aliquet eget ante. Phasellus eget lorem eu eros eleifend ultrices. Cras sit amet neque sit amet nibh fringilla cursus ut id mauris. Praesent quis nunc justo, sed suscipit lectus. Phasellus eget ultrices risus. Curabitur eu semper est. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Ut suscipit, nisl ut imperdiet eleifend, turpis arcu placerat tortor, nec laoreet lacus neque ac tellus. Aenean ac lacus justo, quis ultricies nisi.</p><br />
';<br />
}<br />
public function install(){<br />
<br />
// create new page to add to CMS<br />
$page = new Page();<br />
<br />
// add page attributes<br />
$page->template = "admin";<br />
$page->name = "cms-faq";<br />
$page->title = "CMS FAQ";<br />
$page->save();<br />
<br />
// set this module as the page process, this allows us to display the above<br />
$page->process = 'ProcessSimpleAdminPage';<br />
<br />
// get admin page and set as page parent<br />
$admin = $this->pages->get("id=2");<br />
$page->parent = $admin;<br />
<br />
// save page<br />
$page->save();<br />
}<br />
<br />
public function uninstall(){<br />
<br />
// delete created page<br />
$page = $this->pages->get("name=cms-faq");<br />
if(count($page)) $this->pages->delete($page, true);<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
=== ProcessWire Textformatter Modul ===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
/**<br />
* TextformatterFindReplace<br />
*<br />
* Author: Ben Byford<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2010 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class TextformatterFindReplace extends Textformatter implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'TextformatterFindReplace',<br />
'version' => 0.1,<br />
'summary' => "Finds and replaces any instance of config input to config output",<br />
'author' => 'Ben Byford',<br />
'singular' => true,<br />
'href' => 'https://github.com/benbyford/PW-starter-modules'<br />
);<br />
}<br />
<br />
<br />
/**<br />
* Find and Replace the input string<br />
*<br />
* @param string $str The block of text to parse<br />
*<br />
* The incoming string is replaced with the formatted version of itself.<br />
**/<br />
<br />
public function format(&$str) {<br />
$find = $this->findStr;<br />
$str = preg_replace_callback($find, array($this,"replace"), $str);<br />
<br />
}<br />
<br />
// adding three underscores to a function allows other modules to hook it<br />
public function ___replace($match) {<br />
return $this->replaceStr;<br />
}<br />
}<br />
?><br />
</syntaxhighlight><br />
<br />
=== Admin Funktionalität: Countdown zum Seitenveröffentlichen ===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<br />
The module PageDeferredPublish, on clicking one of the '''Publish Later buttons''', sets LazyCron to check that page’s countdown every minute and publishes the page when its countdown reaches 0. This means I can publish a page approximately 24 hours in advance (obviously the checking interval and delay time can be changed to your requirements).<br />
<br />
I did this by:<br />
<br />
'''Creating two fields''' within my install() function: a checkbox field to set to true when a button is checked to indicate the page should countdown, and a countdown field to store the count in seconds for that specific page.<br />
<br />
'''Adding hooks''' to both ''ProcessPageEdit::buildForm'' and ''ProcessPageListActions::getExtraActions'' enabling me to add the two buttons.<br />
<br />
Checking to see if one of the buttons was clicked with my '''ready() function''' then setting the corresponding page’s checkbox to true.<br />
<br />
Using a '''LazyCron hook function''' to check all pages that are unpublished for true checkboxes and then comparing the seconds field to see if the page needs publishing. If not then deduct the elapsed time in seconds.<br />
<br />
The result is a '''module that has settings''' (the time interval to check and publish at a later time), '''hooks into the admin''' using buttons and fields, and enables us to '''use other modules installe'''d in PW (i.e. LazyCron).<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
/**<br />
* DeferredPublish (0.0.1)<br />
* DeferredPublish publishes a page after a defined amount of time has elapsed using lazycron.<br />
*<br />
* @author Ben Byford<br />
* http://www.benbyford.com<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2011 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class PageDeferredPublish extends WireData implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => "PageDeferredPublish",<br />
'version' => "0.0.1",<br />
'summary' => "PageDeferredPublish",<br />
'author' => "Ben Byford",<br />
'href' => "https://github.com/benbyford/PW-intermediate-modules",<br />
'icon' => "clock-o",<br />
'autoload' => true,<br />
'singular' => true,<br />
'requires' => "LazyCron",<br />
);<br />
}<br />
<br />
private $postPubLater = null;<br />
private $pageID = null;<br />
private $pagePubLater = null;<br />
private $currentPage = null;<br />
<br />
private $submitName = 'pdp_pub_later_submit';<br />
private $listPageName = 'pdp_pub_later_list';<br />
private $fieldName = 'pdp_pub_later';<br />
private $checkboxName = 'pdp_pub_later_check';<br />
<br />
private $defaultInterval = 'everyMinute';<br />
private $defaultTime = 86400;<br />
<br />
<br />
public function install(){<br />
// add new fields needed for module<br />
$this->installFields();<br />
}<br />
public function uninstall(){<br />
// uninstall fields<br />
$this->uninstallFields();<br />
}<br />
<br />
// initialize the hook in your AutoLoad module<br />
public function init() {<br />
<br />
// get defaults from module setting in CMS<br />
$this->defaultTime = $this->pub_after;<br />
$this->defaultInterval = $this->cron_check;<br />
<br />
// get admin URL<br />
$this->adminUrl = $this->wire('config')->urls->admin;<br />
<br />
// add hooks to CRON, PageList, PageEdit<br />
$this->addHookAfter("LazyCron::{$this->defaultInterval}", $this, 'publishDefferedPages');<br />
$this->addHook("ProcessPageListActions::getExtraActions", $this, 'hookPageListActions');<br />
$this->addHookAfter("ProcessPageEdit::buildForm", $this, "editForm");<br />
}<br />
<br />
public function ready() {<br />
<br />
// if list button clicked then grab id<br />
$this->pagePubLater = $this->input->get($this->listPageName);<br />
$this->pageID = $this->input->id;<br />
<br />
// get page<br />
$this->currentPage = $this->pages->get($this->pageID);<br />
<br />
// if pagelist pub later submit button clicked<br />
if($this->pagePubLater){<br />
$this->message("Page {$this->currentPage->name} deffered for publish.");<br />
}<br />
<br />
// if page edit submit button clicked<br />
$this->postPubLater = $this->input->post($this->submitName);<br />
if($this->postPubLater){<br />
$this->message("Page {$this->currentPage->name} deffered for publish.");<br />
}<br />
<br />
// if either deffered publish sumbit found then publish page later<br />
if($this->pagePubLater || $this->postPubLater){<br />
$this->publishLater();<br />
}<br />
}<br />
<br />
/*<br />
* Hook: ProcessPageEdit::buildForm<br />
*<br />
* add Publish Later button to edit page if not yet published<br />
*/<br />
public function ___editForm(HookEvent $form) {<br />
<br />
// get the InputFieldForm object from the event (return value of buildForm())<br />
$form = $form->return;<br />
<br />
$page = $this->pages->get($this->input->get->id);<br />
$check = $page->get($this->checkboxName);<br />
<br />
// check if publish button available and therfore unpublished<br />
$target = $form->get('submit_publish');<br />
<br />
if($target && $check == false){<br />
<br />
// get InputfieldText module<br />
$submit2 = $this->modules->get('InputfieldSubmit');<br />
$submit2->attr('name', $this->submitName);<br />
$submit2->attr('id', 'publish_later');<br />
$submit2->attr('class', 'ui-button ui-widget ui-corner-all head_button_clone ui-state-default ui-priority-secondary');<br />
$submit2->attr('value', 'Publish Later'); // Button: save unpublished<br />
<br />
// get form element save and place before<br />
$target = $form->get('submit_save');<br />
$form->insertBefore($submit2, $target);<br />
<br />
$form->return = $form;<br />
}<br />
}<br />
<br />
public function ___hookPageListActions(HookEvent $event) {<br />
<br />
// get current page<br />
$page = $event->arguments[0];<br />
<br />
// check to see if page is published<br />
$pagePub = $page->is(Page::statusUnpublished);<br />
<br />
// check to see if page template has deffered field<br />
$pageHasDefferField = $page->get($this->fieldName);<br />
<br />
$actions = array();<br />
<br />
// don't get homepage or pages that are already published or are being deffered for publish<br />
if($page->id > 1 && $pagePub == "published" && !is_null($pageHasDefferField) && $page->get($this->checkboxName) == false) {<br />
<br />
$actions['publish_later'] = array(<br />
'cn' => 'PublishLater',<br />
'name' => 'pub later',<br />
'url' => "{$this->adminUrl}?{$this->listPageName}=1&id={$page->id}",<br />
);<br />
}<br />
if(count($actions)) $event->return = $actions + $event->return;<br />
}<br />
<br />
/*<br />
* Publish Page on cron job<br />
*<br />
* Gets deffered page and publishes<br />
*/<br />
public function ___publish($page) {<br />
$page->removeStatus(Page::statusUnpublished);<br />
$page->removeStatus(Page::statusHidden);<br />
$page->Save();<br />
}<br />
<br />
/*<br />
* Main publish later function<br />
*<br />
* Gets deffered page and sets fields to be checked be lazy cron<br />
*/<br />
private function ___publishLater() {<br />
<br />
// get page<br />
$page = $this->pages->get($this->pageID);<br />
<br />
// set output formatting to false<br />
$page->of(false);<br />
<br />
// set field time to settings default time and checkbox to true<br />
$page->set($this->checkboxName, true);<br />
$page->set($this->fieldName, $this->defaultTime);<br />
<br />
// save page<br />
$page->save();<br />
$page->of(true);<br />
}<br />
<br />
/*<br />
* Lazy Cron hook function<br />
*<br />
* Triggers every [set time interval] and checks pages<br />
* Publishes page if time runout<br />
*<br />
* Adds publish page log<br />
*/<br />
public function ___publishDefferedPages(HookEvent $e){<br />
<br />
// seconds since last lazycron<br />
$seconds = $e->arguments[0];<br />
<br />
// find all pages with deffered field<br />
$defferedPages = $this->pages->find("{$this->checkboxName}=1,include=unpublished");<br />
<br />
// for each page decrease time for deffered field<br />
foreach ($defferedPages as $page) {<br />
<br />
// get current page time<br />
$timeTillPublish = $page->get($this->fieldName);<br />
<br />
// set time to time minus time past<br />
$timeLeft = $timeTillPublish - $seconds;<br />
<br />
// if time passed 0 or less then publish page<br />
$page->of(false);<br />
if($timeLeft <= 0){<br />
// remove flags and save<br />
$this->publish($page);<br />
<br />
$page->set($this->fieldName, 0);<br />
$page->set($this->checkboxName, 0);<br />
<br />
// log a page has been published<br />
$log = wire('log');<br />
$log->message('CRON:'. $seconds .' Pages: '. $page->name .' published');<br />
}else{<br />
$page->set($this->fieldName, $timeLeft);<br />
}<br />
// save page time<br />
$page->Save();<br />
$page->of(true);<br />
}<br />
}<br />
<br />
/*<br />
* Install new module specific fields<br />
*/<br />
private function installFields(){<br />
<br />
// install pub later checkbox field<br />
// find installed fields<br />
$f = $this->fields->get($this->fieldName);<br />
if($f){<br />
<br />
// if field already found then don't try and make it<br />
$this->message($this->fieldName . ' field found');<br />
<br />
}else{<br />
<br />
// create new field object to store crontime<br />
$f = new Field();<br />
// get a field type<br />
$f->type = $this->modules->get("FieldtypeInteger");<br />
$f->name = $this->fieldName;<br />
$f->label = 'Publish Time Left';<br />
$f->defaultValue = $this->defaultTime;<br />
$f->icon = 'clock-o';<br />
$f->columnWidth = 50;<br />
$f->collapsed = 1;<br />
$f->flags = 4;<br />
<br />
$f->save(); // save the field<br />
<br />
// create new field object to store whether to publish or not<br />
$f = new Field();<br />
// get a field type<br />
$f->type = $this->modules->get("FieldtypeCheckbox");<br />
$f->name = $this->checkboxName;<br />
$f->label = 'Publish Page later';<br />
$f->defaultValue = false;<br />
$f->columnWidth = 50;<br />
$f->icon = 'clock-o';<br />
$f->collapsed = 1;<br />
$f->flags = 4;<br />
<br />
$f->save(); // save the field<br />
}<br />
}<br />
<br />
/*<br />
* Uninstall module specific fields<br />
*/<br />
private function uninstallFields(){<br />
<br />
// find installed fields<br />
$fInt = $this->fields->get($this->fieldName);<br />
$fCheck = $this->fields->get($this->checkboxName);<br />
<br />
if($fInt && $fCheck){<br />
$fieldIntUsed = $fInt->numFieldgroups();<br />
$fieldCheckUsed = $fCheck->numFieldgroups();<br />
<br />
if($fieldIntUsed){<br />
// field in use by template<br />
$this->message('Unable to uninstall field '.$fInt->name);<br />
}else{<br />
// delete installed fields<br />
$this->fields->delete($fInt);<br />
$this->fields->save;<br />
}<br />
<br />
if($fieldCheckUsed){<br />
// field in use by template<br />
$this->message('Unable to uninstall field '.$fCheck->name);<br />
}else{<br />
// delete installed fields<br />
$this->fields->delete($fCheck);<br />
$this->fields->save;<br />
}<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
=== Inputfield / Fieldtype ===<br />
[[ProcessWire - Fieldtype erstellen (Module)]]</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Module_schreiben&diff=24245ProcessWire - Module schreiben2020-01-06T09:10:49Z<p>84.136.104.26: /* Welche Typen von Modulen gibt es ? */</p>
<hr />
<div>== Links ==<br />
Wichtigste Resourcen<br />
https://processwire.com/docs/modules/development/ - Guter Ausgangspunkt<br />
https://processwire.com/api/ref/module/ - Module API<br />
https://processwire.com/api/ref/configurable-module/ - Klasse für Konfigurierbare Module<br />
https://processwire.com/docs/modules/types/ - Welche Modultypen gibt es ?<br />
https://github.com/ryancramerdesign/ProcessHello - Modul Skelett Beispiel für eigene Backend (Process) Module<br />
https://github.com/ryancramerdesign/FieldtypeMapMarker - Beispiel für ein Fieldtype und Inputfield Modul<br />
https://processwire.com/talk/topic/778-module-dependencies/ - Module die andere Module benötigen<br />
https://processwire.com/talk/forum/19-moduleplugin-development/ - Forum zum Thema Module entwickeln<br />
http://somatonic.github.io/Captain-Hook/ - Hook Cheatsheet<br />
https://processwire.com/blog/posts/new-module-configuration-options/ - Neuere Konfigurationsmöglichkeiten<br />
Weitere Links<br />
https://webdesign.tutsplus.com/tutorials/a-beginners-introduction-to-writing-modules-in-processwire--cms-26862<br />
https://processwire.com/docs/modules/ - Introduction, Development, Hooks, Types, Pro Modules, Third Party<br />
<br />
<br />
<br />
<br />
[[ProcessWire - Module Snippets]]<br />
<br />
== Wo - Was ? ==<br />
=== Welche Typen von Modulen gibt es ? ===<br />
https://processwire.com/docs/modules/types/<br />
* '''Fieldtype''': Repräsentiert einen Datentyp. Meistens keine Public API, Handelt Daten / Datenbank - https://processwire.com/api/ref/fieldtype/<br />
* '''Inputfield''': Sammelt User Eingaben über ein Formular im Admin Bereich. Im Gegensatz zum Fieldtype geht es hier um das UI im Backend. Das Handling der Daten liegt beim Fieldtype.<br />
* '''Process''' for creating admin processes/applications.<br />
* '''Textformatter''' for formatting text.<br />
* '''AdminTheme''' for creating themes in the admin.<br />
* '''WireMail''' for modules that send email and extend the WireMail class.<br />
* '''Tfa''' for implementing a specific kind of two-factor authentication.<br />
* '''ImageSizerEngine''' for modules that extend ImageSizerEngine for resizing images.<br />
* '''FileCompiler''' for modules that extend FileCompilerModule for compilation of files.<br />
* '''FileValidator''' for modules that extend FileValidatorModule for validation of files.<br />
<br />
=== Wie werden Felder in der Datenbank angelegt ? ===<br />
Dazu nutzt man den Typ "Fieldtype"<br />
<br />
=== Wo rendert man die Ausgabe ? ===<br />
Bei Ryan Cramers Event Beispiel legt er zwei Klassen Event und EventArray an, die auch die Render Funktionen enthalten.<br />
<br />
== Spezielle Funktionen in Modulen ==<br />
<br />
=== getModuleInfo ===<br />
Ist die einzige Pflichtfunktion in Modulen. Hier werden title, version, summary und weitere Daten hinterlegt. Hier kann man auch angeben ob ein Modul ein Autoload Modul ist.<br />
<br />
=== init ===<br />
public function init(){}<br />
Initialisiert das Modul. ProcessWire ruft diese Funktion auf, wenn das Modul geladen ist. Bei Autoload Modulen wird es aufgerufen wenn die ProcessWire API bereit ist. Daher ist es ein guter Ort um Hooks einzubinden.<br />
<br />
=== ready ===<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
if($this->page->template == 'admin') {<br />
$this->message($this->hi());<br />
}<br />
}<br />
</syntaxhighlight><br />
Wird in autoload Modulen aufgerufen wenn die API bereit ist. Nützlich für Hooks:<br />
<br />
<br />
== Autoload Module und Hooks ==<br />
Autoload werden automatisch geladen müssen also nicht in einem Template o.ä. gestartet werden. Daher bieten sie sich an um die Funktionalität von ProcessWire zu erweitern. Als Werkzeug dafür dienen Hooks. Mit Hooks kann man an vielen Stellen den Rendering Process der Seiten beeinflussen. Außerdem kann man für eigene Module ebenfalls Hooks bereitstellen. <br />
<br />
=== Hooks ===<br />
https://processwire.com/docs/modules/hooks/<br />
Hooks sind ein mächtiges Werkzeug. Sie geben einem die Möglichkeit an vielen Stellen "einzuhaken" und Funktionalität einzubauen.<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
$this->addHookAfter('Page::render', function($event) {<br />
$event->return .= '<p>Hallo</p>';<br />
});<br />
}<br />
</syntaxhighlight><br />
Schreibt am Ende Jeder Seite ein "Hallo". Das $event Objekt ist ein [https://processwire.com/api/ref/hook-event/ HookEvent]. Im Beispiel fügen wir einfach etwas Markup hinzu. Über $event->arguments() kann man aber auf ale Argumente zugreifen.<br />
<br />
Das gleiche aber nicht mit anonymer Funktion:<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
// add hook after Page::render() and make it call the "test" method of $this module<br />
$this->addHookAfter('Page::render', $this, 'test');<br />
}<br />
<br />
public function test($event) {<br />
// modify the return value of Page::render() to include the following:<br />
$event->return .= '<p>Hallo</p>';<br />
}<br />
</syntaxhighlight><br />
<br />
=== Hooks zum erweitern von existierenden Klassen nutzen ===<br />
Mit Hooks kann man in vorhandene Klassen einhaken. Z.B. läßt sich das Page Objekt erweitern.<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
$this->addHook('Page::summarize', $this, 'summarize');<br />
}<br />
public function summarize($event) {<br />
$page = $event->object; // the $event->object represents the object hooked (Page)<br />
$maxlen = $event->arguments(0); // first argument is the optional max length<br />
if(!$maxlen) $maxlen = 200; // if no $maxlen was present, we'll use a default of 200<br />
$summary = $this->sanitizer->truncate($page->body, $maxlen); // use sanitizer truncate method to create a summary<br />
$event->return = $summary; // populate $summary to $event->return, the return value<br />
}<br />
</syntaxhighlight><br />
So kann man ganz einfach eine Zusammenfassung aller Kindseiten in einem Template rendern:<br />
<syntaxhighlight lang="php"><br />
foreach($page->children as $item) {<br />
$summary = $item->summarize(150);<br />
echo "<li><a href='$item->url'>$item->title</a><br>$summary";<br />
}<br />
</syntaxhighlight><br />
<br />
=== Hook Beispiele ===<br />
Hook am Ende des Renderings<br />
$this->addHookAfter('Page::render', function($event) {...});<br />
Füge eine Funktion "summarize" zum Page Objekt hinzu.<br />
$this->addHook('Page::summarize', $this, 'summarize');<br />
Hook auf eine einzelne Instanz (hier pages Objekt)<br />
$this->pages->addHookAfter('saved', function($event){...});<br />
$this->addHook('Page::method', ...) // Spricht ALLE Instanzen an - Regelfall<br />
$page->addHook('method', ...) // Spricht nur die EINE Instanz der Seite an.<br />
</pre><br />
<br />
=== Autoload Module nur im Admin Bereich laden ===<br />
'autoload' => 'template=admin' <br />
statt<br />
'autoload' => true<br />
<br />
== Beispiele ==<br />
=== Frontend Rendering Module ===<br />
A bit old but working<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
/**<br />
* FrontEndRender<br />
*<br />
* Author: Ben Byford<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2010 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class FrontEndRender extends WireData implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'FrontEndRender',<br />
'version' => 0.1,<br />
'summary' => "Outputs html and static variables to frontend",<br />
'author' => 'Ben Byford',<br />
'singular' => true,<br />
'href' => 'https://github.com/benbyford/PW-starter-modules'<br />
);<br />
}<br />
<br />
// protected variable only accessable within module<br />
protected $name = 'Ben';<br />
<br />
/*<br />
* render function to be called in PW template like this:<br />
* $FrontEndRender = $modules->getModule('FrontEndRender');<br />
* echo '<h1>' . $FrontEndRender->render() . '</h1>';<br />
*<br />
*/<br />
public function render(){<br />
return "Hello " . $this->name;<br />
}<br />
}<br />
?><br />
</syntaxhighlight><br />
<br />
=== ProcessWire Hello World Modul ===<br />
Beispiel Modul mit Hooks (liegt immer in der Standardinstallation)<br />
<syntaxhighlight lang="php"><br />
<?php namespace ProcessWire;<br />
<br />
/**<br />
* ProcessWire 'Hello world' demonstration module<br />
*<br />
* Demonstrates the Module interface and how to add hooks.<br />
* <br />
* See README file for further links regarding module development.<br />
* <br />
* This file is licensed under the MIT license<br />
* https://processwire.com/about/license/mit/<br />
* <br />
* ProcessWire 3.x, Copyright 2016 by Ryan Cramer<br />
* https://processwire.com<br />
*<br />
*/<br />
<br />
class Helloworld extends WireData implements Module {<br />
<br />
/**<br />
* getModuleInfo is a module required by all modules to tell ProcessWire about them<br />
*<br />
* @return array<br />
*<br />
*/<br />
public static function getModuleInfo() {<br />
<br />
return array(<br />
<br />
// The module's title, typically a little more descriptive than the class name<br />
'title' => 'Hello World', <br />
<br />
// version number <br />
'version' => 3, <br />
<br />
// summary is brief description of what this module is<br />
'summary' => 'An example module used for demonstration purposes.',<br />
<br />
// Optional URL to more information about the module<br />
'href' => 'https://processwire.com',<br />
<br />
// singular=true: indicates that only one instance of the module is allowed.<br />
// This is usually what you want for modules that attach hooks. <br />
'singular' => true, <br />
<br />
// autoload=true: indicates the module should be started with ProcessWire.<br />
// This is necessary for any modules that attach runtime hooks, otherwise those<br />
// hooks won't get attached unless some other code calls the module on it's own.<br />
// Note that autoload modules are almost always also 'singular' (seen above).<br />
'autoload' => true, <br />
<br />
// Optional font-awesome icon name, minus the 'fa-' part<br />
'icon' => 'smile-o', <br />
);<br />
}<br />
<br />
/**<br />
* Initialize the module<br />
*<br />
* ProcessWire calls this when the module is loaded. For 'autoload' modules, this will be called<br />
* when ProcessWire's API is ready. As a result, this is a good place to attach hooks. <br />
*<br />
*/<br />
public function init() {<br />
<br />
// add a hook after the $pages->save, to issue a notice every time a page is saved<br />
$this->pages->addHookAfter('save', $this, 'example1'); <br />
<br />
// add a hook after each page is rendered and modify the output<br />
$this->addHookAfter('Page::render', $this, 'example2'); <br />
<br />
// add a 'hello' method to every page that returns "Hello World"<br />
// use "echo $page->hello();" in your template file to display output<br />
$this->addHook('Page::hello', $this, 'example3'); <br />
<br />
// add a 'hello_world' property to every page that returns "Hello [user]"<br />
// use "echo $page->hello_world;" in your template file to display output<br />
$this->addHookProperty('Page::hello_world', $this, 'example4'); <br />
}<br />
<br />
/**<br />
* Example1 hooks into the pages->save method and displays a notice every time a page is saved<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example1($event) {<br />
/** @var Page $page */<br />
$page = $event->arguments[0]; <br />
$this->message("Hello World! You saved {$page->path}."); <br />
}<br />
<br />
<br />
/**<br />
* Example2 hooks into every page after it's rendered and adds "Hello World" text at the bottom<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example2($event) {<br />
<br />
/** @var Page $page */<br />
$page = $event->object; <br />
<br />
// don't add this to the admin pages<br />
if($page->template == 'admin') return;<br />
<br />
// add a "Hello World" paragraph right before the closing body tag<br />
$event->return = str_replace("</body>", "<p>Hello World!</p></body>", $event->return); <br />
}<br />
<br />
/**<br />
* Example3 adds a 'hello' method (not property) to every page that simply returns "Hello World"<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example3($event) {<br />
$event->return = "Hello World";<br />
}<br />
<br />
/**<br />
* Example 4 adds a 'hello_world' property (not method) to every page that returns "Hello [user]"<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example4($event) {<br />
$event->return = "Hello " . $this->user->name; <br />
}<br />
<br />
}<br />
<br />
</syntaxhighlight><br />
<br />
=== ProcessWire Admin Bereich mit eigener Funktionalität erweitern (Modul)===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<syntaxhighlight lang="php"><br />
<br />
<?php<br />
/**<br />
* ProcessSimpleAdminPage<br />
*<br />
* @author Ben Byford<br />
* http://www.benbyford.com<br />
*<br />
* @see http://www.processwire.com<br />
*/<br />
<br />
class ProcessSimpleAdminPage extends Process {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'Process Simple Admin Page',<br />
'summary' => 'Simple Process module that adds new admin page with',<br />
'version' => 001,<br />
<br />
// Modules that extend Process may specify a 'page' attribute in the<br />
// getModuleInfo(), this page will automatically be given the module<br />
// process when added to teh pagetree.<br />
<br />
// I have exampled but commented out the 'page' settings below<br />
// so that I can show how one might add a page to install() and<br />
// uninstall() in this and other modules (that might not extend<br />
// Process)<br />
<br />
<br />
// 'page' => array(<br />
// 'name' => 'site-config',<br />
// 'parent' => 'admin',<br />
// 'title' => 'Site Config'<br />
// )<br />
);<br />
}<br />
<br />
public function execute() {<br />
return '<br />
<h2>Edit the text here in the module</h2><br />
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam mattis eros vitae metus sodales eget suscipit purus rhoncus. Proin ultrices gravida dolor, non porttitor enim interdum vitae. Integer feugiat lacinia tincidunt. Nulla laoreet tristique tristique. Sed elementum justo a nisl elementum sit amet accumsan nisi tempor. Nulla quis eros et massa dignissim imperdiet a vitae purus.</p><br />
<br />
<p>Donec scelerisque pulvinar sem eu lobortis. Maecenas turpis ipsum, tempus dictum pharetra eu, consectetur vitae arcu. Fusce orci mauris, semper at tempus quis, volutpat molestie tellus. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Sed quam tortor, tincidunt sed semper lacinia, scelerisque dapibus quam. Morbi at nisi luctus lacus auctor ultrices eu eu leo.</p><br />
<br />
<p>Praesent faucibus purus id felis tincidunt dignissim. Sed sit amet ligula mi, eget semper dui. Proin consectetur gravida massa, nec luctus purus hendrerit in. Etiam volutpat, elit non venenatis suscipit, libero neque consectetur diam, id rutrum magna odio ac ligula. Maecenas sollicitudin congue neque fermentum vestibulum. Morbi nec leo nisi. Donec at nisl odio, et porta ligula.</p><br />
<br />
<p>Sed quis arcu nisi, ac tempor augue. Praesent non elit libero, a ullamcorper lorem. Curabitur porta odio eu nunc ultricies interdum id nec risus. Donec nibh nibh, porta eget vehicula ac, aliquet eget ante. Phasellus eget lorem eu eros eleifend ultrices. Cras sit amet neque sit amet nibh fringilla cursus ut id mauris. Praesent quis nunc justo, sed suscipit lectus. Phasellus eget ultrices risus. Curabitur eu semper est. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Ut suscipit, nisl ut imperdiet eleifend, turpis arcu placerat tortor, nec laoreet lacus neque ac tellus. Aenean ac lacus justo, quis ultricies nisi.</p><br />
';<br />
}<br />
public function install(){<br />
<br />
// create new page to add to CMS<br />
$page = new Page();<br />
<br />
// add page attributes<br />
$page->template = "admin";<br />
$page->name = "cms-faq";<br />
$page->title = "CMS FAQ";<br />
$page->save();<br />
<br />
// set this module as the page process, this allows us to display the above<br />
$page->process = 'ProcessSimpleAdminPage';<br />
<br />
// get admin page and set as page parent<br />
$admin = $this->pages->get("id=2");<br />
$page->parent = $admin;<br />
<br />
// save page<br />
$page->save();<br />
}<br />
<br />
public function uninstall(){<br />
<br />
// delete created page<br />
$page = $this->pages->get("name=cms-faq");<br />
if(count($page)) $this->pages->delete($page, true);<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
=== ProcessWire Textformatter Modul ===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
/**<br />
* TextformatterFindReplace<br />
*<br />
* Author: Ben Byford<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2010 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class TextformatterFindReplace extends Textformatter implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'TextformatterFindReplace',<br />
'version' => 0.1,<br />
'summary' => "Finds and replaces any instance of config input to config output",<br />
'author' => 'Ben Byford',<br />
'singular' => true,<br />
'href' => 'https://github.com/benbyford/PW-starter-modules'<br />
);<br />
}<br />
<br />
<br />
/**<br />
* Find and Replace the input string<br />
*<br />
* @param string $str The block of text to parse<br />
*<br />
* The incoming string is replaced with the formatted version of itself.<br />
**/<br />
<br />
public function format(&$str) {<br />
$find = $this->findStr;<br />
$str = preg_replace_callback($find, array($this,"replace"), $str);<br />
<br />
}<br />
<br />
// adding three underscores to a function allows other modules to hook it<br />
public function ___replace($match) {<br />
return $this->replaceStr;<br />
}<br />
}<br />
?><br />
</syntaxhighlight><br />
<br />
=== Admin Funktionalität: Countdown zum Seitenveröffentlichen ===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<br />
The module PageDeferredPublish, on clicking one of the '''Publish Later buttons''', sets LazyCron to check that page’s countdown every minute and publishes the page when its countdown reaches 0. This means I can publish a page approximately 24 hours in advance (obviously the checking interval and delay time can be changed to your requirements).<br />
<br />
I did this by:<br />
<br />
'''Creating two fields''' within my install() function: a checkbox field to set to true when a button is checked to indicate the page should countdown, and a countdown field to store the count in seconds for that specific page.<br />
<br />
'''Adding hooks''' to both ''ProcessPageEdit::buildForm'' and ''ProcessPageListActions::getExtraActions'' enabling me to add the two buttons.<br />
<br />
Checking to see if one of the buttons was clicked with my '''ready() function''' then setting the corresponding page’s checkbox to true.<br />
<br />
Using a '''LazyCron hook function''' to check all pages that are unpublished for true checkboxes and then comparing the seconds field to see if the page needs publishing. If not then deduct the elapsed time in seconds.<br />
<br />
The result is a '''module that has settings''' (the time interval to check and publish at a later time), '''hooks into the admin''' using buttons and fields, and enables us to '''use other modules installe'''d in PW (i.e. LazyCron).<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
/**<br />
* DeferredPublish (0.0.1)<br />
* DeferredPublish publishes a page after a defined amount of time has elapsed using lazycron.<br />
*<br />
* @author Ben Byford<br />
* http://www.benbyford.com<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2011 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class PageDeferredPublish extends WireData implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => "PageDeferredPublish",<br />
'version' => "0.0.1",<br />
'summary' => "PageDeferredPublish",<br />
'author' => "Ben Byford",<br />
'href' => "https://github.com/benbyford/PW-intermediate-modules",<br />
'icon' => "clock-o",<br />
'autoload' => true,<br />
'singular' => true,<br />
'requires' => "LazyCron",<br />
);<br />
}<br />
<br />
private $postPubLater = null;<br />
private $pageID = null;<br />
private $pagePubLater = null;<br />
private $currentPage = null;<br />
<br />
private $submitName = 'pdp_pub_later_submit';<br />
private $listPageName = 'pdp_pub_later_list';<br />
private $fieldName = 'pdp_pub_later';<br />
private $checkboxName = 'pdp_pub_later_check';<br />
<br />
private $defaultInterval = 'everyMinute';<br />
private $defaultTime = 86400;<br />
<br />
<br />
public function install(){<br />
// add new fields needed for module<br />
$this->installFields();<br />
}<br />
public function uninstall(){<br />
// uninstall fields<br />
$this->uninstallFields();<br />
}<br />
<br />
// initialize the hook in your AutoLoad module<br />
public function init() {<br />
<br />
// get defaults from module setting in CMS<br />
$this->defaultTime = $this->pub_after;<br />
$this->defaultInterval = $this->cron_check;<br />
<br />
// get admin URL<br />
$this->adminUrl = $this->wire('config')->urls->admin;<br />
<br />
// add hooks to CRON, PageList, PageEdit<br />
$this->addHookAfter("LazyCron::{$this->defaultInterval}", $this, 'publishDefferedPages');<br />
$this->addHook("ProcessPageListActions::getExtraActions", $this, 'hookPageListActions');<br />
$this->addHookAfter("ProcessPageEdit::buildForm", $this, "editForm");<br />
}<br />
<br />
public function ready() {<br />
<br />
// if list button clicked then grab id<br />
$this->pagePubLater = $this->input->get($this->listPageName);<br />
$this->pageID = $this->input->id;<br />
<br />
// get page<br />
$this->currentPage = $this->pages->get($this->pageID);<br />
<br />
// if pagelist pub later submit button clicked<br />
if($this->pagePubLater){<br />
$this->message("Page {$this->currentPage->name} deffered for publish.");<br />
}<br />
<br />
// if page edit submit button clicked<br />
$this->postPubLater = $this->input->post($this->submitName);<br />
if($this->postPubLater){<br />
$this->message("Page {$this->currentPage->name} deffered for publish.");<br />
}<br />
<br />
// if either deffered publish sumbit found then publish page later<br />
if($this->pagePubLater || $this->postPubLater){<br />
$this->publishLater();<br />
}<br />
}<br />
<br />
/*<br />
* Hook: ProcessPageEdit::buildForm<br />
*<br />
* add Publish Later button to edit page if not yet published<br />
*/<br />
public function ___editForm(HookEvent $form) {<br />
<br />
// get the InputFieldForm object from the event (return value of buildForm())<br />
$form = $form->return;<br />
<br />
$page = $this->pages->get($this->input->get->id);<br />
$check = $page->get($this->checkboxName);<br />
<br />
// check if publish button available and therfore unpublished<br />
$target = $form->get('submit_publish');<br />
<br />
if($target && $check == false){<br />
<br />
// get InputfieldText module<br />
$submit2 = $this->modules->get('InputfieldSubmit');<br />
$submit2->attr('name', $this->submitName);<br />
$submit2->attr('id', 'publish_later');<br />
$submit2->attr('class', 'ui-button ui-widget ui-corner-all head_button_clone ui-state-default ui-priority-secondary');<br />
$submit2->attr('value', 'Publish Later'); // Button: save unpublished<br />
<br />
// get form element save and place before<br />
$target = $form->get('submit_save');<br />
$form->insertBefore($submit2, $target);<br />
<br />
$form->return = $form;<br />
}<br />
}<br />
<br />
public function ___hookPageListActions(HookEvent $event) {<br />
<br />
// get current page<br />
$page = $event->arguments[0];<br />
<br />
// check to see if page is published<br />
$pagePub = $page->is(Page::statusUnpublished);<br />
<br />
// check to see if page template has deffered field<br />
$pageHasDefferField = $page->get($this->fieldName);<br />
<br />
$actions = array();<br />
<br />
// don't get homepage or pages that are already published or are being deffered for publish<br />
if($page->id > 1 && $pagePub == "published" && !is_null($pageHasDefferField) && $page->get($this->checkboxName) == false) {<br />
<br />
$actions['publish_later'] = array(<br />
'cn' => 'PublishLater',<br />
'name' => 'pub later',<br />
'url' => "{$this->adminUrl}?{$this->listPageName}=1&id={$page->id}",<br />
);<br />
}<br />
if(count($actions)) $event->return = $actions + $event->return;<br />
}<br />
<br />
/*<br />
* Publish Page on cron job<br />
*<br />
* Gets deffered page and publishes<br />
*/<br />
public function ___publish($page) {<br />
$page->removeStatus(Page::statusUnpublished);<br />
$page->removeStatus(Page::statusHidden);<br />
$page->Save();<br />
}<br />
<br />
/*<br />
* Main publish later function<br />
*<br />
* Gets deffered page and sets fields to be checked be lazy cron<br />
*/<br />
private function ___publishLater() {<br />
<br />
// get page<br />
$page = $this->pages->get($this->pageID);<br />
<br />
// set output formatting to false<br />
$page->of(false);<br />
<br />
// set field time to settings default time and checkbox to true<br />
$page->set($this->checkboxName, true);<br />
$page->set($this->fieldName, $this->defaultTime);<br />
<br />
// save page<br />
$page->save();<br />
$page->of(true);<br />
}<br />
<br />
/*<br />
* Lazy Cron hook function<br />
*<br />
* Triggers every [set time interval] and checks pages<br />
* Publishes page if time runout<br />
*<br />
* Adds publish page log<br />
*/<br />
public function ___publishDefferedPages(HookEvent $e){<br />
<br />
// seconds since last lazycron<br />
$seconds = $e->arguments[0];<br />
<br />
// find all pages with deffered field<br />
$defferedPages = $this->pages->find("{$this->checkboxName}=1,include=unpublished");<br />
<br />
// for each page decrease time for deffered field<br />
foreach ($defferedPages as $page) {<br />
<br />
// get current page time<br />
$timeTillPublish = $page->get($this->fieldName);<br />
<br />
// set time to time minus time past<br />
$timeLeft = $timeTillPublish - $seconds;<br />
<br />
// if time passed 0 or less then publish page<br />
$page->of(false);<br />
if($timeLeft <= 0){<br />
// remove flags and save<br />
$this->publish($page);<br />
<br />
$page->set($this->fieldName, 0);<br />
$page->set($this->checkboxName, 0);<br />
<br />
// log a page has been published<br />
$log = wire('log');<br />
$log->message('CRON:'. $seconds .' Pages: '. $page->name .' published');<br />
}else{<br />
$page->set($this->fieldName, $timeLeft);<br />
}<br />
// save page time<br />
$page->Save();<br />
$page->of(true);<br />
}<br />
}<br />
<br />
/*<br />
* Install new module specific fields<br />
*/<br />
private function installFields(){<br />
<br />
// install pub later checkbox field<br />
// find installed fields<br />
$f = $this->fields->get($this->fieldName);<br />
if($f){<br />
<br />
// if field already found then don't try and make it<br />
$this->message($this->fieldName . ' field found');<br />
<br />
}else{<br />
<br />
// create new field object to store crontime<br />
$f = new Field();<br />
// get a field type<br />
$f->type = $this->modules->get("FieldtypeInteger");<br />
$f->name = $this->fieldName;<br />
$f->label = 'Publish Time Left';<br />
$f->defaultValue = $this->defaultTime;<br />
$f->icon = 'clock-o';<br />
$f->columnWidth = 50;<br />
$f->collapsed = 1;<br />
$f->flags = 4;<br />
<br />
$f->save(); // save the field<br />
<br />
// create new field object to store whether to publish or not<br />
$f = new Field();<br />
// get a field type<br />
$f->type = $this->modules->get("FieldtypeCheckbox");<br />
$f->name = $this->checkboxName;<br />
$f->label = 'Publish Page later';<br />
$f->defaultValue = false;<br />
$f->columnWidth = 50;<br />
$f->icon = 'clock-o';<br />
$f->collapsed = 1;<br />
$f->flags = 4;<br />
<br />
$f->save(); // save the field<br />
}<br />
}<br />
<br />
/*<br />
* Uninstall module specific fields<br />
*/<br />
private function uninstallFields(){<br />
<br />
// find installed fields<br />
$fInt = $this->fields->get($this->fieldName);<br />
$fCheck = $this->fields->get($this->checkboxName);<br />
<br />
if($fInt && $fCheck){<br />
$fieldIntUsed = $fInt->numFieldgroups();<br />
$fieldCheckUsed = $fCheck->numFieldgroups();<br />
<br />
if($fieldIntUsed){<br />
// field in use by template<br />
$this->message('Unable to uninstall field '.$fInt->name);<br />
}else{<br />
// delete installed fields<br />
$this->fields->delete($fInt);<br />
$this->fields->save;<br />
}<br />
<br />
if($fieldCheckUsed){<br />
// field in use by template<br />
$this->message('Unable to uninstall field '.$fCheck->name);<br />
}else{<br />
// delete installed fields<br />
$this->fields->delete($fCheck);<br />
$this->fields->save;<br />
}<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
=== Inputfield / Fieldtype ===<br />
[[ProcessWire - Fieldtype erstellen (Module)]]</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Module_schreiben&diff=24244ProcessWire - Module schreiben2020-01-06T09:04:41Z<p>84.136.104.26: /* Links */</p>
<hr />
<div>== Links ==<br />
Wichtigste Resourcen<br />
https://processwire.com/docs/modules/development/ - Guter Ausgangspunkt<br />
https://processwire.com/api/ref/module/ - Module API<br />
https://processwire.com/api/ref/configurable-module/ - Klasse für Konfigurierbare Module<br />
https://processwire.com/docs/modules/types/ - Welche Modultypen gibt es ?<br />
https://github.com/ryancramerdesign/ProcessHello - Modul Skelett Beispiel für eigene Backend (Process) Module<br />
https://github.com/ryancramerdesign/FieldtypeMapMarker - Beispiel für ein Fieldtype und Inputfield Modul<br />
https://processwire.com/talk/topic/778-module-dependencies/ - Module die andere Module benötigen<br />
https://processwire.com/talk/forum/19-moduleplugin-development/ - Forum zum Thema Module entwickeln<br />
http://somatonic.github.io/Captain-Hook/ - Hook Cheatsheet<br />
https://processwire.com/blog/posts/new-module-configuration-options/ - Neuere Konfigurationsmöglichkeiten<br />
Weitere Links<br />
https://webdesign.tutsplus.com/tutorials/a-beginners-introduction-to-writing-modules-in-processwire--cms-26862<br />
https://processwire.com/docs/modules/ - Introduction, Development, Hooks, Types, Pro Modules, Third Party<br />
<br />
<br />
<br />
<br />
[[ProcessWire - Module Snippets]]<br />
<br />
== Wo - Was ? ==<br />
=== Welche Typen von Modulen gibt es ? ===<br />
https://processwire.com/docs/modules/types/<br />
* '''Fieldtype''': Meistens keine Public API, Handelt Daten / Datenbank - https://processwire.com/api/ref/fieldtype/<br />
* '''Inputfield''': Sammelt User Eingaben über Formulare für Felder (Fieldtypes)<br />
* '''Process''' for creating admin processes/applications.<br />
* '''Textformatter''' for formatting text.<br />
* '''AdminTheme''' for creating themes in the admin.<br />
* '''WireMail''' for modules that send email and extend the WireMail class.<br />
* '''Tfa''' for implementing a specific kind of two-factor authentication.<br />
* '''ImageSizerEngine''' for modules that extend ImageSizerEngine for resizing images.<br />
* '''FileCompiler''' for modules that extend FileCompilerModule for compilation of files.<br />
* '''FileValidator''' for modules that extend FileValidatorModule for validation of files.<br />
<br />
=== Wie werden Felder in der Datenbank angelegt ? ===<br />
Dazu nutzt man den Typ "Fieldtype"<br />
<br />
=== Wo rendert man die Ausgabe ? ===<br />
Bei Ryan Cramers Event Beispiel legt er zwei Klassen Event und EventArray an, die auch die Render Funktionen enthalten.<br />
<br />
== Spezielle Funktionen in Modulen ==<br />
<br />
=== getModuleInfo ===<br />
Ist die einzige Pflichtfunktion in Modulen. Hier werden title, version, summary und weitere Daten hinterlegt. Hier kann man auch angeben ob ein Modul ein Autoload Modul ist.<br />
<br />
=== init ===<br />
public function init(){}<br />
Initialisiert das Modul. ProcessWire ruft diese Funktion auf, wenn das Modul geladen ist. Bei Autoload Modulen wird es aufgerufen wenn die ProcessWire API bereit ist. Daher ist es ein guter Ort um Hooks einzubinden.<br />
<br />
=== ready ===<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
if($this->page->template == 'admin') {<br />
$this->message($this->hi());<br />
}<br />
}<br />
</syntaxhighlight><br />
Wird in autoload Modulen aufgerufen wenn die API bereit ist. Nützlich für Hooks:<br />
<br />
<br />
== Autoload Module und Hooks ==<br />
Autoload werden automatisch geladen müssen also nicht in einem Template o.ä. gestartet werden. Daher bieten sie sich an um die Funktionalität von ProcessWire zu erweitern. Als Werkzeug dafür dienen Hooks. Mit Hooks kann man an vielen Stellen den Rendering Process der Seiten beeinflussen. Außerdem kann man für eigene Module ebenfalls Hooks bereitstellen. <br />
<br />
=== Hooks ===<br />
https://processwire.com/docs/modules/hooks/<br />
Hooks sind ein mächtiges Werkzeug. Sie geben einem die Möglichkeit an vielen Stellen "einzuhaken" und Funktionalität einzubauen.<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
$this->addHookAfter('Page::render', function($event) {<br />
$event->return .= '<p>Hallo</p>';<br />
});<br />
}<br />
</syntaxhighlight><br />
Schreibt am Ende Jeder Seite ein "Hallo". Das $event Objekt ist ein [https://processwire.com/api/ref/hook-event/ HookEvent]. Im Beispiel fügen wir einfach etwas Markup hinzu. Über $event->arguments() kann man aber auf ale Argumente zugreifen.<br />
<br />
Das gleiche aber nicht mit anonymer Funktion:<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
// add hook after Page::render() and make it call the "test" method of $this module<br />
$this->addHookAfter('Page::render', $this, 'test');<br />
}<br />
<br />
public function test($event) {<br />
// modify the return value of Page::render() to include the following:<br />
$event->return .= '<p>Hallo</p>';<br />
}<br />
</syntaxhighlight><br />
<br />
=== Hooks zum erweitern von existierenden Klassen nutzen ===<br />
Mit Hooks kann man in vorhandene Klassen einhaken. Z.B. läßt sich das Page Objekt erweitern.<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
$this->addHook('Page::summarize', $this, 'summarize');<br />
}<br />
public function summarize($event) {<br />
$page = $event->object; // the $event->object represents the object hooked (Page)<br />
$maxlen = $event->arguments(0); // first argument is the optional max length<br />
if(!$maxlen) $maxlen = 200; // if no $maxlen was present, we'll use a default of 200<br />
$summary = $this->sanitizer->truncate($page->body, $maxlen); // use sanitizer truncate method to create a summary<br />
$event->return = $summary; // populate $summary to $event->return, the return value<br />
}<br />
</syntaxhighlight><br />
So kann man ganz einfach eine Zusammenfassung aller Kindseiten in einem Template rendern:<br />
<syntaxhighlight lang="php"><br />
foreach($page->children as $item) {<br />
$summary = $item->summarize(150);<br />
echo "<li><a href='$item->url'>$item->title</a><br>$summary";<br />
}<br />
</syntaxhighlight><br />
<br />
=== Hook Beispiele ===<br />
Hook am Ende des Renderings<br />
$this->addHookAfter('Page::render', function($event) {...});<br />
Füge eine Funktion "summarize" zum Page Objekt hinzu.<br />
$this->addHook('Page::summarize', $this, 'summarize');<br />
Hook auf eine einzelne Instanz (hier pages Objekt)<br />
$this->pages->addHookAfter('saved', function($event){...});<br />
$this->addHook('Page::method', ...) // Spricht ALLE Instanzen an - Regelfall<br />
$page->addHook('method', ...) // Spricht nur die EINE Instanz der Seite an.<br />
</pre><br />
<br />
=== Autoload Module nur im Admin Bereich laden ===<br />
'autoload' => 'template=admin' <br />
statt<br />
'autoload' => true<br />
<br />
== Beispiele ==<br />
=== Frontend Rendering Module ===<br />
A bit old but working<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
/**<br />
* FrontEndRender<br />
*<br />
* Author: Ben Byford<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2010 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class FrontEndRender extends WireData implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'FrontEndRender',<br />
'version' => 0.1,<br />
'summary' => "Outputs html and static variables to frontend",<br />
'author' => 'Ben Byford',<br />
'singular' => true,<br />
'href' => 'https://github.com/benbyford/PW-starter-modules'<br />
);<br />
}<br />
<br />
// protected variable only accessable within module<br />
protected $name = 'Ben';<br />
<br />
/*<br />
* render function to be called in PW template like this:<br />
* $FrontEndRender = $modules->getModule('FrontEndRender');<br />
* echo '<h1>' . $FrontEndRender->render() . '</h1>';<br />
*<br />
*/<br />
public function render(){<br />
return "Hello " . $this->name;<br />
}<br />
}<br />
?><br />
</syntaxhighlight><br />
<br />
=== ProcessWire Hello World Modul ===<br />
Beispiel Modul mit Hooks (liegt immer in der Standardinstallation)<br />
<syntaxhighlight lang="php"><br />
<?php namespace ProcessWire;<br />
<br />
/**<br />
* ProcessWire 'Hello world' demonstration module<br />
*<br />
* Demonstrates the Module interface and how to add hooks.<br />
* <br />
* See README file for further links regarding module development.<br />
* <br />
* This file is licensed under the MIT license<br />
* https://processwire.com/about/license/mit/<br />
* <br />
* ProcessWire 3.x, Copyright 2016 by Ryan Cramer<br />
* https://processwire.com<br />
*<br />
*/<br />
<br />
class Helloworld extends WireData implements Module {<br />
<br />
/**<br />
* getModuleInfo is a module required by all modules to tell ProcessWire about them<br />
*<br />
* @return array<br />
*<br />
*/<br />
public static function getModuleInfo() {<br />
<br />
return array(<br />
<br />
// The module's title, typically a little more descriptive than the class name<br />
'title' => 'Hello World', <br />
<br />
// version number <br />
'version' => 3, <br />
<br />
// summary is brief description of what this module is<br />
'summary' => 'An example module used for demonstration purposes.',<br />
<br />
// Optional URL to more information about the module<br />
'href' => 'https://processwire.com',<br />
<br />
// singular=true: indicates that only one instance of the module is allowed.<br />
// This is usually what you want for modules that attach hooks. <br />
'singular' => true, <br />
<br />
// autoload=true: indicates the module should be started with ProcessWire.<br />
// This is necessary for any modules that attach runtime hooks, otherwise those<br />
// hooks won't get attached unless some other code calls the module on it's own.<br />
// Note that autoload modules are almost always also 'singular' (seen above).<br />
'autoload' => true, <br />
<br />
// Optional font-awesome icon name, minus the 'fa-' part<br />
'icon' => 'smile-o', <br />
);<br />
}<br />
<br />
/**<br />
* Initialize the module<br />
*<br />
* ProcessWire calls this when the module is loaded. For 'autoload' modules, this will be called<br />
* when ProcessWire's API is ready. As a result, this is a good place to attach hooks. <br />
*<br />
*/<br />
public function init() {<br />
<br />
// add a hook after the $pages->save, to issue a notice every time a page is saved<br />
$this->pages->addHookAfter('save', $this, 'example1'); <br />
<br />
// add a hook after each page is rendered and modify the output<br />
$this->addHookAfter('Page::render', $this, 'example2'); <br />
<br />
// add a 'hello' method to every page that returns "Hello World"<br />
// use "echo $page->hello();" in your template file to display output<br />
$this->addHook('Page::hello', $this, 'example3'); <br />
<br />
// add a 'hello_world' property to every page that returns "Hello [user]"<br />
// use "echo $page->hello_world;" in your template file to display output<br />
$this->addHookProperty('Page::hello_world', $this, 'example4'); <br />
}<br />
<br />
/**<br />
* Example1 hooks into the pages->save method and displays a notice every time a page is saved<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example1($event) {<br />
/** @var Page $page */<br />
$page = $event->arguments[0]; <br />
$this->message("Hello World! You saved {$page->path}."); <br />
}<br />
<br />
<br />
/**<br />
* Example2 hooks into every page after it's rendered and adds "Hello World" text at the bottom<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example2($event) {<br />
<br />
/** @var Page $page */<br />
$page = $event->object; <br />
<br />
// don't add this to the admin pages<br />
if($page->template == 'admin') return;<br />
<br />
// add a "Hello World" paragraph right before the closing body tag<br />
$event->return = str_replace("</body>", "<p>Hello World!</p></body>", $event->return); <br />
}<br />
<br />
/**<br />
* Example3 adds a 'hello' method (not property) to every page that simply returns "Hello World"<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example3($event) {<br />
$event->return = "Hello World";<br />
}<br />
<br />
/**<br />
* Example 4 adds a 'hello_world' property (not method) to every page that returns "Hello [user]"<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example4($event) {<br />
$event->return = "Hello " . $this->user->name; <br />
}<br />
<br />
}<br />
<br />
</syntaxhighlight><br />
<br />
=== ProcessWire Admin Bereich mit eigener Funktionalität erweitern (Modul)===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<syntaxhighlight lang="php"><br />
<br />
<?php<br />
/**<br />
* ProcessSimpleAdminPage<br />
*<br />
* @author Ben Byford<br />
* http://www.benbyford.com<br />
*<br />
* @see http://www.processwire.com<br />
*/<br />
<br />
class ProcessSimpleAdminPage extends Process {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'Process Simple Admin Page',<br />
'summary' => 'Simple Process module that adds new admin page with',<br />
'version' => 001,<br />
<br />
// Modules that extend Process may specify a 'page' attribute in the<br />
// getModuleInfo(), this page will automatically be given the module<br />
// process when added to teh pagetree.<br />
<br />
// I have exampled but commented out the 'page' settings below<br />
// so that I can show how one might add a page to install() and<br />
// uninstall() in this and other modules (that might not extend<br />
// Process)<br />
<br />
<br />
// 'page' => array(<br />
// 'name' => 'site-config',<br />
// 'parent' => 'admin',<br />
// 'title' => 'Site Config'<br />
// )<br />
);<br />
}<br />
<br />
public function execute() {<br />
return '<br />
<h2>Edit the text here in the module</h2><br />
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam mattis eros vitae metus sodales eget suscipit purus rhoncus. Proin ultrices gravida dolor, non porttitor enim interdum vitae. Integer feugiat lacinia tincidunt. Nulla laoreet tristique tristique. Sed elementum justo a nisl elementum sit amet accumsan nisi tempor. Nulla quis eros et massa dignissim imperdiet a vitae purus.</p><br />
<br />
<p>Donec scelerisque pulvinar sem eu lobortis. Maecenas turpis ipsum, tempus dictum pharetra eu, consectetur vitae arcu. Fusce orci mauris, semper at tempus quis, volutpat molestie tellus. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Sed quam tortor, tincidunt sed semper lacinia, scelerisque dapibus quam. Morbi at nisi luctus lacus auctor ultrices eu eu leo.</p><br />
<br />
<p>Praesent faucibus purus id felis tincidunt dignissim. Sed sit amet ligula mi, eget semper dui. Proin consectetur gravida massa, nec luctus purus hendrerit in. Etiam volutpat, elit non venenatis suscipit, libero neque consectetur diam, id rutrum magna odio ac ligula. Maecenas sollicitudin congue neque fermentum vestibulum. Morbi nec leo nisi. Donec at nisl odio, et porta ligula.</p><br />
<br />
<p>Sed quis arcu nisi, ac tempor augue. Praesent non elit libero, a ullamcorper lorem. Curabitur porta odio eu nunc ultricies interdum id nec risus. Donec nibh nibh, porta eget vehicula ac, aliquet eget ante. Phasellus eget lorem eu eros eleifend ultrices. Cras sit amet neque sit amet nibh fringilla cursus ut id mauris. Praesent quis nunc justo, sed suscipit lectus. Phasellus eget ultrices risus. Curabitur eu semper est. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Ut suscipit, nisl ut imperdiet eleifend, turpis arcu placerat tortor, nec laoreet lacus neque ac tellus. Aenean ac lacus justo, quis ultricies nisi.</p><br />
';<br />
}<br />
public function install(){<br />
<br />
// create new page to add to CMS<br />
$page = new Page();<br />
<br />
// add page attributes<br />
$page->template = "admin";<br />
$page->name = "cms-faq";<br />
$page->title = "CMS FAQ";<br />
$page->save();<br />
<br />
// set this module as the page process, this allows us to display the above<br />
$page->process = 'ProcessSimpleAdminPage';<br />
<br />
// get admin page and set as page parent<br />
$admin = $this->pages->get("id=2");<br />
$page->parent = $admin;<br />
<br />
// save page<br />
$page->save();<br />
}<br />
<br />
public function uninstall(){<br />
<br />
// delete created page<br />
$page = $this->pages->get("name=cms-faq");<br />
if(count($page)) $this->pages->delete($page, true);<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
=== ProcessWire Textformatter Modul ===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
/**<br />
* TextformatterFindReplace<br />
*<br />
* Author: Ben Byford<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2010 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class TextformatterFindReplace extends Textformatter implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'TextformatterFindReplace',<br />
'version' => 0.1,<br />
'summary' => "Finds and replaces any instance of config input to config output",<br />
'author' => 'Ben Byford',<br />
'singular' => true,<br />
'href' => 'https://github.com/benbyford/PW-starter-modules'<br />
);<br />
}<br />
<br />
<br />
/**<br />
* Find and Replace the input string<br />
*<br />
* @param string $str The block of text to parse<br />
*<br />
* The incoming string is replaced with the formatted version of itself.<br />
**/<br />
<br />
public function format(&$str) {<br />
$find = $this->findStr;<br />
$str = preg_replace_callback($find, array($this,"replace"), $str);<br />
<br />
}<br />
<br />
// adding three underscores to a function allows other modules to hook it<br />
public function ___replace($match) {<br />
return $this->replaceStr;<br />
}<br />
}<br />
?><br />
</syntaxhighlight><br />
<br />
=== Admin Funktionalität: Countdown zum Seitenveröffentlichen ===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<br />
The module PageDeferredPublish, on clicking one of the '''Publish Later buttons''', sets LazyCron to check that page’s countdown every minute and publishes the page when its countdown reaches 0. This means I can publish a page approximately 24 hours in advance (obviously the checking interval and delay time can be changed to your requirements).<br />
<br />
I did this by:<br />
<br />
'''Creating two fields''' within my install() function: a checkbox field to set to true when a button is checked to indicate the page should countdown, and a countdown field to store the count in seconds for that specific page.<br />
<br />
'''Adding hooks''' to both ''ProcessPageEdit::buildForm'' and ''ProcessPageListActions::getExtraActions'' enabling me to add the two buttons.<br />
<br />
Checking to see if one of the buttons was clicked with my '''ready() function''' then setting the corresponding page’s checkbox to true.<br />
<br />
Using a '''LazyCron hook function''' to check all pages that are unpublished for true checkboxes and then comparing the seconds field to see if the page needs publishing. If not then deduct the elapsed time in seconds.<br />
<br />
The result is a '''module that has settings''' (the time interval to check and publish at a later time), '''hooks into the admin''' using buttons and fields, and enables us to '''use other modules installe'''d in PW (i.e. LazyCron).<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
/**<br />
* DeferredPublish (0.0.1)<br />
* DeferredPublish publishes a page after a defined amount of time has elapsed using lazycron.<br />
*<br />
* @author Ben Byford<br />
* http://www.benbyford.com<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2011 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class PageDeferredPublish extends WireData implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => "PageDeferredPublish",<br />
'version' => "0.0.1",<br />
'summary' => "PageDeferredPublish",<br />
'author' => "Ben Byford",<br />
'href' => "https://github.com/benbyford/PW-intermediate-modules",<br />
'icon' => "clock-o",<br />
'autoload' => true,<br />
'singular' => true,<br />
'requires' => "LazyCron",<br />
);<br />
}<br />
<br />
private $postPubLater = null;<br />
private $pageID = null;<br />
private $pagePubLater = null;<br />
private $currentPage = null;<br />
<br />
private $submitName = 'pdp_pub_later_submit';<br />
private $listPageName = 'pdp_pub_later_list';<br />
private $fieldName = 'pdp_pub_later';<br />
private $checkboxName = 'pdp_pub_later_check';<br />
<br />
private $defaultInterval = 'everyMinute';<br />
private $defaultTime = 86400;<br />
<br />
<br />
public function install(){<br />
// add new fields needed for module<br />
$this->installFields();<br />
}<br />
public function uninstall(){<br />
// uninstall fields<br />
$this->uninstallFields();<br />
}<br />
<br />
// initialize the hook in your AutoLoad module<br />
public function init() {<br />
<br />
// get defaults from module setting in CMS<br />
$this->defaultTime = $this->pub_after;<br />
$this->defaultInterval = $this->cron_check;<br />
<br />
// get admin URL<br />
$this->adminUrl = $this->wire('config')->urls->admin;<br />
<br />
// add hooks to CRON, PageList, PageEdit<br />
$this->addHookAfter("LazyCron::{$this->defaultInterval}", $this, 'publishDefferedPages');<br />
$this->addHook("ProcessPageListActions::getExtraActions", $this, 'hookPageListActions');<br />
$this->addHookAfter("ProcessPageEdit::buildForm", $this, "editForm");<br />
}<br />
<br />
public function ready() {<br />
<br />
// if list button clicked then grab id<br />
$this->pagePubLater = $this->input->get($this->listPageName);<br />
$this->pageID = $this->input->id;<br />
<br />
// get page<br />
$this->currentPage = $this->pages->get($this->pageID);<br />
<br />
// if pagelist pub later submit button clicked<br />
if($this->pagePubLater){<br />
$this->message("Page {$this->currentPage->name} deffered for publish.");<br />
}<br />
<br />
// if page edit submit button clicked<br />
$this->postPubLater = $this->input->post($this->submitName);<br />
if($this->postPubLater){<br />
$this->message("Page {$this->currentPage->name} deffered for publish.");<br />
}<br />
<br />
// if either deffered publish sumbit found then publish page later<br />
if($this->pagePubLater || $this->postPubLater){<br />
$this->publishLater();<br />
}<br />
}<br />
<br />
/*<br />
* Hook: ProcessPageEdit::buildForm<br />
*<br />
* add Publish Later button to edit page if not yet published<br />
*/<br />
public function ___editForm(HookEvent $form) {<br />
<br />
// get the InputFieldForm object from the event (return value of buildForm())<br />
$form = $form->return;<br />
<br />
$page = $this->pages->get($this->input->get->id);<br />
$check = $page->get($this->checkboxName);<br />
<br />
// check if publish button available and therfore unpublished<br />
$target = $form->get('submit_publish');<br />
<br />
if($target && $check == false){<br />
<br />
// get InputfieldText module<br />
$submit2 = $this->modules->get('InputfieldSubmit');<br />
$submit2->attr('name', $this->submitName);<br />
$submit2->attr('id', 'publish_later');<br />
$submit2->attr('class', 'ui-button ui-widget ui-corner-all head_button_clone ui-state-default ui-priority-secondary');<br />
$submit2->attr('value', 'Publish Later'); // Button: save unpublished<br />
<br />
// get form element save and place before<br />
$target = $form->get('submit_save');<br />
$form->insertBefore($submit2, $target);<br />
<br />
$form->return = $form;<br />
}<br />
}<br />
<br />
public function ___hookPageListActions(HookEvent $event) {<br />
<br />
// get current page<br />
$page = $event->arguments[0];<br />
<br />
// check to see if page is published<br />
$pagePub = $page->is(Page::statusUnpublished);<br />
<br />
// check to see if page template has deffered field<br />
$pageHasDefferField = $page->get($this->fieldName);<br />
<br />
$actions = array();<br />
<br />
// don't get homepage or pages that are already published or are being deffered for publish<br />
if($page->id > 1 && $pagePub == "published" && !is_null($pageHasDefferField) && $page->get($this->checkboxName) == false) {<br />
<br />
$actions['publish_later'] = array(<br />
'cn' => 'PublishLater',<br />
'name' => 'pub later',<br />
'url' => "{$this->adminUrl}?{$this->listPageName}=1&id={$page->id}",<br />
);<br />
}<br />
if(count($actions)) $event->return = $actions + $event->return;<br />
}<br />
<br />
/*<br />
* Publish Page on cron job<br />
*<br />
* Gets deffered page and publishes<br />
*/<br />
public function ___publish($page) {<br />
$page->removeStatus(Page::statusUnpublished);<br />
$page->removeStatus(Page::statusHidden);<br />
$page->Save();<br />
}<br />
<br />
/*<br />
* Main publish later function<br />
*<br />
* Gets deffered page and sets fields to be checked be lazy cron<br />
*/<br />
private function ___publishLater() {<br />
<br />
// get page<br />
$page = $this->pages->get($this->pageID);<br />
<br />
// set output formatting to false<br />
$page->of(false);<br />
<br />
// set field time to settings default time and checkbox to true<br />
$page->set($this->checkboxName, true);<br />
$page->set($this->fieldName, $this->defaultTime);<br />
<br />
// save page<br />
$page->save();<br />
$page->of(true);<br />
}<br />
<br />
/*<br />
* Lazy Cron hook function<br />
*<br />
* Triggers every [set time interval] and checks pages<br />
* Publishes page if time runout<br />
*<br />
* Adds publish page log<br />
*/<br />
public function ___publishDefferedPages(HookEvent $e){<br />
<br />
// seconds since last lazycron<br />
$seconds = $e->arguments[0];<br />
<br />
// find all pages with deffered field<br />
$defferedPages = $this->pages->find("{$this->checkboxName}=1,include=unpublished");<br />
<br />
// for each page decrease time for deffered field<br />
foreach ($defferedPages as $page) {<br />
<br />
// get current page time<br />
$timeTillPublish = $page->get($this->fieldName);<br />
<br />
// set time to time minus time past<br />
$timeLeft = $timeTillPublish - $seconds;<br />
<br />
// if time passed 0 or less then publish page<br />
$page->of(false);<br />
if($timeLeft <= 0){<br />
// remove flags and save<br />
$this->publish($page);<br />
<br />
$page->set($this->fieldName, 0);<br />
$page->set($this->checkboxName, 0);<br />
<br />
// log a page has been published<br />
$log = wire('log');<br />
$log->message('CRON:'. $seconds .' Pages: '. $page->name .' published');<br />
}else{<br />
$page->set($this->fieldName, $timeLeft);<br />
}<br />
// save page time<br />
$page->Save();<br />
$page->of(true);<br />
}<br />
}<br />
<br />
/*<br />
* Install new module specific fields<br />
*/<br />
private function installFields(){<br />
<br />
// install pub later checkbox field<br />
// find installed fields<br />
$f = $this->fields->get($this->fieldName);<br />
if($f){<br />
<br />
// if field already found then don't try and make it<br />
$this->message($this->fieldName . ' field found');<br />
<br />
}else{<br />
<br />
// create new field object to store crontime<br />
$f = new Field();<br />
// get a field type<br />
$f->type = $this->modules->get("FieldtypeInteger");<br />
$f->name = $this->fieldName;<br />
$f->label = 'Publish Time Left';<br />
$f->defaultValue = $this->defaultTime;<br />
$f->icon = 'clock-o';<br />
$f->columnWidth = 50;<br />
$f->collapsed = 1;<br />
$f->flags = 4;<br />
<br />
$f->save(); // save the field<br />
<br />
// create new field object to store whether to publish or not<br />
$f = new Field();<br />
// get a field type<br />
$f->type = $this->modules->get("FieldtypeCheckbox");<br />
$f->name = $this->checkboxName;<br />
$f->label = 'Publish Page later';<br />
$f->defaultValue = false;<br />
$f->columnWidth = 50;<br />
$f->icon = 'clock-o';<br />
$f->collapsed = 1;<br />
$f->flags = 4;<br />
<br />
$f->save(); // save the field<br />
}<br />
}<br />
<br />
/*<br />
* Uninstall module specific fields<br />
*/<br />
private function uninstallFields(){<br />
<br />
// find installed fields<br />
$fInt = $this->fields->get($this->fieldName);<br />
$fCheck = $this->fields->get($this->checkboxName);<br />
<br />
if($fInt && $fCheck){<br />
$fieldIntUsed = $fInt->numFieldgroups();<br />
$fieldCheckUsed = $fCheck->numFieldgroups();<br />
<br />
if($fieldIntUsed){<br />
// field in use by template<br />
$this->message('Unable to uninstall field '.$fInt->name);<br />
}else{<br />
// delete installed fields<br />
$this->fields->delete($fInt);<br />
$this->fields->save;<br />
}<br />
<br />
if($fieldCheckUsed){<br />
// field in use by template<br />
$this->message('Unable to uninstall field '.$fCheck->name);<br />
}else{<br />
// delete installed fields<br />
$this->fields->delete($fCheck);<br />
$this->fields->save;<br />
}<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
=== Inputfield / Fieldtype ===<br />
[[ProcessWire - Fieldtype erstellen (Module)]]</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Module_schreiben&diff=24243ProcessWire - Module schreiben2020-01-06T09:02:26Z<p>84.136.104.26: </p>
<hr />
<div>== Links ==<br />
https://processwire.com/docs/modules/development/ - Guter Ausgangspunkt<br />
https://processwire.com/api/ref/module/ - Module API<br />
https://processwire.com/api/ref/configurable-module/ - Klasse für Konfigurierbare Module<br />
https://processwire.com/docs/modules/types/ - Welche Modultypen gibt es ?<br />
https://github.com/ryancramerdesign/ProcessHello - Modul Skelett Beispiel für eigene Backend (Process) Module<br />
https://github.com/ryancramerdesign/FieldtypeMapMarker - Beispiel für ein Fieldtype und Inputfield Modul<br />
https://processwire.com/talk/topic/778-module-dependencies/ - Module die andere Module benötigen<br />
https://webdesign.tutsplus.com/tutorials/a-beginners-introduction-to-writing-modules-in-processwire--cms-26862<br />
https://processwire.com/api/ref/module/<br />
https://processwire.com/docs/modules/ - Introduction, Development, Hooks, Types, Pro Modules, Third Party<br />
https://processwire.com/blog/posts/new-module-configuration-options/<br />
https://processwire.com/talk/topic/778-module-dependencies/<br />
http://somatonic.github.io/Captain-Hook/ // Hook Cheatsheet<br />
<br />
[[ProcessWire - Module Snippets]]<br />
<br />
== Wo - Was ? ==<br />
=== Welche Typen von Modulen gibt es ? ===<br />
https://processwire.com/docs/modules/types/<br />
* '''Fieldtype''': Meistens keine Public API, Handelt Daten / Datenbank - https://processwire.com/api/ref/fieldtype/<br />
* '''Inputfield''': Sammelt User Eingaben über Formulare für Felder (Fieldtypes)<br />
* '''Process''' for creating admin processes/applications.<br />
* '''Textformatter''' for formatting text.<br />
* '''AdminTheme''' for creating themes in the admin.<br />
* '''WireMail''' for modules that send email and extend the WireMail class.<br />
* '''Tfa''' for implementing a specific kind of two-factor authentication.<br />
* '''ImageSizerEngine''' for modules that extend ImageSizerEngine for resizing images.<br />
* '''FileCompiler''' for modules that extend FileCompilerModule for compilation of files.<br />
* '''FileValidator''' for modules that extend FileValidatorModule for validation of files.<br />
<br />
=== Wie werden Felder in der Datenbank angelegt ? ===<br />
Dazu nutzt man den Typ "Fieldtype"<br />
<br />
=== Wo rendert man die Ausgabe ? ===<br />
Bei Ryan Cramers Event Beispiel legt er zwei Klassen Event und EventArray an, die auch die Render Funktionen enthalten.<br />
<br />
== Spezielle Funktionen in Modulen ==<br />
<br />
=== getModuleInfo ===<br />
Ist die einzige Pflichtfunktion in Modulen. Hier werden title, version, summary und weitere Daten hinterlegt. Hier kann man auch angeben ob ein Modul ein Autoload Modul ist.<br />
<br />
=== init ===<br />
public function init(){}<br />
Initialisiert das Modul. ProcessWire ruft diese Funktion auf, wenn das Modul geladen ist. Bei Autoload Modulen wird es aufgerufen wenn die ProcessWire API bereit ist. Daher ist es ein guter Ort um Hooks einzubinden.<br />
<br />
=== ready ===<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
if($this->page->template == 'admin') {<br />
$this->message($this->hi());<br />
}<br />
}<br />
</syntaxhighlight><br />
Wird in autoload Modulen aufgerufen wenn die API bereit ist. Nützlich für Hooks:<br />
<br />
<br />
== Autoload Module und Hooks ==<br />
Autoload werden automatisch geladen müssen also nicht in einem Template o.ä. gestartet werden. Daher bieten sie sich an um die Funktionalität von ProcessWire zu erweitern. Als Werkzeug dafür dienen Hooks. Mit Hooks kann man an vielen Stellen den Rendering Process der Seiten beeinflussen. Außerdem kann man für eigene Module ebenfalls Hooks bereitstellen. <br />
<br />
=== Hooks ===<br />
https://processwire.com/docs/modules/hooks/<br />
Hooks sind ein mächtiges Werkzeug. Sie geben einem die Möglichkeit an vielen Stellen "einzuhaken" und Funktionalität einzubauen.<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
$this->addHookAfter('Page::render', function($event) {<br />
$event->return .= '<p>Hallo</p>';<br />
});<br />
}<br />
</syntaxhighlight><br />
Schreibt am Ende Jeder Seite ein "Hallo". Das $event Objekt ist ein [https://processwire.com/api/ref/hook-event/ HookEvent]. Im Beispiel fügen wir einfach etwas Markup hinzu. Über $event->arguments() kann man aber auf ale Argumente zugreifen.<br />
<br />
Das gleiche aber nicht mit anonymer Funktion:<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
// add hook after Page::render() and make it call the "test" method of $this module<br />
$this->addHookAfter('Page::render', $this, 'test');<br />
}<br />
<br />
public function test($event) {<br />
// modify the return value of Page::render() to include the following:<br />
$event->return .= '<p>Hallo</p>';<br />
}<br />
</syntaxhighlight><br />
<br />
=== Hooks zum erweitern von existierenden Klassen nutzen ===<br />
Mit Hooks kann man in vorhandene Klassen einhaken. Z.B. läßt sich das Page Objekt erweitern.<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
$this->addHook('Page::summarize', $this, 'summarize');<br />
}<br />
public function summarize($event) {<br />
$page = $event->object; // the $event->object represents the object hooked (Page)<br />
$maxlen = $event->arguments(0); // first argument is the optional max length<br />
if(!$maxlen) $maxlen = 200; // if no $maxlen was present, we'll use a default of 200<br />
$summary = $this->sanitizer->truncate($page->body, $maxlen); // use sanitizer truncate method to create a summary<br />
$event->return = $summary; // populate $summary to $event->return, the return value<br />
}<br />
</syntaxhighlight><br />
So kann man ganz einfach eine Zusammenfassung aller Kindseiten in einem Template rendern:<br />
<syntaxhighlight lang="php"><br />
foreach($page->children as $item) {<br />
$summary = $item->summarize(150);<br />
echo "<li><a href='$item->url'>$item->title</a><br>$summary";<br />
}<br />
</syntaxhighlight><br />
<br />
=== Hook Beispiele ===<br />
Hook am Ende des Renderings<br />
$this->addHookAfter('Page::render', function($event) {...});<br />
Füge eine Funktion "summarize" zum Page Objekt hinzu.<br />
$this->addHook('Page::summarize', $this, 'summarize');<br />
Hook auf eine einzelne Instanz (hier pages Objekt)<br />
$this->pages->addHookAfter('saved', function($event){...});<br />
$this->addHook('Page::method', ...) // Spricht ALLE Instanzen an - Regelfall<br />
$page->addHook('method', ...) // Spricht nur die EINE Instanz der Seite an.<br />
</pre><br />
<br />
=== Autoload Module nur im Admin Bereich laden ===<br />
'autoload' => 'template=admin' <br />
statt<br />
'autoload' => true<br />
<br />
== Beispiele ==<br />
=== Frontend Rendering Module ===<br />
A bit old but working<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
/**<br />
* FrontEndRender<br />
*<br />
* Author: Ben Byford<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2010 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class FrontEndRender extends WireData implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'FrontEndRender',<br />
'version' => 0.1,<br />
'summary' => "Outputs html and static variables to frontend",<br />
'author' => 'Ben Byford',<br />
'singular' => true,<br />
'href' => 'https://github.com/benbyford/PW-starter-modules'<br />
);<br />
}<br />
<br />
// protected variable only accessable within module<br />
protected $name = 'Ben';<br />
<br />
/*<br />
* render function to be called in PW template like this:<br />
* $FrontEndRender = $modules->getModule('FrontEndRender');<br />
* echo '<h1>' . $FrontEndRender->render() . '</h1>';<br />
*<br />
*/<br />
public function render(){<br />
return "Hello " . $this->name;<br />
}<br />
}<br />
?><br />
</syntaxhighlight><br />
<br />
=== ProcessWire Hello World Modul ===<br />
Beispiel Modul mit Hooks (liegt immer in der Standardinstallation)<br />
<syntaxhighlight lang="php"><br />
<?php namespace ProcessWire;<br />
<br />
/**<br />
* ProcessWire 'Hello world' demonstration module<br />
*<br />
* Demonstrates the Module interface and how to add hooks.<br />
* <br />
* See README file for further links regarding module development.<br />
* <br />
* This file is licensed under the MIT license<br />
* https://processwire.com/about/license/mit/<br />
* <br />
* ProcessWire 3.x, Copyright 2016 by Ryan Cramer<br />
* https://processwire.com<br />
*<br />
*/<br />
<br />
class Helloworld extends WireData implements Module {<br />
<br />
/**<br />
* getModuleInfo is a module required by all modules to tell ProcessWire about them<br />
*<br />
* @return array<br />
*<br />
*/<br />
public static function getModuleInfo() {<br />
<br />
return array(<br />
<br />
// The module's title, typically a little more descriptive than the class name<br />
'title' => 'Hello World', <br />
<br />
// version number <br />
'version' => 3, <br />
<br />
// summary is brief description of what this module is<br />
'summary' => 'An example module used for demonstration purposes.',<br />
<br />
// Optional URL to more information about the module<br />
'href' => 'https://processwire.com',<br />
<br />
// singular=true: indicates that only one instance of the module is allowed.<br />
// This is usually what you want for modules that attach hooks. <br />
'singular' => true, <br />
<br />
// autoload=true: indicates the module should be started with ProcessWire.<br />
// This is necessary for any modules that attach runtime hooks, otherwise those<br />
// hooks won't get attached unless some other code calls the module on it's own.<br />
// Note that autoload modules are almost always also 'singular' (seen above).<br />
'autoload' => true, <br />
<br />
// Optional font-awesome icon name, minus the 'fa-' part<br />
'icon' => 'smile-o', <br />
);<br />
}<br />
<br />
/**<br />
* Initialize the module<br />
*<br />
* ProcessWire calls this when the module is loaded. For 'autoload' modules, this will be called<br />
* when ProcessWire's API is ready. As a result, this is a good place to attach hooks. <br />
*<br />
*/<br />
public function init() {<br />
<br />
// add a hook after the $pages->save, to issue a notice every time a page is saved<br />
$this->pages->addHookAfter('save', $this, 'example1'); <br />
<br />
// add a hook after each page is rendered and modify the output<br />
$this->addHookAfter('Page::render', $this, 'example2'); <br />
<br />
// add a 'hello' method to every page that returns "Hello World"<br />
// use "echo $page->hello();" in your template file to display output<br />
$this->addHook('Page::hello', $this, 'example3'); <br />
<br />
// add a 'hello_world' property to every page that returns "Hello [user]"<br />
// use "echo $page->hello_world;" in your template file to display output<br />
$this->addHookProperty('Page::hello_world', $this, 'example4'); <br />
}<br />
<br />
/**<br />
* Example1 hooks into the pages->save method and displays a notice every time a page is saved<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example1($event) {<br />
/** @var Page $page */<br />
$page = $event->arguments[0]; <br />
$this->message("Hello World! You saved {$page->path}."); <br />
}<br />
<br />
<br />
/**<br />
* Example2 hooks into every page after it's rendered and adds "Hello World" text at the bottom<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example2($event) {<br />
<br />
/** @var Page $page */<br />
$page = $event->object; <br />
<br />
// don't add this to the admin pages<br />
if($page->template == 'admin') return;<br />
<br />
// add a "Hello World" paragraph right before the closing body tag<br />
$event->return = str_replace("</body>", "<p>Hello World!</p></body>", $event->return); <br />
}<br />
<br />
/**<br />
* Example3 adds a 'hello' method (not property) to every page that simply returns "Hello World"<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example3($event) {<br />
$event->return = "Hello World";<br />
}<br />
<br />
/**<br />
* Example 4 adds a 'hello_world' property (not method) to every page that returns "Hello [user]"<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example4($event) {<br />
$event->return = "Hello " . $this->user->name; <br />
}<br />
<br />
}<br />
<br />
</syntaxhighlight><br />
<br />
=== ProcessWire Admin Bereich mit eigener Funktionalität erweitern (Modul)===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<syntaxhighlight lang="php"><br />
<br />
<?php<br />
/**<br />
* ProcessSimpleAdminPage<br />
*<br />
* @author Ben Byford<br />
* http://www.benbyford.com<br />
*<br />
* @see http://www.processwire.com<br />
*/<br />
<br />
class ProcessSimpleAdminPage extends Process {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'Process Simple Admin Page',<br />
'summary' => 'Simple Process module that adds new admin page with',<br />
'version' => 001,<br />
<br />
// Modules that extend Process may specify a 'page' attribute in the<br />
// getModuleInfo(), this page will automatically be given the module<br />
// process when added to teh pagetree.<br />
<br />
// I have exampled but commented out the 'page' settings below<br />
// so that I can show how one might add a page to install() and<br />
// uninstall() in this and other modules (that might not extend<br />
// Process)<br />
<br />
<br />
// 'page' => array(<br />
// 'name' => 'site-config',<br />
// 'parent' => 'admin',<br />
// 'title' => 'Site Config'<br />
// )<br />
);<br />
}<br />
<br />
public function execute() {<br />
return '<br />
<h2>Edit the text here in the module</h2><br />
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam mattis eros vitae metus sodales eget suscipit purus rhoncus. Proin ultrices gravida dolor, non porttitor enim interdum vitae. Integer feugiat lacinia tincidunt. Nulla laoreet tristique tristique. Sed elementum justo a nisl elementum sit amet accumsan nisi tempor. Nulla quis eros et massa dignissim imperdiet a vitae purus.</p><br />
<br />
<p>Donec scelerisque pulvinar sem eu lobortis. Maecenas turpis ipsum, tempus dictum pharetra eu, consectetur vitae arcu. Fusce orci mauris, semper at tempus quis, volutpat molestie tellus. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Sed quam tortor, tincidunt sed semper lacinia, scelerisque dapibus quam. Morbi at nisi luctus lacus auctor ultrices eu eu leo.</p><br />
<br />
<p>Praesent faucibus purus id felis tincidunt dignissim. Sed sit amet ligula mi, eget semper dui. Proin consectetur gravida massa, nec luctus purus hendrerit in. Etiam volutpat, elit non venenatis suscipit, libero neque consectetur diam, id rutrum magna odio ac ligula. Maecenas sollicitudin congue neque fermentum vestibulum. Morbi nec leo nisi. Donec at nisl odio, et porta ligula.</p><br />
<br />
<p>Sed quis arcu nisi, ac tempor augue. Praesent non elit libero, a ullamcorper lorem. Curabitur porta odio eu nunc ultricies interdum id nec risus. Donec nibh nibh, porta eget vehicula ac, aliquet eget ante. Phasellus eget lorem eu eros eleifend ultrices. Cras sit amet neque sit amet nibh fringilla cursus ut id mauris. Praesent quis nunc justo, sed suscipit lectus. Phasellus eget ultrices risus. Curabitur eu semper est. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Ut suscipit, nisl ut imperdiet eleifend, turpis arcu placerat tortor, nec laoreet lacus neque ac tellus. Aenean ac lacus justo, quis ultricies nisi.</p><br />
';<br />
}<br />
public function install(){<br />
<br />
// create new page to add to CMS<br />
$page = new Page();<br />
<br />
// add page attributes<br />
$page->template = "admin";<br />
$page->name = "cms-faq";<br />
$page->title = "CMS FAQ";<br />
$page->save();<br />
<br />
// set this module as the page process, this allows us to display the above<br />
$page->process = 'ProcessSimpleAdminPage';<br />
<br />
// get admin page and set as page parent<br />
$admin = $this->pages->get("id=2");<br />
$page->parent = $admin;<br />
<br />
// save page<br />
$page->save();<br />
}<br />
<br />
public function uninstall(){<br />
<br />
// delete created page<br />
$page = $this->pages->get("name=cms-faq");<br />
if(count($page)) $this->pages->delete($page, true);<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
=== ProcessWire Textformatter Modul ===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
/**<br />
* TextformatterFindReplace<br />
*<br />
* Author: Ben Byford<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2010 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class TextformatterFindReplace extends Textformatter implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'TextformatterFindReplace',<br />
'version' => 0.1,<br />
'summary' => "Finds and replaces any instance of config input to config output",<br />
'author' => 'Ben Byford',<br />
'singular' => true,<br />
'href' => 'https://github.com/benbyford/PW-starter-modules'<br />
);<br />
}<br />
<br />
<br />
/**<br />
* Find and Replace the input string<br />
*<br />
* @param string $str The block of text to parse<br />
*<br />
* The incoming string is replaced with the formatted version of itself.<br />
**/<br />
<br />
public function format(&$str) {<br />
$find = $this->findStr;<br />
$str = preg_replace_callback($find, array($this,"replace"), $str);<br />
<br />
}<br />
<br />
// adding three underscores to a function allows other modules to hook it<br />
public function ___replace($match) {<br />
return $this->replaceStr;<br />
}<br />
}<br />
?><br />
</syntaxhighlight><br />
<br />
=== Admin Funktionalität: Countdown zum Seitenveröffentlichen ===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<br />
The module PageDeferredPublish, on clicking one of the '''Publish Later buttons''', sets LazyCron to check that page’s countdown every minute and publishes the page when its countdown reaches 0. This means I can publish a page approximately 24 hours in advance (obviously the checking interval and delay time can be changed to your requirements).<br />
<br />
I did this by:<br />
<br />
'''Creating two fields''' within my install() function: a checkbox field to set to true when a button is checked to indicate the page should countdown, and a countdown field to store the count in seconds for that specific page.<br />
<br />
'''Adding hooks''' to both ''ProcessPageEdit::buildForm'' and ''ProcessPageListActions::getExtraActions'' enabling me to add the two buttons.<br />
<br />
Checking to see if one of the buttons was clicked with my '''ready() function''' then setting the corresponding page’s checkbox to true.<br />
<br />
Using a '''LazyCron hook function''' to check all pages that are unpublished for true checkboxes and then comparing the seconds field to see if the page needs publishing. If not then deduct the elapsed time in seconds.<br />
<br />
The result is a '''module that has settings''' (the time interval to check and publish at a later time), '''hooks into the admin''' using buttons and fields, and enables us to '''use other modules installe'''d in PW (i.e. LazyCron).<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
/**<br />
* DeferredPublish (0.0.1)<br />
* DeferredPublish publishes a page after a defined amount of time has elapsed using lazycron.<br />
*<br />
* @author Ben Byford<br />
* http://www.benbyford.com<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2011 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class PageDeferredPublish extends WireData implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => "PageDeferredPublish",<br />
'version' => "0.0.1",<br />
'summary' => "PageDeferredPublish",<br />
'author' => "Ben Byford",<br />
'href' => "https://github.com/benbyford/PW-intermediate-modules",<br />
'icon' => "clock-o",<br />
'autoload' => true,<br />
'singular' => true,<br />
'requires' => "LazyCron",<br />
);<br />
}<br />
<br />
private $postPubLater = null;<br />
private $pageID = null;<br />
private $pagePubLater = null;<br />
private $currentPage = null;<br />
<br />
private $submitName = 'pdp_pub_later_submit';<br />
private $listPageName = 'pdp_pub_later_list';<br />
private $fieldName = 'pdp_pub_later';<br />
private $checkboxName = 'pdp_pub_later_check';<br />
<br />
private $defaultInterval = 'everyMinute';<br />
private $defaultTime = 86400;<br />
<br />
<br />
public function install(){<br />
// add new fields needed for module<br />
$this->installFields();<br />
}<br />
public function uninstall(){<br />
// uninstall fields<br />
$this->uninstallFields();<br />
}<br />
<br />
// initialize the hook in your AutoLoad module<br />
public function init() {<br />
<br />
// get defaults from module setting in CMS<br />
$this->defaultTime = $this->pub_after;<br />
$this->defaultInterval = $this->cron_check;<br />
<br />
// get admin URL<br />
$this->adminUrl = $this->wire('config')->urls->admin;<br />
<br />
// add hooks to CRON, PageList, PageEdit<br />
$this->addHookAfter("LazyCron::{$this->defaultInterval}", $this, 'publishDefferedPages');<br />
$this->addHook("ProcessPageListActions::getExtraActions", $this, 'hookPageListActions');<br />
$this->addHookAfter("ProcessPageEdit::buildForm", $this, "editForm");<br />
}<br />
<br />
public function ready() {<br />
<br />
// if list button clicked then grab id<br />
$this->pagePubLater = $this->input->get($this->listPageName);<br />
$this->pageID = $this->input->id;<br />
<br />
// get page<br />
$this->currentPage = $this->pages->get($this->pageID);<br />
<br />
// if pagelist pub later submit button clicked<br />
if($this->pagePubLater){<br />
$this->message("Page {$this->currentPage->name} deffered for publish.");<br />
}<br />
<br />
// if page edit submit button clicked<br />
$this->postPubLater = $this->input->post($this->submitName);<br />
if($this->postPubLater){<br />
$this->message("Page {$this->currentPage->name} deffered for publish.");<br />
}<br />
<br />
// if either deffered publish sumbit found then publish page later<br />
if($this->pagePubLater || $this->postPubLater){<br />
$this->publishLater();<br />
}<br />
}<br />
<br />
/*<br />
* Hook: ProcessPageEdit::buildForm<br />
*<br />
* add Publish Later button to edit page if not yet published<br />
*/<br />
public function ___editForm(HookEvent $form) {<br />
<br />
// get the InputFieldForm object from the event (return value of buildForm())<br />
$form = $form->return;<br />
<br />
$page = $this->pages->get($this->input->get->id);<br />
$check = $page->get($this->checkboxName);<br />
<br />
// check if publish button available and therfore unpublished<br />
$target = $form->get('submit_publish');<br />
<br />
if($target && $check == false){<br />
<br />
// get InputfieldText module<br />
$submit2 = $this->modules->get('InputfieldSubmit');<br />
$submit2->attr('name', $this->submitName);<br />
$submit2->attr('id', 'publish_later');<br />
$submit2->attr('class', 'ui-button ui-widget ui-corner-all head_button_clone ui-state-default ui-priority-secondary');<br />
$submit2->attr('value', 'Publish Later'); // Button: save unpublished<br />
<br />
// get form element save and place before<br />
$target = $form->get('submit_save');<br />
$form->insertBefore($submit2, $target);<br />
<br />
$form->return = $form;<br />
}<br />
}<br />
<br />
public function ___hookPageListActions(HookEvent $event) {<br />
<br />
// get current page<br />
$page = $event->arguments[0];<br />
<br />
// check to see if page is published<br />
$pagePub = $page->is(Page::statusUnpublished);<br />
<br />
// check to see if page template has deffered field<br />
$pageHasDefferField = $page->get($this->fieldName);<br />
<br />
$actions = array();<br />
<br />
// don't get homepage or pages that are already published or are being deffered for publish<br />
if($page->id > 1 && $pagePub == "published" && !is_null($pageHasDefferField) && $page->get($this->checkboxName) == false) {<br />
<br />
$actions['publish_later'] = array(<br />
'cn' => 'PublishLater',<br />
'name' => 'pub later',<br />
'url' => "{$this->adminUrl}?{$this->listPageName}=1&id={$page->id}",<br />
);<br />
}<br />
if(count($actions)) $event->return = $actions + $event->return;<br />
}<br />
<br />
/*<br />
* Publish Page on cron job<br />
*<br />
* Gets deffered page and publishes<br />
*/<br />
public function ___publish($page) {<br />
$page->removeStatus(Page::statusUnpublished);<br />
$page->removeStatus(Page::statusHidden);<br />
$page->Save();<br />
}<br />
<br />
/*<br />
* Main publish later function<br />
*<br />
* Gets deffered page and sets fields to be checked be lazy cron<br />
*/<br />
private function ___publishLater() {<br />
<br />
// get page<br />
$page = $this->pages->get($this->pageID);<br />
<br />
// set output formatting to false<br />
$page->of(false);<br />
<br />
// set field time to settings default time and checkbox to true<br />
$page->set($this->checkboxName, true);<br />
$page->set($this->fieldName, $this->defaultTime);<br />
<br />
// save page<br />
$page->save();<br />
$page->of(true);<br />
}<br />
<br />
/*<br />
* Lazy Cron hook function<br />
*<br />
* Triggers every [set time interval] and checks pages<br />
* Publishes page if time runout<br />
*<br />
* Adds publish page log<br />
*/<br />
public function ___publishDefferedPages(HookEvent $e){<br />
<br />
// seconds since last lazycron<br />
$seconds = $e->arguments[0];<br />
<br />
// find all pages with deffered field<br />
$defferedPages = $this->pages->find("{$this->checkboxName}=1,include=unpublished");<br />
<br />
// for each page decrease time for deffered field<br />
foreach ($defferedPages as $page) {<br />
<br />
// get current page time<br />
$timeTillPublish = $page->get($this->fieldName);<br />
<br />
// set time to time minus time past<br />
$timeLeft = $timeTillPublish - $seconds;<br />
<br />
// if time passed 0 or less then publish page<br />
$page->of(false);<br />
if($timeLeft <= 0){<br />
// remove flags and save<br />
$this->publish($page);<br />
<br />
$page->set($this->fieldName, 0);<br />
$page->set($this->checkboxName, 0);<br />
<br />
// log a page has been published<br />
$log = wire('log');<br />
$log->message('CRON:'. $seconds .' Pages: '. $page->name .' published');<br />
}else{<br />
$page->set($this->fieldName, $timeLeft);<br />
}<br />
// save page time<br />
$page->Save();<br />
$page->of(true);<br />
}<br />
}<br />
<br />
/*<br />
* Install new module specific fields<br />
*/<br />
private function installFields(){<br />
<br />
// install pub later checkbox field<br />
// find installed fields<br />
$f = $this->fields->get($this->fieldName);<br />
if($f){<br />
<br />
// if field already found then don't try and make it<br />
$this->message($this->fieldName . ' field found');<br />
<br />
}else{<br />
<br />
// create new field object to store crontime<br />
$f = new Field();<br />
// get a field type<br />
$f->type = $this->modules->get("FieldtypeInteger");<br />
$f->name = $this->fieldName;<br />
$f->label = 'Publish Time Left';<br />
$f->defaultValue = $this->defaultTime;<br />
$f->icon = 'clock-o';<br />
$f->columnWidth = 50;<br />
$f->collapsed = 1;<br />
$f->flags = 4;<br />
<br />
$f->save(); // save the field<br />
<br />
// create new field object to store whether to publish or not<br />
$f = new Field();<br />
// get a field type<br />
$f->type = $this->modules->get("FieldtypeCheckbox");<br />
$f->name = $this->checkboxName;<br />
$f->label = 'Publish Page later';<br />
$f->defaultValue = false;<br />
$f->columnWidth = 50;<br />
$f->icon = 'clock-o';<br />
$f->collapsed = 1;<br />
$f->flags = 4;<br />
<br />
$f->save(); // save the field<br />
}<br />
}<br />
<br />
/*<br />
* Uninstall module specific fields<br />
*/<br />
private function uninstallFields(){<br />
<br />
// find installed fields<br />
$fInt = $this->fields->get($this->fieldName);<br />
$fCheck = $this->fields->get($this->checkboxName);<br />
<br />
if($fInt && $fCheck){<br />
$fieldIntUsed = $fInt->numFieldgroups();<br />
$fieldCheckUsed = $fCheck->numFieldgroups();<br />
<br />
if($fieldIntUsed){<br />
// field in use by template<br />
$this->message('Unable to uninstall field '.$fInt->name);<br />
}else{<br />
// delete installed fields<br />
$this->fields->delete($fInt);<br />
$this->fields->save;<br />
}<br />
<br />
if($fieldCheckUsed){<br />
// field in use by template<br />
$this->message('Unable to uninstall field '.$fCheck->name);<br />
}else{<br />
// delete installed fields<br />
$this->fields->delete($fCheck);<br />
$this->fields->save;<br />
}<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
=== Inputfield / Fieldtype ===<br />
[[ProcessWire - Fieldtype erstellen (Module)]]</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Module_schreiben&diff=24242ProcessWire - Module schreiben2020-01-06T08:37:12Z<p>84.136.104.26: /* Autoload Module und Hooks */</p>
<hr />
<div>== Links ==<br />
https://processwire.com/docs/modules/development/ - Guter Ausgangspunkt<br />
https://webdesign.tutsplus.com/tutorials/a-beginners-introduction-to-writing-modules-in-processwire--cms-26862<br />
https://processwire.com/api/ref/module/<br />
https://processwire.com/docs/modules/ - Introduction, Development, Hooks, Types, Pro Modules, Third Party<br />
https://processwire.com/blog/posts/new-module-configuration-options/<br />
https://processwire.com/talk/topic/778-module-dependencies/<br />
http://somatonic.github.io/Captain-Hook/ // Hook Cheatsheet<br />
<br />
[[ProcessWire - Module Snippets]]<br />
<br />
== Wo - Was ? ==<br />
=== Welche Typen von Modulen gibt es ? ===<br />
https://processwire.com/docs/modules/types/<br />
* '''Fieldtype''': Meistens keine Public API, Handelt Daten / Datenbank - https://processwire.com/api/ref/fieldtype/<br />
* '''Inputfield''': Sammelt User Eingaben über Formulare für Felder (Fieldtypes)<br />
* '''Process''' for creating admin processes/applications.<br />
* '''Textformatter''' for formatting text.<br />
* '''AdminTheme''' for creating themes in the admin.<br />
* '''WireMail''' for modules that send email and extend the WireMail class.<br />
* '''Tfa''' for implementing a specific kind of two-factor authentication.<br />
* '''ImageSizerEngine''' for modules that extend ImageSizerEngine for resizing images.<br />
* '''FileCompiler''' for modules that extend FileCompilerModule for compilation of files.<br />
* '''FileValidator''' for modules that extend FileValidatorModule for validation of files.<br />
<br />
=== Wie werden Felder in der Datenbank angelegt ? ===<br />
Dazu nutzt man den Typ "Fieldtype"<br />
<br />
=== Wo rendert man die Ausgabe ? ===<br />
Bei Ryan Cramers Event Beispiel legt er zwei Klassen Event und EventArray an, die auch die Render Funktionen enthalten.<br />
<br />
== Spezielle Funktionen in Modulen ==<br />
<br />
=== getModuleInfo ===<br />
Ist die einzige Pflichtfunktion in Modulen. Hier werden title, version, summary und weitere Daten hinterlegt. Hier kann man auch angeben ob ein Modul ein Autoload Modul ist.<br />
<br />
=== init ===<br />
public function init(){}<br />
Initialisiert das Modul. ProcessWire ruft diese Funktion auf, wenn das Modul geladen ist. Bei Autoload Modulen wird es aufgerufen wenn die ProcessWire API bereit ist. Daher ist es ein guter Ort um Hooks einzubinden.<br />
<br />
=== ready ===<br />
public function ready() {<br />
if($this->page->template == 'admin') {<br />
$this->message($this->hi());<br />
}<br />
}<br />
Wird in autoload Modulen aufgerufen wenn die API bereit ist. Nützlich für Hooks:<br />
<br />
<br />
== Autoload Module und Hooks ==<br />
Autoload werden automatisch geladen müssen also nicht in einem Template o.ä. gestartet werden. Daher bieten sie sich an um die Funktionalität von ProcessWire zu erweitern. Als Werkzeug dafür dienen Hooks. Mit Hooks kann man an vielen Stellen den Rendering Process der Seiten beeinflussen. Außerdem kann man für eigene Module ebenfalls Hooks bereitstellen. <br />
<br />
=== Hooks ===<br />
https://processwire.com/docs/modules/hooks/<br />
Hooks sind ein mächtiges Werkzeug. Sie geben einem die Möglichkeit an vielen Stellen "einzuhaken" und Funktionalität einzubauen.<br />
<pre><br />
public function ready() {<br />
$this->addHookAfter('Page::render', function($event) {<br />
$event->return .= '<p>Hallo</p>';<br />
});<br />
}<br />
</pre><br />
Schreibt am Ende Jeder Seite ein "Hallo". Das $event Objekt ist ein [https://processwire.com/api/ref/hook-event/ HookEvent]. Im Beispiel fügen wir einfach etwas Markup hinzu. Über $event->arguments() kann man aber auf ale Argumente zugreifen.<br />
<br />
Das gleiche aber nicht mit anonymer Funktion:<br />
<syntaxhighlight lang="php"><br />
public function ready() {<br />
// add hook after Page::render() and make it call the "test" method of $this module<br />
$this->addHookAfter('Page::render', $this, 'test');<br />
}<br />
<br />
public function test($event) {<br />
// modify the return value of Page::render() to include the following:<br />
$event->return .= '<p>Hallo</p>';<br />
}<br />
</syntaxhighlight><br />
<br />
=== Hooks zum erweitern von existierenden Klassen nutzen ===<br />
Mit Hooks kann man in vorhandene Klassen einhaken. Z.B. läßt sich das Page Objekt erweitern.<br />
<pre><br />
public function ready() {<br />
$this->addHook('Page::summarize', $this, 'summarize');<br />
}<br />
public function summarize($event) {<br />
$page = $event->object; // the $event->object represents the object hooked (Page)<br />
$maxlen = $event->arguments(0); // first argument is the optional max length<br />
if(!$maxlen) $maxlen = 200; // if no $maxlen was present, we'll use a default of 200<br />
$summary = $this->sanitizer->truncate($page->body, $maxlen); // use sanitizer truncate method to create a summary<br />
$event->return = $summary; // populate $summary to $event->return, the return value<br />
}<br />
</pre><br />
So kann man ganz einfach eine Zusammenfassung aller Kindseiten in einem Template rendern:<br />
<pre><br />
foreach($page->children as $item) {<br />
$summary = $item->summarize(150);<br />
echo "<li><a href='$item->url'>$item->title</a><br>$summary";<br />
}<br />
</pre><br />
<br />
=== Hook Beispiele ===<br />
Hook am Ende des Renderings<br />
$this->addHookAfter('Page::render', function($event) {...});<br />
Füge eine Funktion "summarize" zum Page Objekt hinzu.<br />
$this->addHook('Page::summarize', $this, 'summarize');<br />
}<br />
</pre><br />
<br />
=== Autoload Module nur im Admin Bereich laden ===<br />
'autoload' => 'template=admin' <br />
statt<br />
'autoload' => true<br />
<br />
== Beispiele ==<br />
=== Frontend Rendering Module ===<br />
A bit old but working<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
/**<br />
* FrontEndRender<br />
*<br />
* Author: Ben Byford<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2010 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class FrontEndRender extends WireData implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'FrontEndRender',<br />
'version' => 0.1,<br />
'summary' => "Outputs html and static variables to frontend",<br />
'author' => 'Ben Byford',<br />
'singular' => true,<br />
'href' => 'https://github.com/benbyford/PW-starter-modules'<br />
);<br />
}<br />
<br />
// protected variable only accessable within module<br />
protected $name = 'Ben';<br />
<br />
/*<br />
* render function to be called in PW template like this:<br />
* $FrontEndRender = $modules->getModule('FrontEndRender');<br />
* echo '<h1>' . $FrontEndRender->render() . '</h1>';<br />
*<br />
*/<br />
public function render(){<br />
return "Hello " . $this->name;<br />
}<br />
}<br />
?><br />
</syntaxhighlight><br />
<br />
=== ProcessWire Hello World Modul ===<br />
Beispiel Modul mit Hooks (liegt immer in der Standardinstallation)<br />
<syntaxhighlight lang="php"><br />
<?php namespace ProcessWire;<br />
<br />
/**<br />
* ProcessWire 'Hello world' demonstration module<br />
*<br />
* Demonstrates the Module interface and how to add hooks.<br />
* <br />
* See README file for further links regarding module development.<br />
* <br />
* This file is licensed under the MIT license<br />
* https://processwire.com/about/license/mit/<br />
* <br />
* ProcessWire 3.x, Copyright 2016 by Ryan Cramer<br />
* https://processwire.com<br />
*<br />
*/<br />
<br />
class Helloworld extends WireData implements Module {<br />
<br />
/**<br />
* getModuleInfo is a module required by all modules to tell ProcessWire about them<br />
*<br />
* @return array<br />
*<br />
*/<br />
public static function getModuleInfo() {<br />
<br />
return array(<br />
<br />
// The module's title, typically a little more descriptive than the class name<br />
'title' => 'Hello World', <br />
<br />
// version number <br />
'version' => 3, <br />
<br />
// summary is brief description of what this module is<br />
'summary' => 'An example module used for demonstration purposes.',<br />
<br />
// Optional URL to more information about the module<br />
'href' => 'https://processwire.com',<br />
<br />
// singular=true: indicates that only one instance of the module is allowed.<br />
// This is usually what you want for modules that attach hooks. <br />
'singular' => true, <br />
<br />
// autoload=true: indicates the module should be started with ProcessWire.<br />
// This is necessary for any modules that attach runtime hooks, otherwise those<br />
// hooks won't get attached unless some other code calls the module on it's own.<br />
// Note that autoload modules are almost always also 'singular' (seen above).<br />
'autoload' => true, <br />
<br />
// Optional font-awesome icon name, minus the 'fa-' part<br />
'icon' => 'smile-o', <br />
);<br />
}<br />
<br />
/**<br />
* Initialize the module<br />
*<br />
* ProcessWire calls this when the module is loaded. For 'autoload' modules, this will be called<br />
* when ProcessWire's API is ready. As a result, this is a good place to attach hooks. <br />
*<br />
*/<br />
public function init() {<br />
<br />
// add a hook after the $pages->save, to issue a notice every time a page is saved<br />
$this->pages->addHookAfter('save', $this, 'example1'); <br />
<br />
// add a hook after each page is rendered and modify the output<br />
$this->addHookAfter('Page::render', $this, 'example2'); <br />
<br />
// add a 'hello' method to every page that returns "Hello World"<br />
// use "echo $page->hello();" in your template file to display output<br />
$this->addHook('Page::hello', $this, 'example3'); <br />
<br />
// add a 'hello_world' property to every page that returns "Hello [user]"<br />
// use "echo $page->hello_world;" in your template file to display output<br />
$this->addHookProperty('Page::hello_world', $this, 'example4'); <br />
}<br />
<br />
/**<br />
* Example1 hooks into the pages->save method and displays a notice every time a page is saved<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example1($event) {<br />
/** @var Page $page */<br />
$page = $event->arguments[0]; <br />
$this->message("Hello World! You saved {$page->path}."); <br />
}<br />
<br />
<br />
/**<br />
* Example2 hooks into every page after it's rendered and adds "Hello World" text at the bottom<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example2($event) {<br />
<br />
/** @var Page $page */<br />
$page = $event->object; <br />
<br />
// don't add this to the admin pages<br />
if($page->template == 'admin') return;<br />
<br />
// add a "Hello World" paragraph right before the closing body tag<br />
$event->return = str_replace("</body>", "<p>Hello World!</p></body>", $event->return); <br />
}<br />
<br />
/**<br />
* Example3 adds a 'hello' method (not property) to every page that simply returns "Hello World"<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example3($event) {<br />
$event->return = "Hello World";<br />
}<br />
<br />
/**<br />
* Example 4 adds a 'hello_world' property (not method) to every page that returns "Hello [user]"<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example4($event) {<br />
$event->return = "Hello " . $this->user->name; <br />
}<br />
<br />
}<br />
<br />
</syntaxhighlight><br />
<br />
=== ProcessWire Admin Bereich mit eigener Funktionalität erweitern (Modul)===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<syntaxhighlight lang="php"><br />
<br />
<?php<br />
/**<br />
* ProcessSimpleAdminPage<br />
*<br />
* @author Ben Byford<br />
* http://www.benbyford.com<br />
*<br />
* @see http://www.processwire.com<br />
*/<br />
<br />
class ProcessSimpleAdminPage extends Process {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'Process Simple Admin Page',<br />
'summary' => 'Simple Process module that adds new admin page with',<br />
'version' => 001,<br />
<br />
// Modules that extend Process may specify a 'page' attribute in the<br />
// getModuleInfo(), this page will automatically be given the module<br />
// process when added to teh pagetree.<br />
<br />
// I have exampled but commented out the 'page' settings below<br />
// so that I can show how one might add a page to install() and<br />
// uninstall() in this and other modules (that might not extend<br />
// Process)<br />
<br />
<br />
// 'page' => array(<br />
// 'name' => 'site-config',<br />
// 'parent' => 'admin',<br />
// 'title' => 'Site Config'<br />
// )<br />
);<br />
}<br />
<br />
public function execute() {<br />
return '<br />
<h2>Edit the text here in the module</h2><br />
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam mattis eros vitae metus sodales eget suscipit purus rhoncus. Proin ultrices gravida dolor, non porttitor enim interdum vitae. Integer feugiat lacinia tincidunt. Nulla laoreet tristique tristique. Sed elementum justo a nisl elementum sit amet accumsan nisi tempor. Nulla quis eros et massa dignissim imperdiet a vitae purus.</p><br />
<br />
<p>Donec scelerisque pulvinar sem eu lobortis. Maecenas turpis ipsum, tempus dictum pharetra eu, consectetur vitae arcu. Fusce orci mauris, semper at tempus quis, volutpat molestie tellus. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Sed quam tortor, tincidunt sed semper lacinia, scelerisque dapibus quam. Morbi at nisi luctus lacus auctor ultrices eu eu leo.</p><br />
<br />
<p>Praesent faucibus purus id felis tincidunt dignissim. Sed sit amet ligula mi, eget semper dui. Proin consectetur gravida massa, nec luctus purus hendrerit in. Etiam volutpat, elit non venenatis suscipit, libero neque consectetur diam, id rutrum magna odio ac ligula. Maecenas sollicitudin congue neque fermentum vestibulum. Morbi nec leo nisi. Donec at nisl odio, et porta ligula.</p><br />
<br />
<p>Sed quis arcu nisi, ac tempor augue. Praesent non elit libero, a ullamcorper lorem. Curabitur porta odio eu nunc ultricies interdum id nec risus. Donec nibh nibh, porta eget vehicula ac, aliquet eget ante. Phasellus eget lorem eu eros eleifend ultrices. Cras sit amet neque sit amet nibh fringilla cursus ut id mauris. Praesent quis nunc justo, sed suscipit lectus. Phasellus eget ultrices risus. Curabitur eu semper est. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Ut suscipit, nisl ut imperdiet eleifend, turpis arcu placerat tortor, nec laoreet lacus neque ac tellus. Aenean ac lacus justo, quis ultricies nisi.</p><br />
';<br />
}<br />
public function install(){<br />
<br />
// create new page to add to CMS<br />
$page = new Page();<br />
<br />
// add page attributes<br />
$page->template = "admin";<br />
$page->name = "cms-faq";<br />
$page->title = "CMS FAQ";<br />
$page->save();<br />
<br />
// set this module as the page process, this allows us to display the above<br />
$page->process = 'ProcessSimpleAdminPage';<br />
<br />
// get admin page and set as page parent<br />
$admin = $this->pages->get("id=2");<br />
$page->parent = $admin;<br />
<br />
// save page<br />
$page->save();<br />
}<br />
<br />
public function uninstall(){<br />
<br />
// delete created page<br />
$page = $this->pages->get("name=cms-faq");<br />
if(count($page)) $this->pages->delete($page, true);<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
=== ProcessWire Textformatter Modul ===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
/**<br />
* TextformatterFindReplace<br />
*<br />
* Author: Ben Byford<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2010 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class TextformatterFindReplace extends Textformatter implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'TextformatterFindReplace',<br />
'version' => 0.1,<br />
'summary' => "Finds and replaces any instance of config input to config output",<br />
'author' => 'Ben Byford',<br />
'singular' => true,<br />
'href' => 'https://github.com/benbyford/PW-starter-modules'<br />
);<br />
}<br />
<br />
<br />
/**<br />
* Find and Replace the input string<br />
*<br />
* @param string $str The block of text to parse<br />
*<br />
* The incoming string is replaced with the formatted version of itself.<br />
**/<br />
<br />
public function format(&$str) {<br />
$find = $this->findStr;<br />
$str = preg_replace_callback($find, array($this,"replace"), $str);<br />
<br />
}<br />
<br />
// adding three underscores to a function allows other modules to hook it<br />
public function ___replace($match) {<br />
return $this->replaceStr;<br />
}<br />
}<br />
?><br />
</syntaxhighlight><br />
<br />
=== Admin Funktionalität: Countdown zum Seitenveröffentlichen ===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<br />
The module PageDeferredPublish, on clicking one of the '''Publish Later buttons''', sets LazyCron to check that page’s countdown every minute and publishes the page when its countdown reaches 0. This means I can publish a page approximately 24 hours in advance (obviously the checking interval and delay time can be changed to your requirements).<br />
<br />
I did this by:<br />
<br />
'''Creating two fields''' within my install() function: a checkbox field to set to true when a button is checked to indicate the page should countdown, and a countdown field to store the count in seconds for that specific page.<br />
<br />
'''Adding hooks''' to both ''ProcessPageEdit::buildForm'' and ''ProcessPageListActions::getExtraActions'' enabling me to add the two buttons.<br />
<br />
Checking to see if one of the buttons was clicked with my '''ready() function''' then setting the corresponding page’s checkbox to true.<br />
<br />
Using a '''LazyCron hook function''' to check all pages that are unpublished for true checkboxes and then comparing the seconds field to see if the page needs publishing. If not then deduct the elapsed time in seconds.<br />
<br />
The result is a '''module that has settings''' (the time interval to check and publish at a later time), '''hooks into the admin''' using buttons and fields, and enables us to '''use other modules installe'''d in PW (i.e. LazyCron).<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
/**<br />
* DeferredPublish (0.0.1)<br />
* DeferredPublish publishes a page after a defined amount of time has elapsed using lazycron.<br />
*<br />
* @author Ben Byford<br />
* http://www.benbyford.com<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2011 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class PageDeferredPublish extends WireData implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => "PageDeferredPublish",<br />
'version' => "0.0.1",<br />
'summary' => "PageDeferredPublish",<br />
'author' => "Ben Byford",<br />
'href' => "https://github.com/benbyford/PW-intermediate-modules",<br />
'icon' => "clock-o",<br />
'autoload' => true,<br />
'singular' => true,<br />
'requires' => "LazyCron",<br />
);<br />
}<br />
<br />
private $postPubLater = null;<br />
private $pageID = null;<br />
private $pagePubLater = null;<br />
private $currentPage = null;<br />
<br />
private $submitName = 'pdp_pub_later_submit';<br />
private $listPageName = 'pdp_pub_later_list';<br />
private $fieldName = 'pdp_pub_later';<br />
private $checkboxName = 'pdp_pub_later_check';<br />
<br />
private $defaultInterval = 'everyMinute';<br />
private $defaultTime = 86400;<br />
<br />
<br />
public function install(){<br />
// add new fields needed for module<br />
$this->installFields();<br />
}<br />
public function uninstall(){<br />
// uninstall fields<br />
$this->uninstallFields();<br />
}<br />
<br />
// initialize the hook in your AutoLoad module<br />
public function init() {<br />
<br />
// get defaults from module setting in CMS<br />
$this->defaultTime = $this->pub_after;<br />
$this->defaultInterval = $this->cron_check;<br />
<br />
// get admin URL<br />
$this->adminUrl = $this->wire('config')->urls->admin;<br />
<br />
// add hooks to CRON, PageList, PageEdit<br />
$this->addHookAfter("LazyCron::{$this->defaultInterval}", $this, 'publishDefferedPages');<br />
$this->addHook("ProcessPageListActions::getExtraActions", $this, 'hookPageListActions');<br />
$this->addHookAfter("ProcessPageEdit::buildForm", $this, "editForm");<br />
}<br />
<br />
public function ready() {<br />
<br />
// if list button clicked then grab id<br />
$this->pagePubLater = $this->input->get($this->listPageName);<br />
$this->pageID = $this->input->id;<br />
<br />
// get page<br />
$this->currentPage = $this->pages->get($this->pageID);<br />
<br />
// if pagelist pub later submit button clicked<br />
if($this->pagePubLater){<br />
$this->message("Page {$this->currentPage->name} deffered for publish.");<br />
}<br />
<br />
// if page edit submit button clicked<br />
$this->postPubLater = $this->input->post($this->submitName);<br />
if($this->postPubLater){<br />
$this->message("Page {$this->currentPage->name} deffered for publish.");<br />
}<br />
<br />
// if either deffered publish sumbit found then publish page later<br />
if($this->pagePubLater || $this->postPubLater){<br />
$this->publishLater();<br />
}<br />
}<br />
<br />
/*<br />
* Hook: ProcessPageEdit::buildForm<br />
*<br />
* add Publish Later button to edit page if not yet published<br />
*/<br />
public function ___editForm(HookEvent $form) {<br />
<br />
// get the InputFieldForm object from the event (return value of buildForm())<br />
$form = $form->return;<br />
<br />
$page = $this->pages->get($this->input->get->id);<br />
$check = $page->get($this->checkboxName);<br />
<br />
// check if publish button available and therfore unpublished<br />
$target = $form->get('submit_publish');<br />
<br />
if($target && $check == false){<br />
<br />
// get InputfieldText module<br />
$submit2 = $this->modules->get('InputfieldSubmit');<br />
$submit2->attr('name', $this->submitName);<br />
$submit2->attr('id', 'publish_later');<br />
$submit2->attr('class', 'ui-button ui-widget ui-corner-all head_button_clone ui-state-default ui-priority-secondary');<br />
$submit2->attr('value', 'Publish Later'); // Button: save unpublished<br />
<br />
// get form element save and place before<br />
$target = $form->get('submit_save');<br />
$form->insertBefore($submit2, $target);<br />
<br />
$form->return = $form;<br />
}<br />
}<br />
<br />
public function ___hookPageListActions(HookEvent $event) {<br />
<br />
// get current page<br />
$page = $event->arguments[0];<br />
<br />
// check to see if page is published<br />
$pagePub = $page->is(Page::statusUnpublished);<br />
<br />
// check to see if page template has deffered field<br />
$pageHasDefferField = $page->get($this->fieldName);<br />
<br />
$actions = array();<br />
<br />
// don't get homepage or pages that are already published or are being deffered for publish<br />
if($page->id > 1 && $pagePub == "published" && !is_null($pageHasDefferField) && $page->get($this->checkboxName) == false) {<br />
<br />
$actions['publish_later'] = array(<br />
'cn' => 'PublishLater',<br />
'name' => 'pub later',<br />
'url' => "{$this->adminUrl}?{$this->listPageName}=1&id={$page->id}",<br />
);<br />
}<br />
if(count($actions)) $event->return = $actions + $event->return;<br />
}<br />
<br />
/*<br />
* Publish Page on cron job<br />
*<br />
* Gets deffered page and publishes<br />
*/<br />
public function ___publish($page) {<br />
$page->removeStatus(Page::statusUnpublished);<br />
$page->removeStatus(Page::statusHidden);<br />
$page->Save();<br />
}<br />
<br />
/*<br />
* Main publish later function<br />
*<br />
* Gets deffered page and sets fields to be checked be lazy cron<br />
*/<br />
private function ___publishLater() {<br />
<br />
// get page<br />
$page = $this->pages->get($this->pageID);<br />
<br />
// set output formatting to false<br />
$page->of(false);<br />
<br />
// set field time to settings default time and checkbox to true<br />
$page->set($this->checkboxName, true);<br />
$page->set($this->fieldName, $this->defaultTime);<br />
<br />
// save page<br />
$page->save();<br />
$page->of(true);<br />
}<br />
<br />
/*<br />
* Lazy Cron hook function<br />
*<br />
* Triggers every [set time interval] and checks pages<br />
* Publishes page if time runout<br />
*<br />
* Adds publish page log<br />
*/<br />
public function ___publishDefferedPages(HookEvent $e){<br />
<br />
// seconds since last lazycron<br />
$seconds = $e->arguments[0];<br />
<br />
// find all pages with deffered field<br />
$defferedPages = $this->pages->find("{$this->checkboxName}=1,include=unpublished");<br />
<br />
// for each page decrease time for deffered field<br />
foreach ($defferedPages as $page) {<br />
<br />
// get current page time<br />
$timeTillPublish = $page->get($this->fieldName);<br />
<br />
// set time to time minus time past<br />
$timeLeft = $timeTillPublish - $seconds;<br />
<br />
// if time passed 0 or less then publish page<br />
$page->of(false);<br />
if($timeLeft <= 0){<br />
// remove flags and save<br />
$this->publish($page);<br />
<br />
$page->set($this->fieldName, 0);<br />
$page->set($this->checkboxName, 0);<br />
<br />
// log a page has been published<br />
$log = wire('log');<br />
$log->message('CRON:'. $seconds .' Pages: '. $page->name .' published');<br />
}else{<br />
$page->set($this->fieldName, $timeLeft);<br />
}<br />
// save page time<br />
$page->Save();<br />
$page->of(true);<br />
}<br />
}<br />
<br />
/*<br />
* Install new module specific fields<br />
*/<br />
private function installFields(){<br />
<br />
// install pub later checkbox field<br />
// find installed fields<br />
$f = $this->fields->get($this->fieldName);<br />
if($f){<br />
<br />
// if field already found then don't try and make it<br />
$this->message($this->fieldName . ' field found');<br />
<br />
}else{<br />
<br />
// create new field object to store crontime<br />
$f = new Field();<br />
// get a field type<br />
$f->type = $this->modules->get("FieldtypeInteger");<br />
$f->name = $this->fieldName;<br />
$f->label = 'Publish Time Left';<br />
$f->defaultValue = $this->defaultTime;<br />
$f->icon = 'clock-o';<br />
$f->columnWidth = 50;<br />
$f->collapsed = 1;<br />
$f->flags = 4;<br />
<br />
$f->save(); // save the field<br />
<br />
// create new field object to store whether to publish or not<br />
$f = new Field();<br />
// get a field type<br />
$f->type = $this->modules->get("FieldtypeCheckbox");<br />
$f->name = $this->checkboxName;<br />
$f->label = 'Publish Page later';<br />
$f->defaultValue = false;<br />
$f->columnWidth = 50;<br />
$f->icon = 'clock-o';<br />
$f->collapsed = 1;<br />
$f->flags = 4;<br />
<br />
$f->save(); // save the field<br />
}<br />
}<br />
<br />
/*<br />
* Uninstall module specific fields<br />
*/<br />
private function uninstallFields(){<br />
<br />
// find installed fields<br />
$fInt = $this->fields->get($this->fieldName);<br />
$fCheck = $this->fields->get($this->checkboxName);<br />
<br />
if($fInt && $fCheck){<br />
$fieldIntUsed = $fInt->numFieldgroups();<br />
$fieldCheckUsed = $fCheck->numFieldgroups();<br />
<br />
if($fieldIntUsed){<br />
// field in use by template<br />
$this->message('Unable to uninstall field '.$fInt->name);<br />
}else{<br />
// delete installed fields<br />
$this->fields->delete($fInt);<br />
$this->fields->save;<br />
}<br />
<br />
if($fieldCheckUsed){<br />
// field in use by template<br />
$this->message('Unable to uninstall field '.$fCheck->name);<br />
}else{<br />
// delete installed fields<br />
$this->fields->delete($fCheck);<br />
$this->fields->save;<br />
}<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
=== Inputfield / Fieldtype ===<br />
[[ProcessWire - Fieldtype erstellen (Module)]]</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Module_schreiben&diff=24241ProcessWire - Module schreiben2020-01-06T08:01:40Z<p>84.136.104.26: </p>
<hr />
<div>== Links ==<br />
https://processwire.com/docs/modules/development/ - Guter Ausgangspunkt<br />
https://webdesign.tutsplus.com/tutorials/a-beginners-introduction-to-writing-modules-in-processwire--cms-26862<br />
https://processwire.com/api/ref/module/<br />
https://processwire.com/docs/modules/ - Introduction, Development, Hooks, Types, Pro Modules, Third Party<br />
https://processwire.com/blog/posts/new-module-configuration-options/<br />
https://processwire.com/talk/topic/778-module-dependencies/<br />
http://somatonic.github.io/Captain-Hook/ // Hook Cheatsheet<br />
<br />
[[ProcessWire - Module Snippets]]<br />
<br />
== Wo - Was ? ==<br />
=== Welche Typen von Modulen gibt es ? ===<br />
https://processwire.com/docs/modules/types/<br />
* '''Fieldtype''': Meistens keine Public API, Handelt Daten / Datenbank - https://processwire.com/api/ref/fieldtype/<br />
* '''Inputfield''': Sammelt User Eingaben über Formulare für Felder (Fieldtypes)<br />
* '''Process''' for creating admin processes/applications.<br />
* '''Textformatter''' for formatting text.<br />
* '''AdminTheme''' for creating themes in the admin.<br />
* '''WireMail''' for modules that send email and extend the WireMail class.<br />
* '''Tfa''' for implementing a specific kind of two-factor authentication.<br />
* '''ImageSizerEngine''' for modules that extend ImageSizerEngine for resizing images.<br />
* '''FileCompiler''' for modules that extend FileCompilerModule for compilation of files.<br />
* '''FileValidator''' for modules that extend FileValidatorModule for validation of files.<br />
<br />
=== Wie werden Felder in der Datenbank angelegt ? ===<br />
Dazu nutzt man den Typ "Fieldtype"<br />
<br />
=== Wo rendert man die Ausgabe ? ===<br />
Bei Ryan Cramers Event Beispiel legt er zwei Klassen Event und EventArray an, die auch die Render Funktionen enthalten.<br />
<br />
== Spezielle Funktionen in Modulen ==<br />
<br />
=== getModuleInfo ===<br />
Ist die einzige Pflichtfunktion in Modulen. Hier werden title, version, summary und weitere Daten hinterlegt. Hier kann man auch angeben ob ein Modul ein Autoload Modul ist.<br />
<br />
=== init ===<br />
public function init(){}<br />
Initialisiert das Modul. ProcessWire ruft diese Funktion auf, wenn das Modul geladen ist. Bei Autoload Modulen wird es aufgerufen wenn die ProcessWire API bereit ist. Daher ist es ein guter Ort um Hooks einzubinden.<br />
<br />
=== ready ===<br />
public function ready() {<br />
if($this->page->template == 'admin') {<br />
$this->message($this->hi());<br />
}<br />
}<br />
Wird in autoload Modulen aufgerufen wenn die API bereit ist. Nützlich für Hooks:<br />
<br />
<br />
== Autoload Module und Hooks ==<br />
Autoload werden automatisch geladen müssen also nicht in einem Template o.ä. gestartet werden. Daher bieten sie sich an um die Funktionalität von ProcessWire zu erweitern. Als Werkzeug dafür dienen Hooks. Mit Hooks kann man an vielen Stellen den Rendering Process der Seiten beeinflussen. Außerdem kann man für eigene Module ebenfalls Hooks bereitstellen. <br />
<br />
=== Hooks ===<br />
https://processwire.com/docs/modules/hooks/<br />
Hooks sind ein mächtiges Werkzeug. Sie geben einem die Möglichkeit an vielen Stellen "einzuhaken" und Funktionalität einzubauen.<br />
<pre><br />
public function ready() {<br />
$this->addHookAfter('Page::render', function($event) {<br />
$event->return .= '<p>Hallo</p>';<br />
});<br />
}<br />
</pre><br />
Schreibt am Ende Jeder Seite ein "Hallo". Das $event Objekt ist ein [https://processwire.com/api/ref/hook-event/ HookEvent]. Im Beispiel fügen wir einfach etwas Markup hinzu. Über $event->arguments() kann man aber auf ale Argumente zugreifen.<br />
<br />
=== Hooks zum erweitern von existierenden Klassen nutzen ===<br />
Mit Hooks kann man in vorhandene Klassen einhaken. Z.B. läßt sich das Page Objekt erweitern.<br />
<pre><br />
public function ready() {<br />
$this->addHook('Page::summarize', $this, 'summarize');<br />
}<br />
public function summarize($event) {<br />
$page = $event->object; // the $event->object represents the object hooked (Page)<br />
$maxlen = $event->arguments(0); // first argument is the optional max length<br />
if(!$maxlen) $maxlen = 200; // if no $maxlen was present, we'll use a default of 200<br />
$summary = $this->sanitizer->truncate($page->body, $maxlen); // use sanitizer truncate method to create a summary<br />
$event->return = $summary; // populate $summary to $event->return, the return value<br />
}<br />
</pre><br />
So kann man ganz einfach eine Zusammenfassung aller Kindseiten in einem Template rendern:<br />
<pre><br />
foreach($page->children as $item) {<br />
$summary = $item->summarize(150);<br />
echo "<li><a href='$item->url'>$item->title</a><br>$summary";<br />
}<br />
</pre><br />
<br />
=== Autoload Module nur im Admin Bereich laden ===<br />
'autoload' => 'template=admin' <br />
statt<br />
'autoload' => true<br />
<br />
== Beispiele ==<br />
=== Frontend Rendering Module ===<br />
A bit old but working<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
/**<br />
* FrontEndRender<br />
*<br />
* Author: Ben Byford<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2010 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class FrontEndRender extends WireData implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'FrontEndRender',<br />
'version' => 0.1,<br />
'summary' => "Outputs html and static variables to frontend",<br />
'author' => 'Ben Byford',<br />
'singular' => true,<br />
'href' => 'https://github.com/benbyford/PW-starter-modules'<br />
);<br />
}<br />
<br />
// protected variable only accessable within module<br />
protected $name = 'Ben';<br />
<br />
/*<br />
* render function to be called in PW template like this:<br />
* $FrontEndRender = $modules->getModule('FrontEndRender');<br />
* echo '<h1>' . $FrontEndRender->render() . '</h1>';<br />
*<br />
*/<br />
public function render(){<br />
return "Hello " . $this->name;<br />
}<br />
}<br />
?><br />
</syntaxhighlight><br />
<br />
=== ProcessWire Hello World Modul ===<br />
Beispiel Modul mit Hooks (liegt immer in der Standardinstallation)<br />
<syntaxhighlight lang="php"><br />
<?php namespace ProcessWire;<br />
<br />
/**<br />
* ProcessWire 'Hello world' demonstration module<br />
*<br />
* Demonstrates the Module interface and how to add hooks.<br />
* <br />
* See README file for further links regarding module development.<br />
* <br />
* This file is licensed under the MIT license<br />
* https://processwire.com/about/license/mit/<br />
* <br />
* ProcessWire 3.x, Copyright 2016 by Ryan Cramer<br />
* https://processwire.com<br />
*<br />
*/<br />
<br />
class Helloworld extends WireData implements Module {<br />
<br />
/**<br />
* getModuleInfo is a module required by all modules to tell ProcessWire about them<br />
*<br />
* @return array<br />
*<br />
*/<br />
public static function getModuleInfo() {<br />
<br />
return array(<br />
<br />
// The module's title, typically a little more descriptive than the class name<br />
'title' => 'Hello World', <br />
<br />
// version number <br />
'version' => 3, <br />
<br />
// summary is brief description of what this module is<br />
'summary' => 'An example module used for demonstration purposes.',<br />
<br />
// Optional URL to more information about the module<br />
'href' => 'https://processwire.com',<br />
<br />
// singular=true: indicates that only one instance of the module is allowed.<br />
// This is usually what you want for modules that attach hooks. <br />
'singular' => true, <br />
<br />
// autoload=true: indicates the module should be started with ProcessWire.<br />
// This is necessary for any modules that attach runtime hooks, otherwise those<br />
// hooks won't get attached unless some other code calls the module on it's own.<br />
// Note that autoload modules are almost always also 'singular' (seen above).<br />
'autoload' => true, <br />
<br />
// Optional font-awesome icon name, minus the 'fa-' part<br />
'icon' => 'smile-o', <br />
);<br />
}<br />
<br />
/**<br />
* Initialize the module<br />
*<br />
* ProcessWire calls this when the module is loaded. For 'autoload' modules, this will be called<br />
* when ProcessWire's API is ready. As a result, this is a good place to attach hooks. <br />
*<br />
*/<br />
public function init() {<br />
<br />
// add a hook after the $pages->save, to issue a notice every time a page is saved<br />
$this->pages->addHookAfter('save', $this, 'example1'); <br />
<br />
// add a hook after each page is rendered and modify the output<br />
$this->addHookAfter('Page::render', $this, 'example2'); <br />
<br />
// add a 'hello' method to every page that returns "Hello World"<br />
// use "echo $page->hello();" in your template file to display output<br />
$this->addHook('Page::hello', $this, 'example3'); <br />
<br />
// add a 'hello_world' property to every page that returns "Hello [user]"<br />
// use "echo $page->hello_world;" in your template file to display output<br />
$this->addHookProperty('Page::hello_world', $this, 'example4'); <br />
}<br />
<br />
/**<br />
* Example1 hooks into the pages->save method and displays a notice every time a page is saved<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example1($event) {<br />
/** @var Page $page */<br />
$page = $event->arguments[0]; <br />
$this->message("Hello World! You saved {$page->path}."); <br />
}<br />
<br />
<br />
/**<br />
* Example2 hooks into every page after it's rendered and adds "Hello World" text at the bottom<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example2($event) {<br />
<br />
/** @var Page $page */<br />
$page = $event->object; <br />
<br />
// don't add this to the admin pages<br />
if($page->template == 'admin') return;<br />
<br />
// add a "Hello World" paragraph right before the closing body tag<br />
$event->return = str_replace("</body>", "<p>Hello World!</p></body>", $event->return); <br />
}<br />
<br />
/**<br />
* Example3 adds a 'hello' method (not property) to every page that simply returns "Hello World"<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example3($event) {<br />
$event->return = "Hello World";<br />
}<br />
<br />
/**<br />
* Example 4 adds a 'hello_world' property (not method) to every page that returns "Hello [user]"<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example4($event) {<br />
$event->return = "Hello " . $this->user->name; <br />
}<br />
<br />
}<br />
<br />
</syntaxhighlight><br />
<br />
=== ProcessWire Admin Bereich mit eigener Funktionalität erweitern (Modul)===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<syntaxhighlight lang="php"><br />
<br />
<?php<br />
/**<br />
* ProcessSimpleAdminPage<br />
*<br />
* @author Ben Byford<br />
* http://www.benbyford.com<br />
*<br />
* @see http://www.processwire.com<br />
*/<br />
<br />
class ProcessSimpleAdminPage extends Process {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'Process Simple Admin Page',<br />
'summary' => 'Simple Process module that adds new admin page with',<br />
'version' => 001,<br />
<br />
// Modules that extend Process may specify a 'page' attribute in the<br />
// getModuleInfo(), this page will automatically be given the module<br />
// process when added to teh pagetree.<br />
<br />
// I have exampled but commented out the 'page' settings below<br />
// so that I can show how one might add a page to install() and<br />
// uninstall() in this and other modules (that might not extend<br />
// Process)<br />
<br />
<br />
// 'page' => array(<br />
// 'name' => 'site-config',<br />
// 'parent' => 'admin',<br />
// 'title' => 'Site Config'<br />
// )<br />
);<br />
}<br />
<br />
public function execute() {<br />
return '<br />
<h2>Edit the text here in the module</h2><br />
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam mattis eros vitae metus sodales eget suscipit purus rhoncus. Proin ultrices gravida dolor, non porttitor enim interdum vitae. Integer feugiat lacinia tincidunt. Nulla laoreet tristique tristique. Sed elementum justo a nisl elementum sit amet accumsan nisi tempor. Nulla quis eros et massa dignissim imperdiet a vitae purus.</p><br />
<br />
<p>Donec scelerisque pulvinar sem eu lobortis. Maecenas turpis ipsum, tempus dictum pharetra eu, consectetur vitae arcu. Fusce orci mauris, semper at tempus quis, volutpat molestie tellus. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Sed quam tortor, tincidunt sed semper lacinia, scelerisque dapibus quam. Morbi at nisi luctus lacus auctor ultrices eu eu leo.</p><br />
<br />
<p>Praesent faucibus purus id felis tincidunt dignissim. Sed sit amet ligula mi, eget semper dui. Proin consectetur gravida massa, nec luctus purus hendrerit in. Etiam volutpat, elit non venenatis suscipit, libero neque consectetur diam, id rutrum magna odio ac ligula. Maecenas sollicitudin congue neque fermentum vestibulum. Morbi nec leo nisi. Donec at nisl odio, et porta ligula.</p><br />
<br />
<p>Sed quis arcu nisi, ac tempor augue. Praesent non elit libero, a ullamcorper lorem. Curabitur porta odio eu nunc ultricies interdum id nec risus. Donec nibh nibh, porta eget vehicula ac, aliquet eget ante. Phasellus eget lorem eu eros eleifend ultrices. Cras sit amet neque sit amet nibh fringilla cursus ut id mauris. Praesent quis nunc justo, sed suscipit lectus. Phasellus eget ultrices risus. Curabitur eu semper est. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Ut suscipit, nisl ut imperdiet eleifend, turpis arcu placerat tortor, nec laoreet lacus neque ac tellus. Aenean ac lacus justo, quis ultricies nisi.</p><br />
';<br />
}<br />
public function install(){<br />
<br />
// create new page to add to CMS<br />
$page = new Page();<br />
<br />
// add page attributes<br />
$page->template = "admin";<br />
$page->name = "cms-faq";<br />
$page->title = "CMS FAQ";<br />
$page->save();<br />
<br />
// set this module as the page process, this allows us to display the above<br />
$page->process = 'ProcessSimpleAdminPage';<br />
<br />
// get admin page and set as page parent<br />
$admin = $this->pages->get("id=2");<br />
$page->parent = $admin;<br />
<br />
// save page<br />
$page->save();<br />
}<br />
<br />
public function uninstall(){<br />
<br />
// delete created page<br />
$page = $this->pages->get("name=cms-faq");<br />
if(count($page)) $this->pages->delete($page, true);<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
=== ProcessWire Textformatter Modul ===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
/**<br />
* TextformatterFindReplace<br />
*<br />
* Author: Ben Byford<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2010 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class TextformatterFindReplace extends Textformatter implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'TextformatterFindReplace',<br />
'version' => 0.1,<br />
'summary' => "Finds and replaces any instance of config input to config output",<br />
'author' => 'Ben Byford',<br />
'singular' => true,<br />
'href' => 'https://github.com/benbyford/PW-starter-modules'<br />
);<br />
}<br />
<br />
<br />
/**<br />
* Find and Replace the input string<br />
*<br />
* @param string $str The block of text to parse<br />
*<br />
* The incoming string is replaced with the formatted version of itself.<br />
**/<br />
<br />
public function format(&$str) {<br />
$find = $this->findStr;<br />
$str = preg_replace_callback($find, array($this,"replace"), $str);<br />
<br />
}<br />
<br />
// adding three underscores to a function allows other modules to hook it<br />
public function ___replace($match) {<br />
return $this->replaceStr;<br />
}<br />
}<br />
?><br />
</syntaxhighlight><br />
<br />
=== Admin Funktionalität: Countdown zum Seitenveröffentlichen ===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<br />
The module PageDeferredPublish, on clicking one of the '''Publish Later buttons''', sets LazyCron to check that page’s countdown every minute and publishes the page when its countdown reaches 0. This means I can publish a page approximately 24 hours in advance (obviously the checking interval and delay time can be changed to your requirements).<br />
<br />
I did this by:<br />
<br />
'''Creating two fields''' within my install() function: a checkbox field to set to true when a button is checked to indicate the page should countdown, and a countdown field to store the count in seconds for that specific page.<br />
<br />
'''Adding hooks''' to both ''ProcessPageEdit::buildForm'' and ''ProcessPageListActions::getExtraActions'' enabling me to add the two buttons.<br />
<br />
Checking to see if one of the buttons was clicked with my '''ready() function''' then setting the corresponding page’s checkbox to true.<br />
<br />
Using a '''LazyCron hook function''' to check all pages that are unpublished for true checkboxes and then comparing the seconds field to see if the page needs publishing. If not then deduct the elapsed time in seconds.<br />
<br />
The result is a '''module that has settings''' (the time interval to check and publish at a later time), '''hooks into the admin''' using buttons and fields, and enables us to '''use other modules installe'''d in PW (i.e. LazyCron).<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
/**<br />
* DeferredPublish (0.0.1)<br />
* DeferredPublish publishes a page after a defined amount of time has elapsed using lazycron.<br />
*<br />
* @author Ben Byford<br />
* http://www.benbyford.com<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2011 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class PageDeferredPublish extends WireData implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => "PageDeferredPublish",<br />
'version' => "0.0.1",<br />
'summary' => "PageDeferredPublish",<br />
'author' => "Ben Byford",<br />
'href' => "https://github.com/benbyford/PW-intermediate-modules",<br />
'icon' => "clock-o",<br />
'autoload' => true,<br />
'singular' => true,<br />
'requires' => "LazyCron",<br />
);<br />
}<br />
<br />
private $postPubLater = null;<br />
private $pageID = null;<br />
private $pagePubLater = null;<br />
private $currentPage = null;<br />
<br />
private $submitName = 'pdp_pub_later_submit';<br />
private $listPageName = 'pdp_pub_later_list';<br />
private $fieldName = 'pdp_pub_later';<br />
private $checkboxName = 'pdp_pub_later_check';<br />
<br />
private $defaultInterval = 'everyMinute';<br />
private $defaultTime = 86400;<br />
<br />
<br />
public function install(){<br />
// add new fields needed for module<br />
$this->installFields();<br />
}<br />
public function uninstall(){<br />
// uninstall fields<br />
$this->uninstallFields();<br />
}<br />
<br />
// initialize the hook in your AutoLoad module<br />
public function init() {<br />
<br />
// get defaults from module setting in CMS<br />
$this->defaultTime = $this->pub_after;<br />
$this->defaultInterval = $this->cron_check;<br />
<br />
// get admin URL<br />
$this->adminUrl = $this->wire('config')->urls->admin;<br />
<br />
// add hooks to CRON, PageList, PageEdit<br />
$this->addHookAfter("LazyCron::{$this->defaultInterval}", $this, 'publishDefferedPages');<br />
$this->addHook("ProcessPageListActions::getExtraActions", $this, 'hookPageListActions');<br />
$this->addHookAfter("ProcessPageEdit::buildForm", $this, "editForm");<br />
}<br />
<br />
public function ready() {<br />
<br />
// if list button clicked then grab id<br />
$this->pagePubLater = $this->input->get($this->listPageName);<br />
$this->pageID = $this->input->id;<br />
<br />
// get page<br />
$this->currentPage = $this->pages->get($this->pageID);<br />
<br />
// if pagelist pub later submit button clicked<br />
if($this->pagePubLater){<br />
$this->message("Page {$this->currentPage->name} deffered for publish.");<br />
}<br />
<br />
// if page edit submit button clicked<br />
$this->postPubLater = $this->input->post($this->submitName);<br />
if($this->postPubLater){<br />
$this->message("Page {$this->currentPage->name} deffered for publish.");<br />
}<br />
<br />
// if either deffered publish sumbit found then publish page later<br />
if($this->pagePubLater || $this->postPubLater){<br />
$this->publishLater();<br />
}<br />
}<br />
<br />
/*<br />
* Hook: ProcessPageEdit::buildForm<br />
*<br />
* add Publish Later button to edit page if not yet published<br />
*/<br />
public function ___editForm(HookEvent $form) {<br />
<br />
// get the InputFieldForm object from the event (return value of buildForm())<br />
$form = $form->return;<br />
<br />
$page = $this->pages->get($this->input->get->id);<br />
$check = $page->get($this->checkboxName);<br />
<br />
// check if publish button available and therfore unpublished<br />
$target = $form->get('submit_publish');<br />
<br />
if($target && $check == false){<br />
<br />
// get InputfieldText module<br />
$submit2 = $this->modules->get('InputfieldSubmit');<br />
$submit2->attr('name', $this->submitName);<br />
$submit2->attr('id', 'publish_later');<br />
$submit2->attr('class', 'ui-button ui-widget ui-corner-all head_button_clone ui-state-default ui-priority-secondary');<br />
$submit2->attr('value', 'Publish Later'); // Button: save unpublished<br />
<br />
// get form element save and place before<br />
$target = $form->get('submit_save');<br />
$form->insertBefore($submit2, $target);<br />
<br />
$form->return = $form;<br />
}<br />
}<br />
<br />
public function ___hookPageListActions(HookEvent $event) {<br />
<br />
// get current page<br />
$page = $event->arguments[0];<br />
<br />
// check to see if page is published<br />
$pagePub = $page->is(Page::statusUnpublished);<br />
<br />
// check to see if page template has deffered field<br />
$pageHasDefferField = $page->get($this->fieldName);<br />
<br />
$actions = array();<br />
<br />
// don't get homepage or pages that are already published or are being deffered for publish<br />
if($page->id > 1 && $pagePub == "published" && !is_null($pageHasDefferField) && $page->get($this->checkboxName) == false) {<br />
<br />
$actions['publish_later'] = array(<br />
'cn' => 'PublishLater',<br />
'name' => 'pub later',<br />
'url' => "{$this->adminUrl}?{$this->listPageName}=1&id={$page->id}",<br />
);<br />
}<br />
if(count($actions)) $event->return = $actions + $event->return;<br />
}<br />
<br />
/*<br />
* Publish Page on cron job<br />
*<br />
* Gets deffered page and publishes<br />
*/<br />
public function ___publish($page) {<br />
$page->removeStatus(Page::statusUnpublished);<br />
$page->removeStatus(Page::statusHidden);<br />
$page->Save();<br />
}<br />
<br />
/*<br />
* Main publish later function<br />
*<br />
* Gets deffered page and sets fields to be checked be lazy cron<br />
*/<br />
private function ___publishLater() {<br />
<br />
// get page<br />
$page = $this->pages->get($this->pageID);<br />
<br />
// set output formatting to false<br />
$page->of(false);<br />
<br />
// set field time to settings default time and checkbox to true<br />
$page->set($this->checkboxName, true);<br />
$page->set($this->fieldName, $this->defaultTime);<br />
<br />
// save page<br />
$page->save();<br />
$page->of(true);<br />
}<br />
<br />
/*<br />
* Lazy Cron hook function<br />
*<br />
* Triggers every [set time interval] and checks pages<br />
* Publishes page if time runout<br />
*<br />
* Adds publish page log<br />
*/<br />
public function ___publishDefferedPages(HookEvent $e){<br />
<br />
// seconds since last lazycron<br />
$seconds = $e->arguments[0];<br />
<br />
// find all pages with deffered field<br />
$defferedPages = $this->pages->find("{$this->checkboxName}=1,include=unpublished");<br />
<br />
// for each page decrease time for deffered field<br />
foreach ($defferedPages as $page) {<br />
<br />
// get current page time<br />
$timeTillPublish = $page->get($this->fieldName);<br />
<br />
// set time to time minus time past<br />
$timeLeft = $timeTillPublish - $seconds;<br />
<br />
// if time passed 0 or less then publish page<br />
$page->of(false);<br />
if($timeLeft <= 0){<br />
// remove flags and save<br />
$this->publish($page);<br />
<br />
$page->set($this->fieldName, 0);<br />
$page->set($this->checkboxName, 0);<br />
<br />
// log a page has been published<br />
$log = wire('log');<br />
$log->message('CRON:'. $seconds .' Pages: '. $page->name .' published');<br />
}else{<br />
$page->set($this->fieldName, $timeLeft);<br />
}<br />
// save page time<br />
$page->Save();<br />
$page->of(true);<br />
}<br />
}<br />
<br />
/*<br />
* Install new module specific fields<br />
*/<br />
private function installFields(){<br />
<br />
// install pub later checkbox field<br />
// find installed fields<br />
$f = $this->fields->get($this->fieldName);<br />
if($f){<br />
<br />
// if field already found then don't try and make it<br />
$this->message($this->fieldName . ' field found');<br />
<br />
}else{<br />
<br />
// create new field object to store crontime<br />
$f = new Field();<br />
// get a field type<br />
$f->type = $this->modules->get("FieldtypeInteger");<br />
$f->name = $this->fieldName;<br />
$f->label = 'Publish Time Left';<br />
$f->defaultValue = $this->defaultTime;<br />
$f->icon = 'clock-o';<br />
$f->columnWidth = 50;<br />
$f->collapsed = 1;<br />
$f->flags = 4;<br />
<br />
$f->save(); // save the field<br />
<br />
// create new field object to store whether to publish or not<br />
$f = new Field();<br />
// get a field type<br />
$f->type = $this->modules->get("FieldtypeCheckbox");<br />
$f->name = $this->checkboxName;<br />
$f->label = 'Publish Page later';<br />
$f->defaultValue = false;<br />
$f->columnWidth = 50;<br />
$f->icon = 'clock-o';<br />
$f->collapsed = 1;<br />
$f->flags = 4;<br />
<br />
$f->save(); // save the field<br />
}<br />
}<br />
<br />
/*<br />
* Uninstall module specific fields<br />
*/<br />
private function uninstallFields(){<br />
<br />
// find installed fields<br />
$fInt = $this->fields->get($this->fieldName);<br />
$fCheck = $this->fields->get($this->checkboxName);<br />
<br />
if($fInt && $fCheck){<br />
$fieldIntUsed = $fInt->numFieldgroups();<br />
$fieldCheckUsed = $fCheck->numFieldgroups();<br />
<br />
if($fieldIntUsed){<br />
// field in use by template<br />
$this->message('Unable to uninstall field '.$fInt->name);<br />
}else{<br />
// delete installed fields<br />
$this->fields->delete($fInt);<br />
$this->fields->save;<br />
}<br />
<br />
if($fieldCheckUsed){<br />
// field in use by template<br />
$this->message('Unable to uninstall field '.$fCheck->name);<br />
}else{<br />
// delete installed fields<br />
$this->fields->delete($fCheck);<br />
$this->fields->save;<br />
}<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
=== Inputfield / Fieldtype ===<br />
[[ProcessWire - Fieldtype erstellen (Module)]]</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Module_schreiben&diff=24240ProcessWire - Module schreiben2020-01-06T07:19:19Z<p>84.136.104.26: /* Admin Funktionalität: Countdown zum Seitenveröffentlichen */</p>
<hr />
<div>== Links ==<br />
https://webdesign.tutsplus.com/tutorials/a-beginners-introduction-to-writing-modules-in-processwire--cms-26862<br />
https://processwire.com/api/ref/module/<br />
https://processwire.com/docs/modules/ - Introduction, Development, Hooks, Types, Pro Modules, Third Party<br />
https://processwire.com/docs/modules/development/ - <br />
https://processwire.com/blog/posts/new-module-configuration-options/<br />
https://processwire.com/talk/topic/778-module-dependencies/<br />
http://somatonic.github.io/Captain-Hook/ // Hook Cheatsheet<br />
<br />
[[ProcessWire - Module Snippets]]<br />
<br />
== Wo - Was ? ==<br />
=== Welche Typen von Modulen gibt es ? ===<br />
https://processwire.com/docs/modules/types/<br />
* '''Fieldtype''': Meistens keine Public API, Handelt Daten / Datenbank - https://processwire.com/api/ref/fieldtype/<br />
* '''Inputfield''': Sammelt User Eingaben über Formulare für Felder (Fieldtypes)<br />
* '''Process''' for creating admin processes/applications.<br />
* '''Textformatter''' for formatting text.<br />
* '''AdminTheme''' for creating themes in the admin.<br />
* '''WireMail''' for modules that send email and extend the WireMail class.<br />
* '''Tfa''' for implementing a specific kind of two-factor authentication.<br />
* '''ImageSizerEngine''' for modules that extend ImageSizerEngine for resizing images.<br />
* '''FileCompiler''' for modules that extend FileCompilerModule for compilation of files.<br />
* '''FileValidator''' for modules that extend FileValidatorModule for validation of files.<br />
<br />
=== Wie werden Felder in der Datenbank angelegt ? ===<br />
Dazu nutzt man den Typ "Fieldtype"<br />
=== Wo rendert man die Ausgabe ? ===<br />
Bei Ryan Cramers Event Beispiel legt er zwei Klassen Event und EventArray an, die auch die Render Funktionen enthalten.<br />
<br />
== Beispiele ==<br />
=== Frontend Rendering Module ===<br />
A bit old but working<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
/**<br />
* FrontEndRender<br />
*<br />
* Author: Ben Byford<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2010 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class FrontEndRender extends WireData implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'FrontEndRender',<br />
'version' => 0.1,<br />
'summary' => "Outputs html and static variables to frontend",<br />
'author' => 'Ben Byford',<br />
'singular' => true,<br />
'href' => 'https://github.com/benbyford/PW-starter-modules'<br />
);<br />
}<br />
<br />
// protected variable only accessable within module<br />
protected $name = 'Ben';<br />
<br />
/*<br />
* render function to be called in PW template like this:<br />
* $FrontEndRender = $modules->getModule('FrontEndRender');<br />
* echo '<h1>' . $FrontEndRender->render() . '</h1>';<br />
*<br />
*/<br />
public function render(){<br />
return "Hello " . $this->name;<br />
}<br />
}<br />
?><br />
</syntaxhighlight><br />
<br />
=== ProcessWire Hello World Modul ===<br />
Beispiel Modul mit Hooks (liegt immer in der Standardinstallation)<br />
<syntaxhighlight lang="php"><br />
<?php namespace ProcessWire;<br />
<br />
/**<br />
* ProcessWire 'Hello world' demonstration module<br />
*<br />
* Demonstrates the Module interface and how to add hooks.<br />
* <br />
* See README file for further links regarding module development.<br />
* <br />
* This file is licensed under the MIT license<br />
* https://processwire.com/about/license/mit/<br />
* <br />
* ProcessWire 3.x, Copyright 2016 by Ryan Cramer<br />
* https://processwire.com<br />
*<br />
*/<br />
<br />
class Helloworld extends WireData implements Module {<br />
<br />
/**<br />
* getModuleInfo is a module required by all modules to tell ProcessWire about them<br />
*<br />
* @return array<br />
*<br />
*/<br />
public static function getModuleInfo() {<br />
<br />
return array(<br />
<br />
// The module's title, typically a little more descriptive than the class name<br />
'title' => 'Hello World', <br />
<br />
// version number <br />
'version' => 3, <br />
<br />
// summary is brief description of what this module is<br />
'summary' => 'An example module used for demonstration purposes.',<br />
<br />
// Optional URL to more information about the module<br />
'href' => 'https://processwire.com',<br />
<br />
// singular=true: indicates that only one instance of the module is allowed.<br />
// This is usually what you want for modules that attach hooks. <br />
'singular' => true, <br />
<br />
// autoload=true: indicates the module should be started with ProcessWire.<br />
// This is necessary for any modules that attach runtime hooks, otherwise those<br />
// hooks won't get attached unless some other code calls the module on it's own.<br />
// Note that autoload modules are almost always also 'singular' (seen above).<br />
'autoload' => true, <br />
<br />
// Optional font-awesome icon name, minus the 'fa-' part<br />
'icon' => 'smile-o', <br />
);<br />
}<br />
<br />
/**<br />
* Initialize the module<br />
*<br />
* ProcessWire calls this when the module is loaded. For 'autoload' modules, this will be called<br />
* when ProcessWire's API is ready. As a result, this is a good place to attach hooks. <br />
*<br />
*/<br />
public function init() {<br />
<br />
// add a hook after the $pages->save, to issue a notice every time a page is saved<br />
$this->pages->addHookAfter('save', $this, 'example1'); <br />
<br />
// add a hook after each page is rendered and modify the output<br />
$this->addHookAfter('Page::render', $this, 'example2'); <br />
<br />
// add a 'hello' method to every page that returns "Hello World"<br />
// use "echo $page->hello();" in your template file to display output<br />
$this->addHook('Page::hello', $this, 'example3'); <br />
<br />
// add a 'hello_world' property to every page that returns "Hello [user]"<br />
// use "echo $page->hello_world;" in your template file to display output<br />
$this->addHookProperty('Page::hello_world', $this, 'example4'); <br />
}<br />
<br />
/**<br />
* Example1 hooks into the pages->save method and displays a notice every time a page is saved<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example1($event) {<br />
/** @var Page $page */<br />
$page = $event->arguments[0]; <br />
$this->message("Hello World! You saved {$page->path}."); <br />
}<br />
<br />
<br />
/**<br />
* Example2 hooks into every page after it's rendered and adds "Hello World" text at the bottom<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example2($event) {<br />
<br />
/** @var Page $page */<br />
$page = $event->object; <br />
<br />
// don't add this to the admin pages<br />
if($page->template == 'admin') return;<br />
<br />
// add a "Hello World" paragraph right before the closing body tag<br />
$event->return = str_replace("</body>", "<p>Hello World!</p></body>", $event->return); <br />
}<br />
<br />
/**<br />
* Example3 adds a 'hello' method (not property) to every page that simply returns "Hello World"<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example3($event) {<br />
$event->return = "Hello World";<br />
}<br />
<br />
/**<br />
* Example 4 adds a 'hello_world' property (not method) to every page that returns "Hello [user]"<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example4($event) {<br />
$event->return = "Hello " . $this->user->name; <br />
}<br />
<br />
}<br />
<br />
</syntaxhighlight><br />
<br />
=== ProcessWire Admin Bereich mit eigener Funktionalität erweitern (Modul)===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<syntaxhighlight lang="php"><br />
<br />
<?php<br />
/**<br />
* ProcessSimpleAdminPage<br />
*<br />
* @author Ben Byford<br />
* http://www.benbyford.com<br />
*<br />
* @see http://www.processwire.com<br />
*/<br />
<br />
class ProcessSimpleAdminPage extends Process {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'Process Simple Admin Page',<br />
'summary' => 'Simple Process module that adds new admin page with',<br />
'version' => 001,<br />
<br />
// Modules that extend Process may specify a 'page' attribute in the<br />
// getModuleInfo(), this page will automatically be given the module<br />
// process when added to teh pagetree.<br />
<br />
// I have exampled but commented out the 'page' settings below<br />
// so that I can show how one might add a page to install() and<br />
// uninstall() in this and other modules (that might not extend<br />
// Process)<br />
<br />
<br />
// 'page' => array(<br />
// 'name' => 'site-config',<br />
// 'parent' => 'admin',<br />
// 'title' => 'Site Config'<br />
// )<br />
);<br />
}<br />
<br />
public function execute() {<br />
return '<br />
<h2>Edit the text here in the module</h2><br />
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam mattis eros vitae metus sodales eget suscipit purus rhoncus. Proin ultrices gravida dolor, non porttitor enim interdum vitae. Integer feugiat lacinia tincidunt. Nulla laoreet tristique tristique. Sed elementum justo a nisl elementum sit amet accumsan nisi tempor. Nulla quis eros et massa dignissim imperdiet a vitae purus.</p><br />
<br />
<p>Donec scelerisque pulvinar sem eu lobortis. Maecenas turpis ipsum, tempus dictum pharetra eu, consectetur vitae arcu. Fusce orci mauris, semper at tempus quis, volutpat molestie tellus. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Sed quam tortor, tincidunt sed semper lacinia, scelerisque dapibus quam. Morbi at nisi luctus lacus auctor ultrices eu eu leo.</p><br />
<br />
<p>Praesent faucibus purus id felis tincidunt dignissim. Sed sit amet ligula mi, eget semper dui. Proin consectetur gravida massa, nec luctus purus hendrerit in. Etiam volutpat, elit non venenatis suscipit, libero neque consectetur diam, id rutrum magna odio ac ligula. Maecenas sollicitudin congue neque fermentum vestibulum. Morbi nec leo nisi. Donec at nisl odio, et porta ligula.</p><br />
<br />
<p>Sed quis arcu nisi, ac tempor augue. Praesent non elit libero, a ullamcorper lorem. Curabitur porta odio eu nunc ultricies interdum id nec risus. Donec nibh nibh, porta eget vehicula ac, aliquet eget ante. Phasellus eget lorem eu eros eleifend ultrices. Cras sit amet neque sit amet nibh fringilla cursus ut id mauris. Praesent quis nunc justo, sed suscipit lectus. Phasellus eget ultrices risus. Curabitur eu semper est. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Ut suscipit, nisl ut imperdiet eleifend, turpis arcu placerat tortor, nec laoreet lacus neque ac tellus. Aenean ac lacus justo, quis ultricies nisi.</p><br />
';<br />
}<br />
public function install(){<br />
<br />
// create new page to add to CMS<br />
$page = new Page();<br />
<br />
// add page attributes<br />
$page->template = "admin";<br />
$page->name = "cms-faq";<br />
$page->title = "CMS FAQ";<br />
$page->save();<br />
<br />
// set this module as the page process, this allows us to display the above<br />
$page->process = 'ProcessSimpleAdminPage';<br />
<br />
// get admin page and set as page parent<br />
$admin = $this->pages->get("id=2");<br />
$page->parent = $admin;<br />
<br />
// save page<br />
$page->save();<br />
}<br />
<br />
public function uninstall(){<br />
<br />
// delete created page<br />
$page = $this->pages->get("name=cms-faq");<br />
if(count($page)) $this->pages->delete($page, true);<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
=== ProcessWire Textformatter Modul ===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
/**<br />
* TextformatterFindReplace<br />
*<br />
* Author: Ben Byford<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2010 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class TextformatterFindReplace extends Textformatter implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'TextformatterFindReplace',<br />
'version' => 0.1,<br />
'summary' => "Finds and replaces any instance of config input to config output",<br />
'author' => 'Ben Byford',<br />
'singular' => true,<br />
'href' => 'https://github.com/benbyford/PW-starter-modules'<br />
);<br />
}<br />
<br />
<br />
/**<br />
* Find and Replace the input string<br />
*<br />
* @param string $str The block of text to parse<br />
*<br />
* The incoming string is replaced with the formatted version of itself.<br />
**/<br />
<br />
public function format(&$str) {<br />
$find = $this->findStr;<br />
$str = preg_replace_callback($find, array($this,"replace"), $str);<br />
<br />
}<br />
<br />
// adding three underscores to a function allows other modules to hook it<br />
public function ___replace($match) {<br />
return $this->replaceStr;<br />
}<br />
}<br />
?><br />
</syntaxhighlight><br />
<br />
=== Admin Funktionalität: Countdown zum Seitenveröffentlichen ===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<br />
The module PageDeferredPublish, on clicking one of the '''Publish Later buttons''', sets LazyCron to check that page’s countdown every minute and publishes the page when its countdown reaches 0. This means I can publish a page approximately 24 hours in advance (obviously the checking interval and delay time can be changed to your requirements).<br />
<br />
I did this by:<br />
<br />
'''Creating two fields''' within my install() function: a checkbox field to set to true when a button is checked to indicate the page should countdown, and a countdown field to store the count in seconds for that specific page.<br />
<br />
'''Adding hooks''' to both ''ProcessPageEdit::buildForm'' and ''ProcessPageListActions::getExtraActions'' enabling me to add the two buttons.<br />
<br />
Checking to see if one of the buttons was clicked with my '''ready() function''' then setting the corresponding page’s checkbox to true.<br />
<br />
Using a '''LazyCron hook function''' to check all pages that are unpublished for true checkboxes and then comparing the seconds field to see if the page needs publishing. If not then deduct the elapsed time in seconds.<br />
<br />
The result is a '''module that has settings''' (the time interval to check and publish at a later time), '''hooks into the admin''' using buttons and fields, and enables us to '''use other modules installe'''d in PW (i.e. LazyCron).<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
/**<br />
* DeferredPublish (0.0.1)<br />
* DeferredPublish publishes a page after a defined amount of time has elapsed using lazycron.<br />
*<br />
* @author Ben Byford<br />
* http://www.benbyford.com<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2011 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class PageDeferredPublish extends WireData implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => "PageDeferredPublish",<br />
'version' => "0.0.1",<br />
'summary' => "PageDeferredPublish",<br />
'author' => "Ben Byford",<br />
'href' => "https://github.com/benbyford/PW-intermediate-modules",<br />
'icon' => "clock-o",<br />
'autoload' => true,<br />
'singular' => true,<br />
'requires' => "LazyCron",<br />
);<br />
}<br />
<br />
private $postPubLater = null;<br />
private $pageID = null;<br />
private $pagePubLater = null;<br />
private $currentPage = null;<br />
<br />
private $submitName = 'pdp_pub_later_submit';<br />
private $listPageName = 'pdp_pub_later_list';<br />
private $fieldName = 'pdp_pub_later';<br />
private $checkboxName = 'pdp_pub_later_check';<br />
<br />
private $defaultInterval = 'everyMinute';<br />
private $defaultTime = 86400;<br />
<br />
<br />
public function install(){<br />
// add new fields needed for module<br />
$this->installFields();<br />
}<br />
public function uninstall(){<br />
// uninstall fields<br />
$this->uninstallFields();<br />
}<br />
<br />
// initialize the hook in your AutoLoad module<br />
public function init() {<br />
<br />
// get defaults from module setting in CMS<br />
$this->defaultTime = $this->pub_after;<br />
$this->defaultInterval = $this->cron_check;<br />
<br />
// get admin URL<br />
$this->adminUrl = $this->wire('config')->urls->admin;<br />
<br />
// add hooks to CRON, PageList, PageEdit<br />
$this->addHookAfter("LazyCron::{$this->defaultInterval}", $this, 'publishDefferedPages');<br />
$this->addHook("ProcessPageListActions::getExtraActions", $this, 'hookPageListActions');<br />
$this->addHookAfter("ProcessPageEdit::buildForm", $this, "editForm");<br />
}<br />
<br />
public function ready() {<br />
<br />
// if list button clicked then grab id<br />
$this->pagePubLater = $this->input->get($this->listPageName);<br />
$this->pageID = $this->input->id;<br />
<br />
// get page<br />
$this->currentPage = $this->pages->get($this->pageID);<br />
<br />
// if pagelist pub later submit button clicked<br />
if($this->pagePubLater){<br />
$this->message("Page {$this->currentPage->name} deffered for publish.");<br />
}<br />
<br />
// if page edit submit button clicked<br />
$this->postPubLater = $this->input->post($this->submitName);<br />
if($this->postPubLater){<br />
$this->message("Page {$this->currentPage->name} deffered for publish.");<br />
}<br />
<br />
// if either deffered publish sumbit found then publish page later<br />
if($this->pagePubLater || $this->postPubLater){<br />
$this->publishLater();<br />
}<br />
}<br />
<br />
/*<br />
* Hook: ProcessPageEdit::buildForm<br />
*<br />
* add Publish Later button to edit page if not yet published<br />
*/<br />
public function ___editForm(HookEvent $form) {<br />
<br />
// get the InputFieldForm object from the event (return value of buildForm())<br />
$form = $form->return;<br />
<br />
$page = $this->pages->get($this->input->get->id);<br />
$check = $page->get($this->checkboxName);<br />
<br />
// check if publish button available and therfore unpublished<br />
$target = $form->get('submit_publish');<br />
<br />
if($target && $check == false){<br />
<br />
// get InputfieldText module<br />
$submit2 = $this->modules->get('InputfieldSubmit');<br />
$submit2->attr('name', $this->submitName);<br />
$submit2->attr('id', 'publish_later');<br />
$submit2->attr('class', 'ui-button ui-widget ui-corner-all head_button_clone ui-state-default ui-priority-secondary');<br />
$submit2->attr('value', 'Publish Later'); // Button: save unpublished<br />
<br />
// get form element save and place before<br />
$target = $form->get('submit_save');<br />
$form->insertBefore($submit2, $target);<br />
<br />
$form->return = $form;<br />
}<br />
}<br />
<br />
public function ___hookPageListActions(HookEvent $event) {<br />
<br />
// get current page<br />
$page = $event->arguments[0];<br />
<br />
// check to see if page is published<br />
$pagePub = $page->is(Page::statusUnpublished);<br />
<br />
// check to see if page template has deffered field<br />
$pageHasDefferField = $page->get($this->fieldName);<br />
<br />
$actions = array();<br />
<br />
// don't get homepage or pages that are already published or are being deffered for publish<br />
if($page->id > 1 && $pagePub == "published" && !is_null($pageHasDefferField) && $page->get($this->checkboxName) == false) {<br />
<br />
$actions['publish_later'] = array(<br />
'cn' => 'PublishLater',<br />
'name' => 'pub later',<br />
'url' => "{$this->adminUrl}?{$this->listPageName}=1&id={$page->id}",<br />
);<br />
}<br />
if(count($actions)) $event->return = $actions + $event->return;<br />
}<br />
<br />
/*<br />
* Publish Page on cron job<br />
*<br />
* Gets deffered page and publishes<br />
*/<br />
public function ___publish($page) {<br />
$page->removeStatus(Page::statusUnpublished);<br />
$page->removeStatus(Page::statusHidden);<br />
$page->Save();<br />
}<br />
<br />
/*<br />
* Main publish later function<br />
*<br />
* Gets deffered page and sets fields to be checked be lazy cron<br />
*/<br />
private function ___publishLater() {<br />
<br />
// get page<br />
$page = $this->pages->get($this->pageID);<br />
<br />
// set output formatting to false<br />
$page->of(false);<br />
<br />
// set field time to settings default time and checkbox to true<br />
$page->set($this->checkboxName, true);<br />
$page->set($this->fieldName, $this->defaultTime);<br />
<br />
// save page<br />
$page->save();<br />
$page->of(true);<br />
}<br />
<br />
/*<br />
* Lazy Cron hook function<br />
*<br />
* Triggers every [set time interval] and checks pages<br />
* Publishes page if time runout<br />
*<br />
* Adds publish page log<br />
*/<br />
public function ___publishDefferedPages(HookEvent $e){<br />
<br />
// seconds since last lazycron<br />
$seconds = $e->arguments[0];<br />
<br />
// find all pages with deffered field<br />
$defferedPages = $this->pages->find("{$this->checkboxName}=1,include=unpublished");<br />
<br />
// for each page decrease time for deffered field<br />
foreach ($defferedPages as $page) {<br />
<br />
// get current page time<br />
$timeTillPublish = $page->get($this->fieldName);<br />
<br />
// set time to time minus time past<br />
$timeLeft = $timeTillPublish - $seconds;<br />
<br />
// if time passed 0 or less then publish page<br />
$page->of(false);<br />
if($timeLeft <= 0){<br />
// remove flags and save<br />
$this->publish($page);<br />
<br />
$page->set($this->fieldName, 0);<br />
$page->set($this->checkboxName, 0);<br />
<br />
// log a page has been published<br />
$log = wire('log');<br />
$log->message('CRON:'. $seconds .' Pages: '. $page->name .' published');<br />
}else{<br />
$page->set($this->fieldName, $timeLeft);<br />
}<br />
// save page time<br />
$page->Save();<br />
$page->of(true);<br />
}<br />
}<br />
<br />
/*<br />
* Install new module specific fields<br />
*/<br />
private function installFields(){<br />
<br />
// install pub later checkbox field<br />
// find installed fields<br />
$f = $this->fields->get($this->fieldName);<br />
if($f){<br />
<br />
// if field already found then don't try and make it<br />
$this->message($this->fieldName . ' field found');<br />
<br />
}else{<br />
<br />
// create new field object to store crontime<br />
$f = new Field();<br />
// get a field type<br />
$f->type = $this->modules->get("FieldtypeInteger");<br />
$f->name = $this->fieldName;<br />
$f->label = 'Publish Time Left';<br />
$f->defaultValue = $this->defaultTime;<br />
$f->icon = 'clock-o';<br />
$f->columnWidth = 50;<br />
$f->collapsed = 1;<br />
$f->flags = 4;<br />
<br />
$f->save(); // save the field<br />
<br />
// create new field object to store whether to publish or not<br />
$f = new Field();<br />
// get a field type<br />
$f->type = $this->modules->get("FieldtypeCheckbox");<br />
$f->name = $this->checkboxName;<br />
$f->label = 'Publish Page later';<br />
$f->defaultValue = false;<br />
$f->columnWidth = 50;<br />
$f->icon = 'clock-o';<br />
$f->collapsed = 1;<br />
$f->flags = 4;<br />
<br />
$f->save(); // save the field<br />
}<br />
}<br />
<br />
/*<br />
* Uninstall module specific fields<br />
*/<br />
private function uninstallFields(){<br />
<br />
// find installed fields<br />
$fInt = $this->fields->get($this->fieldName);<br />
$fCheck = $this->fields->get($this->checkboxName);<br />
<br />
if($fInt && $fCheck){<br />
$fieldIntUsed = $fInt->numFieldgroups();<br />
$fieldCheckUsed = $fCheck->numFieldgroups();<br />
<br />
if($fieldIntUsed){<br />
// field in use by template<br />
$this->message('Unable to uninstall field '.$fInt->name);<br />
}else{<br />
// delete installed fields<br />
$this->fields->delete($fInt);<br />
$this->fields->save;<br />
}<br />
<br />
if($fieldCheckUsed){<br />
// field in use by template<br />
$this->message('Unable to uninstall field '.$fCheck->name);<br />
}else{<br />
// delete installed fields<br />
$this->fields->delete($fCheck);<br />
$this->fields->save;<br />
}<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
=== Inputfield / Fieldtype ===<br />
[[ProcessWire - Fieldtype erstellen (Module)]]</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Module_Snippets&diff=24239ProcessWire - Module Snippets2020-01-06T07:10:51Z<p>84.136.104.26: </p>
<hr />
<div>Nützliche Snippets für das Schreiben von Modulen<br />
<br />
== Testen ob ein bestimmtes Modul installiert ist ==<br />
<syntaxhighlight lang="php"><br />
if (!$this->modules->isInstalled('Tasker')) {<br />
$this->message('Tasker module is missing. Install it before using Dataset module.');<br />
return;<br />
}<br />
$this->tasker = $this->modules->get('Tasker');<br />
</syntaxhighlight><br />
<br />
== Selektoren ==<br />
=== Einfacher Selector Check ===<br />
<syntaxhighlight lang="php"><br />
// check the page selector<br />
if (strlen($selector)<2 || !strpos($selector, '=')) {<br />
$this->error("ERROR: invalid page selector '{$selector}' found in the input.");<br />
return false;<br />
}<br />
</syntaxhighlight></div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Module_Snippets&diff=24238ProcessWire - Module Snippets2020-01-06T06:57:14Z<p>84.136.104.26: Die Seite wurde neu angelegt: „Nützliche Snippets für das Schreiben von Modulen == Testen ob ein bestimmtes Modul installiert ist == <syntaxhighlight lang="php"> if (!$this->modules->isIn…“</p>
<hr />
<div>Nützliche Snippets für das Schreiben von Modulen<br />
<br />
== Testen ob ein bestimmtes Modul installiert ist ==<br />
<syntaxhighlight lang="php"><br />
if (!$this->modules->isInstalled('Tasker')) {<br />
$this->message('Tasker module is missing. Install it before using Dataset module.');<br />
return;<br />
}<br />
$this->tasker = $this->modules->get('Tasker');<br />
</syntaxhighlight></div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Module_schreiben&diff=24237ProcessWire - Module schreiben2020-01-06T06:55:00Z<p>84.136.104.26: </p>
<hr />
<div>== Links ==<br />
https://webdesign.tutsplus.com/tutorials/a-beginners-introduction-to-writing-modules-in-processwire--cms-26862<br />
https://processwire.com/api/ref/module/<br />
https://processwire.com/docs/modules/ - Introduction, Development, Hooks, Types, Pro Modules, Third Party<br />
https://processwire.com/docs/modules/development/ - <br />
https://processwire.com/blog/posts/new-module-configuration-options/<br />
https://processwire.com/talk/topic/778-module-dependencies/<br />
http://somatonic.github.io/Captain-Hook/ // Hook Cheatsheet<br />
<br />
[[ProcessWire - Module Snippets]]<br />
<br />
== Wo - Was ? ==<br />
=== Welche Typen von Modulen gibt es ? ===<br />
https://processwire.com/docs/modules/types/<br />
* '''Fieldtype''': Meistens keine Public API, Handelt Daten / Datenbank - https://processwire.com/api/ref/fieldtype/<br />
* '''Inputfield''': Sammelt User Eingaben über Formulare für Felder (Fieldtypes)<br />
* '''Process''' for creating admin processes/applications.<br />
* '''Textformatter''' for formatting text.<br />
* '''AdminTheme''' for creating themes in the admin.<br />
* '''WireMail''' for modules that send email and extend the WireMail class.<br />
* '''Tfa''' for implementing a specific kind of two-factor authentication.<br />
* '''ImageSizerEngine''' for modules that extend ImageSizerEngine for resizing images.<br />
* '''FileCompiler''' for modules that extend FileCompilerModule for compilation of files.<br />
* '''FileValidator''' for modules that extend FileValidatorModule for validation of files.<br />
<br />
=== Wie werden Felder in der Datenbank angelegt ? ===<br />
Dazu nutzt man den Typ "Fieldtype"<br />
=== Wo rendert man die Ausgabe ? ===<br />
Bei Ryan Cramers Event Beispiel legt er zwei Klassen Event und EventArray an, die auch die Render Funktionen enthalten.<br />
<br />
== Beispiele ==<br />
=== Frontend Rendering Module ===<br />
A bit old but working<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
/**<br />
* FrontEndRender<br />
*<br />
* Author: Ben Byford<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2010 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class FrontEndRender extends WireData implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'FrontEndRender',<br />
'version' => 0.1,<br />
'summary' => "Outputs html and static variables to frontend",<br />
'author' => 'Ben Byford',<br />
'singular' => true,<br />
'href' => 'https://github.com/benbyford/PW-starter-modules'<br />
);<br />
}<br />
<br />
// protected variable only accessable within module<br />
protected $name = 'Ben';<br />
<br />
/*<br />
* render function to be called in PW template like this:<br />
* $FrontEndRender = $modules->getModule('FrontEndRender');<br />
* echo '<h1>' . $FrontEndRender->render() . '</h1>';<br />
*<br />
*/<br />
public function render(){<br />
return "Hello " . $this->name;<br />
}<br />
}<br />
?><br />
</syntaxhighlight><br />
<br />
=== ProcessWire Hello World Modul ===<br />
Beispiel Modul mit Hooks (liegt immer in der Standardinstallation)<br />
<syntaxhighlight lang="php"><br />
<?php namespace ProcessWire;<br />
<br />
/**<br />
* ProcessWire 'Hello world' demonstration module<br />
*<br />
* Demonstrates the Module interface and how to add hooks.<br />
* <br />
* See README file for further links regarding module development.<br />
* <br />
* This file is licensed under the MIT license<br />
* https://processwire.com/about/license/mit/<br />
* <br />
* ProcessWire 3.x, Copyright 2016 by Ryan Cramer<br />
* https://processwire.com<br />
*<br />
*/<br />
<br />
class Helloworld extends WireData implements Module {<br />
<br />
/**<br />
* getModuleInfo is a module required by all modules to tell ProcessWire about them<br />
*<br />
* @return array<br />
*<br />
*/<br />
public static function getModuleInfo() {<br />
<br />
return array(<br />
<br />
// The module's title, typically a little more descriptive than the class name<br />
'title' => 'Hello World', <br />
<br />
// version number <br />
'version' => 3, <br />
<br />
// summary is brief description of what this module is<br />
'summary' => 'An example module used for demonstration purposes.',<br />
<br />
// Optional URL to more information about the module<br />
'href' => 'https://processwire.com',<br />
<br />
// singular=true: indicates that only one instance of the module is allowed.<br />
// This is usually what you want for modules that attach hooks. <br />
'singular' => true, <br />
<br />
// autoload=true: indicates the module should be started with ProcessWire.<br />
// This is necessary for any modules that attach runtime hooks, otherwise those<br />
// hooks won't get attached unless some other code calls the module on it's own.<br />
// Note that autoload modules are almost always also 'singular' (seen above).<br />
'autoload' => true, <br />
<br />
// Optional font-awesome icon name, minus the 'fa-' part<br />
'icon' => 'smile-o', <br />
);<br />
}<br />
<br />
/**<br />
* Initialize the module<br />
*<br />
* ProcessWire calls this when the module is loaded. For 'autoload' modules, this will be called<br />
* when ProcessWire's API is ready. As a result, this is a good place to attach hooks. <br />
*<br />
*/<br />
public function init() {<br />
<br />
// add a hook after the $pages->save, to issue a notice every time a page is saved<br />
$this->pages->addHookAfter('save', $this, 'example1'); <br />
<br />
// add a hook after each page is rendered and modify the output<br />
$this->addHookAfter('Page::render', $this, 'example2'); <br />
<br />
// add a 'hello' method to every page that returns "Hello World"<br />
// use "echo $page->hello();" in your template file to display output<br />
$this->addHook('Page::hello', $this, 'example3'); <br />
<br />
// add a 'hello_world' property to every page that returns "Hello [user]"<br />
// use "echo $page->hello_world;" in your template file to display output<br />
$this->addHookProperty('Page::hello_world', $this, 'example4'); <br />
}<br />
<br />
/**<br />
* Example1 hooks into the pages->save method and displays a notice every time a page is saved<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example1($event) {<br />
/** @var Page $page */<br />
$page = $event->arguments[0]; <br />
$this->message("Hello World! You saved {$page->path}."); <br />
}<br />
<br />
<br />
/**<br />
* Example2 hooks into every page after it's rendered and adds "Hello World" text at the bottom<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example2($event) {<br />
<br />
/** @var Page $page */<br />
$page = $event->object; <br />
<br />
// don't add this to the admin pages<br />
if($page->template == 'admin') return;<br />
<br />
// add a "Hello World" paragraph right before the closing body tag<br />
$event->return = str_replace("</body>", "<p>Hello World!</p></body>", $event->return); <br />
}<br />
<br />
/**<br />
* Example3 adds a 'hello' method (not property) to every page that simply returns "Hello World"<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example3($event) {<br />
$event->return = "Hello World";<br />
}<br />
<br />
/**<br />
* Example 4 adds a 'hello_world' property (not method) to every page that returns "Hello [user]"<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example4($event) {<br />
$event->return = "Hello " . $this->user->name; <br />
}<br />
<br />
}<br />
<br />
</syntaxhighlight><br />
<br />
=== ProcessWire Admin Bereich mit eigener Funktionalität erweitern (Modul)===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<syntaxhighlight lang="php"><br />
<br />
<?php<br />
/**<br />
* ProcessSimpleAdminPage<br />
*<br />
* @author Ben Byford<br />
* http://www.benbyford.com<br />
*<br />
* @see http://www.processwire.com<br />
*/<br />
<br />
class ProcessSimpleAdminPage extends Process {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'Process Simple Admin Page',<br />
'summary' => 'Simple Process module that adds new admin page with',<br />
'version' => 001,<br />
<br />
// Modules that extend Process may specify a 'page' attribute in the<br />
// getModuleInfo(), this page will automatically be given the module<br />
// process when added to teh pagetree.<br />
<br />
// I have exampled but commented out the 'page' settings below<br />
// so that I can show how one might add a page to install() and<br />
// uninstall() in this and other modules (that might not extend<br />
// Process)<br />
<br />
<br />
// 'page' => array(<br />
// 'name' => 'site-config',<br />
// 'parent' => 'admin',<br />
// 'title' => 'Site Config'<br />
// )<br />
);<br />
}<br />
<br />
public function execute() {<br />
return '<br />
<h2>Edit the text here in the module</h2><br />
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam mattis eros vitae metus sodales eget suscipit purus rhoncus. Proin ultrices gravida dolor, non porttitor enim interdum vitae. Integer feugiat lacinia tincidunt. Nulla laoreet tristique tristique. Sed elementum justo a nisl elementum sit amet accumsan nisi tempor. Nulla quis eros et massa dignissim imperdiet a vitae purus.</p><br />
<br />
<p>Donec scelerisque pulvinar sem eu lobortis. Maecenas turpis ipsum, tempus dictum pharetra eu, consectetur vitae arcu. Fusce orci mauris, semper at tempus quis, volutpat molestie tellus. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Sed quam tortor, tincidunt sed semper lacinia, scelerisque dapibus quam. Morbi at nisi luctus lacus auctor ultrices eu eu leo.</p><br />
<br />
<p>Praesent faucibus purus id felis tincidunt dignissim. Sed sit amet ligula mi, eget semper dui. Proin consectetur gravida massa, nec luctus purus hendrerit in. Etiam volutpat, elit non venenatis suscipit, libero neque consectetur diam, id rutrum magna odio ac ligula. Maecenas sollicitudin congue neque fermentum vestibulum. Morbi nec leo nisi. Donec at nisl odio, et porta ligula.</p><br />
<br />
<p>Sed quis arcu nisi, ac tempor augue. Praesent non elit libero, a ullamcorper lorem. Curabitur porta odio eu nunc ultricies interdum id nec risus. Donec nibh nibh, porta eget vehicula ac, aliquet eget ante. Phasellus eget lorem eu eros eleifend ultrices. Cras sit amet neque sit amet nibh fringilla cursus ut id mauris. Praesent quis nunc justo, sed suscipit lectus. Phasellus eget ultrices risus. Curabitur eu semper est. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Ut suscipit, nisl ut imperdiet eleifend, turpis arcu placerat tortor, nec laoreet lacus neque ac tellus. Aenean ac lacus justo, quis ultricies nisi.</p><br />
';<br />
}<br />
public function install(){<br />
<br />
// create new page to add to CMS<br />
$page = new Page();<br />
<br />
// add page attributes<br />
$page->template = "admin";<br />
$page->name = "cms-faq";<br />
$page->title = "CMS FAQ";<br />
$page->save();<br />
<br />
// set this module as the page process, this allows us to display the above<br />
$page->process = 'ProcessSimpleAdminPage';<br />
<br />
// get admin page and set as page parent<br />
$admin = $this->pages->get("id=2");<br />
$page->parent = $admin;<br />
<br />
// save page<br />
$page->save();<br />
}<br />
<br />
public function uninstall(){<br />
<br />
// delete created page<br />
$page = $this->pages->get("name=cms-faq");<br />
if(count($page)) $this->pages->delete($page, true);<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
=== ProcessWire Textformatter Modul ===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
/**<br />
* TextformatterFindReplace<br />
*<br />
* Author: Ben Byford<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2010 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class TextformatterFindReplace extends Textformatter implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'TextformatterFindReplace',<br />
'version' => 0.1,<br />
'summary' => "Finds and replaces any instance of config input to config output",<br />
'author' => 'Ben Byford',<br />
'singular' => true,<br />
'href' => 'https://github.com/benbyford/PW-starter-modules'<br />
);<br />
}<br />
<br />
<br />
/**<br />
* Find and Replace the input string<br />
*<br />
* @param string $str The block of text to parse<br />
*<br />
* The incoming string is replaced with the formatted version of itself.<br />
**/<br />
<br />
public function format(&$str) {<br />
$find = $this->findStr;<br />
$str = preg_replace_callback($find, array($this,"replace"), $str);<br />
<br />
}<br />
<br />
// adding three underscores to a function allows other modules to hook it<br />
public function ___replace($match) {<br />
return $this->replaceStr;<br />
}<br />
}<br />
?><br />
</syntaxhighlight><br />
<br />
=== Admin Funktionalität: Countdown zum Seitenveröffentlichen ===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<br />
The module PageDeferredPublish, on clicking one of the Publish Later buttons, sets LazyCron to check that page’s countdown every minute and publishes the page when its countdown reaches 0. This means I can publish a page approximately 24 hours in advance (obviously the checking interval and delay time can be changed to your requirements).<br />
<br />
I did this by:<br />
<br />
Creating two fields within my install() function: a checkbox field to set to true when a button is checked to indicate the page should countdown, and a countdown field to store the count in seconds for that specific page.<br />
Adding hooks to both ProcessPageEdit::buildForm and ProcessPageListActions::getExtraActions enabling me to add the two buttons.<br />
Checking to see if one of the buttons was clicked with my ready() function then setting the corresponding page’s checkbox to true.<br />
Using a LazyCron hook function to check all pages that are unpublished for true checkboxes and then comparing the seconds field to see if the page needs publishing. If not then deduct the elapsed time in seconds.<br />
The result is a module that has settings (the time interval to check and publish at a later time), hooks into the admin using buttons and fields, and enables us to use other modules installed in PW (i.e. LazyCron).<br />
<syntaxhighlight lang="php"><br />
<?php<br />
/**<br />
* DeferredPublish (0.0.1)<br />
* DeferredPublish publishes a page after a defined amount of time has elapsed using lazycron.<br />
*<br />
* @author Ben Byford<br />
* http://www.benbyford.com<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2011 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class PageDeferredPublish extends WireData implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => "PageDeferredPublish",<br />
'version' => "0.0.1",<br />
'summary' => "PageDeferredPublish",<br />
'author' => "Ben Byford",<br />
'href' => "https://github.com/benbyford/PW-intermediate-modules",<br />
'icon' => "clock-o",<br />
'autoload' => true,<br />
'singular' => true,<br />
'requires' => "LazyCron",<br />
);<br />
}<br />
<br />
private $postPubLater = null;<br />
private $pageID = null;<br />
private $pagePubLater = null;<br />
private $currentPage = null;<br />
<br />
private $submitName = 'pdp_pub_later_submit';<br />
private $listPageName = 'pdp_pub_later_list';<br />
private $fieldName = 'pdp_pub_later';<br />
private $checkboxName = 'pdp_pub_later_check';<br />
<br />
private $defaultInterval = 'everyMinute';<br />
private $defaultTime = 86400;<br />
<br />
<br />
public function install(){<br />
// add new fields needed for module<br />
$this->installFields();<br />
}<br />
public function uninstall(){<br />
// uninstall fields<br />
$this->uninstallFields();<br />
}<br />
<br />
// initialize the hook in your AutoLoad module<br />
public function init() {<br />
<br />
// get defaults from module setting in CMS<br />
$this->defaultTime = $this->pub_after;<br />
$this->defaultInterval = $this->cron_check;<br />
<br />
// get admin URL<br />
$this->adminUrl = $this->wire('config')->urls->admin;<br />
<br />
// add hooks to CRON, PageList, PageEdit<br />
$this->addHookAfter("LazyCron::{$this->defaultInterval}", $this, 'publishDefferedPages');<br />
$this->addHook("ProcessPageListActions::getExtraActions", $this, 'hookPageListActions');<br />
$this->addHookAfter("ProcessPageEdit::buildForm", $this, "editForm");<br />
}<br />
<br />
public function ready() {<br />
<br />
// if list button clicked then grab id<br />
$this->pagePubLater = $this->input->get($this->listPageName);<br />
$this->pageID = $this->input->id;<br />
<br />
// get page<br />
$this->currentPage = $this->pages->get($this->pageID);<br />
<br />
// if pagelist pub later submit button clicked<br />
if($this->pagePubLater){<br />
$this->message("Page {$this->currentPage->name} deffered for publish.");<br />
}<br />
<br />
// if page edit submit button clicked<br />
$this->postPubLater = $this->input->post($this->submitName);<br />
if($this->postPubLater){<br />
$this->message("Page {$this->currentPage->name} deffered for publish.");<br />
}<br />
<br />
// if either deffered publish sumbit found then publish page later<br />
if($this->pagePubLater || $this->postPubLater){<br />
$this->publishLater();<br />
}<br />
}<br />
<br />
/*<br />
* Hook: ProcessPageEdit::buildForm<br />
*<br />
* add Publish Later button to edit page if not yet published<br />
*/<br />
public function ___editForm(HookEvent $form) {<br />
<br />
// get the InputFieldForm object from the event (return value of buildForm())<br />
$form = $form->return;<br />
<br />
$page = $this->pages->get($this->input->get->id);<br />
$check = $page->get($this->checkboxName);<br />
<br />
// check if publish button available and therfore unpublished<br />
$target = $form->get('submit_publish');<br />
<br />
if($target && $check == false){<br />
<br />
// get InputfieldText module<br />
$submit2 = $this->modules->get('InputfieldSubmit');<br />
$submit2->attr('name', $this->submitName);<br />
$submit2->attr('id', 'publish_later');<br />
$submit2->attr('class', 'ui-button ui-widget ui-corner-all head_button_clone ui-state-default ui-priority-secondary');<br />
$submit2->attr('value', 'Publish Later'); // Button: save unpublished<br />
<br />
// get form element save and place before<br />
$target = $form->get('submit_save');<br />
$form->insertBefore($submit2, $target);<br />
<br />
$form->return = $form;<br />
}<br />
}<br />
<br />
public function ___hookPageListActions(HookEvent $event) {<br />
<br />
// get current page<br />
$page = $event->arguments[0];<br />
<br />
// check to see if page is published<br />
$pagePub = $page->is(Page::statusUnpublished);<br />
<br />
// check to see if page template has deffered field<br />
$pageHasDefferField = $page->get($this->fieldName);<br />
<br />
$actions = array();<br />
<br />
// don't get homepage or pages that are already published or are being deffered for publish<br />
if($page->id > 1 && $pagePub == "published" && !is_null($pageHasDefferField) && $page->get($this->checkboxName) == false) {<br />
<br />
$actions['publish_later'] = array(<br />
'cn' => 'PublishLater',<br />
'name' => 'pub later',<br />
'url' => "{$this->adminUrl}?{$this->listPageName}=1&id={$page->id}",<br />
);<br />
}<br />
if(count($actions)) $event->return = $actions + $event->return;<br />
}<br />
<br />
/*<br />
* Publish Page on cron job<br />
*<br />
* Gets deffered page and publishes<br />
*/<br />
public function ___publish($page) {<br />
$page->removeStatus(Page::statusUnpublished);<br />
$page->removeStatus(Page::statusHidden);<br />
$page->Save();<br />
}<br />
<br />
/*<br />
* Main publish later function<br />
*<br />
* Gets deffered page and sets fields to be checked be lazy cron<br />
*/<br />
private function ___publishLater() {<br />
<br />
// get page<br />
$page = $this->pages->get($this->pageID);<br />
<br />
// set output formatting to false<br />
$page->of(false);<br />
<br />
// set field time to settings default time and checkbox to true<br />
$page->set($this->checkboxName, true);<br />
$page->set($this->fieldName, $this->defaultTime);<br />
<br />
// save page<br />
$page->save();<br />
$page->of(true);<br />
}<br />
<br />
/*<br />
* Lazy Cron hook function<br />
*<br />
* Triggers every [set time interval] and checks pages<br />
* Publishes page if time runout<br />
*<br />
* Adds publish page log<br />
*/<br />
public function ___publishDefferedPages(HookEvent $e){<br />
<br />
// seconds since last lazycron<br />
$seconds = $e->arguments[0];<br />
<br />
// find all pages with deffered field<br />
$defferedPages = $this->pages->find("{$this->checkboxName}=1,include=unpublished");<br />
<br />
// for each page decrease time for deffered field<br />
foreach ($defferedPages as $page) {<br />
<br />
// get current page time<br />
$timeTillPublish = $page->get($this->fieldName);<br />
<br />
// set time to time minus time past<br />
$timeLeft = $timeTillPublish - $seconds;<br />
<br />
// if time passed 0 or less then publish page<br />
$page->of(false);<br />
if($timeLeft <= 0){<br />
// remove flags and save<br />
$this->publish($page);<br />
<br />
$page->set($this->fieldName, 0);<br />
$page->set($this->checkboxName, 0);<br />
<br />
// log a page has been published<br />
$log = wire('log');<br />
$log->message('CRON:'. $seconds .' Pages: '. $page->name .' published');<br />
}else{<br />
$page->set($this->fieldName, $timeLeft);<br />
}<br />
// save page time<br />
$page->Save();<br />
$page->of(true);<br />
}<br />
}<br />
<br />
/*<br />
* Install new module specific fields<br />
*/<br />
private function installFields(){<br />
<br />
// install pub later checkbox field<br />
// find installed fields<br />
$f = $this->fields->get($this->fieldName);<br />
if($f){<br />
<br />
// if field already found then don't try and make it<br />
$this->message($this->fieldName . ' field found');<br />
<br />
}else{<br />
<br />
// create new field object to store crontime<br />
$f = new Field();<br />
// get a field type<br />
$f->type = $this->modules->get("FieldtypeInteger");<br />
$f->name = $this->fieldName;<br />
$f->label = 'Publish Time Left';<br />
$f->defaultValue = $this->defaultTime;<br />
$f->icon = 'clock-o';<br />
$f->columnWidth = 50;<br />
$f->collapsed = 1;<br />
$f->flags = 4;<br />
<br />
$f->save(); // save the field<br />
<br />
// create new field object to store whether to publish or not<br />
$f = new Field();<br />
// get a field type<br />
$f->type = $this->modules->get("FieldtypeCheckbox");<br />
$f->name = $this->checkboxName;<br />
$f->label = 'Publish Page later';<br />
$f->defaultValue = false;<br />
$f->columnWidth = 50;<br />
$f->icon = 'clock-o';<br />
$f->collapsed = 1;<br />
$f->flags = 4;<br />
<br />
$f->save(); // save the field<br />
}<br />
}<br />
<br />
/*<br />
* Uninstall module specific fields<br />
*/<br />
private function uninstallFields(){<br />
<br />
// find installed fields<br />
$fInt = $this->fields->get($this->fieldName);<br />
$fCheck = $this->fields->get($this->checkboxName);<br />
<br />
if($fInt && $fCheck){<br />
$fieldIntUsed = $fInt->numFieldgroups();<br />
$fieldCheckUsed = $fCheck->numFieldgroups();<br />
<br />
if($fieldIntUsed){<br />
// field in use by template<br />
$this->message('Unable to uninstall field '.$fInt->name);<br />
}else{<br />
// delete installed fields<br />
$this->fields->delete($fInt);<br />
$this->fields->save;<br />
}<br />
<br />
if($fieldCheckUsed){<br />
// field in use by template<br />
$this->message('Unable to uninstall field '.$fCheck->name);<br />
}else{<br />
// delete installed fields<br />
$this->fields->delete($fCheck);<br />
$this->fields->save;<br />
}<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
=== Inputfield / Fieldtype ===<br />
[[ProcessWire - Fieldtype erstellen (Module)]]</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Module_schreiben&diff=24236ProcessWire - Module schreiben2020-01-04T17:04:22Z<p>84.136.104.26: /* Welche Typen von Modulen gibt es ? */</p>
<hr />
<div>== Links ==<br />
https://webdesign.tutsplus.com/tutorials/a-beginners-introduction-to-writing-modules-in-processwire--cms-26862<br />
https://processwire.com/api/ref/module/<br />
https://processwire.com/docs/modules/ - Introduction, Development, Hooks, Types, Pro Modules, Third Party<br />
https://processwire.com/docs/modules/development/ - <br />
https://processwire.com/blog/posts/new-module-configuration-options/<br />
https://processwire.com/talk/topic/778-module-dependencies/<br />
http://somatonic.github.io/Captain-Hook/ // Hook Cheatsheet<br />
<br />
== Wo - Was ? ==<br />
=== Welche Typen von Modulen gibt es ? ===<br />
https://processwire.com/docs/modules/types/<br />
* '''Fieldtype''': Meistens keine Public API, Handelt Daten / Datenbank - https://processwire.com/api/ref/fieldtype/<br />
* '''Inputfield''': Sammelt User Eingaben über Formulare für Felder (Fieldtypes)<br />
* '''Process''' for creating admin processes/applications.<br />
* '''Textformatter''' for formatting text.<br />
* '''AdminTheme''' for creating themes in the admin.<br />
* '''WireMail''' for modules that send email and extend the WireMail class.<br />
* '''Tfa''' for implementing a specific kind of two-factor authentication.<br />
* '''ImageSizerEngine''' for modules that extend ImageSizerEngine for resizing images.<br />
* '''FileCompiler''' for modules that extend FileCompilerModule for compilation of files.<br />
* '''FileValidator''' for modules that extend FileValidatorModule for validation of files.<br />
<br />
=== Wie werden Felder in der Datenbank angelegt ? ===<br />
Dazu nutzt man den Typ "Fieldtype"<br />
=== Wo rendert man die Ausgabe ? ===<br />
Bei Ryan Cramers Event Beispiel legt er zwei Klassen Event und EventArray an, die auch die Render Funktionen enthalten.<br />
<br />
== Beispiele ==<br />
=== Frontend Rendering Module ===<br />
A bit old but working<br />
<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
/**<br />
* FrontEndRender<br />
*<br />
* Author: Ben Byford<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2010 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class FrontEndRender extends WireData implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'FrontEndRender',<br />
'version' => 0.1,<br />
'summary' => "Outputs html and static variables to frontend",<br />
'author' => 'Ben Byford',<br />
'singular' => true,<br />
'href' => 'https://github.com/benbyford/PW-starter-modules'<br />
);<br />
}<br />
<br />
// protected variable only accessable within module<br />
protected $name = 'Ben';<br />
<br />
/*<br />
* render function to be called in PW template like this:<br />
* $FrontEndRender = $modules->getModule('FrontEndRender');<br />
* echo '<h1>' . $FrontEndRender->render() . '</h1>';<br />
*<br />
*/<br />
public function render(){<br />
return "Hello " . $this->name;<br />
}<br />
}<br />
?><br />
</syntaxhighlight><br />
<br />
=== ProcessWire Hello World Modul ===<br />
Beispiel Modul mit Hooks (liegt immer in der Standardinstallation)<br />
<syntaxhighlight lang="php"><br />
<?php namespace ProcessWire;<br />
<br />
/**<br />
* ProcessWire 'Hello world' demonstration module<br />
*<br />
* Demonstrates the Module interface and how to add hooks.<br />
* <br />
* See README file for further links regarding module development.<br />
* <br />
* This file is licensed under the MIT license<br />
* https://processwire.com/about/license/mit/<br />
* <br />
* ProcessWire 3.x, Copyright 2016 by Ryan Cramer<br />
* https://processwire.com<br />
*<br />
*/<br />
<br />
class Helloworld extends WireData implements Module {<br />
<br />
/**<br />
* getModuleInfo is a module required by all modules to tell ProcessWire about them<br />
*<br />
* @return array<br />
*<br />
*/<br />
public static function getModuleInfo() {<br />
<br />
return array(<br />
<br />
// The module's title, typically a little more descriptive than the class name<br />
'title' => 'Hello World', <br />
<br />
// version number <br />
'version' => 3, <br />
<br />
// summary is brief description of what this module is<br />
'summary' => 'An example module used for demonstration purposes.',<br />
<br />
// Optional URL to more information about the module<br />
'href' => 'https://processwire.com',<br />
<br />
// singular=true: indicates that only one instance of the module is allowed.<br />
// This is usually what you want for modules that attach hooks. <br />
'singular' => true, <br />
<br />
// autoload=true: indicates the module should be started with ProcessWire.<br />
// This is necessary for any modules that attach runtime hooks, otherwise those<br />
// hooks won't get attached unless some other code calls the module on it's own.<br />
// Note that autoload modules are almost always also 'singular' (seen above).<br />
'autoload' => true, <br />
<br />
// Optional font-awesome icon name, minus the 'fa-' part<br />
'icon' => 'smile-o', <br />
);<br />
}<br />
<br />
/**<br />
* Initialize the module<br />
*<br />
* ProcessWire calls this when the module is loaded. For 'autoload' modules, this will be called<br />
* when ProcessWire's API is ready. As a result, this is a good place to attach hooks. <br />
*<br />
*/<br />
public function init() {<br />
<br />
// add a hook after the $pages->save, to issue a notice every time a page is saved<br />
$this->pages->addHookAfter('save', $this, 'example1'); <br />
<br />
// add a hook after each page is rendered and modify the output<br />
$this->addHookAfter('Page::render', $this, 'example2'); <br />
<br />
// add a 'hello' method to every page that returns "Hello World"<br />
// use "echo $page->hello();" in your template file to display output<br />
$this->addHook('Page::hello', $this, 'example3'); <br />
<br />
// add a 'hello_world' property to every page that returns "Hello [user]"<br />
// use "echo $page->hello_world;" in your template file to display output<br />
$this->addHookProperty('Page::hello_world', $this, 'example4'); <br />
}<br />
<br />
/**<br />
* Example1 hooks into the pages->save method and displays a notice every time a page is saved<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example1($event) {<br />
/** @var Page $page */<br />
$page = $event->arguments[0]; <br />
$this->message("Hello World! You saved {$page->path}."); <br />
}<br />
<br />
<br />
/**<br />
* Example2 hooks into every page after it's rendered and adds "Hello World" text at the bottom<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example2($event) {<br />
<br />
/** @var Page $page */<br />
$page = $event->object; <br />
<br />
// don't add this to the admin pages<br />
if($page->template == 'admin') return;<br />
<br />
// add a "Hello World" paragraph right before the closing body tag<br />
$event->return = str_replace("</body>", "<p>Hello World!</p></body>", $event->return); <br />
}<br />
<br />
/**<br />
* Example3 adds a 'hello' method (not property) to every page that simply returns "Hello World"<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example3($event) {<br />
$event->return = "Hello World";<br />
}<br />
<br />
/**<br />
* Example 4 adds a 'hello_world' property (not method) to every page that returns "Hello [user]"<br />
* <br />
* @param HookEvent $event<br />
*<br />
*/<br />
public function example4($event) {<br />
$event->return = "Hello " . $this->user->name; <br />
}<br />
<br />
}<br />
<br />
</syntaxhighlight><br />
<br />
=== ProcessWire Admin Bereich mit eigener Funktionalität erweitern (Modul)===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<syntaxhighlight lang="php"><br />
<br />
<?php<br />
/**<br />
* ProcessSimpleAdminPage<br />
*<br />
* @author Ben Byford<br />
* http://www.benbyford.com<br />
*<br />
* @see http://www.processwire.com<br />
*/<br />
<br />
class ProcessSimpleAdminPage extends Process {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'Process Simple Admin Page',<br />
'summary' => 'Simple Process module that adds new admin page with',<br />
'version' => 001,<br />
<br />
// Modules that extend Process may specify a 'page' attribute in the<br />
// getModuleInfo(), this page will automatically be given the module<br />
// process when added to teh pagetree.<br />
<br />
// I have exampled but commented out the 'page' settings below<br />
// so that I can show how one might add a page to install() and<br />
// uninstall() in this and other modules (that might not extend<br />
// Process)<br />
<br />
<br />
// 'page' => array(<br />
// 'name' => 'site-config',<br />
// 'parent' => 'admin',<br />
// 'title' => 'Site Config'<br />
// )<br />
);<br />
}<br />
<br />
public function execute() {<br />
return '<br />
<h2>Edit the text here in the module</h2><br />
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam mattis eros vitae metus sodales eget suscipit purus rhoncus. Proin ultrices gravida dolor, non porttitor enim interdum vitae. Integer feugiat lacinia tincidunt. Nulla laoreet tristique tristique. Sed elementum justo a nisl elementum sit amet accumsan nisi tempor. Nulla quis eros et massa dignissim imperdiet a vitae purus.</p><br />
<br />
<p>Donec scelerisque pulvinar sem eu lobortis. Maecenas turpis ipsum, tempus dictum pharetra eu, consectetur vitae arcu. Fusce orci mauris, semper at tempus quis, volutpat molestie tellus. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Sed quam tortor, tincidunt sed semper lacinia, scelerisque dapibus quam. Morbi at nisi luctus lacus auctor ultrices eu eu leo.</p><br />
<br />
<p>Praesent faucibus purus id felis tincidunt dignissim. Sed sit amet ligula mi, eget semper dui. Proin consectetur gravida massa, nec luctus purus hendrerit in. Etiam volutpat, elit non venenatis suscipit, libero neque consectetur diam, id rutrum magna odio ac ligula. Maecenas sollicitudin congue neque fermentum vestibulum. Morbi nec leo nisi. Donec at nisl odio, et porta ligula.</p><br />
<br />
<p>Sed quis arcu nisi, ac tempor augue. Praesent non elit libero, a ullamcorper lorem. Curabitur porta odio eu nunc ultricies interdum id nec risus. Donec nibh nibh, porta eget vehicula ac, aliquet eget ante. Phasellus eget lorem eu eros eleifend ultrices. Cras sit amet neque sit amet nibh fringilla cursus ut id mauris. Praesent quis nunc justo, sed suscipit lectus. Phasellus eget ultrices risus. Curabitur eu semper est. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Ut suscipit, nisl ut imperdiet eleifend, turpis arcu placerat tortor, nec laoreet lacus neque ac tellus. Aenean ac lacus justo, quis ultricies nisi.</p><br />
';<br />
}<br />
public function install(){<br />
<br />
// create new page to add to CMS<br />
$page = new Page();<br />
<br />
// add page attributes<br />
$page->template = "admin";<br />
$page->name = "cms-faq";<br />
$page->title = "CMS FAQ";<br />
$page->save();<br />
<br />
// set this module as the page process, this allows us to display the above<br />
$page->process = 'ProcessSimpleAdminPage';<br />
<br />
// get admin page and set as page parent<br />
$admin = $this->pages->get("id=2");<br />
$page->parent = $admin;<br />
<br />
// save page<br />
$page->save();<br />
}<br />
<br />
public function uninstall(){<br />
<br />
// delete created page<br />
$page = $this->pages->get("name=cms-faq");<br />
if(count($page)) $this->pages->delete($page, true);<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
=== ProcessWire Textformatter Modul ===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<syntaxhighlight lang="php"><br />
<?php<br />
<br />
/**<br />
* TextformatterFindReplace<br />
*<br />
* Author: Ben Byford<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2010 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class TextformatterFindReplace extends Textformatter implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => 'TextformatterFindReplace',<br />
'version' => 0.1,<br />
'summary' => "Finds and replaces any instance of config input to config output",<br />
'author' => 'Ben Byford',<br />
'singular' => true,<br />
'href' => 'https://github.com/benbyford/PW-starter-modules'<br />
);<br />
}<br />
<br />
<br />
/**<br />
* Find and Replace the input string<br />
*<br />
* @param string $str The block of text to parse<br />
*<br />
* The incoming string is replaced with the formatted version of itself.<br />
**/<br />
<br />
public function format(&$str) {<br />
$find = $this->findStr;<br />
$str = preg_replace_callback($find, array($this,"replace"), $str);<br />
<br />
}<br />
<br />
// adding three underscores to a function allows other modules to hook it<br />
public function ___replace($match) {<br />
return $this->replaceStr;<br />
}<br />
}<br />
?><br />
</syntaxhighlight><br />
<br />
=== Admin Funktionalität: Countdown zum Seitenveröffentlichen ===<br />
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863<br />
<br />
The module PageDeferredPublish, on clicking one of the Publish Later buttons, sets LazyCron to check that page’s countdown every minute and publishes the page when its countdown reaches 0. This means I can publish a page approximately 24 hours in advance (obviously the checking interval and delay time can be changed to your requirements).<br />
<br />
I did this by:<br />
<br />
Creating two fields within my install() function: a checkbox field to set to true when a button is checked to indicate the page should countdown, and a countdown field to store the count in seconds for that specific page.<br />
Adding hooks to both ProcessPageEdit::buildForm and ProcessPageListActions::getExtraActions enabling me to add the two buttons.<br />
Checking to see if one of the buttons was clicked with my ready() function then setting the corresponding page’s checkbox to true.<br />
Using a LazyCron hook function to check all pages that are unpublished for true checkboxes and then comparing the seconds field to see if the page needs publishing. If not then deduct the elapsed time in seconds.<br />
The result is a module that has settings (the time interval to check and publish at a later time), hooks into the admin using buttons and fields, and enables us to use other modules installed in PW (i.e. LazyCron).<br />
<syntaxhighlight lang="php"><br />
<?php<br />
/**<br />
* DeferredPublish (0.0.1)<br />
* DeferredPublish publishes a page after a defined amount of time has elapsed using lazycron.<br />
*<br />
* @author Ben Byford<br />
* http://www.benbyford.com<br />
*<br />
* ProcessWire 2.x<br />
* Copyright (C) 2011 by Ryan Cramer<br />
* Licensed under GNU/GPL v2, see LICENSE.TXT<br />
*<br />
* http://www.processwire.com<br />
* http://www.ryancramer.com<br />
*<br />
*/<br />
<br />
class PageDeferredPublish extends WireData implements Module {<br />
<br />
public static function getModuleInfo() {<br />
return array(<br />
'title' => "PageDeferredPublish",<br />
'version' => "0.0.1",<br />
'summary' => "PageDeferredPublish",<br />
'author' => "Ben Byford",<br />
'href' => "https://github.com/benbyford/PW-intermediate-modules",<br />
'icon' => "clock-o",<br />
'autoload' => true,<br />
'singular' => true,<br />
'requires' => "LazyCron",<br />
);<br />
}<br />
<br />
private $postPubLater = null;<br />
private $pageID = null;<br />
private $pagePubLater = null;<br />
private $currentPage = null;<br />
<br />
private $submitName = 'pdp_pub_later_submit';<br />
private $listPageName = 'pdp_pub_later_list';<br />
private $fieldName = 'pdp_pub_later';<br />
private $checkboxName = 'pdp_pub_later_check';<br />
<br />
private $defaultInterval = 'everyMinute';<br />
private $defaultTime = 86400;<br />
<br />
<br />
public function install(){<br />
// add new fields needed for module<br />
$this->installFields();<br />
}<br />
public function uninstall(){<br />
// uninstall fields<br />
$this->uninstallFields();<br />
}<br />
<br />
// initialize the hook in your AutoLoad module<br />
public function init() {<br />
<br />
// get defaults from module setting in CMS<br />
$this->defaultTime = $this->pub_after;<br />
$this->defaultInterval = $this->cron_check;<br />
<br />
// get admin URL<br />
$this->adminUrl = $this->wire('config')->urls->admin;<br />
<br />
// add hooks to CRON, PageList, PageEdit<br />
$this->addHookAfter("LazyCron::{$this->defaultInterval}", $this, 'publishDefferedPages');<br />
$this->addHook("ProcessPageListActions::getExtraActions", $this, 'hookPageListActions');<br />
$this->addHookAfter("ProcessPageEdit::buildForm", $this, "editForm");<br />
}<br />
<br />
public function ready() {<br />
<br />
// if list button clicked then grab id<br />
$this->pagePubLater = $this->input->get($this->listPageName);<br />
$this->pageID = $this->input->id;<br />
<br />
// get page<br />
$this->currentPage = $this->pages->get($this->pageID);<br />
<br />
// if pagelist pub later submit button clicked<br />
if($this->pagePubLater){<br />
$this->message("Page {$this->currentPage->name} deffered for publish.");<br />
}<br />
<br />
// if page edit submit button clicked<br />
$this->postPubLater = $this->input->post($this->submitName);<br />
if($this->postPubLater){<br />
$this->message("Page {$this->currentPage->name} deffered for publish.");<br />
}<br />
<br />
// if either deffered publish sumbit found then publish page later<br />
if($this->pagePubLater || $this->postPubLater){<br />
$this->publishLater();<br />
}<br />
}<br />
<br />
/*<br />
* Hook: ProcessPageEdit::buildForm<br />
*<br />
* add Publish Later button to edit page if not yet published<br />
*/<br />
public function ___editForm(HookEvent $form) {<br />
<br />
// get the InputFieldForm object from the event (return value of buildForm())<br />
$form = $form->return;<br />
<br />
$page = $this->pages->get($this->input->get->id);<br />
$check = $page->get($this->checkboxName);<br />
<br />
// check if publish button available and therfore unpublished<br />
$target = $form->get('submit_publish');<br />
<br />
if($target && $check == false){<br />
<br />
// get InputfieldText module<br />
$submit2 = $this->modules->get('InputfieldSubmit');<br />
$submit2->attr('name', $this->submitName);<br />
$submit2->attr('id', 'publish_later');<br />
$submit2->attr('class', 'ui-button ui-widget ui-corner-all head_button_clone ui-state-default ui-priority-secondary');<br />
$submit2->attr('value', 'Publish Later'); // Button: save unpublished<br />
<br />
// get form element save and place before<br />
$target = $form->get('submit_save');<br />
$form->insertBefore($submit2, $target);<br />
<br />
$form->return = $form;<br />
}<br />
}<br />
<br />
public function ___hookPageListActions(HookEvent $event) {<br />
<br />
// get current page<br />
$page = $event->arguments[0];<br />
<br />
// check to see if page is published<br />
$pagePub = $page->is(Page::statusUnpublished);<br />
<br />
// check to see if page template has deffered field<br />
$pageHasDefferField = $page->get($this->fieldName);<br />
<br />
$actions = array();<br />
<br />
// don't get homepage or pages that are already published or are being deffered for publish<br />
if($page->id > 1 && $pagePub == "published" && !is_null($pageHasDefferField) && $page->get($this->checkboxName) == false) {<br />
<br />
$actions['publish_later'] = array(<br />
'cn' => 'PublishLater',<br />
'name' => 'pub later',<br />
'url' => "{$this->adminUrl}?{$this->listPageName}=1&id={$page->id}",<br />
);<br />
}<br />
if(count($actions)) $event->return = $actions + $event->return;<br />
}<br />
<br />
/*<br />
* Publish Page on cron job<br />
*<br />
* Gets deffered page and publishes<br />
*/<br />
public function ___publish($page) {<br />
$page->removeStatus(Page::statusUnpublished);<br />
$page->removeStatus(Page::statusHidden);<br />
$page->Save();<br />
}<br />
<br />
/*<br />
* Main publish later function<br />
*<br />
* Gets deffered page and sets fields to be checked be lazy cron<br />
*/<br />
private function ___publishLater() {<br />
<br />
// get page<br />
$page = $this->pages->get($this->pageID);<br />
<br />
// set output formatting to false<br />
$page->of(false);<br />
<br />
// set field time to settings default time and checkbox to true<br />
$page->set($this->checkboxName, true);<br />
$page->set($this->fieldName, $this->defaultTime);<br />
<br />
// save page<br />
$page->save();<br />
$page->of(true);<br />
}<br />
<br />
/*<br />
* Lazy Cron hook function<br />
*<br />
* Triggers every [set time interval] and checks pages<br />
* Publishes page if time runout<br />
*<br />
* Adds publish page log<br />
*/<br />
public function ___publishDefferedPages(HookEvent $e){<br />
<br />
// seconds since last lazycron<br />
$seconds = $e->arguments[0];<br />
<br />
// find all pages with deffered field<br />
$defferedPages = $this->pages->find("{$this->checkboxName}=1,include=unpublished");<br />
<br />
// for each page decrease time for deffered field<br />
foreach ($defferedPages as $page) {<br />
<br />
// get current page time<br />
$timeTillPublish = $page->get($this->fieldName);<br />
<br />
// set time to time minus time past<br />
$timeLeft = $timeTillPublish - $seconds;<br />
<br />
// if time passed 0 or less then publish page<br />
$page->of(false);<br />
if($timeLeft <= 0){<br />
// remove flags and save<br />
$this->publish($page);<br />
<br />
$page->set($this->fieldName, 0);<br />
$page->set($this->checkboxName, 0);<br />
<br />
// log a page has been published<br />
$log = wire('log');<br />
$log->message('CRON:'. $seconds .' Pages: '. $page->name .' published');<br />
}else{<br />
$page->set($this->fieldName, $timeLeft);<br />
}<br />
// save page time<br />
$page->Save();<br />
$page->of(true);<br />
}<br />
}<br />
<br />
/*<br />
* Install new module specific fields<br />
*/<br />
private function installFields(){<br />
<br />
// install pub later checkbox field<br />
// find installed fields<br />
$f = $this->fields->get($this->fieldName);<br />
if($f){<br />
<br />
// if field already found then don't try and make it<br />
$this->message($this->fieldName . ' field found');<br />
<br />
}else{<br />
<br />
// create new field object to store crontime<br />
$f = new Field();<br />
// get a field type<br />
$f->type = $this->modules->get("FieldtypeInteger");<br />
$f->name = $this->fieldName;<br />
$f->label = 'Publish Time Left';<br />
$f->defaultValue = $this->defaultTime;<br />
$f->icon = 'clock-o';<br />
$f->columnWidth = 50;<br />
$f->collapsed = 1;<br />
$f->flags = 4;<br />
<br />
$f->save(); // save the field<br />
<br />
// create new field object to store whether to publish or not<br />
$f = new Field();<br />
// get a field type<br />
$f->type = $this->modules->get("FieldtypeCheckbox");<br />
$f->name = $this->checkboxName;<br />
$f->label = 'Publish Page later';<br />
$f->defaultValue = false;<br />
$f->columnWidth = 50;<br />
$f->icon = 'clock-o';<br />
$f->collapsed = 1;<br />
$f->flags = 4;<br />
<br />
$f->save(); // save the field<br />
}<br />
}<br />
<br />
/*<br />
* Uninstall module specific fields<br />
*/<br />
private function uninstallFields(){<br />
<br />
// find installed fields<br />
$fInt = $this->fields->get($this->fieldName);<br />
$fCheck = $this->fields->get($this->checkboxName);<br />
<br />
if($fInt && $fCheck){<br />
$fieldIntUsed = $fInt->numFieldgroups();<br />
$fieldCheckUsed = $fCheck->numFieldgroups();<br />
<br />
if($fieldIntUsed){<br />
// field in use by template<br />
$this->message('Unable to uninstall field '.$fInt->name);<br />
}else{<br />
// delete installed fields<br />
$this->fields->delete($fInt);<br />
$this->fields->save;<br />
}<br />
<br />
if($fieldCheckUsed){<br />
// field in use by template<br />
$this->message('Unable to uninstall field '.$fCheck->name);<br />
}else{<br />
// delete installed fields<br />
$this->fields->delete($fCheck);<br />
$this->fields->save;<br />
}<br />
}<br />
}<br />
}<br />
</syntaxhighlight><br />
=== Inputfield / Fieldtype ===<br />
[[ProcessWire - Fieldtype erstellen (Module)]]</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=Processwire_-_Writing_Modules&diff=24235Processwire - Writing Modules2020-01-04T17:00:02Z<p>84.136.104.26: </p>
<hr />
<div>Siehe<br />
[[ProcessWire - Module schreiben]]</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Scheduler&diff=24234ProcessWire - Scheduler2020-01-04T16:45:53Z<p>84.136.104.26: </p>
<hr />
<div>Cronjobs / Scheduler für ProcessWire<br />
<br />
== Module ==<br />
=== LazyCron ===<br />
https://processwire.com/talk/topic/5403-cron-job-for-processwire-mailer-template/<br />
https://processwire.com/docs/more/lazy-cron/<br />
<br />
== Tipps im Zusammenhang ==<br />
=== Seitenaufruf triggern ===<br />
Man kann Seiten so bauen, dass sie beim Aufruf Aktionen ausführen. Um die Seitenaufrufe ohne Browser durchzuführen kann man so etwas machen:<br />
<br />
Ah, ok. You may also try to create a simple php script somewhere outside of pw with this content:<br />
<br />
header("location: http://www.your-site.com/page-url-with-mail-script/");<br />
<br />
or with this one:<br />
<br />
file_get_contents("http://www.your-site.com/page-url-with-mail-script/");<br />
<br />
and call that with your cronjob.<br />
<br />
== Tasker ==<br />
Modul für lang andauernde Jobs<br />
https://modules.processwire.com/modules/tasker/<br />
https://github.com/mtwebit/Tasker/wiki/How-to-use-Tasker<br />
https://processwire.com/talk/topic/17708-tasker/</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=Linux_-_Cronjobs&diff=24233Linux - Cronjobs2020-01-04T16:42:20Z<p>84.136.104.26: </p>
<hr />
<div>== Links ==<br />
http://www.debian-administration.org/articles/56<br />
<br />
<br />
<br />
== Cronjobs / Crontab ==<br />
<br />
Cronjobs sind Aufgaben, die regelmäßig zu einer bestimmten Zeit ausgeführt werden.<br />
Das können z.B. Serverstatistiken sein, die man jede Nacht generieren möchte.<br />
<br />
Anzeigen kann man die Liste der Cronjobs, des aktuellen Benutzers, mit dem Befehl:<br />
<br />
crontab -l<br />
<br />
Alle Cronjobs aller Benutzer anzeigen geht mit einem Trick:<br />
for user in $(cut -f1 -d: /etc/passwd); do echo $user; crontab -u $user -l; <br />
done<br />
<br />
Editieren kann man die Liste mit:<br />
<br />
crontab -e<br />
<br />
Nun wird die Liste der Cronjobs mit dem Standardeditor (in der Regel vim) geöffnet.<br />
<br />
Hier stehen nun Zeilen dirn, die in etwa, wie die folgende aussehen:<br />
<br />
<pre><br />
0 */6 * * * /usr/local/confixx/runwebalizer.sh 2>/dev/null >/dev/null<br />
0 20 * * * /srv/scripts/backup.sh 2>&1 | /usr/global/bin/cmail -s "Mail-Subject" mail@admin.de<br />
1 3 * * * /srv/scripts/backup.sh<br />
</pre><br />
<br />
Die ersten 5 Stellen sind Zahlen, die durch Leerzeichen, oder Tabs getrennt werden dürfen.<br />
Dabei stehen die Zahlen der Reihenfolge nach für:<br />
<br />
Die Minute zu der das Script ausgeführt werden soll (0-59),<br />
<br />
Die Stunde (0-23),<br />
<br />
Den Tag (1-31),<br />
<br />
Den Monat (1-12),<br />
<br />
Den Wochentag (0-6 wobei 0=Sonntag).<br />
<br />
Ein * steht jeweils für 'jeden'.<br />
1 3 * * * <br />
<br />
würde also bedeuten: Jeden Tag um 3.01 Uhr<br />
*/6 <br />
<br />
bedeutet: "Wenn die Zahl durch 6 teilbar ist", also alle 6 Stunden/Minute, ...<br />
0 */6 * * * <br />
<br />
würde bedeuten jede 6 Stunden und 0 Minuten, also jeden Tag um 0.00, um 6.00, um 12.00 und um 18.00.<br />
<br />
Man kann mehrere Zahlen auch durch Komata trennen:<br />
7 1,2,5 * * * würde jeden Tag um 1:07, um 2:07 und um 5:07 ausgeführt werden.<br />
<br />
Auch - (bis) ist Möglich<br />
0 0 * * 1-5 würde jeden Wochentag um 0.00 ausgeführt werden.<br />
<br />
Nach dieser Zeitangabe folgt das Komando, dass zu den zuvor festgelegten Zeiten ausgeführt werden soll.<br />
z.B.: Das Script /srv/scripts/backup.sh aufrufen, welches z.B. wichtige Dateien sichert. <br />
<br />
Quelle: http://www.orgapage.net/pages/server/linux/cronjobs.php (1.10.2009)<br />
<br />
== Cronjobs auf all-inkl Server ==<br />
Manche Provider erlauben keinen direkten Zugriff auf Crontab. All-inkl erlaubt seit Mitte 2010 das zeitgesteuerte Ausführen von php Skripten.<br />
Tools -> Cronjobs -> Cronjobs <br />
Neuen Cronjob anlegen und dann die auszuführende Datei angeben (vollständige url)<br />
<br />
=== Geschütztes cron Verzeichnis ===<br />
Die Skripte kann man z.B. in ein Webverzeichnis cron/ legen, und dieses dann über .htaccess schützen. <br />
=== Endung phpx ===<br />
Skripte benennt man mit der Endung phpx das umgeht (ungetestet) die Zeitbeschränkung von php. Eventuell kann auch das Ausführen über exec das Timeout Problem umgehen.<br />
<br />
=== Aufruf über exec ===<br />
Der php Interpreter kann auch direkt über das exec Kommando aufgerufen werden. Siehe Typo3 Beispiel.<br />
<br />
=== Kontroll E-Mail ===<br />
Ausgaben des Skriptes werden in eine Mail geschrieben, wenn eine Kontroll-Adresse angegeben ist.<br />
<br />
<br />
=== Beispiel: Cronjob für Direct Mail Versand in Typo3 auf all-inkl Server ===<br />
Wenn PHP so konfiguriert ist, daß man das exec (oder auch einige andere) Kommandos ausführen kann, so ist es möglich dennoch Cronjobs auszuführen. Auch das Anfahren des Command Line Interface in Typo3 ist darüber möglich.<br />
<br />
Eine Anfrage bei all-inkl ergab folgendes:<br />
<br />
<Zitat Anfang><br />
<br />
...direkte Shell Befehle können Sie im KAS nicht eingeben. Bitte erstellen Sie sich dazu ein PHP Script mit der '''Endung .phpx''' und folgendem Inhalt:...<br />
<pre><br />
<?php<br />
exec("php /www/htdocs/w00c43b9/typo3/cli_dispatch.phpsh direct_mail masssend",$ausgabe);<br />
echo "&lt;pre&gt;";<br />
print_r($ausgabe);<br />
echo "&lt;/pre&gt;";<br />
?><br />
</pre><br />
Geben Sie dann die HTTP Adresse zu diesem Script im KAS an. Den gewünschten Zeitintervall für die Ausführung können Sie dann auch im KAS mit angeben.<br />
<br />
<Zitat Ende><br />
<br />
Den absoluten Pfad zum Skript bekommt man über die Funktion phpinfo. <br />
<br />
<br />
=== Beispiel mit Geschützter phpx Datei ===<br />
Man sollte das Skript evtl. vor dem Zugriff von außen schützen. Dazu kann man ein Verzeichnis (z.B. cron) anlegen und dies über htaccess (oder direkt im all-inkl kas mit Passwort schützen)<br />
<br />
<br />
Die Server sind scheinbar so konfiguriert, daß ein Skript mit der Endung phpx direkt über den statischen php-interpreter ausgeführt wird. Damit sollten auch Timeout Probleme kein Problem darstellen.<br />
<br />
== Cronjobs auf dem Mac ==<br />
http://www.apfelwiki.de/Main/CRON<br />
Seit Mac OS X 10.4 werden die periodic-Skripte nicht mehr über cron, sondern mittels launchd ausgeführt.<br />
http://www.apfelwiki.de/Main/Launchd</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire&diff=24232ProcessWire2020-01-04T16:10:25Z<p>84.136.104.26: </p>
<hr />
<div>== ProcessWire CMS ==<br />
== Einsatz ==<br />
* bei gehobenen Anforderungen an eine exzellente Programmierbarkeit, optimierte Datenverwaltung und Schnelligkeit<br />
* Sparsamer Code im Frontend (Verzicht auf Pagebuilder: man kann genau steuern, welcher HTML-Code ausgegeben wird)<br />
* wenn Sicherheit des Gesamtsystems eine sehr hohe Priorität hat<br />
* bei speziellen Wünschen an Funktion und Design unter Inkaufnahme eines gewissen Programmieraufwands<br />
* bei größeren Editoren-Teams mit wechselnden Mitarbeitern (Sie profitieren von geringen Einarbeitungszeiten und einer guten Beschränkung und Kontrolle aller Eingaben)<br />
<br />
== Argumente ==<br />
=== Für Entwickler ===<br />
'''Flexibilität'''<br />
<br />
ProcessWire wird genau so programmiert, wie es das Konzept und gewünschte Layout vorsieht. Der Einsatz von komplexen Templates von Drittanbietern, die den Rahmen des gestalterisch Möglichen vorgeben, ist nicht notwendig. ProcessWire ist nicht nur ein CMS, sondern eine kleine, moderne und sehr elegante Programmierumgebung (PHP-Framework). Damit kann man benötigte Elemente gut selbst programmieren (100% genau so wie man es braucht) und ist nicht auf vorgefertigte Modulen und deren Möglichkeiten beschränkt.<br />
<br />
'''Schnell'''<br />
<br />
Das schlanke Programmdesign und übersichtliche Datenbankdesign ermöglichen schnell ladende und schlanke Webseiten ohne Code-Ballast. Das moderne Cachesystem (Zwischenspeicher) bringt weitere Geschwindigkeit.<br />
<br />
'''Sicherheit'''<br />
<br />
Soweit uns bekannt ist, wurde ProcessWire bisher noch nie erfolgreich gehackt. (100% Schutz gibt es im Internet allerdings nie.)<br />
<br />
'''International'''<br />
<br />
Beherrscht eine echte Mehrsprachigkeit im Frontend perfekt out-of-the-box. Einfacher und übersichtlicher geht’s nicht.<br />
<br />
'''Skalierbarkeit'''<br />
<br />
Auch sehr große Systeme mit vielen Daten und mehreren Domains sind für ProcessWire kein Problem. Beispiele aus der Praxis belegen uns dies eindrucksvoll.<br />
<br />
'''Gute Programmierbarkeit'''<br />
<br />
Das System (Core) hinter ProcessWire ist durchdacht, anpassbar und ausgefeilt. Programmieraufgaben in Teams werden erleichtert und die Entwicklungszeiten verkürzt. Das System ist wenig komplex, einfach anzupassen und zu warten, also sicher und aktuell zu halten.<br />
<br />
'''Datenverwaltung''' <br />
<br />
Eine ProcessWire Seite kann beliebig viele Inhaltsbereiche (Datenfelder) mit unterschiedlichen Eigenschaften haben. Es kann genau festgelegt werden, welche Inhalte diese haben dürfen, wo und wie diese verwendet und dargestellt werden. Das Endresultat ist damit sehr gut plan- und steuerbar.<br />
<br />
'''Contentausgabe'''<br />
<br />
Die mögliche softwaregestützte Datenaufbereitung ist eine der großen Stärken dieses Systems. Bis ins kleinste Detail kann programmiert werden, wie Menus und Inhalte automatisiert oder manuell zusammengestellt, gefiltert, sortiert, ausgegeben und dargestellt werden, welche SEO-Features man benötigt und wie diese eingesetzt werden.<br />
<br />
'''Dokumentation'''<br />
<br />
Vieles in ProcessWire ist nach einer sehr kurzen Einarbeitungszeit selbsterklärend, besonders, wenn man das von jQuery übernommene Programmierprinzip bereits kennt. In einem, von einer sehr freundlichen, hilfsbereiten Community betriebenem Internetforum gibt es zu fast allen Fragen versierte Anwtorten. Es ist immer wieder verblüffend, was andere User mit ProcessWire machen und wie sie arbeiten.<br />
<br />
=== Für Designer und Kunden ===<br />
<br />
'''Designfreiheit'''<br />
<br />
Unabhängigkeit von vorgefertigten Design-Templates und -Add-ons und deren Möglichkeiten und Einschränkungen. Der Designer hat die volle Kontrolle über wirklich alle Aspekte des Layouts. Das Template-System ist einfach anzuwenden und bleibt dadurch übersichtlich: Designaufaben können präzise gelöst werden. Wollen das tolle neue Design-Feature, was Sie irgendwo gesehen haben? Das lässt sich einbauen, ohne auf Fremdmodule warten zu müssen.<br />
<br />
'''International'''<br />
<br />
Mehrsprachige Websites sind sehr einfach zu verwalten.<br />
<br />
'''Rechtevergabe'''<br />
<br />
Rechte können sehr genau eingestellt werden. Es können sogar Benutzerrechte für einzelne Felder festlegt werden und dort, welche Art von Inhalten erlaubt ist oder welche enthaltene Sprache bearbeitet werden darf. Das schützt die Software wirkungsvoll for Falscheingaben und ist besonders in Teams mit wechselnden oder ungeschulten Mitarbeitern sehr hilfreich.<br />
<br />
'''Perfekte Verwaltung'''<br />
<br />
Der Admin-Bereich kann anwendungsbezogen nach den Bedürfnissen der Redakteure genau geplant und aufgebaut werden und damit auch komplexe Sachverhalte einfach und übersichtlich verwaltbar machen. Eingabebereiche sind meist selbsterklärend und genaue Vorgaben für die einzelnen Bereiche schützen den Bearbeiter. Er muss keine Angst haben, Layouts durch Fehleingaben zu zerschießen.<br />
<br />
'''Pflegeleicht'''<br />
<br />
Geringe Wartungskosten. Auch wenn ProcessWire als ein sehr sicheres CMS gilt, ist es ratsam, die Software, Module und Templates aktuell zu halten und auch gute Backups nicht zu vergessen. Hierfür bieten wir günstige Service-Verträge.<br />
<br />
== Versionshinweise ==<br />
https://processwire.com/blog/posts/pw-3.0.148-master/</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_N%C3%BCtzliche_Module&diff=24231ProcessWire - Nützliche Module2020-01-04T16:09:38Z<p>84.136.104.26: /* Bedienungshilfen / Backend */</p>
<hr />
<div>Dies ist keine vollständige Liste aber mal eine kleine Hilfe auch um Kunden Module anbieten zu können...<br />
* Cool<br />
** Sehr Hilfreich - Killerfeatures für Kunden<br />
*** Musthave Ohne geht's nicht<br />
== Development ==<br />
* '''ProcessAdminActions''' *** - Musthave bei komplexen Projekten. Kann viele Dinge als Batch erledigen und spart unendlich Zeit.<br />
* '''GithubConnect'''<br />
* '''ConnectPageFields''' 2 Wege Verbindung für Datenfelder. Kein richtiges m:n, hält aber die Felder synchron<br />
<br />
=== Debugging ===<br />
* '''TracyDebugger''' *** - für programmierlastige Projekte das Debugger Tool der Wahl<br />
<br />
=== Daten Im- / Exportieren ===<br />
* '''ImportPagesCSV''' *** - Importiert CSV Daten als Seiten in ProcessWire<br />
* '''TableCsvImportExport''' - Importiert CSV Daten in Table Fields<br />
* '''[[DataSet - ProcessWire Modul|DataSet]]''' - Importiert CSV und XML Daten. Config-Datei für Anweisungen. Kann mit Tasker auch als Cronjob laufen. Für große Datenssätze. https://github.com/mtwebit/DataSet<br />
<br />
== Administration / Verwaltung ==<br />
* '''AdminRestrictBranch''' - Redakteure auf einen Seitenzweig beschränken<br />
* '''ModulesManager''' - Zugriff auf das offizielle Modulverzeichnis aus dem Backend heraus<br />
* '''PageReferencesTab''' - Seitenverwaltung "Welche Seiten verweisen auf diese mittels PageReference Field"<br />
* '''EmailNewUser''' - User über seinen Account Informieren. Nutzen mit '''PasswordForceChange'''<br />
* '''ProcessWireUpgrade''' ** - Informiert über Upgrades - nützlich wenn man Updates als kostnpfl. Service anbieten möchte<br />
* '''ProcessJumplinks''' * - Redirects verwalten<br />
* '''PageRenameOptions''' - Ändert den Seitennamen bei Änderung des Titels. Am besten mit PagePathHistory verwenden wg. broken Links.<br />
* '''RestrictRepeaterMatrix''' Zugriff auf Repeater Matrix Felder regulieren [[RestrictRepeaterMatrix (ProcessWire Modul)]]<br />
* '''TemplatesChildPages''' Zugriff auf Kindseiten einschränken - erweitert Zugriffsregeln auf Seitenbasis, statt nur auf Templatebasis<br />
* '''CronjobDatabaseBackup''' Automatische Datenbank Backups - nutzt LazyCron<br />
<br />
== Navigation / Menüs ==<br />
* '''ProcessMenuBuilder''' - Manuelle Custom Menu Erstellung - sinnvoll bei sehr individuellen Navigationen. <br />
<br />
== Hilfe für Redakteure ==<br />
* '''AssistedURL''' - Linkhilfe Adrians Fork ist oft weiter (https://github.com/adrianbj/processwire-fieldtype-assisted-url)<br />
* '''PrevNextTabs''' - Abkürzung zur nächsten / vorigen Seite im Backend. Sinnvoll wenn viele Seiten bearbeitet werden müssen.<br />
* '''CkeLinkFiles''' - Dateilinks leichter im Editor einfügen<br />
* '''SchedulePages''' - Seiten auf Termin veröffentlichen<br />
<br />
== Sicherheit und Recht ==<br />
* '''EmailObfuscation''' **<br />
* '''MarkupCookieConsent'''<br />
* '''CookieManagementBanner''' - von Adrian<br />
<br />
== Bedienungshilfen / Backend / Fieldtypes==<br />
* '''AssistedUrl'''<br />
* '''MinimalFieldset''' - läßt flexiblere Gestaltung der Felder im Backend zu.<br />
* '''PageListSelectMultipleQuickly''' Mehrere Seiten auwählen ohne jedesmal den Baum neu zu öffnen<br />
* '''PageFieldInfo''' - zusätzliche Infos bei Page Select Checkboxen anzeigen (bei hover und wenn gecheckt)<br />
* '''FieldtypeTime''' - Feld zum Speichern von Zeit und Zeitintervallen, Es gibt noch ein weiteres schickes Zeitfeld mit Eingabehilfe (Genbänkle oder Yoga Namaste ? - TODO)<br />
<br />
== Markup etc. erzeugen ==<br />
* '''Pages2Pdf''' - Wrapper für mPdf Library zur PDF Erzeugung<br />
* '''RockPdf''' - Wrapper für mPdf Library von Bernhard Baumrock (https://github.com/BernhardBaumrock/RockPDF, https://modules.processwire.com/modules/rock-pdf/, https://processwire.com/talk/topic/19468-360%C2%B0-feedbacksurvey-tool/)<br />
* '''TextformatterHannaCode''' ** - Snippets für den Editor erstellen, die dann komplexeren Markup erzeugen können (Killer für Wordpress-Lovers) <br />
* '''TextformatterAutoAnchor''' - Erzeugt automatisch Ids und Slugs in den Überschrift Elementen<br />
* '''TextformatterSoundmanager''' - Formatter für den Soundmanager2 Player - kann auch Multitrack und krasse Visualisierungen<br />
* '''FieldtypePhone''' - Standard Telefonformatierung (https://github.com/adrianbj/FieldtypePhone)<br />
* '''TextformatterFileInfo''' - Dateiinfo Textformatter<br />
* '''InputfieldMarkupCKEditor''' - Text in Formbuilder Formularen einfügen<br />
<br />
== Social Functionality Community Stuff ==<br />
* '''NewsletterSubscription''' - Double Opt In Funktionalität für Newsletter etc.<br />
* '''LoginRegister''' - Ryans Self Registration Beispiel<br />
<br />
<br />
== Mal Testen ==<br />
* '''ProcessCustomUploadNames''' - Renaming Rulse for Pages and other fields.<br />
* '''ProcessBlog''' - Blog Modul von Ryan (für das Blog Profile entwickelt)<br />
* '''MarkupSocialShareButtons'''<br />
* '''MarkupPlyrMediaPlayer'''<br />
* '''InstagramFeed'''<br />
* '''MediaLibrary''' - Medienzugriff über Libraries. Auswahl in übergeordneten Seiten möglich.<br />
* '''FrontEndEditLightbox''' - Frontend Editing der aktuellen Seite in einer Lightbox<br />
* '''Sassify''' - Kompiliert Sass/SCSS/Compass - evtl. praktisch während der Entwicklungsphase<br />
* '''Oauth2Login'''<br />
* '''MarkupSitemap'''<br />
* '''Blackhole''' - Lockt Bots die robots.txt missachten in ein Blackhole -> werden gebannt<br />
* '''AdminThemeBoss''' - Platzsparendes zurückhaltendes uikit 3 Theme. Setzt auf dem Standard Theme auf<br />
* '''MillSite''' - Milligram SiteProfile mit einigen Zusatzfeatures<br />
* '''MillBlog''' - Milligram Framework Blog SiteProfile<br />
* '''SeoMaestro''' - SEO Tool noch Alpha (2019-02)</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_N%C3%BCtzliche_Module&diff=24230ProcessWire - Nützliche Module2020-01-04T15:55:37Z<p>84.136.104.26: /* Administration / Verwaltung */</p>
<hr />
<div>Dies ist keine vollständige Liste aber mal eine kleine Hilfe auch um Kunden Module anbieten zu können...<br />
* Cool<br />
** Sehr Hilfreich - Killerfeatures für Kunden<br />
*** Musthave Ohne geht's nicht<br />
== Development ==<br />
* '''ProcessAdminActions''' *** - Musthave bei komplexen Projekten. Kann viele Dinge als Batch erledigen und spart unendlich Zeit.<br />
* '''GithubConnect'''<br />
* '''ConnectPageFields''' 2 Wege Verbindung für Datenfelder. Kein richtiges m:n, hält aber die Felder synchron<br />
<br />
=== Debugging ===<br />
* '''TracyDebugger''' *** - für programmierlastige Projekte das Debugger Tool der Wahl<br />
<br />
=== Daten Im- / Exportieren ===<br />
* '''ImportPagesCSV''' *** - Importiert CSV Daten als Seiten in ProcessWire<br />
* '''TableCsvImportExport''' - Importiert CSV Daten in Table Fields<br />
* '''[[DataSet - ProcessWire Modul|DataSet]]''' - Importiert CSV und XML Daten. Config-Datei für Anweisungen. Kann mit Tasker auch als Cronjob laufen. Für große Datenssätze. https://github.com/mtwebit/DataSet<br />
<br />
== Administration / Verwaltung ==<br />
* '''AdminRestrictBranch''' - Redakteure auf einen Seitenzweig beschränken<br />
* '''ModulesManager''' - Zugriff auf das offizielle Modulverzeichnis aus dem Backend heraus<br />
* '''PageReferencesTab''' - Seitenverwaltung "Welche Seiten verweisen auf diese mittels PageReference Field"<br />
* '''EmailNewUser''' - User über seinen Account Informieren. Nutzen mit '''PasswordForceChange'''<br />
* '''ProcessWireUpgrade''' ** - Informiert über Upgrades - nützlich wenn man Updates als kostnpfl. Service anbieten möchte<br />
* '''ProcessJumplinks''' * - Redirects verwalten<br />
* '''PageRenameOptions''' - Ändert den Seitennamen bei Änderung des Titels. Am besten mit PagePathHistory verwenden wg. broken Links.<br />
* '''RestrictRepeaterMatrix''' Zugriff auf Repeater Matrix Felder regulieren [[RestrictRepeaterMatrix (ProcessWire Modul)]]<br />
* '''TemplatesChildPages''' Zugriff auf Kindseiten einschränken - erweitert Zugriffsregeln auf Seitenbasis, statt nur auf Templatebasis<br />
* '''CronjobDatabaseBackup''' Automatische Datenbank Backups - nutzt LazyCron<br />
<br />
== Navigation / Menüs ==<br />
* '''ProcessMenuBuilder''' - Manuelle Custom Menu Erstellung - sinnvoll bei sehr individuellen Navigationen. <br />
<br />
== Hilfe für Redakteure ==<br />
* '''AssistedURL''' - Linkhilfe Adrians Fork ist oft weiter (https://github.com/adrianbj/processwire-fieldtype-assisted-url)<br />
* '''PrevNextTabs''' - Abkürzung zur nächsten / vorigen Seite im Backend. Sinnvoll wenn viele Seiten bearbeitet werden müssen.<br />
* '''CkeLinkFiles''' - Dateilinks leichter im Editor einfügen<br />
* '''SchedulePages''' - Seiten auf Termin veröffentlichen<br />
<br />
== Sicherheit und Recht ==<br />
* '''EmailObfuscation''' **<br />
* '''MarkupCookieConsent'''<br />
* '''CookieManagementBanner''' - von Adrian<br />
<br />
== Bedienungshilfen / Backend ==<br />
* '''AssistedUrl'''<br />
* '''MinimalFieldset''' - läßt flexiblere Gestaltung der Felder im Backend zu.<br />
* '''PageListSelectMultipleQuickly''' Mehrere Seiten auwählen ohne jedesmal den Baum neu zu öffnen<br />
* '''PageFieldInfo''' - zusätzliche Infos bei Page Select Checkboxen anzeigen (bei hover und wenn gecheckt)<br />
<br />
== Markup etc. erzeugen ==<br />
* '''Pages2Pdf''' - Wrapper für mPdf Library zur PDF Erzeugung<br />
* '''RockPdf''' - Wrapper für mPdf Library von Bernhard Baumrock (https://github.com/BernhardBaumrock/RockPDF, https://modules.processwire.com/modules/rock-pdf/, https://processwire.com/talk/topic/19468-360%C2%B0-feedbacksurvey-tool/)<br />
* '''TextformatterHannaCode''' ** - Snippets für den Editor erstellen, die dann komplexeren Markup erzeugen können (Killer für Wordpress-Lovers) <br />
* '''TextformatterAutoAnchor''' - Erzeugt automatisch Ids und Slugs in den Überschrift Elementen<br />
* '''TextformatterSoundmanager''' - Formatter für den Soundmanager2 Player - kann auch Multitrack und krasse Visualisierungen<br />
* '''FieldtypePhone''' - Standard Telefonformatierung (https://github.com/adrianbj/FieldtypePhone)<br />
* '''TextformatterFileInfo''' - Dateiinfo Textformatter<br />
* '''InputfieldMarkupCKEditor''' - Text in Formbuilder Formularen einfügen<br />
<br />
== Social Functionality Community Stuff ==<br />
* '''NewsletterSubscription''' - Double Opt In Funktionalität für Newsletter etc.<br />
* '''LoginRegister''' - Ryans Self Registration Beispiel<br />
<br />
<br />
== Mal Testen ==<br />
* '''ProcessCustomUploadNames''' - Renaming Rulse for Pages and other fields.<br />
* '''ProcessBlog''' - Blog Modul von Ryan (für das Blog Profile entwickelt)<br />
* '''MarkupSocialShareButtons'''<br />
* '''MarkupPlyrMediaPlayer'''<br />
* '''InstagramFeed'''<br />
* '''MediaLibrary''' - Medienzugriff über Libraries. Auswahl in übergeordneten Seiten möglich.<br />
* '''FrontEndEditLightbox''' - Frontend Editing der aktuellen Seite in einer Lightbox<br />
* '''Sassify''' - Kompiliert Sass/SCSS/Compass - evtl. praktisch während der Entwicklungsphase<br />
* '''Oauth2Login'''<br />
* '''MarkupSitemap'''<br />
* '''Blackhole''' - Lockt Bots die robots.txt missachten in ein Blackhole -> werden gebannt<br />
* '''AdminThemeBoss''' - Platzsparendes zurückhaltendes uikit 3 Theme. Setzt auf dem Standard Theme auf<br />
* '''MillSite''' - Milligram SiteProfile mit einigen Zusatzfeatures<br />
* '''MillBlog''' - Milligram Framework Blog SiteProfile<br />
* '''SeoMaestro''' - SEO Tool noch Alpha (2019-02)</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_N%C3%BCtzliche_Module&diff=24229ProcessWire - Nützliche Module2020-01-04T15:43:12Z<p>84.136.104.26: /* Hilfe für Redakteure */</p>
<hr />
<div>Dies ist keine vollständige Liste aber mal eine kleine Hilfe auch um Kunden Module anbieten zu können...<br />
* Cool<br />
** Sehr Hilfreich - Killerfeatures für Kunden<br />
*** Musthave Ohne geht's nicht<br />
== Development ==<br />
* '''ProcessAdminActions''' *** - Musthave bei komplexen Projekten. Kann viele Dinge als Batch erledigen und spart unendlich Zeit.<br />
* '''GithubConnect'''<br />
* '''ConnectPageFields''' 2 Wege Verbindung für Datenfelder. Kein richtiges m:n, hält aber die Felder synchron<br />
<br />
=== Debugging ===<br />
* '''TracyDebugger''' *** - für programmierlastige Projekte das Debugger Tool der Wahl<br />
<br />
=== Daten Im- / Exportieren ===<br />
* '''ImportPagesCSV''' *** - Importiert CSV Daten als Seiten in ProcessWire<br />
* '''TableCsvImportExport''' - Importiert CSV Daten in Table Fields<br />
* '''[[DataSet - ProcessWire Modul|DataSet]]''' - Importiert CSV und XML Daten. Config-Datei für Anweisungen. Kann mit Tasker auch als Cronjob laufen. Für große Datenssätze. https://github.com/mtwebit/DataSet<br />
<br />
== Administration / Verwaltung ==<br />
* '''AdminRestrictBranch''' - Redakteure auf einen Seitenzweig beschränken<br />
* '''ModulesManager''' - Zugriff auf das offizielle Modulverzeichnis aus dem Backend heraus<br />
* '''PageReferencesTab''' - Seitenverwaltung "Welche Seiten verweisen auf diese mittels PageReference Field"<br />
* '''EmailNewUser''' - User über seinen Account Informieren. Nutzen mit '''PasswordForceChange'''<br />
* '''ProcessWireUpgrade''' ** - Informiert über Upgrades - nützlich wenn man Updates als kostnpfl. Service anbieten möchte<br />
* '''ProcessJumplinks''' * - Redirects verwalten<br />
* '''PageRenameOptions''' - Ändert den Seitennamen bei Änderung des Titels. Am besten mit PagePathHistory verwenden wg. broken Links.<br />
* '''RestrictRepeaterMatrix''' Zugriff auf Repeater Matrix Felder regulieren [[RestrictRepeaterMatrix (ProcessWire Modul)]]<br />
* ''' TemplatesChildPages''' Zugriff auf Kindseiten einschränken - erweitert Zugriffsregeln auf Seitenbasis, statt nur auf Templatebasis<br />
<br />
== Navigation / Menüs ==<br />
* '''ProcessMenuBuilder''' - Manuelle Custom Menu Erstellung - sinnvoll bei sehr individuellen Navigationen. <br />
<br />
== Hilfe für Redakteure ==<br />
* '''AssistedURL''' - Linkhilfe Adrians Fork ist oft weiter (https://github.com/adrianbj/processwire-fieldtype-assisted-url)<br />
* '''PrevNextTabs''' - Abkürzung zur nächsten / vorigen Seite im Backend. Sinnvoll wenn viele Seiten bearbeitet werden müssen.<br />
* '''CkeLinkFiles''' - Dateilinks leichter im Editor einfügen<br />
* '''SchedulePages''' - Seiten auf Termin veröffentlichen<br />
<br />
== Sicherheit und Recht ==<br />
* '''EmailObfuscation''' **<br />
* '''MarkupCookieConsent'''<br />
* '''CookieManagementBanner''' - von Adrian<br />
<br />
== Bedienungshilfen / Backend ==<br />
* '''AssistedUrl'''<br />
* '''MinimalFieldset''' - läßt flexiblere Gestaltung der Felder im Backend zu.<br />
* '''PageListSelectMultipleQuickly''' Mehrere Seiten auwählen ohne jedesmal den Baum neu zu öffnen<br />
* '''PageFieldInfo''' - zusätzliche Infos bei Page Select Checkboxen anzeigen (bei hover und wenn gecheckt)<br />
<br />
== Markup etc. erzeugen ==<br />
* '''Pages2Pdf''' - Wrapper für mPdf Library zur PDF Erzeugung<br />
* '''RockPdf''' - Wrapper für mPdf Library von Bernhard Baumrock (https://github.com/BernhardBaumrock/RockPDF, https://modules.processwire.com/modules/rock-pdf/, https://processwire.com/talk/topic/19468-360%C2%B0-feedbacksurvey-tool/)<br />
* '''TextformatterHannaCode''' ** - Snippets für den Editor erstellen, die dann komplexeren Markup erzeugen können (Killer für Wordpress-Lovers) <br />
* '''TextformatterAutoAnchor''' - Erzeugt automatisch Ids und Slugs in den Überschrift Elementen<br />
* '''TextformatterSoundmanager''' - Formatter für den Soundmanager2 Player - kann auch Multitrack und krasse Visualisierungen<br />
* '''FieldtypePhone''' - Standard Telefonformatierung (https://github.com/adrianbj/FieldtypePhone)<br />
* '''TextformatterFileInfo''' - Dateiinfo Textformatter<br />
* '''InputfieldMarkupCKEditor''' - Text in Formbuilder Formularen einfügen<br />
<br />
== Social Functionality Community Stuff ==<br />
* '''NewsletterSubscription''' - Double Opt In Funktionalität für Newsletter etc.<br />
* '''LoginRegister''' - Ryans Self Registration Beispiel<br />
<br />
<br />
== Mal Testen ==<br />
* '''ProcessCustomUploadNames''' - Renaming Rulse for Pages and other fields.<br />
* '''ProcessBlog''' - Blog Modul von Ryan (für das Blog Profile entwickelt)<br />
* '''MarkupSocialShareButtons'''<br />
* '''MarkupPlyrMediaPlayer'''<br />
* '''InstagramFeed'''<br />
* '''MediaLibrary''' - Medienzugriff über Libraries. Auswahl in übergeordneten Seiten möglich.<br />
* '''FrontEndEditLightbox''' - Frontend Editing der aktuellen Seite in einer Lightbox<br />
* '''Sassify''' - Kompiliert Sass/SCSS/Compass - evtl. praktisch während der Entwicklungsphase<br />
* '''Oauth2Login'''<br />
* '''MarkupSitemap'''<br />
* '''Blackhole''' - Lockt Bots die robots.txt missachten in ein Blackhole -> werden gebannt<br />
* '''AdminThemeBoss''' - Platzsparendes zurückhaltendes uikit 3 Theme. Setzt auf dem Standard Theme auf<br />
* '''MillSite''' - Milligram SiteProfile mit einigen Zusatzfeatures<br />
* '''MillBlog''' - Milligram Framework Blog SiteProfile<br />
* '''SeoMaestro''' - SEO Tool noch Alpha (2019-02)</div>84.136.104.26https://wiki.stephanschlegel.de/index.php?title=ProcessWire_-_Scheduler&diff=24228ProcessWire - Scheduler2020-01-04T15:20:59Z<p>84.136.104.26: </p>
<hr />
<div>Cronjobs / Scheduler für ProcessWire<br />
<br />
== Module ==<br />
=== LazyCron ===<br />
https://processwire.com/talk/topic/5403-cron-job-for-processwire-mailer-template/<br />
https://processwire.com/docs/more/lazy-cron/<br />
<br />
== Tipps im Zusammenhang ==<br />
=== Seitenaufruf triggern ===<br />
Man kann Seiten so bauen, dass sie beim Aufruf Aktionen ausführen. Um die Seitenaufrufe ohne Browser durchzuführen kann man so etwas machen:<br />
<br />
Ah, ok. You may also try to create a simple php script somewhere outside of pw with this content:<br />
<br />
header("location: http://www.your-site.com/page-url-with-mail-script/");<br />
<br />
or with this one:<br />
<br />
file_get_contents("http://www.your-site.com/page-url-with-mail-script/");<br />
<br />
and call that with your cronjob.</div>84.136.104.26