Wikizone - Benutzerbeiträge [de]

UIkit Theme mit Sass erstellen

2020-11-15T13:48:45Z

84.155.186.35:

Theme Datei erstellen z.B. site.scss

<syntaxhighlight lang="sass">
// 1. Your custom variables and variable overwrites.
$global-link-color: #DA7D02;

// 2. Import default variables and available mixins.
@import "uikit/src/scss/variables-theme.scss";
@import "uikit/src/scss/mixins-theme.scss";

// 3. Your custom mixin overwrites.
@mixin hook-card() { color: #000; }

// 4. Import UIkit.
@import "uikit/src/scss/uikit-theme.scss";
</syntaxhighlight>

https://getuikit.com/docs/sass

Todo

The compiled CSS will then have your custom value. But not only has the global link color changed. Many components make use of the @global-* variables to infer their own colors, and just adapt them slightly. That way you can rapidly create a theme by just changing some global variables.

== Inverse Komponenten abschalten ==
Disable inverse component
The Inverse component includes additional styles to implement the flexible inverse behaviour. If your project does not make use of these styles, you can leave them out when compiling Sass. This allows smaller file sizes of the compiled CSS. To do so, search for Sass variables containing color-mode (e.g. $inverse-global-color-mode), and set them to none.

To disable the inverse styles completely, set:

<syntaxhighlight lang="sass">
$inverse-global-color-mode: none;
You can also disable the inverse mode for specific components:

// Card
$card-primary-color-mode: none;
$card-secondary-color-mode: none;

// Navbar
$navbar-color-mode: none;

// Off-canvas
$offcanvas-bar-color-mode: none;

// Overlay
$overlay-primary-color-mode: none;

// Section
$section-primary-color-mode: none;
$section-secondary-color-mode: none;

// Tile
$tile-primary-color-mode: none;
$tile-secondary-color-mode: none;
</syntaxhighlight>

== Komplexere Konfiguration ==

<syntaxhighlight lang="sass">
The entry point for the Sass compiler is site.scss. Here you compile all source files in the following order:

// site.scss

// 1. Your custom variables and variable overwrites.
@import "theme/accordion.scss";
@import "theme/alert.scss";
@import "theme/align.scss";
// ... import all

// 2. Import default variables and available mixins.
@import "uikit/src/scss/variables.scss";
@import "uikit/src/scss/mixins.scss";

// 3. Your custom mixin overwrites.
@import "theme/accordion-mixins.scss";
@import "theme/alert-mixins.scss";
@import "theme/align-mixins.scss";
// ... import all

// 4. Import UIkit
@import "uikit/src/scss/uikit.scss";

</syntaxhighlight>
Now you can compile site.scss and the resulting CSS will include all your customizations.

NOTE You can further extend this setup by replacing part "4." with single import statements from the UIkit source. You can then omit some components you do not use to produce smaller CSS. Just copy from src/scss/components/_import.scss and make sure to preserve the correct import order.

UIkit Theme mit Sass erstellen

2020-11-15T12:51:55Z

84.155.186.35: Die Seite wurde neu angelegt: „Theme Datei erstellen z.B. site.scss <syntaxhighlight lang="sass"> // 1. Your custom variables and variable overwrites. $global-link-color: #DA7D02; // 2. Im…“

UIkit

2020-11-15T12:49:36Z

84.155.186.35:

== Sass Strategie ==
[[UIkit Theme mit Sass erstellen]]

== Less Strategie ==
=== UIKit mit Yarn installieren ===

[[Yarn]] ist ein Paketmanager. Wenn dieser installiert ist kann man es einfach hinzufügen. Hinweis: es gibt wohl auch eine npm Version. Nach Recherche scheint Yarn hinsichtlich Müllerzeugung, Sicherheit und Deinstallierbarkeit auf dem Rechner das bessere Instrument sein.

yarn add uikit

Dann wird in node_modules uikit installiert

<pre>
FOLDER DESCRIPTION
/src Contains all Less, JavaScript and image sources.
/dist Contains compiled CSS and JS, updated on every release.
/tests Contains HTML test files of all components.
</pre>

=== Ordnerstruktur ===

=== Watcher ===

=== Angepasste Less / CSS Dateien mit dem Customizer ===

== Manuelle Strategie ==
=== UIKit Customizer ===

Erzeugt ein Theme CSS Dateien

== UIKit Events ==
Die UIKit Komponenten stellen Events zur Verfügung die man für eigene Skripte nutzen kann.

=== Beispiele ===
Slideshow Events
<syntaxhighlight lang="javascript">
// Using **** JQuery ****
// Initialize slideshow
var slideshow = UIkit.slideshow('#slideshow');

// Variable with element that fire event
var $slideItem = $('#slideshow ul > li');

$slideItem.on('beforeitemshow', function(){
UIkit.notification({ message: 'Fire Before Item Show', timeout:1000 });
});
$slideItem.on('itemshown', function(){
UIkit.notification({ message: 'Item shown', timeout:1000 });
});
</syntaxhighlight>

Toggle Component Events (Vanilla JS)
<syntaxhighlight lang="html5">

<div class="uk-container">
<div class="uk-grid-expand">
<h1>UIKit Toggle Events</h1>
<button id="toggle" uk-toggle="target: #target">THE TRIGGER</button>
<div id="target">THE TARGET</div>
</div>
</div>
</syntaxhighlight>
<syntaxhighlight lang="javascript">
var ready = (callback) => {
if (document.readyState != "loading") callback();
else document.addEventListener("DOMContentLoaded", callback);
}
ready(() => {
// get element that fires the events (use the target not the trigger)
var ele = document.getElementById('target');

// catch events and do something
ele.addEventListener('shown',function(e){
UIkit.notification({ message: 'shown event fired', timeout:2000 });
});

ele.addEventListener('hidden', function(e){
UIkit.notification({ message: 'hidden event fired', timeout:2000 });
});
});
// other events are: beforeshow, show, beforehide, hide
// Ref: https://getuikit.com/docs/toggle
</syntaxhighlight>

ProcessWire - Konfigurierbare Module

2020-11-07T13:25:08Z

84.155.186.35:

Ab ProcessWire 2.5.5. kann man Module mit Konfigurationsmöglichkeiten einfacher erstellen. Die Konfigurationsoptionen lagert man in eine extra Datei aus.

https://processwire.com/blog/posts/new-module-configuration-options/
https://processwire.com/api/ref/modules/save-config/

Beispiel Modul "Test" (gibt eine Meldung im Admin bei jeder Seitenladen aus)

* Datei mit dem Namen und Klasse [Modulname]Config erstellen
* Klasse extends ModulConfig
* Default Werte über getDefaults() Funktion definieren
* Inputfelder über getInputfields() Funktion definieren

Test.php
<syntaxhighlight lang="php">
class Test extends WireData implements Module {
public static function getModuleInfo() {
return array(
'title' => 'Module Test',
'version' => 1,
'summary' => 'Module for testing/demo purposes.',
'autoload' => 'template=admin',
);
}
public function ready() {
if($this->fullname && !count($this->input->post)) {
$msg = "Hi $this->fullname! ";
$msg .= "Your age: $this->age. ";
$msg .= "Favorite color: $this->color.";
$this->message($msg);
}
}
}
</syntaxhighlight>

TestConfig.php
<syntaxhighlight lang="php">
class TestConfig extends ModuleConfig {
public function getDefaults() {
return array(
'fullname' => '',
'color' => 'blue',
'age' => 40,
);
}
public function getInputfields() {
$inputfields = parent::getInputfields();

$f = $this->modules->get('InputfieldText');
$f->attr('name', 'fullname');
$f->label = 'Full Name';
$f->required = true;
$inputfields->add($f);

$f = $this->modules->get('InputfieldSelect');
$f->attr('name', 'color');
$f->label = 'Favorite Color';
$f->options = array(
'red' => 'Red',
'green' => 'Green',
'blue' => 'Blue'
);
$inputfields->add($f);

$f = $this->modules->get('InputfieldInteger');
$f->attr('name', 'age');
$f->label = 'Your Age';
$inputfields->add($f);

return $inputfields;
}
}
</syntaxhighlight>

ProcessWire - Module schreiben

2020-11-04T21:43:54Z

84.155.186.35: /* Interessantes - Read On */

== Links ==
'''Wichtigste Resourcen'''
https://processwire.com/docs/modules/development/ - Guter Ausgangspunkt
https://processwire.com/api/ref/module/ - Module API
https://processwire.com/api/ref/configurable-module/ - Klasse für Konfigurierbare Module
https://processwire.com/docs/modules/types/ - Welche Modultypen gibt es ?
https://processwire.com/talk/topic/778-module-dependencies/ - Module die andere Module benötigen
https://processwire.com/talk/forum/19-moduleplugin-development/ - Forum zum Thema Module entwickeln
http://somatonic.github.io/Captain-Hook/ - Hook Cheatsheet
https://processwire.com/blog/posts/new-module-configuration-options/ - Neuere Konfigurationsmöglichkeiten
https://processwire.com/docs/start/api-access/ Zugriff auf ProcessWire API Variablen (wire Objekt)

''' Tutorials und Beispiele zum Einstieg '''
https://processwire.com/docs/modules/ - Introduction, Development, Hooks, Types, Pro Modules, Third Party
https://github.com/ryancramerdesign/ProcessHello - Modul Skelett Beispiel für eigene Backend (Process) Module
https://github.com/ryancramerdesign/FieldtypeMapMarker - Beispiel für ein Fieldtype und Inputfield Modul
https://webdesign.tutsplus.com/tutorials/a-beginners-introduction-to-writing-modules-in-processwire--cms-26862

'''Wikiseiten'''
[[ProcessWire - Module Snippets]]
[[ProcessWire - Fieldtype erstellen (Module)]]

'''Weitere Links'''
http://modules.pw/ (Module Creator)

== Wo - Was ? ==
=== Welche Typen von Modulen gibt es ? ===
https://processwire.com/docs/modules/types/
* '''Fieldtype''': Repräsentiert einen Datentyp. Meistens keine Public API, Handelt Daten / Datenbank - [[ProcessWire - Fieldtype erstellen (Module)]]
* '''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.
* [[Process Module (ProcessWire)|'''Process''' for creating admin processes/applications.]]
* '''Textformatter''' for formatting text.
* '''AdminTheme''' for creating themes in the admin.
* '''WireMail''' for modules that send email and extend the WireMail class.
* '''Tfa''' for implementing a specific kind of two-factor authentication.
* '''ImageSizerEngine''' for modules that extend ImageSizerEngine for resizing images.
* '''FileCompiler''' for modules that extend FileCompilerModule for compilation of files.
* '''FileValidator''' for modules that extend FileValidatorModule for validation of files.

=== Wie werden Felder in der Datenbank angelegt ? ===
Dazu nutzt man den Typ "Fieldtype"

=== Wo rendert man die Ausgabe ? ===
Bei Ryan Cramers Event Beispiel legt er zwei Klassen Event und EventArray an, die auch die Render Funktionen enthalten.

=== Namenskonventionen ===
Ein Modulname sollte mit dem Typ den das Modul hat beginnen. Also etwa ProcessMeinAdminModul oder FieldtypeTable. ProcessWire listet das Modul dann in der Entsprechenden Kategorie auf. Wenn man etwas anderes nimmt z.B. LoginRegister dann kommt das Modul unter der neuen Rubrik "Login"

=== Konfigurierbare Module ===
Das geht seit 2.5.5 mittlerweile sehr einfach mit den neuen configuration-options.
https://processwire.com/blog/posts/new-module-configuration-options/
[[ProcessWire - Konfigurierbare Module]]

== Spezielle Funktionen in Modulen ==

=== Modulinformation ===
Das Modul stellt Infos zur Verfügung und nutzt dafür eine von 3 Methoden:
getModuleInfo() static method in your module class that returns an array.
YourModuleClass.info.php file that populates an $info array.
YourModuleClass.info.json file that contains an info object.

Hier werden title, version, summary und weitere Daten hinterlegt. Hier kann man auch angeben ob ein Modul ein Autoload Modul ist.

https://processwire.com/api/ref/module/

=== init ===
public function init(){}
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.

=== ready ===
<syntaxhighlight lang="php">
public function ready() {
if($this->page->template == 'admin') {
$this->message($this->hi());
}
}
</syntaxhighlight>
Wird in autoload Modulen aufgerufen wenn die API bereit ist. Nützlich für Hooks:

=== execute ===
<syntaxhighlight lang="php">
/**
* This function is executed when a page with your Process assigned is accessed.
*
* This can be seen as your main or index function. You'll probably want to replace
* everything in this function.
*
*/
public function ___execute() {
// greetingType and greeting are automatically populated to this module
// and they were defined in ProcessHello.config.php
if($this->greetingType == 'message') {
$this->message($this->greeting);
} else if($this->greetingType == 'warning') {
$this->warning($this->greeting);
} else {
$this->error($this->greeting);
}
// generate some navigation
$out = "
<h2>$this->greeting</h2>
<dl class='nav'>
<dt><a href='./something/'>Do Something</a></dt>
<dd>Runs the executeSomething() function.</dd>
</dl>
";
return $out;
}
</syntaxhighlight>

=== executeSomething ===
Ruft man eine Unterseite des Moduls auf kann man eine eigene execute Funktion nutzen
___executeSlug wobei Slug für den Url Slug steht. Heißt der slug /field/ dann wird executeField() aufgerufen, falls diese Funktion existiert.
<syntaxhighlight lang="php">
/**
* Called when the URL is this module's page URL + "/something/"
*
*/
public function ___executeSomething() {
// set a new headline, replacing the one used by our page
// this is optional as PW will auto-generate a headline
$this->headline('This is something!');
// add a breadcrumb that returns to our main page
// this is optional as PW will auto-generate breadcrumbs
$this->breadcrumb('../', 'Hello');
$out = "
<h2>Not much to to see here</h2>
<p><a href='../'>Go Back</a></p>
";
return $out;
}
</syntaxhighlight>

=== install & uninstall ===
<syntaxhighlight lang="php">

/**
* Called only when your module is installed
*
* If you don't need anything here, you can simply remove this method.
*
*/
public function ___install() {
parent::___install(); // always remember to call parent method
}
/**
* Called only when your module is uninstalled
*
* This should return the site to the same state it was in before the module was installed.
*
* If you don't need anything here, you can simply remove this method.
*
*/
public function ___uninstall() {
parent::___uninstall(); // always remember to call parent method
}
</syntaxhighlight>

== Vererbung und Eigenschaften in Modulen ==
Modules are not different from PHP classes.

To change the properties of MyModule class from within MyOtherModule class, you can either:

#Make MyOtherModule class extend MyModule. It will thus inherit MyModule's public and protected properties and methods
#Make the properties firstName and lastName configurable by passing them as parameters/arguments in MyModule's constructor method.

== Autoload Module und Hooks ==
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.

=== Hooks ===
https://processwire.com/docs/modules/hooks/
Hooks sind ein mächtiges Werkzeug. Sie geben einem die Möglichkeit an vielen Stellen "einzuhaken" und Funktionalität einzubauen.
<syntaxhighlight lang="php">
public function ready() {
$this->addHookAfter('Page::render', function($event) {
$event->return .= '<p>Hallo</p>';
});
}
</syntaxhighlight>
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.

Das gleiche aber nicht mit anonymer Funktion:
<syntaxhighlight lang="php">
public function ready() {
// add hook after Page::render() and make it call the "test" method of $this module
$this->addHookAfter('Page::render', $this, 'test');
}

public function test($event) {
// modify the return value of Page::render() to include the following:
$event->return .= '<p>Hallo</p>';
}
</syntaxhighlight>

=== Hooks zum erweitern von existierenden Klassen nutzen ===
Mit Hooks kann man in vorhandene Klassen einhaken. Z.B. läßt sich das Page Objekt erweitern.
<syntaxhighlight lang="php">
public function ready() {
$this->addHook('Page::summarize', $this, 'summarize');
}
public function summarize($event) {
$page = $event->object; // the $event->object represents the object hooked (Page)
$maxlen = $event->arguments(0); // first argument is the optional max length
if(!$maxlen) $maxlen = 200; // if no $maxlen was present, we'll use a default of 200
$summary = $this->sanitizer->truncate($page->body, $maxlen); // use sanitizer truncate method to create a summary
$event->return = $summary; // populate $summary to $event->return, the return value
}
</syntaxhighlight>
So kann man ganz einfach eine Zusammenfassung aller Kindseiten in einem Template rendern:
<syntaxhighlight lang="php">
foreach($page->children as $item) {
$summary = $item->summarize(150);
echo "<li><a href='$item->url'>$item->title</a><br>$summary";
}
</syntaxhighlight>

=== Autoload Module nur im Admin Bereich laden ===

'autoload' => 'template=admin'
statt
'autoload' => true

=== Hook Beispiele ===
Hook am Ende des Renderings
$this->addHookAfter('Page::render', function($event) {...});
Füge eine Funktion "summarize" zum Page Objekt hinzu.
$this->addHook('Page::summarize', $this, 'summarize');
Hook auf eine einzelne Instanz (hier pages Objekt)
$this->pages->addHookAfter('saved', function($event){...});
$this->addHook('Page::method', ...) // Spricht ALLE Instanzen an - Regelfall
$page->addHook('method', ...) // Spricht nur die EINE Instanz der Seite an.
</pre>

== Module Dependencies - voneinander abhängige Module ==

https://processwire.com/talk/topic/778-module-dependencies/
Wenn ein Modul nicht ohne ein anderes funktioniert spricht man von Module Dependency. In solchen Fällen kann man in der Modul Info angeben In vielen Fällen besteht ein Modul unter der Haube aus mehreren Einzelmodulen.

Um ProcessWire mitzuteilen dass ein Modul benötigt wird gibt man es in der Moduldefinition an:
'requires' => "LazyCron" // added this line
oder auch mehrere als Array
'requires' => array("LazyCron", "AdminBar") // added this line

ProcessWire kann auch dafür sorgen, dass ein Modul andere "Kindmodule" gleich mitinstalliert bzw. deinstalliert wenn es nicht mehr benötigt wird. Dazu gibt man dem Modul noch die 'install' dependency mit:

<syntaxhighlight lang="php">
<?php
public static function getModuleInfo() {
return array(
'title' => 'Log Master',
'version' => 101,
'author' => 'Lumberjack Bob',
'summary' => 'Log all actions on your site',
'requires' => 'LazyCron',
'installs' => 'ProcessLogMaster' // added this line
);
);
</syntaxhighlight>

ProcessWire sieht dann eine Kindabhängigkeit zu diesem Modul und handelt auch das Deinstallieren, wenn das Elternmodul deinstalliert wird.

== CSS und JavaScript in Modulen ==
Bei Process Modulen möchte man für das Styling etc. im Backend oft CSS und JS Dateien hinzufügen.

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:

<pre>

/**
* This JS file is only loaded when the ProcessHello module is run
*
* You should delete it if you have no javascript to add.
*
*/

$(document).ready(function() {
// do something
});
</pre>

== Beispiele ==
=== Frontend Rendering Module ===
A bit old but working

<syntaxhighlight lang="php">
<?php

/**
* FrontEndRender
*
* Author: Ben Byford
*
* ProcessWire 2.x
* Copyright (C) 2010 by Ryan Cramer
* Licensed under GNU/GPL v2, see LICENSE.TXT
*
* http://www.processwire.com
* http://www.ryancramer.com
*
*/

class FrontEndRender extends WireData implements Module {

public static function getModuleInfo() {
return array(
'title' => 'FrontEndRender',
'version' => 0.1,
'summary' => "Outputs html and static variables to frontend",
'author' => 'Ben Byford',
'singular' => true,
'href' => 'https://github.com/benbyford/PW-starter-modules'
);
}

// protected variable only accessable within module
protected $name = 'Ben';

/*
* render function to be called in PW template like this:
* $FrontEndRender = $modules->getModule('FrontEndRender');
* echo '<h1>' . $FrontEndRender->render() . '</h1>';
*
*/
public function render(){
return "Hello " . $this->name;
}
}
?>
</syntaxhighlight>

=== ProcessWire Hello World Modul ===
Beispiel Modul mit Hooks (liegt immer in der Standardinstallation)
<syntaxhighlight lang="php">
<?php namespace ProcessWire;

/**
* ProcessWire 'Hello world' demonstration module
*
* Demonstrates the Module interface and how to add hooks.
*
* See README file for further links regarding module development.
*
* This file is licensed under the MIT license
* https://processwire.com/about/license/mit/
*
* ProcessWire 3.x, Copyright 2016 by Ryan Cramer
* https://processwire.com
*
*/

class Helloworld extends WireData implements Module {

/**
* getModuleInfo is a module required by all modules to tell ProcessWire about them
*
* @return array
*
*/
public static function getModuleInfo() {

return array(

// The module's title, typically a little more descriptive than the class name
'title' => 'Hello World',

// version number
'version' => 3,

// summary is brief description of what this module is
'summary' => 'An example module used for demonstration purposes.',

// Optional URL to more information about the module
'href' => 'https://processwire.com',

// singular=true: indicates that only one instance of the module is allowed.
// This is usually what you want for modules that attach hooks.
'singular' => true,

// autoload=true: indicates the module should be started with ProcessWire.
// This is necessary for any modules that attach runtime hooks, otherwise those
// hooks won't get attached unless some other code calls the module on it's own.
// Note that autoload modules are almost always also 'singular' (seen above).
'autoload' => true,

// Optional font-awesome icon name, minus the 'fa-' part
'icon' => 'smile-o',
);
}

/**
* Initialize the module
*
* ProcessWire calls this when the module is loaded. For 'autoload' modules, this will be called
* when ProcessWire's API is ready. As a result, this is a good place to attach hooks.
*
*/
public function init() {

// add a hook after the $pages->save, to issue a notice every time a page is saved
$this->pages->addHookAfter('save', $this, 'example1');

// add a hook after each page is rendered and modify the output
$this->addHookAfter('Page::render', $this, 'example2');

// add a 'hello' method to every page that returns "Hello World"
// use "echo $page->hello();" in your template file to display output
$this->addHook('Page::hello', $this, 'example3');

// add a 'hello_world' property to every page that returns "Hello [user]"
// use "echo $page->hello_world;" in your template file to display output
$this->addHookProperty('Page::hello_world', $this, 'example4');
}

/**
* Example1 hooks into the pages->save method and displays a notice every time a page is saved
*
* @param HookEvent $event
*
*/
public function example1($event) {
/** @var Page $page */
$page = $event->arguments[0];
$this->message("Hello World! You saved {$page->path}.");
}

/**
* Example2 hooks into every page after it's rendered and adds "Hello World" text at the bottom
*
* @param HookEvent $event
*
*/
public function example2($event) {

/** @var Page $page */
$page = $event->object;

// don't add this to the admin pages
if($page->template == 'admin') return;

// add a "Hello World" paragraph right before the closing body tag
$event->return = str_replace("</body>", "<p>Hello World!</p></body>", $event->return);
}

/**
* Example3 adds a 'hello' method (not property) to every page that simply returns "Hello World"
*
* @param HookEvent $event
*
*/
public function example3($event) {
$event->return = "Hello World";
}

/**
* Example 4 adds a 'hello_world' property (not method) to every page that returns "Hello [user]"
*
* @param HookEvent $event
*
*/
public function example4($event) {
$event->return = "Hello " . $this->user->name;
}

}

</syntaxhighlight>

=== ProcessWire Admin Bereich mit eigener Funktionalität erweitern (Modul)===
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863
<syntaxhighlight lang="php">

<?php
/**
* ProcessSimpleAdminPage
*
* @author Ben Byford
* http://www.benbyford.com
*
* @see http://www.processwire.com
*/

class ProcessSimpleAdminPage extends Process {

public static function getModuleInfo() {
return array(
'title' => 'Process Simple Admin Page',
'summary' => 'Simple Process module that adds new admin page with',
'version' => 001,

// Modules that extend Process may specify a 'page' attribute in the
// getModuleInfo(), this page will automatically be given the module
// process when added to teh pagetree.

// I have exampled but commented out the 'page' settings below
// so that I can show how one might add a page to install() and
// uninstall() in this and other modules (that might not extend
// Process)

// 'page' => array(
// 'name' => 'site-config',
// 'parent' => 'admin',
// 'title' => 'Site Config'
// )
);
}

public function execute() {
return '
<h2>Edit the text here in the module</h2>
<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>

<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>

<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>

<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>
';
}
public function install(){

// create new page to add to CMS
$page = new Page();

// add page attributes
$page->template = "admin";
$page->name = "cms-faq";
$page->title = "CMS FAQ";
$page->save();

// set this module as the page process, this allows us to display the above
$page->process = 'ProcessSimpleAdminPage';

// get admin page and set as page parent
$admin = $this->pages->get("id=2");
$page->parent = $admin;

// save page
$page->save();
}

public function uninstall(){

// delete created page
$page = $this->pages->get("name=cms-faq");
if(count($page)) $this->pages->delete($page, true);
}
}
</syntaxhighlight>

=== ProcessWire Textformatter Modul ===
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863
<syntaxhighlight lang="php">
<?php

/**
* TextformatterFindReplace
*
* Author: Ben Byford
*
* ProcessWire 2.x
* Copyright (C) 2010 by Ryan Cramer
* Licensed under GNU/GPL v2, see LICENSE.TXT
*
* http://www.processwire.com
* http://www.ryancramer.com
*
*/

class TextformatterFindReplace extends Textformatter implements Module {

public static function getModuleInfo() {
return array(
'title' => 'TextformatterFindReplace',
'version' => 0.1,
'summary' => "Finds and replaces any instance of config input to config output",
'author' => 'Ben Byford',
'singular' => true,
'href' => 'https://github.com/benbyford/PW-starter-modules'
);
}

/**
* Find and Replace the input string
*
* @param string $str The block of text to parse
*
* The incoming string is replaced with the formatted version of itself.
**/

public function format(&$str) {
$find = $this->findStr;
$str = preg_replace_callback($find, array($this,"replace"), $str);

}

// adding three underscores to a function allows other modules to hook it
public function ___replace($match) {
return $this->replaceStr;
}
}
?>
</syntaxhighlight>

=== Admin Funktionalität: Countdown zum Seitenveröffentlichen ===
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863

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).

I did this by:

'''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.

'''Adding hooks''' to both ''ProcessPageEdit::buildForm'' and ''ProcessPageListActions::getExtraActions'' enabling me to add the two buttons.

Checking to see if one of the buttons was clicked with my '''ready() function''' then setting the corresponding page’s checkbox to true.

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.

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).

<syntaxhighlight lang="php">
<?php
/**
* DeferredPublish (0.0.1)
* DeferredPublish publishes a page after a defined amount of time has elapsed using lazycron.
*
* @author Ben Byford
* http://www.benbyford.com
*
* ProcessWire 2.x
* Copyright (C) 2011 by Ryan Cramer
* Licensed under GNU/GPL v2, see LICENSE.TXT
*
* http://www.processwire.com
* http://www.ryancramer.com
*
*/

class PageDeferredPublish extends WireData implements Module {

public static function getModuleInfo() {
return array(
'title' => "PageDeferredPublish",
'version' => "0.0.1",
'summary' => "PageDeferredPublish",
'author' => "Ben Byford",
'href' => "https://github.com/benbyford/PW-intermediate-modules",
'icon' => "clock-o",
'autoload' => true,
'singular' => true,
'requires' => "LazyCron",
);
}

private $postPubLater = null;
private $pageID = null;
private $pagePubLater = null;
private $currentPage = null;

private $submitName = 'pdp_pub_later_submit';
private $listPageName = 'pdp_pub_later_list';
private $fieldName = 'pdp_pub_later';
private $checkboxName = 'pdp_pub_later_check';

private $defaultInterval = 'everyMinute';
private $defaultTime = 86400;

public function install(){
// add new fields needed for module
$this->installFields();
}
public function uninstall(){
// uninstall fields
$this->uninstallFields();
}

// initialize the hook in your AutoLoad module
public function init() {

// get defaults from module setting in CMS
$this->defaultTime = $this->pub_after;
$this->defaultInterval = $this->cron_check;

// get admin URL
$this->adminUrl = $this->wire('config')->urls->admin;

// add hooks to CRON, PageList, PageEdit
$this->addHookAfter("LazyCron::{$this->defaultInterval}", $this, 'publishDefferedPages');
$this->addHook("ProcessPageListActions::getExtraActions", $this, 'hookPageListActions');
$this->addHookAfter("ProcessPageEdit::buildForm", $this, "editForm");
}

public function ready() {

// if list button clicked then grab id
$this->pagePubLater = $this->input->get($this->listPageName);
$this->pageID = $this->input->id;

// get page
$this->currentPage = $this->pages->get($this->pageID);

// if pagelist pub later submit button clicked
if($this->pagePubLater){
$this->message("Page {$this->currentPage->name} deffered for publish.");
}

// if page edit submit button clicked
$this->postPubLater = $this->input->post($this->submitName);
if($this->postPubLater){
$this->message("Page {$this->currentPage->name} deffered for publish.");
}

// if either deffered publish sumbit found then publish page later
if($this->pagePubLater || $this->postPubLater){
$this->publishLater();
}
}

/*
* Hook: ProcessPageEdit::buildForm
*
* add Publish Later button to edit page if not yet published
*/
public function ___editForm(HookEvent $form) {

// get the InputFieldForm object from the event (return value of buildForm())
$form = $form->return;

$page = $this->pages->get($this->input->get->id);
$check = $page->get($this->checkboxName);

// check if publish button available and therfore unpublished
$target = $form->get('submit_publish');

if($target && $check == false){

// get InputfieldText module
$submit2 = $this->modules->get('InputfieldSubmit');
$submit2->attr('name', $this->submitName);
$submit2->attr('id', 'publish_later');
$submit2->attr('class', 'ui-button ui-widget ui-corner-all head_button_clone ui-state-default ui-priority-secondary');
$submit2->attr('value', 'Publish Later'); // Button: save unpublished

// get form element save and place before
$target = $form->get('submit_save');
$form->insertBefore($submit2, $target);

$form->return = $form;
}
}

public function ___hookPageListActions(HookEvent $event) {

// get current page
$page = $event->arguments[0];

// check to see if page is published
$pagePub = $page->is(Page::statusUnpublished);

// check to see if page template has deffered field
$pageHasDefferField = $page->get($this->fieldName);

$actions = array();

// don't get homepage or pages that are already published or are being deffered for publish
if($page->id > 1 && $pagePub == "published" && !is_null($pageHasDefferField) && $page->get($this->checkboxName) == false) {

$actions['publish_later'] = array(
'cn' => 'PublishLater',
'name' => 'pub later',
'url' => "{$this->adminUrl}?{$this->listPageName}=1&id={$page->id}",
);
}
if(count($actions)) $event->return = $actions + $event->return;
}

/*
* Publish Page on cron job
*
* Gets deffered page and publishes
*/
public function ___publish($page) {
$page->removeStatus(Page::statusUnpublished);
$page->removeStatus(Page::statusHidden);
$page->Save();
}

/*
* Main publish later function
*
* Gets deffered page and sets fields to be checked be lazy cron
*/
private function ___publishLater() {

// get page
$page = $this->pages->get($this->pageID);

// set output formatting to false
$page->of(false);

// set field time to settings default time and checkbox to true
$page->set($this->checkboxName, true);
$page->set($this->fieldName, $this->defaultTime);

// save page
$page->save();
$page->of(true);
}

/*
* Lazy Cron hook function
*
* Triggers every [set time interval] and checks pages
* Publishes page if time runout
*
* Adds publish page log
*/
public function ___publishDefferedPages(HookEvent $e){

// seconds since last lazycron
$seconds = $e->arguments[0];

// find all pages with deffered field
$defferedPages = $this->pages->find("{$this->checkboxName}=1,include=unpublished");

// for each page decrease time for deffered field
foreach ($defferedPages as $page) {

// get current page time
$timeTillPublish = $page->get($this->fieldName);

// set time to time minus time past
$timeLeft = $timeTillPublish - $seconds;

// if time passed 0 or less then publish page
$page->of(false);
if($timeLeft <= 0){
// remove flags and save
$this->publish($page);

$page->set($this->fieldName, 0);
$page->set($this->checkboxName, 0);

// log a page has been published
$log = wire('log');
$log->message('CRON:'. $seconds .' Pages: '. $page->name .' published');
}else{
$page->set($this->fieldName, $timeLeft);
}
// save page time
$page->Save();
$page->of(true);
}
}

/*
* Install new module specific fields
*/
private function installFields(){

// install pub later checkbox field
// find installed fields
$f = $this->fields->get($this->fieldName);
if($f){

// if field already found then don't try and make it
$this->message($this->fieldName . ' field found');

}else{

// create new field object to store crontime
$f = new Field();
// get a field type
$f->type = $this->modules->get("FieldtypeInteger");
$f->name = $this->fieldName;
$f->label = 'Publish Time Left';
$f->defaultValue = $this->defaultTime;
$f->icon = 'clock-o';
$f->columnWidth = 50;
$f->collapsed = 1;
$f->flags = 4;

$f->save(); // save the field

// create new field object to store whether to publish or not
$f = new Field();
// get a field type
$f->type = $this->modules->get("FieldtypeCheckbox");
$f->name = $this->checkboxName;
$f->label = 'Publish Page later';
$f->defaultValue = false;
$f->columnWidth = 50;
$f->icon = 'clock-o';
$f->collapsed = 1;
$f->flags = 4;

$f->save(); // save the field
}
}

/*
* Uninstall module specific fields
*/
private function uninstallFields(){

// find installed fields
$fInt = $this->fields->get($this->fieldName);
$fCheck = $this->fields->get($this->checkboxName);

if($fInt && $fCheck){
$fieldIntUsed = $fInt->numFieldgroups();
$fieldCheckUsed = $fCheck->numFieldgroups();

if($fieldIntUsed){
// field in use by template
$this->message('Unable to uninstall field '.$fInt->name);
}else{
// delete installed fields
$this->fields->delete($fInt);
$this->fields->save;
}

if($fieldCheckUsed){
// field in use by template
$this->message('Unable to uninstall field '.$fCheck->name);
}else{
// delete installed fields
$this->fields->delete($fCheck);
$this->fields->save;
}
}
}
}
</syntaxhighlight>

=== Inputfield / Fieldtype ===
[[ProcessWire - Fieldtype erstellen (Module)]]

=== Konfigurationsdatei statt getModuleInfo ===
Bei größeren Konfigruation (z.B. Admin Page Navigation) sinnvoll.
<syntaxhighlight lang="php">
<?php
/**
* ProcessHello.info.php
*
* Return information about this module.
*
* If preferred, you can use a getModuleInfo() method in your module file,
* or you can use a ModuleName.info.json file (if you prefer JSON definition).
*
*/
$info = array(
// Your module's title
'title' => 'Hello: Process Module Example',
// A 1 sentence description of what your module does
'summary' => 'A starting point module skeleton from which to build your own Process module.',
// Module version number: use 1 for 0.0.1 or 100 for 1.0.0, and so on
'version' => 1,
// Name of person who created this module (change to your name)
'author' => 'Ryan Cramer',
// Icon to accompany this module (optional), uses font-awesome icon names, minus the "fa-" part
'icon' => 'thumbs-up',
// URL to more info: change to your full modules.processwire.com URL (if available), or something else if you prefer
'href' => 'http://modules.processwire.com/',
// name of permission required of users to execute this Process (optional)
'permission' => 'helloworld',
// permissions that you want automatically installed/uninstalled with this module (name => description)
'permissions' => array(
'helloworld' => 'Run the HelloWorld module'
),

// page that you want created to execute this module
'page' => array(
'name' => 'helloworld',
'parent' => 'setup',
'title' => 'Hello World'
),
// optional extra navigation that appears in admin
// if you change this, you'll need to a Modules > Refresh to see changes
'nav' => array(
array(
'url' => '',
'label' => 'Hello',
'icon' => 'smile-o',
),
array(
'url' => 'something/',
'label' => 'Something',
'icon' => 'beer',
),
)
// for more options that you may specify here, see the file: /wire/core/Process.php
// and the file: /wire/core/Module.php
);
</syntaxhighlight>

== Interessantes - Read On ==
https://processwire.com/talk/topic/24067-solved-settings-fields-that-dont-save-to-database/
https://processwire.com/talk/topic/24075-solved-create-field-and-add-to-template/

ProcessWire - Module schreiben

2020-11-04T21:42:39Z

84.155.186.35:

ProcessWire - Module schreiben

2020-11-04T20:12:52Z

84.155.186.35: /* getModuleInfo */

ProcessWire - Konfigurierbare Module

2020-11-04T19:57:08Z

84.155.186.35: Die Seite wurde neu angelegt: „Ab ProcessWire 2.5.5. kann man Module mit Konfigurationsmöglichkeiten einfacher erstellen. Die Konfigurationsoptionen lagert man in eine extra Datei aus. h…“

Ab ProcessWire 2.5.5. kann man Module mit Konfigurationsmöglichkeiten einfacher erstellen. Die Konfigurationsoptionen lagert man in eine extra Datei aus.

https://processwire.com/blog/posts/new-module-configuration-options/

Beispiel Modul "Test" (gibt eine Meldung im Admin bei jeder Seitenladen aus)

* Datei mit dem Namen und Klasse [Modulname]Config erstellen
* Klasse extends ModulConfig
* Default Werte über getDefaults() Funktion definieren
* Inputfelder über getInputfields() Funktion definieren

Test.php
<syntaxhighlight lang="php">
class Test extends WireData implements Module {
public static function getModuleInfo() {
return array(
'title' => 'Module Test',
'version' => 1,
'summary' => 'Module for testing/demo purposes.',
'autoload' => 'template=admin',
);
}
public function ready() {
if($this->fullname && !count($this->input->post)) {
$msg = "Hi $this->fullname! ";
$msg .= "Your age: $this->age. ";
$msg .= "Favorite color: $this->color.";
$this->message($msg);
}
}
}
</syntaxhighlight>

TestConfig.php
<syntaxhighlight lang="php">
class TestConfig extends ModuleConfig {
public function getDefaults() {
return array(
'fullname' => '',
'color' => 'blue',
'age' => 40,
);
}
public function getInputfields() {
$inputfields = parent::getInputfields();

$f = $this->modules->get('InputfieldText');
$f->attr('name', 'fullname');
$f->label = 'Full Name';
$f->required = true;
$inputfields->add($f);

$f = $this->modules->get('InputfieldSelect');
$f->attr('name', 'color');
$f->label = 'Favorite Color';
$f->options = array(
'red' => 'Red',
'green' => 'Green',
'blue' => 'Blue'
);
$inputfields->add($f);

$f = $this->modules->get('InputfieldInteger');
$f->attr('name', 'age');
$f->label = 'Your Age';
$inputfields->add($f);

return $inputfields;
}
}
</syntaxhighlight>

ProcessWire - Module schreiben

2020-11-04T19:46:28Z

84.155.186.35:

== Links ==
'''Wichtigste Resourcen'''
https://processwire.com/docs/modules/development/ - Guter Ausgangspunkt
https://processwire.com/api/ref/module/ - Module API
https://processwire.com/api/ref/configurable-module/ - Klasse für Konfigurierbare Module
https://processwire.com/docs/modules/types/ - Welche Modultypen gibt es ?
https://processwire.com/talk/topic/778-module-dependencies/ - Module die andere Module benötigen
https://processwire.com/talk/forum/19-moduleplugin-development/ - Forum zum Thema Module entwickeln
http://somatonic.github.io/Captain-Hook/ - Hook Cheatsheet
https://processwire.com/blog/posts/new-module-configuration-options/ - Neuere Konfigurationsmöglichkeiten
https://processwire.com/docs/start/api-access/ Zugriff auf ProcessWire API Variablen (wire Objekt)

''' Tutorials und Beispiele zum Einstieg '''
https://processwire.com/docs/modules/ - Introduction, Development, Hooks, Types, Pro Modules, Third Party
https://github.com/ryancramerdesign/ProcessHello - Modul Skelett Beispiel für eigene Backend (Process) Module
https://github.com/ryancramerdesign/FieldtypeMapMarker - Beispiel für ein Fieldtype und Inputfield Modul
https://webdesign.tutsplus.com/tutorials/a-beginners-introduction-to-writing-modules-in-processwire--cms-26862

'''Wikiseiten'''
[[ProcessWire - Module Snippets]]
[[ProcessWire - Fieldtype erstellen (Module)]]

'''Weitere Links'''
http://modules.pw/ (Module Creator)

== Wo - Was ? ==
=== Welche Typen von Modulen gibt es ? ===
https://processwire.com/docs/modules/types/
* '''Fieldtype''': Repräsentiert einen Datentyp. Meistens keine Public API, Handelt Daten / Datenbank - [[ProcessWire - Fieldtype erstellen (Module)]]
* '''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.
* [[Process Module (ProcessWire)|'''Process''' for creating admin processes/applications.]]
* '''Textformatter''' for formatting text.
* '''AdminTheme''' for creating themes in the admin.
* '''WireMail''' for modules that send email and extend the WireMail class.
* '''Tfa''' for implementing a specific kind of two-factor authentication.
* '''ImageSizerEngine''' for modules that extend ImageSizerEngine for resizing images.
* '''FileCompiler''' for modules that extend FileCompilerModule for compilation of files.
* '''FileValidator''' for modules that extend FileValidatorModule for validation of files.

=== Wie werden Felder in der Datenbank angelegt ? ===
Dazu nutzt man den Typ "Fieldtype"

=== Wo rendert man die Ausgabe ? ===
Bei Ryan Cramers Event Beispiel legt er zwei Klassen Event und EventArray an, die auch die Render Funktionen enthalten.

=== Namenskonventionen ===
Ein Modulname sollte mit dem Typ den das Modul hat beginnen. Also etwa ProcessMeinAdminModul oder FieldtypeTable. ProcessWire listet das Modul dann in der Entsprechenden Kategorie auf. Wenn man etwas anderes nimmt z.B. LoginRegister dann kommt das Modul unter der neuen Rubrik "Login"

=== Konfigurierbare Module ===
Das geht seit 2.5.5 mittlerweile sehr einfach mit den neuen configuration-options.
https://processwire.com/blog/posts/new-module-configuration-options/
[[ProcessWire - Konfigurierbare Module]]

== Spezielle Funktionen in Modulen ==

=== getModuleInfo ===
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.

Statt einer getModuleInfo() Funktion kann man auch eine json Konfiguration als Datei hinterlegen

Siehe Beispiel unten

=== init ===
public function init(){}
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.

=== ready ===
<syntaxhighlight lang="php">
public function ready() {
if($this->page->template == 'admin') {
$this->message($this->hi());
}
}
</syntaxhighlight>
Wird in autoload Modulen aufgerufen wenn die API bereit ist. Nützlich für Hooks:

=== execute ===
<syntaxhighlight lang="php">
/**
* This function is executed when a page with your Process assigned is accessed.
*
* This can be seen as your main or index function. You'll probably want to replace
* everything in this function.
*
*/
public function ___execute() {
// greetingType and greeting are automatically populated to this module
// and they were defined in ProcessHello.config.php
if($this->greetingType == 'message') {
$this->message($this->greeting);
} else if($this->greetingType == 'warning') {
$this->warning($this->greeting);
} else {
$this->error($this->greeting);
}
// generate some navigation
$out = "
<h2>$this->greeting</h2>
<dl class='nav'>
<dt><a href='./something/'>Do Something</a></dt>
<dd>Runs the executeSomething() function.</dd>
</dl>
";
return $out;
}
</syntaxhighlight>

=== executeSomething ===
Ruft man eine Unterseite des Moduls auf kann man eine eigene execute Funktion nutzen
___executeSlug wobei Slug für den Url Slug steht. Heißt der slug /field/ dann wird executeField() aufgerufen, falls diese Funktion existiert.
<syntaxhighlight lang="php">
/**
* Called when the URL is this module's page URL + "/something/"
*
*/
public function ___executeSomething() {
// set a new headline, replacing the one used by our page
// this is optional as PW will auto-generate a headline
$this->headline('This is something!');
// add a breadcrumb that returns to our main page
// this is optional as PW will auto-generate breadcrumbs
$this->breadcrumb('../', 'Hello');
$out = "
<h2>Not much to to see here</h2>
<p><a href='../'>Go Back</a></p>
";
return $out;
}
</syntaxhighlight>

=== install & uninstall ===
<syntaxhighlight lang="php">

/**
* Called only when your module is installed
*
* If you don't need anything here, you can simply remove this method.
*
*/
public function ___install() {
parent::___install(); // always remember to call parent method
}
/**
* Called only when your module is uninstalled
*
* This should return the site to the same state it was in before the module was installed.
*
* If you don't need anything here, you can simply remove this method.
*
*/
public function ___uninstall() {
parent::___uninstall(); // always remember to call parent method
}
</syntaxhighlight>

== Vererbung und Eigenschaften in Modulen ==
Modules are not different from PHP classes.

To change the properties of MyModule class from within MyOtherModule class, you can either:

#Make MyOtherModule class extend MyModule. It will thus inherit MyModule's public and protected properties and methods
#Make the properties firstName and lastName configurable by passing them as parameters/arguments in MyModule's constructor method.

== Autoload Module und Hooks ==
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.

=== Hooks ===
https://processwire.com/docs/modules/hooks/
Hooks sind ein mächtiges Werkzeug. Sie geben einem die Möglichkeit an vielen Stellen "einzuhaken" und Funktionalität einzubauen.
<syntaxhighlight lang="php">
public function ready() {
$this->addHookAfter('Page::render', function($event) {
$event->return .= '<p>Hallo</p>';
});
}
</syntaxhighlight>
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.

Das gleiche aber nicht mit anonymer Funktion:
<syntaxhighlight lang="php">
public function ready() {
// add hook after Page::render() and make it call the "test" method of $this module
$this->addHookAfter('Page::render', $this, 'test');
}

public function test($event) {
// modify the return value of Page::render() to include the following:
$event->return .= '<p>Hallo</p>';
}
</syntaxhighlight>

=== Hooks zum erweitern von existierenden Klassen nutzen ===
Mit Hooks kann man in vorhandene Klassen einhaken. Z.B. läßt sich das Page Objekt erweitern.
<syntaxhighlight lang="php">
public function ready() {
$this->addHook('Page::summarize', $this, 'summarize');
}
public function summarize($event) {
$page = $event->object; // the $event->object represents the object hooked (Page)
$maxlen = $event->arguments(0); // first argument is the optional max length
if(!$maxlen) $maxlen = 200; // if no $maxlen was present, we'll use a default of 200
$summary = $this->sanitizer->truncate($page->body, $maxlen); // use sanitizer truncate method to create a summary
$event->return = $summary; // populate $summary to $event->return, the return value
}
</syntaxhighlight>
So kann man ganz einfach eine Zusammenfassung aller Kindseiten in einem Template rendern:
<syntaxhighlight lang="php">
foreach($page->children as $item) {
$summary = $item->summarize(150);
echo "<li><a href='$item->url'>$item->title</a><br>$summary";
}
</syntaxhighlight>

=== Autoload Module nur im Admin Bereich laden ===

'autoload' => 'template=admin'
statt
'autoload' => true

=== Hook Beispiele ===
Hook am Ende des Renderings
$this->addHookAfter('Page::render', function($event) {...});
Füge eine Funktion "summarize" zum Page Objekt hinzu.
$this->addHook('Page::summarize', $this, 'summarize');
Hook auf eine einzelne Instanz (hier pages Objekt)
$this->pages->addHookAfter('saved', function($event){...});
$this->addHook('Page::method', ...) // Spricht ALLE Instanzen an - Regelfall
$page->addHook('method', ...) // Spricht nur die EINE Instanz der Seite an.
</pre>

== Module Dependencies - voneinander abhängige Module ==

https://processwire.com/talk/topic/778-module-dependencies/
Wenn ein Modul nicht ohne ein anderes funktioniert spricht man von Module Dependency. In solchen Fällen kann man in der Modul Info angeben In vielen Fällen besteht ein Modul unter der Haube aus mehreren Einzelmodulen.

Um ProcessWire mitzuteilen dass ein Modul benötigt wird gibt man es in der Moduldefinition an:
'requires' => "LazyCron" // added this line
oder auch mehrere als Array
'requires' => array("LazyCron", "AdminBar") // added this line

ProcessWire kann auch dafür sorgen, dass ein Modul andere "Kindmodule" gleich mitinstalliert bzw. deinstalliert wenn es nicht mehr benötigt wird. Dazu gibt man dem Modul noch die 'install' dependency mit:

<syntaxhighlight lang="php">
<?php
public static function getModuleInfo() {
return array(
'title' => 'Log Master',
'version' => 101,
'author' => 'Lumberjack Bob',
'summary' => 'Log all actions on your site',
'requires' => 'LazyCron',
'installs' => 'ProcessLogMaster' // added this line
);
);
</syntaxhighlight>

ProcessWire sieht dann eine Kindabhängigkeit zu diesem Modul und handelt auch das Deinstallieren, wenn das Elternmodul deinstalliert wird.

== CSS und JavaScript in Modulen ==
Bei Process Modulen möchte man für das Styling etc. im Backend oft CSS und JS Dateien hinzufügen.

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:

<pre>

/**
* This JS file is only loaded when the ProcessHello module is run
*
* You should delete it if you have no javascript to add.
*
*/

$(document).ready(function() {
// do something
});
</pre>

== Beispiele ==
=== Frontend Rendering Module ===
A bit old but working

<syntaxhighlight lang="php">
<?php

/**
* FrontEndRender
*
* Author: Ben Byford
*
* ProcessWire 2.x
* Copyright (C) 2010 by Ryan Cramer
* Licensed under GNU/GPL v2, see LICENSE.TXT
*
* http://www.processwire.com
* http://www.ryancramer.com
*
*/

class FrontEndRender extends WireData implements Module {

public static function getModuleInfo() {
return array(
'title' => 'FrontEndRender',
'version' => 0.1,
'summary' => "Outputs html and static variables to frontend",
'author' => 'Ben Byford',
'singular' => true,
'href' => 'https://github.com/benbyford/PW-starter-modules'
);
}

// protected variable only accessable within module
protected $name = 'Ben';

/*
* render function to be called in PW template like this:
* $FrontEndRender = $modules->getModule('FrontEndRender');
* echo '<h1>' . $FrontEndRender->render() . '</h1>';
*
*/
public function render(){
return "Hello " . $this->name;
}
}
?>
</syntaxhighlight>

=== ProcessWire Hello World Modul ===
Beispiel Modul mit Hooks (liegt immer in der Standardinstallation)
<syntaxhighlight lang="php">
<?php namespace ProcessWire;

/**
* ProcessWire 'Hello world' demonstration module
*
* Demonstrates the Module interface and how to add hooks.
*
* See README file for further links regarding module development.
*
* This file is licensed under the MIT license
* https://processwire.com/about/license/mit/
*
* ProcessWire 3.x, Copyright 2016 by Ryan Cramer
* https://processwire.com
*
*/

class Helloworld extends WireData implements Module {

/**
* getModuleInfo is a module required by all modules to tell ProcessWire about them
*
* @return array
*
*/
public static function getModuleInfo() {

return array(

// The module's title, typically a little more descriptive than the class name
'title' => 'Hello World',

// version number
'version' => 3,

// summary is brief description of what this module is
'summary' => 'An example module used for demonstration purposes.',

// Optional URL to more information about the module
'href' => 'https://processwire.com',

// singular=true: indicates that only one instance of the module is allowed.
// This is usually what you want for modules that attach hooks.
'singular' => true,

// autoload=true: indicates the module should be started with ProcessWire.
// This is necessary for any modules that attach runtime hooks, otherwise those
// hooks won't get attached unless some other code calls the module on it's own.
// Note that autoload modules are almost always also 'singular' (seen above).
'autoload' => true,

// Optional font-awesome icon name, minus the 'fa-' part
'icon' => 'smile-o',
);
}

/**
* Initialize the module
*
* ProcessWire calls this when the module is loaded. For 'autoload' modules, this will be called
* when ProcessWire's API is ready. As a result, this is a good place to attach hooks.
*
*/
public function init() {

// add a hook after the $pages->save, to issue a notice every time a page is saved
$this->pages->addHookAfter('save', $this, 'example1');

// add a hook after each page is rendered and modify the output
$this->addHookAfter('Page::render', $this, 'example2');

// add a 'hello' method to every page that returns "Hello World"
// use "echo $page->hello();" in your template file to display output
$this->addHook('Page::hello', $this, 'example3');

// add a 'hello_world' property to every page that returns "Hello [user]"
// use "echo $page->hello_world;" in your template file to display output
$this->addHookProperty('Page::hello_world', $this, 'example4');
}

/**
* Example1 hooks into the pages->save method and displays a notice every time a page is saved
*
* @param HookEvent $event
*
*/
public function example1($event) {
/** @var Page $page */
$page = $event->arguments[0];
$this->message("Hello World! You saved {$page->path}.");
}

/**
* Example2 hooks into every page after it's rendered and adds "Hello World" text at the bottom
*
* @param HookEvent $event
*
*/
public function example2($event) {

/** @var Page $page */
$page = $event->object;

// don't add this to the admin pages
if($page->template == 'admin') return;

// add a "Hello World" paragraph right before the closing body tag
$event->return = str_replace("</body>", "<p>Hello World!</p></body>", $event->return);
}

/**
* Example3 adds a 'hello' method (not property) to every page that simply returns "Hello World"
*
* @param HookEvent $event
*
*/
public function example3($event) {
$event->return = "Hello World";
}

/**
* Example 4 adds a 'hello_world' property (not method) to every page that returns "Hello [user]"
*
* @param HookEvent $event
*
*/
public function example4($event) {
$event->return = "Hello " . $this->user->name;
}

}

</syntaxhighlight>

=== ProcessWire Admin Bereich mit eigener Funktionalität erweitern (Modul)===
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863
<syntaxhighlight lang="php">

<?php
/**
* ProcessSimpleAdminPage
*
* @author Ben Byford
* http://www.benbyford.com
*
* @see http://www.processwire.com
*/

class ProcessSimpleAdminPage extends Process {

public static function getModuleInfo() {
return array(
'title' => 'Process Simple Admin Page',
'summary' => 'Simple Process module that adds new admin page with',
'version' => 001,

// Modules that extend Process may specify a 'page' attribute in the
// getModuleInfo(), this page will automatically be given the module
// process when added to teh pagetree.

// I have exampled but commented out the 'page' settings below
// so that I can show how one might add a page to install() and
// uninstall() in this and other modules (that might not extend
// Process)

// 'page' => array(
// 'name' => 'site-config',
// 'parent' => 'admin',
// 'title' => 'Site Config'
// )
);
}

public function execute() {
return '
<h2>Edit the text here in the module</h2>
<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>

<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>

<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>

<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>
';
}
public function install(){

// create new page to add to CMS
$page = new Page();

// add page attributes
$page->template = "admin";
$page->name = "cms-faq";
$page->title = "CMS FAQ";
$page->save();

// set this module as the page process, this allows us to display the above
$page->process = 'ProcessSimpleAdminPage';

// get admin page and set as page parent
$admin = $this->pages->get("id=2");
$page->parent = $admin;

// save page
$page->save();
}

public function uninstall(){

// delete created page
$page = $this->pages->get("name=cms-faq");
if(count($page)) $this->pages->delete($page, true);
}
}
</syntaxhighlight>

=== ProcessWire Textformatter Modul ===
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863
<syntaxhighlight lang="php">
<?php

/**
* TextformatterFindReplace
*
* Author: Ben Byford
*
* ProcessWire 2.x
* Copyright (C) 2010 by Ryan Cramer
* Licensed under GNU/GPL v2, see LICENSE.TXT
*
* http://www.processwire.com
* http://www.ryancramer.com
*
*/

class TextformatterFindReplace extends Textformatter implements Module {

public static function getModuleInfo() {
return array(
'title' => 'TextformatterFindReplace',
'version' => 0.1,
'summary' => "Finds and replaces any instance of config input to config output",
'author' => 'Ben Byford',
'singular' => true,
'href' => 'https://github.com/benbyford/PW-starter-modules'
);
}

/**
* Find and Replace the input string
*
* @param string $str The block of text to parse
*
* The incoming string is replaced with the formatted version of itself.
**/

public function format(&$str) {
$find = $this->findStr;
$str = preg_replace_callback($find, array($this,"replace"), $str);

}

// adding three underscores to a function allows other modules to hook it
public function ___replace($match) {
return $this->replaceStr;
}
}
?>
</syntaxhighlight>

=== Admin Funktionalität: Countdown zum Seitenveröffentlichen ===
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863

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).

I did this by:

'''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.

'''Adding hooks''' to both ''ProcessPageEdit::buildForm'' and ''ProcessPageListActions::getExtraActions'' enabling me to add the two buttons.

Checking to see if one of the buttons was clicked with my '''ready() function''' then setting the corresponding page’s checkbox to true.

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.

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).

<syntaxhighlight lang="php">
<?php
/**
* DeferredPublish (0.0.1)
* DeferredPublish publishes a page after a defined amount of time has elapsed using lazycron.
*
* @author Ben Byford
* http://www.benbyford.com
*
* ProcessWire 2.x
* Copyright (C) 2011 by Ryan Cramer
* Licensed under GNU/GPL v2, see LICENSE.TXT
*
* http://www.processwire.com
* http://www.ryancramer.com
*
*/

class PageDeferredPublish extends WireData implements Module {

public static function getModuleInfo() {
return array(
'title' => "PageDeferredPublish",
'version' => "0.0.1",
'summary' => "PageDeferredPublish",
'author' => "Ben Byford",
'href' => "https://github.com/benbyford/PW-intermediate-modules",
'icon' => "clock-o",
'autoload' => true,
'singular' => true,
'requires' => "LazyCron",
);
}

private $postPubLater = null;
private $pageID = null;
private $pagePubLater = null;
private $currentPage = null;

private $submitName = 'pdp_pub_later_submit';
private $listPageName = 'pdp_pub_later_list';
private $fieldName = 'pdp_pub_later';
private $checkboxName = 'pdp_pub_later_check';

private $defaultInterval = 'everyMinute';
private $defaultTime = 86400;

public function install(){
// add new fields needed for module
$this->installFields();
}
public function uninstall(){
// uninstall fields
$this->uninstallFields();
}

// initialize the hook in your AutoLoad module
public function init() {

// get defaults from module setting in CMS
$this->defaultTime = $this->pub_after;
$this->defaultInterval = $this->cron_check;

// get admin URL
$this->adminUrl = $this->wire('config')->urls->admin;

// add hooks to CRON, PageList, PageEdit
$this->addHookAfter("LazyCron::{$this->defaultInterval}", $this, 'publishDefferedPages');
$this->addHook("ProcessPageListActions::getExtraActions", $this, 'hookPageListActions');
$this->addHookAfter("ProcessPageEdit::buildForm", $this, "editForm");
}

public function ready() {

// if list button clicked then grab id
$this->pagePubLater = $this->input->get($this->listPageName);
$this->pageID = $this->input->id;

// get page
$this->currentPage = $this->pages->get($this->pageID);

// if pagelist pub later submit button clicked
if($this->pagePubLater){
$this->message("Page {$this->currentPage->name} deffered for publish.");
}

// if page edit submit button clicked
$this->postPubLater = $this->input->post($this->submitName);
if($this->postPubLater){
$this->message("Page {$this->currentPage->name} deffered for publish.");
}

// if either deffered publish sumbit found then publish page later
if($this->pagePubLater || $this->postPubLater){
$this->publishLater();
}
}

/*
* Hook: ProcessPageEdit::buildForm
*
* add Publish Later button to edit page if not yet published
*/
public function ___editForm(HookEvent $form) {

// get the InputFieldForm object from the event (return value of buildForm())
$form = $form->return;

$page = $this->pages->get($this->input->get->id);
$check = $page->get($this->checkboxName);

// check if publish button available and therfore unpublished
$target = $form->get('submit_publish');

if($target && $check == false){

// get InputfieldText module
$submit2 = $this->modules->get('InputfieldSubmit');
$submit2->attr('name', $this->submitName);
$submit2->attr('id', 'publish_later');
$submit2->attr('class', 'ui-button ui-widget ui-corner-all head_button_clone ui-state-default ui-priority-secondary');
$submit2->attr('value', 'Publish Later'); // Button: save unpublished

// get form element save and place before
$target = $form->get('submit_save');
$form->insertBefore($submit2, $target);

$form->return = $form;
}
}

public function ___hookPageListActions(HookEvent $event) {

// get current page
$page = $event->arguments[0];

// check to see if page is published
$pagePub = $page->is(Page::statusUnpublished);

// check to see if page template has deffered field
$pageHasDefferField = $page->get($this->fieldName);

$actions = array();

// don't get homepage or pages that are already published or are being deffered for publish
if($page->id > 1 && $pagePub == "published" && !is_null($pageHasDefferField) && $page->get($this->checkboxName) == false) {

$actions['publish_later'] = array(
'cn' => 'PublishLater',
'name' => 'pub later',
'url' => "{$this->adminUrl}?{$this->listPageName}=1&id={$page->id}",
);
}
if(count($actions)) $event->return = $actions + $event->return;
}

/*
* Publish Page on cron job
*
* Gets deffered page and publishes
*/
public function ___publish($page) {
$page->removeStatus(Page::statusUnpublished);
$page->removeStatus(Page::statusHidden);
$page->Save();
}

/*
* Main publish later function
*
* Gets deffered page and sets fields to be checked be lazy cron
*/
private function ___publishLater() {

// get page
$page = $this->pages->get($this->pageID);

// set output formatting to false
$page->of(false);

// set field time to settings default time and checkbox to true
$page->set($this->checkboxName, true);
$page->set($this->fieldName, $this->defaultTime);

// save page
$page->save();
$page->of(true);
}

/*
* Lazy Cron hook function
*
* Triggers every [set time interval] and checks pages
* Publishes page if time runout
*
* Adds publish page log
*/
public function ___publishDefferedPages(HookEvent $e){

// seconds since last lazycron
$seconds = $e->arguments[0];

// find all pages with deffered field
$defferedPages = $this->pages->find("{$this->checkboxName}=1,include=unpublished");

// for each page decrease time for deffered field
foreach ($defferedPages as $page) {

// get current page time
$timeTillPublish = $page->get($this->fieldName);

// set time to time minus time past
$timeLeft = $timeTillPublish - $seconds;

// if time passed 0 or less then publish page
$page->of(false);
if($timeLeft <= 0){
// remove flags and save
$this->publish($page);

$page->set($this->fieldName, 0);
$page->set($this->checkboxName, 0);

// log a page has been published
$log = wire('log');
$log->message('CRON:'. $seconds .' Pages: '. $page->name .' published');
}else{
$page->set($this->fieldName, $timeLeft);
}
// save page time
$page->Save();
$page->of(true);
}
}

/*
* Install new module specific fields
*/
private function installFields(){

// install pub later checkbox field
// find installed fields
$f = $this->fields->get($this->fieldName);
if($f){

// if field already found then don't try and make it
$this->message($this->fieldName . ' field found');

}else{

// create new field object to store crontime
$f = new Field();
// get a field type
$f->type = $this->modules->get("FieldtypeInteger");
$f->name = $this->fieldName;
$f->label = 'Publish Time Left';
$f->defaultValue = $this->defaultTime;
$f->icon = 'clock-o';
$f->columnWidth = 50;
$f->collapsed = 1;
$f->flags = 4;

$f->save(); // save the field

// create new field object to store whether to publish or not
$f = new Field();
// get a field type
$f->type = $this->modules->get("FieldtypeCheckbox");
$f->name = $this->checkboxName;
$f->label = 'Publish Page later';
$f->defaultValue = false;
$f->columnWidth = 50;
$f->icon = 'clock-o';
$f->collapsed = 1;
$f->flags = 4;

$f->save(); // save the field
}
}

/*
* Uninstall module specific fields
*/
private function uninstallFields(){

// find installed fields
$fInt = $this->fields->get($this->fieldName);
$fCheck = $this->fields->get($this->checkboxName);

if($fInt && $fCheck){
$fieldIntUsed = $fInt->numFieldgroups();
$fieldCheckUsed = $fCheck->numFieldgroups();

if($fieldIntUsed){
// field in use by template
$this->message('Unable to uninstall field '.$fInt->name);
}else{
// delete installed fields
$this->fields->delete($fInt);
$this->fields->save;
}

if($fieldCheckUsed){
// field in use by template
$this->message('Unable to uninstall field '.$fCheck->name);
}else{
// delete installed fields
$this->fields->delete($fCheck);
$this->fields->save;
}
}
}
}
</syntaxhighlight>

=== Inputfield / Fieldtype ===
[[ProcessWire - Fieldtype erstellen (Module)]]

=== Konfigurationsdatei statt getModuleInfo ===
Bei größeren Konfigruation (z.B. Admin Page Navigation) sinnvoll.
<syntaxhighlight lang="php">
<?php
/**
* ProcessHello.info.php
*
* Return information about this module.
*
* If preferred, you can use a getModuleInfo() method in your module file,
* or you can use a ModuleName.info.json file (if you prefer JSON definition).
*
*/
$info = array(
// Your module's title
'title' => 'Hello: Process Module Example',
// A 1 sentence description of what your module does
'summary' => 'A starting point module skeleton from which to build your own Process module.',
// Module version number: use 1 for 0.0.1 or 100 for 1.0.0, and so on
'version' => 1,
// Name of person who created this module (change to your name)
'author' => 'Ryan Cramer',
// Icon to accompany this module (optional), uses font-awesome icon names, minus the "fa-" part
'icon' => 'thumbs-up',
// URL to more info: change to your full modules.processwire.com URL (if available), or something else if you prefer
'href' => 'http://modules.processwire.com/',
// name of permission required of users to execute this Process (optional)
'permission' => 'helloworld',
// permissions that you want automatically installed/uninstalled with this module (name => description)
'permissions' => array(
'helloworld' => 'Run the HelloWorld module'
),

// page that you want created to execute this module
'page' => array(
'name' => 'helloworld',
'parent' => 'setup',
'title' => 'Hello World'
),
// optional extra navigation that appears in admin
// if you change this, you'll need to a Modules > Refresh to see changes
'nav' => array(
array(
'url' => '',
'label' => 'Hello',
'icon' => 'smile-o',
),
array(
'url' => 'something/',
'label' => 'Something',
'icon' => 'beer',
),
)
// for more options that you may specify here, see the file: /wire/core/Process.php
// and the file: /wire/core/Module.php
);
</syntaxhighlight>

ProcessWire - Module schreiben

2020-11-04T19:34:36Z

84.155.186.35: /* Links */

== Links ==
'''Wichtigste Resourcen'''
https://processwire.com/docs/modules/development/ - Guter Ausgangspunkt
https://processwire.com/api/ref/module/ - Module API
https://processwire.com/api/ref/configurable-module/ - Klasse für Konfigurierbare Module
https://processwire.com/docs/modules/types/ - Welche Modultypen gibt es ?
https://processwire.com/talk/topic/778-module-dependencies/ - Module die andere Module benötigen
https://processwire.com/talk/forum/19-moduleplugin-development/ - Forum zum Thema Module entwickeln
http://somatonic.github.io/Captain-Hook/ - Hook Cheatsheet
https://processwire.com/blog/posts/new-module-configuration-options/ - Neuere Konfigurationsmöglichkeiten
https://processwire.com/docs/start/api-access/ Zugriff auf ProcessWire API Variablen (wire Objekt)

''' Tutorials und Beispiele zum Einstieg '''
https://processwire.com/docs/modules/ - Introduction, Development, Hooks, Types, Pro Modules, Third Party
https://github.com/ryancramerdesign/ProcessHello - Modul Skelett Beispiel für eigene Backend (Process) Module
https://github.com/ryancramerdesign/FieldtypeMapMarker - Beispiel für ein Fieldtype und Inputfield Modul
https://webdesign.tutsplus.com/tutorials/a-beginners-introduction-to-writing-modules-in-processwire--cms-26862

'''Wikiseiten'''
[[ProcessWire - Module Snippets]]
[[ProcessWire - Fieldtype erstellen (Module)]]

'''Weitere Links'''
http://modules.pw/ (Module Creator)

== Wo - Was ? ==
=== Welche Typen von Modulen gibt es ? ===
https://processwire.com/docs/modules/types/
* '''Fieldtype''': Repräsentiert einen Datentyp. Meistens keine Public API, Handelt Daten / Datenbank - [[ProcessWire - Fieldtype erstellen (Module)]]
* '''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.
* [[Process Module (ProcessWire)|'''Process''' for creating admin processes/applications.]]
* '''Textformatter''' for formatting text.
* '''AdminTheme''' for creating themes in the admin.
* '''WireMail''' for modules that send email and extend the WireMail class.
* '''Tfa''' for implementing a specific kind of two-factor authentication.
* '''ImageSizerEngine''' for modules that extend ImageSizerEngine for resizing images.
* '''FileCompiler''' for modules that extend FileCompilerModule for compilation of files.
* '''FileValidator''' for modules that extend FileValidatorModule for validation of files.

=== Wie werden Felder in der Datenbank angelegt ? ===
Dazu nutzt man den Typ "Fieldtype"

=== Wo rendert man die Ausgabe ? ===
Bei Ryan Cramers Event Beispiel legt er zwei Klassen Event und EventArray an, die auch die Render Funktionen enthalten.
=== Namenskonvention ===
Ein Modulname sollte mit dem Typ den das Modul hat beginnen. Also etwa ProcessMeinAdminModul oder FieldtypeTable. ProcessWire listet das Modul dann in der Entsprechenden Kategorie auf. Wenn man etwas anderes nimmt z.B. LoginRegister dann kommt das Modul unter der neuen Rubrik "Login"

== Spezielle Funktionen in Modulen ==

=== getModuleInfo ===
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.

Statt einer getModuleInfo() Funktion kann man auch eine json Konfiguration als Datei hinterlegen

Siehe Beispiel unten

=== init ===
public function init(){}
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.

=== ready ===
<syntaxhighlight lang="php">
public function ready() {
if($this->page->template == 'admin') {
$this->message($this->hi());
}
}
</syntaxhighlight>
Wird in autoload Modulen aufgerufen wenn die API bereit ist. Nützlich für Hooks:

=== execute ===
<syntaxhighlight lang="php">
/**
* This function is executed when a page with your Process assigned is accessed.
*
* This can be seen as your main or index function. You'll probably want to replace
* everything in this function.
*
*/
public function ___execute() {
// greetingType and greeting are automatically populated to this module
// and they were defined in ProcessHello.config.php
if($this->greetingType == 'message') {
$this->message($this->greeting);
} else if($this->greetingType == 'warning') {
$this->warning($this->greeting);
} else {
$this->error($this->greeting);
}
// generate some navigation
$out = "
<h2>$this->greeting</h2>
<dl class='nav'>
<dt><a href='./something/'>Do Something</a></dt>
<dd>Runs the executeSomething() function.</dd>
</dl>
";
return $out;
}
</syntaxhighlight>

=== executeSomething ===
Ruft man eine Unterseite des Moduls auf kann man eine eigene execute Funktion nutzen
___executeSlug wobei Slug für den Url Slug steht. Heißt der slug /field/ dann wird executeField() aufgerufen, falls diese Funktion existiert.
<syntaxhighlight lang="php">
/**
* Called when the URL is this module's page URL + "/something/"
*
*/
public function ___executeSomething() {
// set a new headline, replacing the one used by our page
// this is optional as PW will auto-generate a headline
$this->headline('This is something!');
// add a breadcrumb that returns to our main page
// this is optional as PW will auto-generate breadcrumbs
$this->breadcrumb('../', 'Hello');
$out = "
<h2>Not much to to see here</h2>
<p><a href='../'>Go Back</a></p>
";
return $out;
}
</syntaxhighlight>

=== install & uninstall ===
<syntaxhighlight lang="php">

/**
* Called only when your module is installed
*
* If you don't need anything here, you can simply remove this method.
*
*/
public function ___install() {
parent::___install(); // always remember to call parent method
}
/**
* Called only when your module is uninstalled
*
* This should return the site to the same state it was in before the module was installed.
*
* If you don't need anything here, you can simply remove this method.
*
*/
public function ___uninstall() {
parent::___uninstall(); // always remember to call parent method
}
</syntaxhighlight>

== Vererbung und Eigenschaften in Modulen ==
Modules are not different from PHP classes.

To change the properties of MyModule class from within MyOtherModule class, you can either:

#Make MyOtherModule class extend MyModule. It will thus inherit MyModule's public and protected properties and methods
#Make the properties firstName and lastName configurable by passing them as parameters/arguments in MyModule's constructor method.

== Autoload Module und Hooks ==
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.

=== Hooks ===
https://processwire.com/docs/modules/hooks/
Hooks sind ein mächtiges Werkzeug. Sie geben einem die Möglichkeit an vielen Stellen "einzuhaken" und Funktionalität einzubauen.
<syntaxhighlight lang="php">
public function ready() {
$this->addHookAfter('Page::render', function($event) {
$event->return .= '<p>Hallo</p>';
});
}
</syntaxhighlight>
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.

Das gleiche aber nicht mit anonymer Funktion:
<syntaxhighlight lang="php">
public function ready() {
// add hook after Page::render() and make it call the "test" method of $this module
$this->addHookAfter('Page::render', $this, 'test');
}

public function test($event) {
// modify the return value of Page::render() to include the following:
$event->return .= '<p>Hallo</p>';
}
</syntaxhighlight>

=== Hooks zum erweitern von existierenden Klassen nutzen ===
Mit Hooks kann man in vorhandene Klassen einhaken. Z.B. läßt sich das Page Objekt erweitern.
<syntaxhighlight lang="php">
public function ready() {
$this->addHook('Page::summarize', $this, 'summarize');
}
public function summarize($event) {
$page = $event->object; // the $event->object represents the object hooked (Page)
$maxlen = $event->arguments(0); // first argument is the optional max length
if(!$maxlen) $maxlen = 200; // if no $maxlen was present, we'll use a default of 200
$summary = $this->sanitizer->truncate($page->body, $maxlen); // use sanitizer truncate method to create a summary
$event->return = $summary; // populate $summary to $event->return, the return value
}
</syntaxhighlight>
So kann man ganz einfach eine Zusammenfassung aller Kindseiten in einem Template rendern:
<syntaxhighlight lang="php">
foreach($page->children as $item) {
$summary = $item->summarize(150);
echo "<li><a href='$item->url'>$item->title</a><br>$summary";
}
</syntaxhighlight>

=== Autoload Module nur im Admin Bereich laden ===

'autoload' => 'template=admin'
statt
'autoload' => true

=== Hook Beispiele ===
Hook am Ende des Renderings
$this->addHookAfter('Page::render', function($event) {...});
Füge eine Funktion "summarize" zum Page Objekt hinzu.
$this->addHook('Page::summarize', $this, 'summarize');
Hook auf eine einzelne Instanz (hier pages Objekt)
$this->pages->addHookAfter('saved', function($event){...});
$this->addHook('Page::method', ...) // Spricht ALLE Instanzen an - Regelfall
$page->addHook('method', ...) // Spricht nur die EINE Instanz der Seite an.
</pre>

== Module Dependencies - voneinander abhängige Module ==

https://processwire.com/talk/topic/778-module-dependencies/
Wenn ein Modul nicht ohne ein anderes funktioniert spricht man von Module Dependency. In solchen Fällen kann man in der Modul Info angeben In vielen Fällen besteht ein Modul unter der Haube aus mehreren Einzelmodulen.

Um ProcessWire mitzuteilen dass ein Modul benötigt wird gibt man es in der Moduldefinition an:
'requires' => "LazyCron" // added this line
oder auch mehrere als Array
'requires' => array("LazyCron", "AdminBar") // added this line

ProcessWire kann auch dafür sorgen, dass ein Modul andere "Kindmodule" gleich mitinstalliert bzw. deinstalliert wenn es nicht mehr benötigt wird. Dazu gibt man dem Modul noch die 'install' dependency mit:

<syntaxhighlight lang="php">
<?php
public static function getModuleInfo() {
return array(
'title' => 'Log Master',
'version' => 101,
'author' => 'Lumberjack Bob',
'summary' => 'Log all actions on your site',
'requires' => 'LazyCron',
'installs' => 'ProcessLogMaster' // added this line
);
);
</syntaxhighlight>

ProcessWire sieht dann eine Kindabhängigkeit zu diesem Modul und handelt auch das Deinstallieren, wenn das Elternmodul deinstalliert wird.

== CSS und JavaScript in Modulen ==
Bei Process Modulen möchte man für das Styling etc. im Backend oft CSS und JS Dateien hinzufügen.

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:

<pre>

/**
* This JS file is only loaded when the ProcessHello module is run
*
* You should delete it if you have no javascript to add.
*
*/

$(document).ready(function() {
// do something
});
</pre>

== Beispiele ==
=== Frontend Rendering Module ===
A bit old but working

<syntaxhighlight lang="php">
<?php

/**
* FrontEndRender
*
* Author: Ben Byford
*
* ProcessWire 2.x
* Copyright (C) 2010 by Ryan Cramer
* Licensed under GNU/GPL v2, see LICENSE.TXT
*
* http://www.processwire.com
* http://www.ryancramer.com
*
*/

class FrontEndRender extends WireData implements Module {

public static function getModuleInfo() {
return array(
'title' => 'FrontEndRender',
'version' => 0.1,
'summary' => "Outputs html and static variables to frontend",
'author' => 'Ben Byford',
'singular' => true,
'href' => 'https://github.com/benbyford/PW-starter-modules'
);
}

// protected variable only accessable within module
protected $name = 'Ben';

/*
* render function to be called in PW template like this:
* $FrontEndRender = $modules->getModule('FrontEndRender');
* echo '<h1>' . $FrontEndRender->render() . '</h1>';
*
*/
public function render(){
return "Hello " . $this->name;
}
}
?>
</syntaxhighlight>

=== ProcessWire Hello World Modul ===
Beispiel Modul mit Hooks (liegt immer in der Standardinstallation)
<syntaxhighlight lang="php">
<?php namespace ProcessWire;

/**
* ProcessWire 'Hello world' demonstration module
*
* Demonstrates the Module interface and how to add hooks.
*
* See README file for further links regarding module development.
*
* This file is licensed under the MIT license
* https://processwire.com/about/license/mit/
*
* ProcessWire 3.x, Copyright 2016 by Ryan Cramer
* https://processwire.com
*
*/

class Helloworld extends WireData implements Module {

/**
* getModuleInfo is a module required by all modules to tell ProcessWire about them
*
* @return array
*
*/
public static function getModuleInfo() {

return array(

// The module's title, typically a little more descriptive than the class name
'title' => 'Hello World',

// version number
'version' => 3,

// summary is brief description of what this module is
'summary' => 'An example module used for demonstration purposes.',

// Optional URL to more information about the module
'href' => 'https://processwire.com',

// singular=true: indicates that only one instance of the module is allowed.
// This is usually what you want for modules that attach hooks.
'singular' => true,

// autoload=true: indicates the module should be started with ProcessWire.
// This is necessary for any modules that attach runtime hooks, otherwise those
// hooks won't get attached unless some other code calls the module on it's own.
// Note that autoload modules are almost always also 'singular' (seen above).
'autoload' => true,

// Optional font-awesome icon name, minus the 'fa-' part
'icon' => 'smile-o',
);
}

/**
* Initialize the module
*
* ProcessWire calls this when the module is loaded. For 'autoload' modules, this will be called
* when ProcessWire's API is ready. As a result, this is a good place to attach hooks.
*
*/
public function init() {

// add a hook after the $pages->save, to issue a notice every time a page is saved
$this->pages->addHookAfter('save', $this, 'example1');

// add a hook after each page is rendered and modify the output
$this->addHookAfter('Page::render', $this, 'example2');

// add a 'hello' method to every page that returns "Hello World"
// use "echo $page->hello();" in your template file to display output
$this->addHook('Page::hello', $this, 'example3');

// add a 'hello_world' property to every page that returns "Hello [user]"
// use "echo $page->hello_world;" in your template file to display output
$this->addHookProperty('Page::hello_world', $this, 'example4');
}

/**
* Example1 hooks into the pages->save method and displays a notice every time a page is saved
*
* @param HookEvent $event
*
*/
public function example1($event) {
/** @var Page $page */
$page = $event->arguments[0];
$this->message("Hello World! You saved {$page->path}.");
}

/**
* Example2 hooks into every page after it's rendered and adds "Hello World" text at the bottom
*
* @param HookEvent $event
*
*/
public function example2($event) {

/** @var Page $page */
$page = $event->object;

// don't add this to the admin pages
if($page->template == 'admin') return;

// add a "Hello World" paragraph right before the closing body tag
$event->return = str_replace("</body>", "<p>Hello World!</p></body>", $event->return);
}

/**
* Example3 adds a 'hello' method (not property) to every page that simply returns "Hello World"
*
* @param HookEvent $event
*
*/
public function example3($event) {
$event->return = "Hello World";
}

/**
* Example 4 adds a 'hello_world' property (not method) to every page that returns "Hello [user]"
*
* @param HookEvent $event
*
*/
public function example4($event) {
$event->return = "Hello " . $this->user->name;
}

}

</syntaxhighlight>

=== ProcessWire Admin Bereich mit eigener Funktionalität erweitern (Modul)===
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863
<syntaxhighlight lang="php">

<?php
/**
* ProcessSimpleAdminPage
*
* @author Ben Byford
* http://www.benbyford.com
*
* @see http://www.processwire.com
*/

class ProcessSimpleAdminPage extends Process {

public static function getModuleInfo() {
return array(
'title' => 'Process Simple Admin Page',
'summary' => 'Simple Process module that adds new admin page with',
'version' => 001,

// Modules that extend Process may specify a 'page' attribute in the
// getModuleInfo(), this page will automatically be given the module
// process when added to teh pagetree.

// I have exampled but commented out the 'page' settings below
// so that I can show how one might add a page to install() and
// uninstall() in this and other modules (that might not extend
// Process)

// 'page' => array(
// 'name' => 'site-config',
// 'parent' => 'admin',
// 'title' => 'Site Config'
// )
);
}

public function execute() {
return '
<h2>Edit the text here in the module</h2>
<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>

<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>

<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>

<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>
';
}
public function install(){

// create new page to add to CMS
$page = new Page();

// add page attributes
$page->template = "admin";
$page->name = "cms-faq";
$page->title = "CMS FAQ";
$page->save();

// set this module as the page process, this allows us to display the above
$page->process = 'ProcessSimpleAdminPage';

// get admin page and set as page parent
$admin = $this->pages->get("id=2");
$page->parent = $admin;

// save page
$page->save();
}

public function uninstall(){

// delete created page
$page = $this->pages->get("name=cms-faq");
if(count($page)) $this->pages->delete($page, true);
}
}
</syntaxhighlight>

=== ProcessWire Textformatter Modul ===
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863
<syntaxhighlight lang="php">
<?php

/**
* TextformatterFindReplace
*
* Author: Ben Byford
*
* ProcessWire 2.x
* Copyright (C) 2010 by Ryan Cramer
* Licensed under GNU/GPL v2, see LICENSE.TXT
*
* http://www.processwire.com
* http://www.ryancramer.com
*
*/

class TextformatterFindReplace extends Textformatter implements Module {

public static function getModuleInfo() {
return array(
'title' => 'TextformatterFindReplace',
'version' => 0.1,
'summary' => "Finds and replaces any instance of config input to config output",
'author' => 'Ben Byford',
'singular' => true,
'href' => 'https://github.com/benbyford/PW-starter-modules'
);
}

/**
* Find and Replace the input string
*
* @param string $str The block of text to parse
*
* The incoming string is replaced with the formatted version of itself.
**/

public function format(&$str) {
$find = $this->findStr;
$str = preg_replace_callback($find, array($this,"replace"), $str);

}

// adding three underscores to a function allows other modules to hook it
public function ___replace($match) {
return $this->replaceStr;
}
}
?>
</syntaxhighlight>

=== Admin Funktionalität: Countdown zum Seitenveröffentlichen ===
https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863

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).

I did this by:

'''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.

'''Adding hooks''' to both ''ProcessPageEdit::buildForm'' and ''ProcessPageListActions::getExtraActions'' enabling me to add the two buttons.

Checking to see if one of the buttons was clicked with my '''ready() function''' then setting the corresponding page’s checkbox to true.

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.

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).

<syntaxhighlight lang="php">
<?php
/**
* DeferredPublish (0.0.1)
* DeferredPublish publishes a page after a defined amount of time has elapsed using lazycron.
*
* @author Ben Byford
* http://www.benbyford.com
*
* ProcessWire 2.x
* Copyright (C) 2011 by Ryan Cramer
* Licensed under GNU/GPL v2, see LICENSE.TXT
*
* http://www.processwire.com
* http://www.ryancramer.com
*
*/

class PageDeferredPublish extends WireData implements Module {

public static function getModuleInfo() {
return array(
'title' => "PageDeferredPublish",
'version' => "0.0.1",
'summary' => "PageDeferredPublish",
'author' => "Ben Byford",
'href' => "https://github.com/benbyford/PW-intermediate-modules",
'icon' => "clock-o",
'autoload' => true,
'singular' => true,
'requires' => "LazyCron",
);
}

private $postPubLater = null;
private $pageID = null;
private $pagePubLater = null;
private $currentPage = null;

private $submitName = 'pdp_pub_later_submit';
private $listPageName = 'pdp_pub_later_list';
private $fieldName = 'pdp_pub_later';
private $checkboxName = 'pdp_pub_later_check';

private $defaultInterval = 'everyMinute';
private $defaultTime = 86400;

public function install(){
// add new fields needed for module
$this->installFields();
}
public function uninstall(){
// uninstall fields
$this->uninstallFields();
}

// initialize the hook in your AutoLoad module
public function init() {

// get defaults from module setting in CMS
$this->defaultTime = $this->pub_after;
$this->defaultInterval = $this->cron_check;

// get admin URL
$this->adminUrl = $this->wire('config')->urls->admin;

// add hooks to CRON, PageList, PageEdit
$this->addHookAfter("LazyCron::{$this->defaultInterval}", $this, 'publishDefferedPages');
$this->addHook("ProcessPageListActions::getExtraActions", $this, 'hookPageListActions');
$this->addHookAfter("ProcessPageEdit::buildForm", $this, "editForm");
}

public function ready() {

// if list button clicked then grab id
$this->pagePubLater = $this->input->get($this->listPageName);
$this->pageID = $this->input->id;

// get page
$this->currentPage = $this->pages->get($this->pageID);

// if pagelist pub later submit button clicked
if($this->pagePubLater){
$this->message("Page {$this->currentPage->name} deffered for publish.");
}

// if page edit submit button clicked
$this->postPubLater = $this->input->post($this->submitName);
if($this->postPubLater){
$this->message("Page {$this->currentPage->name} deffered for publish.");
}

// if either deffered publish sumbit found then publish page later
if($this->pagePubLater || $this->postPubLater){
$this->publishLater();
}
}

/*
* Hook: ProcessPageEdit::buildForm
*
* add Publish Later button to edit page if not yet published
*/
public function ___editForm(HookEvent $form) {

// get the InputFieldForm object from the event (return value of buildForm())
$form = $form->return;

$page = $this->pages->get($this->input->get->id);
$check = $page->get($this->checkboxName);

// check if publish button available and therfore unpublished
$target = $form->get('submit_publish');

if($target && $check == false){

// get InputfieldText module
$submit2 = $this->modules->get('InputfieldSubmit');
$submit2->attr('name', $this->submitName);
$submit2->attr('id', 'publish_later');
$submit2->attr('class', 'ui-button ui-widget ui-corner-all head_button_clone ui-state-default ui-priority-secondary');
$submit2->attr('value', 'Publish Later'); // Button: save unpublished

// get form element save and place before
$target = $form->get('submit_save');
$form->insertBefore($submit2, $target);

$form->return = $form;
}
}

public function ___hookPageListActions(HookEvent $event) {

// get current page
$page = $event->arguments[0];

// check to see if page is published
$pagePub = $page->is(Page::statusUnpublished);

// check to see if page template has deffered field
$pageHasDefferField = $page->get($this->fieldName);

$actions = array();

// don't get homepage or pages that are already published or are being deffered for publish
if($page->id > 1 && $pagePub == "published" && !is_null($pageHasDefferField) && $page->get($this->checkboxName) == false) {

$actions['publish_later'] = array(
'cn' => 'PublishLater',
'name' => 'pub later',
'url' => "{$this->adminUrl}?{$this->listPageName}=1&id={$page->id}",
);
}
if(count($actions)) $event->return = $actions + $event->return;
}

/*
* Publish Page on cron job
*
* Gets deffered page and publishes
*/
public function ___publish($page) {
$page->removeStatus(Page::statusUnpublished);
$page->removeStatus(Page::statusHidden);
$page->Save();
}

/*
* Main publish later function
*
* Gets deffered page and sets fields to be checked be lazy cron
*/
private function ___publishLater() {

// get page
$page = $this->pages->get($this->pageID);

// set output formatting to false
$page->of(false);

// set field time to settings default time and checkbox to true
$page->set($this->checkboxName, true);
$page->set($this->fieldName, $this->defaultTime);

// save page
$page->save();
$page->of(true);
}

/*
* Lazy Cron hook function
*
* Triggers every [set time interval] and checks pages
* Publishes page if time runout
*
* Adds publish page log
*/
public function ___publishDefferedPages(HookEvent $e){

// seconds since last lazycron
$seconds = $e->arguments[0];

// find all pages with deffered field
$defferedPages = $this->pages->find("{$this->checkboxName}=1,include=unpublished");

// for each page decrease time for deffered field
foreach ($defferedPages as $page) {

// get current page time
$timeTillPublish = $page->get($this->fieldName);

// set time to time minus time past
$timeLeft = $timeTillPublish - $seconds;

// if time passed 0 or less then publish page
$page->of(false);
if($timeLeft <= 0){
// remove flags and save
$this->publish($page);

$page->set($this->fieldName, 0);
$page->set($this->checkboxName, 0);

// log a page has been published
$log = wire('log');
$log->message('CRON:'. $seconds .' Pages: '. $page->name .' published');
}else{
$page->set($this->fieldName, $timeLeft);
}
// save page time
$page->Save();
$page->of(true);
}
}

/*
* Install new module specific fields
*/
private function installFields(){

// install pub later checkbox field
// find installed fields
$f = $this->fields->get($this->fieldName);
if($f){

// if field already found then don't try and make it
$this->message($this->fieldName . ' field found');

}else{

// create new field object to store crontime
$f = new Field();
// get a field type
$f->type = $this->modules->get("FieldtypeInteger");
$f->name = $this->fieldName;
$f->label = 'Publish Time Left';
$f->defaultValue = $this->defaultTime;
$f->icon = 'clock-o';
$f->columnWidth = 50;
$f->collapsed = 1;
$f->flags = 4;

$f->save(); // save the field

// create new field object to store whether to publish or not
$f = new Field();
// get a field type
$f->type = $this->modules->get("FieldtypeCheckbox");
$f->name = $this->checkboxName;
$f->label = 'Publish Page later';
$f->defaultValue = false;
$f->columnWidth = 50;
$f->icon = 'clock-o';
$f->collapsed = 1;
$f->flags = 4;

$f->save(); // save the field
}
}

/*
* Uninstall module specific fields
*/
private function uninstallFields(){

// find installed fields
$fInt = $this->fields->get($this->fieldName);
$fCheck = $this->fields->get($this->checkboxName);

if($fInt && $fCheck){
$fieldIntUsed = $fInt->numFieldgroups();
$fieldCheckUsed = $fCheck->numFieldgroups();

if($fieldIntUsed){
// field in use by template
$this->message('Unable to uninstall field '.$fInt->name);
}else{
// delete installed fields
$this->fields->delete($fInt);
$this->fields->save;
}

if($fieldCheckUsed){
// field in use by template
$this->message('Unable to uninstall field '.$fCheck->name);
}else{
// delete installed fields
$this->fields->delete($fCheck);
$this->fields->save;
}
}
}
}
</syntaxhighlight>

=== Inputfield / Fieldtype ===
[[ProcessWire - Fieldtype erstellen (Module)]]

=== Konfigurationsdatei statt getModuleInfo ===
Bei größeren Konfigruation (z.B. Admin Page Navigation) sinnvoll.
<syntaxhighlight lang="php">
<?php
/**
* ProcessHello.info.php
*
* Return information about this module.
*
* If preferred, you can use a getModuleInfo() method in your module file,
* or you can use a ModuleName.info.json file (if you prefer JSON definition).
*
*/
$info = array(
// Your module's title
'title' => 'Hello: Process Module Example',
// A 1 sentence description of what your module does
'summary' => 'A starting point module skeleton from which to build your own Process module.',
// Module version number: use 1 for 0.0.1 or 100 for 1.0.0, and so on
'version' => 1,
// Name of person who created this module (change to your name)
'author' => 'Ryan Cramer',
// Icon to accompany this module (optional), uses font-awesome icon names, minus the "fa-" part
'icon' => 'thumbs-up',
// URL to more info: change to your full modules.processwire.com URL (if available), or something else if you prefer
'href' => 'http://modules.processwire.com/',
// name of permission required of users to execute this Process (optional)
'permission' => 'helloworld',
// permissions that you want automatically installed/uninstalled with this module (name => description)
'permissions' => array(
'helloworld' => 'Run the HelloWorld module'
),

// page that you want created to execute this module
'page' => array(
'name' => 'helloworld',
'parent' => 'setup',
'title' => 'Hello World'
),
// optional extra navigation that appears in admin
// if you change this, you'll need to a Modules > Refresh to see changes
'nav' => array(
array(
'url' => '',
'label' => 'Hello',
'icon' => 'smile-o',
),
array(
'url' => 'something/',
'label' => 'Something',
'icon' => 'beer',
),
)
// for more options that you may specify here, see the file: /wire/core/Process.php
// and the file: /wire/core/Module.php
);
</syntaxhighlight>

Apache

2020-10-31T21:58:30Z

84.155.186.35: /* Virtual Host */

Tipps und Tricks für die Arbeit mit dem Apache Server.

Siehe auch:
htaccess Apache auf dem Mac etc.
[[Mac - Apache MySql PHP Server mit Homebrew]] Super flexible Möglichkeit.

== Apache2 und CGI/FastCGI ==
[[Apache2 und CGI/FastCGI]]

== Informationen der Apache Umgebung herausfinden ==
In der Shell
httpd -V
gibt einige Informationen zu Logfiles, Konfigurationsfiles etc. aus.
Funktioniert auch unter Windows, Mac usw.

==XAMPP auf Mac Apache Port ändern ==
Problem: In Mac OSX läuft bereits ein Apache auf Port 80. Wenn zusätzlich eine XAMPP Installation als Testumgebung läuft kann das zu langen Wartezeiten führen.
Lösung: XAMPP auf Port 8080 umstellen. Dazu in
'''etc/httpd.conf'''
Listen 8080
einstellen. Dann im Browser mit
http://localhost:8080
aufrufen.

== Eigener AMP Server mit Homebrew ==
[[Mac - Apache MySql PHP Server mit Homebrew]]

== Apache mySQL PHP auf Mac High Sierra ==
Mit Bordmitteln (Apache und PHP ist Teil von High Sierra mySQL wird dazu installiert)
[[Apache, PHP, mySQL auf High Sierra]]

== Virtual Host ==
Virtual Hosts kann man folgendermaßen einrichten:

etc/httpd.conf - diese Zeile auskommentieren (oder einfügen wenn nicht vorhanden)
Include etc/extra/httpd-vhosts.conf

Die Virtuellen Hosts können minimal z.b. so aussehen:

httpd-vhosts.conf file in the etc/extra/
<pre>
<VirtualHost *:80>
DocumentRoot "/Applications/XAMPP/xamppfiles/htdocs/"
ServerName localhost
</VirtualHost>
<VirtualHost *:80>
DocumentRoot "/Applications/XAMPP/xamppfiles/apps/wordpress/htdocs"
ServerName wordpress.localhost
</VirtualHost>
</pre>
Dabei ist der erste der Default Host für alle Domains die nicht explizit vorgegeben sind. Danach kommen beliebig viele Blöcke für Domains oder Subdomains. Für Domains auf dem localhost muss man evtl. die hosts Datei noch anpassen. Einfacher gehts mits subdomain.localhost

Apache

2020-10-31T21:57:00Z

84.155.186.35: /* Virtual Host */

Tipps und Tricks für die Arbeit mit dem Apache Server.

Siehe auch:
htaccess Apache auf dem Mac etc.
[[Mac - Apache MySql PHP Server mit Homebrew]] Super flexible Möglichkeit.

== Apache2 und CGI/FastCGI ==
[[Apache2 und CGI/FastCGI]]

== Informationen der Apache Umgebung herausfinden ==
In der Shell
httpd -V
gibt einige Informationen zu Logfiles, Konfigurationsfiles etc. aus.
Funktioniert auch unter Windows, Mac usw.

==XAMPP auf Mac Apache Port ändern ==
Problem: In Mac OSX läuft bereits ein Apache auf Port 80. Wenn zusätzlich eine XAMPP Installation als Testumgebung läuft kann das zu langen Wartezeiten führen.
Lösung: XAMPP auf Port 8080 umstellen. Dazu in
'''etc/httpd.conf'''
Listen 8080
einstellen. Dann im Browser mit
http://localhost:8080
aufrufen.

== Eigener AMP Server mit Homebrew ==
[[Mac - Apache MySql PHP Server mit Homebrew]]

== Apache mySQL PHP auf Mac High Sierra ==
Mit Bordmitteln (Apache und PHP ist Teil von High Sierra mySQL wird dazu installiert)
[[Apache, PHP, mySQL auf High Sierra]]

== Virtual Host ==
Virtual Hosts kann man folgendermaßen einrichten:

etc/httpd.conf - diese Zeile auskommentieren (oder einfügen wenn nicht vorhanden)
Include etc/extra/httpd-vhosts.conf

Die Virtuellen Hosts können minimal z.b. so aussehen:

httpd-vhosts.conf file in the etc/extra/
<pre>
<VirtualHost *:80>
DocumentRoot "/Applications/XAMPP/xamppfiles/htdocs/"
ServerName localhost
</VirtualHost>
<VirtualHost *:80>
DocumentRoot "/Applications/XAMPP/xamppfiles/apps/wordpress/htdocs"
ServerName wordpress.localhost </VirtualHost>
</pre>
Dabei ist der erste der Default Host für alle Domains die nicht explizit vorgegeben sind. Danach kommen beliebig viele Blöcke für Domains oder Subdomains. Für Domains auf dem localhost muss man evtl. die hosts Datei noch anpassen. Einfacher gehts mits subdomain.localhost

Apache

2020-10-31T21:56:18Z

84.155.186.35: /* Virtual Host */

Tipps und Tricks für die Arbeit mit dem Apache Server.

Siehe auch:
htaccess Apache auf dem Mac etc.
[[Mac - Apache MySql PHP Server mit Homebrew]] Super flexible Möglichkeit.

== Apache2 und CGI/FastCGI ==
[[Apache2 und CGI/FastCGI]]

== Informationen der Apache Umgebung herausfinden ==
In der Shell
httpd -V
gibt einige Informationen zu Logfiles, Konfigurationsfiles etc. aus.
Funktioniert auch unter Windows, Mac usw.

==XAMPP auf Mac Apache Port ändern ==
Problem: In Mac OSX läuft bereits ein Apache auf Port 80. Wenn zusätzlich eine XAMPP Installation als Testumgebung läuft kann das zu langen Wartezeiten führen.
Lösung: XAMPP auf Port 8080 umstellen. Dazu in
'''etc/httpd.conf'''
Listen 8080
einstellen. Dann im Browser mit
http://localhost:8080
aufrufen.

== Eigener AMP Server mit Homebrew ==
[[Mac - Apache MySql PHP Server mit Homebrew]]

== Apache mySQL PHP auf Mac High Sierra ==
Mit Bordmitteln (Apache und PHP ist Teil von High Sierra mySQL wird dazu installiert)
[[Apache, PHP, mySQL auf High Sierra]]

== Virtual Host ==
Virtual Hosts kann man folgendermaßen einrichten:

etc/httpd.conf - diese Zeile auskommentieren (oder einfügen wenn nicht vorhanden)
Include etc/extra/httpd-vhosts.conf

Die Virtuellen Hosts können minimal z.b. so aussehen:

httpd-vhosts.conf file in the etc/extra/
<pre>
<VirtualHost *:80>
DocumentRoot "/Applications/XAMPP/xamppfiles/htdocs/" ServerName localhost
</VirtualHost>
<VirtualHost *:80>
DocumentRoot "/Applications/XAMPP/xamppfiles/apps/wordpress/htdocs"
ServerName wordpress.localhost </VirtualHost>
</pre>
Dabei ist der erste der Default Host für alle Domains die nicht explizit vorgegeben sind. Danach kommen beliebig viele Blöcke für Domains oder Subdomains. Für Domains auf dem localhost muss man evtl. die hosts Datei noch anpassen. Einfacher gehts mits subdomain.localhost

Apache

2020-10-31T21:55:16Z

84.155.186.35:

Tipps und Tricks für die Arbeit mit dem Apache Server.

Siehe auch:
htaccess Apache auf dem Mac etc.
[[Mac - Apache MySql PHP Server mit Homebrew]] Super flexible Möglichkeit.

== Apache2 und CGI/FastCGI ==
[[Apache2 und CGI/FastCGI]]

== Informationen der Apache Umgebung herausfinden ==
In der Shell
httpd -V
gibt einige Informationen zu Logfiles, Konfigurationsfiles etc. aus.
Funktioniert auch unter Windows, Mac usw.

==XAMPP auf Mac Apache Port ändern ==
Problem: In Mac OSX läuft bereits ein Apache auf Port 80. Wenn zusätzlich eine XAMPP Installation als Testumgebung läuft kann das zu langen Wartezeiten führen.
Lösung: XAMPP auf Port 8080 umstellen. Dazu in
'''etc/httpd.conf'''
Listen 8080
einstellen. Dann im Browser mit
http://localhost:8080
aufrufen.

== Eigener AMP Server mit Homebrew ==
[[Mac - Apache MySql PHP Server mit Homebrew]]

== Apache mySQL PHP auf Mac High Sierra ==
Mit Bordmitteln (Apache und PHP ist Teil von High Sierra mySQL wird dazu installiert)
[[Apache, PHP, mySQL auf High Sierra]]

== Virtual Host ==
Virtual Hosts kann man folgendermaßen einrichten:

etc/httpd.conf - diese Zeile auskommentieren (oder einfügen wenn nicht vorhanden)
Include etc/extra/httpd-vhosts.conf

Die Virtuellen Hosts können minimal z.b. so aussehen:

httpd-vhosts.conf file in the etc/extra/
<pre>
<VirtualHost *:80>
DocumentRoot "/Applications/XAMPP/xamppfiles/htdocs/" ServerName localhost
</VirtualHost>
<VirtualHost *:80>
DocumentRoot "/Applications/XAMPP/xamppfiles/apps/wordpress/htdocs"
ServerName wordpress.localhost </VirtualHost>
</pre>
Dabei ist der erste der Default Host für alle Domains die nicht explizit vorgegeben sind. Danach kommen beliebig viele Blöcke für Domains.

ProcessWire - Nützliche Module

2020-10-28T19:44:10Z

84.155.186.35: /* Bedienungshilfen / Backend / Fieldtypes */

== Mal anschauen ==
https://modules.processwire.com/modules/process-cache-control/
https://modules.processwire.com/modules/inputfield-selector-select-id/ SeitenID über Seitenbaum in Modalwindow holen
https://modules.processwire.com/modules/markup-sitemap-xml/
https://modules.processwire.com/modules/process-page-field-select-creator/
https://modules.processwire.com/modules/pro-cache/
https://modules.processwire.com/modules/fieldtype-page-table-extended/
https://modules.processwire.com/modules/fieldtype-rock-awesome/ FontAwsome Icons einfügen
https://modules.processwire.com/modules/rest-api/ REST
https://modules.processwire.com/modules/process-graph-ql/
https://modules.processwire.com/modules/maintenance-mode/
https://modules.processwire.com/modules/fieldtype-secure-file/
https://modules.processwire.com/modules/mobile-detect/ mal schauen wie es gemacht ist
https://modules.processwire.com/modules/search-engine/
https://modules.processwire.com/modules/cronjob-empty-trash/ schauen wie es gemacht ist
https://modules.processwire.com/modules/process-general-settings/ anschauen
https://modules.processwire.com/modules/file-validator-svg-sanitizer/
https://modules.processwire.com/modules/download-guard/ Download Link
https://modules.processwire.com/modules/payment-stripe/ Stripe Erweiterung für Payment Modul
https://modules.processwire.com/modules/payment-module/
https://modules.processwire.com/modules/payment-paypal/ Papal Erweiterung für Payment Modul

Dies ist keine vollständige Liste aber mal eine kleine Hilfe auch um Kunden Module anbieten zu können...
* Cool
** Sehr Hilfreich - Killerfeatures für Kunden
*** Musthave Ohne geht's nicht
== Development ==
* '''ProcessAdminActions''' *** - Musthave bei komplexen Projekten. Kann viele Dinge als Batch erledigen und spart unendlich Zeit.
* '''GithubConnect'''
* '''ConnectPageFields''' 2 Wege Verbindung für Datenfelder. Kein richtiges m:n, hält aber die Felder synchron
* '''jQueryDataTables''' - Datatables in eigenen Modulen verwenden https://modules.processwire.com/modules/jquery-data-tables/
* '''HelperFieldLinks''' - Infos zu Feldern anzeigen und Shortcuts zu den Templates und Felddefinitionen die dazugehören.

=== Debugging ===
* '''TracyDebugger''' *** - für programmierlastige Projekte das Debugger Tool der Wahl

=== Daten Im- / Exportieren ===
* '''ImportPagesCSV''' *** - Importiert CSV Daten als Seiten in ProcessWire
* '''TableCsvImportExport''' - Importiert CSV Daten in Table Fields
* '''[[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

== Administration / Verwaltung ==
* '''AdminRestrictBranch''' - Redakteure auf einen Seitenzweig beschränken
* '''ModulesManager''' - Zugriff auf das offizielle Modulverzeichnis aus dem Backend heraus
* '''PageReferencesTab''' - Seitenverwaltung "Welche Seiten verweisen auf diese mittels PageReference Field"
* '''EmailNewUser''' - User über seinen Account Informieren. Nutzen mit '''PasswordForceChange'''
* '''ProcessWireUpgrade''' ** - Informiert über Upgrades - nützlich wenn man Updates als kostnpfl. Service anbieten möchte
* '''ProcessJumplinks''' * - Redirects verwalten
* '''PageRenameOptions''' - Ändert den Seitennamen bei Änderung des Titels. Am besten mit PagePathHistory verwenden wg. broken Links.
* '''RestrictRepeaterMatrix''' Zugriff auf Repeater Matrix Felder regulieren [[RestrictRepeaterMatrix (ProcessWire Modul)]]
* '''TemplatesChildPages''' Zugriff auf Kindseiten einschränken - erweitert Zugriffsregeln auf Seitenbasis, statt nur auf Templatebasis
* '''CronjobDatabaseBackup''' Automatische Datenbank Backups - nutzt LazyCron
* '''AdminPageFieldEditLinks''' - Anlegen und Verändern von Seiten die auf diese Zeigen
* '''ConnectPageFields''' - Zweiwege Verbindung von Page References (jede Seite zeigt auf die andere)
* '''ProcessPageFieldSelectCreator''' - Erzeugt Templates, Seiten und Felder für Select Strukturen z.B. Parentseite RoomTypes und Kindseiten Single Double Suite.
* '''AdminLinksInFrontend''' - Einstellbare Admin Links für das Bearbeiten der Seite + User Switcher...
* '''Duplicator''' - Duplizieren von Installationen inklusive Datenbank. Gut für regelmäßige Backups auch Crongesteuert und in die Cloud. Vorsicht beim Duplizieren für andere Websites, das Salz für die Verschlüsselung bleibt dann gleich.

== Navigation / Menüs ==
* '''ProcessMenuBuilder''' - Manuelle Custom Menu Erstellung - sinnvoll bei sehr individuellen Navigationen.

== Hilfe für Redakteure ==
* '''AssistedURL''' - Linkhilfe Adrians Fork ist oft weiter (https://github.com/adrianbj/processwire-fieldtype-assisted-url)
* '''PrevNextTabs''' - Abkürzung zur nächsten / vorigen Seite im Backend. Sinnvoll wenn viele Seiten bearbeitet werden müssen.
* '''CkeLinkFiles''' - Dateilinks leichter im Editor einfügen
* '''SchedulePages''' - Seiten auf Termin veröffentlichen
* '''ImageCropRatios''' - Super nützlich für Bildcropping mit Aspect Ratio (vorgegebene Seitenverhältnisse)

== Sicherheit und Recht ==
* '''EmailObfuscation''' **
* '''MarkupCookieConsent'''
* '''CookieManagementBanner''' - von Adrian

== Bedienungshilfen / Backend / Fieldtypes==
* '''AssistedUrl'''
* '''MinimalFieldset''' - läßt flexiblere Gestaltung der Felder im Backend zu.
* '''PageListSelectMultipleQuickly''' Mehrere Seiten auwählen ohne jedesmal den Baum neu zu öffnen
* '''PageFieldInfo''' - zusätzliche Infos bei Page Select Checkboxen anzeigen (bei hover und wenn gecheckt)
* '''FieldtypeTime''' - Feld zum Speichern von Zeit und Zeitintervallen, Es gibt noch ein weiteres schickes Zeitfeld mit Eingabehilfe (Genbänkle oder Yoga Namaste ? - TODO)
* '''RuntimeMarkup''' - Feld das PHP Code ausführen und das Ergebnis im Backend anzeigen kann. So kann man dynamischen Inhalt im Backend anzeigen z.B. Informationen aus Kindseiten etc.
* '''FieldtypeSelectExtOption''' - Select Felder bei dem die Optionen aus einer externen Quelle kommen können (z.B. eine Tabelle)
* '''RuntimeMarkup''' - Das Feld führt PHP-Code aus. Der Output wird dann an der Stelle des Felds im Backend ausgegeben. Nützlich um z.B. Referenzen oder Infos anzuzeigen.
* '''AdminPageFieldEditLinks''' - Mit dem Feld kann man Referenzen auf diese Seite direkt in einem Modal bearbeiten ohne extra die referenzierende Seite aufzurufen. Kann viel Arbeit sparen.

== Markup etc. erzeugen ==
* '''Pages2Pdf''' - Wrapper für mPdf Library zur PDF Erzeugung
* '''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/)
* '''TextformatterHannaCode''' ** - Snippets für den Editor erstellen, die dann komplexeren Markup erzeugen können (Killer für Wordpress-Lovers)
* '''TextformatterAutoAnchor''' - Erzeugt automatisch Ids und Slugs in den Überschrift Elementen
* '''TextformatterSoundmanager''' - Formatter für den Soundmanager2 Player - kann auch Multitrack und krasse Visualisierungen
* '''FieldtypePhone''' - Standard Telefonformatierung (https://github.com/adrianbj/FieldtypePhone)
* '''TextformatterFileInfo''' - Dateiinfo Textformatter
* '''InputfieldMarkupCKEditor''' - Text in Formbuilder Formularen einfügen

== Social Functionality Community Stuff ==
* '''NewsletterSubscription''' - Double Opt In Funktionalität für Newsletter etc.
* '''LoginRegister''' - Ryans Self Registration Beispiel

== SEO Module ==
* SEOMaestro - Quasi Nachfolger von MarkupSEO ?
* ProcessJumplinks - Manage Referers Basiert auf dem älteren
* MarkupRSS
* MarkupSitemap Erweiterte Version von MarkupSitemapXML. Kann auch Multilanguage Sites Managen.
* Process404Page - Load search results into 404 page using terms from the failed URL
* https://modules.processwire.com/modules/profields-autolinks/ - Generiert automatisch Links
* SearchEngineReferrerTracker - speichert Keywords über die Besucher von Suchmaschinen gekommen sind. Matomo kann das auch, dies wäre aber eine einfache Lösung.

== DSGVO ==
* MarkupCookieConsent - noch nicht getestet

== Structured Data - Schema.org ==
* MarkupJsonLDSchema

== Mal Testen ==
* '''ProcessCustomUploadNames''' - Renaming Rulse for Pages and other fields.
* '''ProcessBlog''' - Blog Modul von Ryan (für das Blog Profile entwickelt)
* '''MarkupSocialShareButtons'''
* '''MarkupPlyrMediaPlayer'''
* '''InstagramFeed'''
* '''MediaLibrary''' - Medienzugriff über Libraries. Auswahl in übergeordneten Seiten möglich.
* '''FrontEndEditLightbox''' - Frontend Editing der aktuellen Seite in einer Lightbox
* '''Sassify''' - Kompiliert Sass/SCSS/Compass - evtl. praktisch während der Entwicklungsphase
* '''Oauth2Login'''
* '''MarkupSitemap'''
* '''Blackhole''' - Lockt Bots die robots.txt missachten in ein Blackhole -> werden gebannt
* '''AdminThemeBoss''' - Platzsparendes zurückhaltendes uikit 3 Theme. Setzt auf dem Standard Theme auf
* '''MillSite''' - Milligram SiteProfile mit einigen Zusatzfeatures
* '''MillBlog''' - Milligram Framework Blog SiteProfile
* '''SeoMaestro''' - SEO Tool noch Alpha (2019-02)

ProcessWire - Nützliche Module

2020-10-28T19:42:36Z

84.155.186.35: /* Bedienungshilfen / Backend / Fieldtypes */

== Mal anschauen ==
https://modules.processwire.com/modules/process-cache-control/
https://modules.processwire.com/modules/inputfield-selector-select-id/ SeitenID über Seitenbaum in Modalwindow holen
https://modules.processwire.com/modules/markup-sitemap-xml/
https://modules.processwire.com/modules/process-page-field-select-creator/
https://modules.processwire.com/modules/pro-cache/
https://modules.processwire.com/modules/fieldtype-page-table-extended/
https://modules.processwire.com/modules/fieldtype-rock-awesome/ FontAwsome Icons einfügen
https://modules.processwire.com/modules/rest-api/ REST
https://modules.processwire.com/modules/process-graph-ql/
https://modules.processwire.com/modules/maintenance-mode/
https://modules.processwire.com/modules/fieldtype-secure-file/
https://modules.processwire.com/modules/mobile-detect/ mal schauen wie es gemacht ist
https://modules.processwire.com/modules/search-engine/
https://modules.processwire.com/modules/cronjob-empty-trash/ schauen wie es gemacht ist
https://modules.processwire.com/modules/process-general-settings/ anschauen
https://modules.processwire.com/modules/file-validator-svg-sanitizer/
https://modules.processwire.com/modules/download-guard/ Download Link
https://modules.processwire.com/modules/payment-stripe/ Stripe Erweiterung für Payment Modul
https://modules.processwire.com/modules/payment-module/
https://modules.processwire.com/modules/payment-paypal/ Papal Erweiterung für Payment Modul

Dies ist keine vollständige Liste aber mal eine kleine Hilfe auch um Kunden Module anbieten zu können...
* Cool
** Sehr Hilfreich - Killerfeatures für Kunden
*** Musthave Ohne geht's nicht
== Development ==
* '''ProcessAdminActions''' *** - Musthave bei komplexen Projekten. Kann viele Dinge als Batch erledigen und spart unendlich Zeit.
* '''GithubConnect'''
* '''ConnectPageFields''' 2 Wege Verbindung für Datenfelder. Kein richtiges m:n, hält aber die Felder synchron
* '''jQueryDataTables''' - Datatables in eigenen Modulen verwenden https://modules.processwire.com/modules/jquery-data-tables/
* '''HelperFieldLinks''' - Infos zu Feldern anzeigen und Shortcuts zu den Templates und Felddefinitionen die dazugehören.

=== Debugging ===
* '''TracyDebugger''' *** - für programmierlastige Projekte das Debugger Tool der Wahl

=== Daten Im- / Exportieren ===
* '''ImportPagesCSV''' *** - Importiert CSV Daten als Seiten in ProcessWire
* '''TableCsvImportExport''' - Importiert CSV Daten in Table Fields
* '''[[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

== Administration / Verwaltung ==
* '''AdminRestrictBranch''' - Redakteure auf einen Seitenzweig beschränken
* '''ModulesManager''' - Zugriff auf das offizielle Modulverzeichnis aus dem Backend heraus
* '''PageReferencesTab''' - Seitenverwaltung "Welche Seiten verweisen auf diese mittels PageReference Field"
* '''EmailNewUser''' - User über seinen Account Informieren. Nutzen mit '''PasswordForceChange'''
* '''ProcessWireUpgrade''' ** - Informiert über Upgrades - nützlich wenn man Updates als kostnpfl. Service anbieten möchte
* '''ProcessJumplinks''' * - Redirects verwalten
* '''PageRenameOptions''' - Ändert den Seitennamen bei Änderung des Titels. Am besten mit PagePathHistory verwenden wg. broken Links.
* '''RestrictRepeaterMatrix''' Zugriff auf Repeater Matrix Felder regulieren [[RestrictRepeaterMatrix (ProcessWire Modul)]]
* '''TemplatesChildPages''' Zugriff auf Kindseiten einschränken - erweitert Zugriffsregeln auf Seitenbasis, statt nur auf Templatebasis
* '''CronjobDatabaseBackup''' Automatische Datenbank Backups - nutzt LazyCron
* '''AdminPageFieldEditLinks''' - Anlegen und Verändern von Seiten die auf diese Zeigen
* '''ConnectPageFields''' - Zweiwege Verbindung von Page References (jede Seite zeigt auf die andere)
* '''ProcessPageFieldSelectCreator''' - Erzeugt Templates, Seiten und Felder für Select Strukturen z.B. Parentseite RoomTypes und Kindseiten Single Double Suite.
* '''AdminLinksInFrontend''' - Einstellbare Admin Links für das Bearbeiten der Seite + User Switcher...
* '''Duplicator''' - Duplizieren von Installationen inklusive Datenbank. Gut für regelmäßige Backups auch Crongesteuert und in die Cloud. Vorsicht beim Duplizieren für andere Websites, das Salz für die Verschlüsselung bleibt dann gleich.

== Navigation / Menüs ==
* '''ProcessMenuBuilder''' - Manuelle Custom Menu Erstellung - sinnvoll bei sehr individuellen Navigationen.

== Hilfe für Redakteure ==
* '''AssistedURL''' - Linkhilfe Adrians Fork ist oft weiter (https://github.com/adrianbj/processwire-fieldtype-assisted-url)
* '''PrevNextTabs''' - Abkürzung zur nächsten / vorigen Seite im Backend. Sinnvoll wenn viele Seiten bearbeitet werden müssen.
* '''CkeLinkFiles''' - Dateilinks leichter im Editor einfügen
* '''SchedulePages''' - Seiten auf Termin veröffentlichen
* '''ImageCropRatios''' - Super nützlich für Bildcropping mit Aspect Ratio (vorgegebene Seitenverhältnisse)

== Sicherheit und Recht ==
* '''EmailObfuscation''' **
* '''MarkupCookieConsent'''
* '''CookieManagementBanner''' - von Adrian

== Bedienungshilfen / Backend / Fieldtypes==
* '''AssistedUrl'''
* '''MinimalFieldset''' - läßt flexiblere Gestaltung der Felder im Backend zu.
* '''PageListSelectMultipleQuickly''' Mehrere Seiten auwählen ohne jedesmal den Baum neu zu öffnen
* '''PageFieldInfo''' - zusätzliche Infos bei Page Select Checkboxen anzeigen (bei hover und wenn gecheckt)
* '''FieldtypeTime''' - Feld zum Speichern von Zeit und Zeitintervallen, Es gibt noch ein weiteres schickes Zeitfeld mit Eingabehilfe (Genbänkle oder Yoga Namaste ? - TODO)
* '''RuntimeMarkup''' - Feld das PHP Code ausführen und das Ergebnis im Backend anzeigen kann. So kann man dynamischen Inhalt im Backend anzeigen z.B. Informationen aus Kindseiten etc.
* '''FieldtypeSelectExtOption''' - Select Felder bei dem die Optionen aus einer externen Quelle kommen können (z.B. eine Tabelle)
* '''RuntimeMarkup''' - Das Feld führt PHP-Code aus. Der Output wird dann an der Stelle des Felds im Backend ausgegeben. Nützlich um z.B. Referenzen oder Infos anzuzeigen.

== Markup etc. erzeugen ==
* '''Pages2Pdf''' - Wrapper für mPdf Library zur PDF Erzeugung
* '''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/)
* '''TextformatterHannaCode''' ** - Snippets für den Editor erstellen, die dann komplexeren Markup erzeugen können (Killer für Wordpress-Lovers)
* '''TextformatterAutoAnchor''' - Erzeugt automatisch Ids und Slugs in den Überschrift Elementen
* '''TextformatterSoundmanager''' - Formatter für den Soundmanager2 Player - kann auch Multitrack und krasse Visualisierungen
* '''FieldtypePhone''' - Standard Telefonformatierung (https://github.com/adrianbj/FieldtypePhone)
* '''TextformatterFileInfo''' - Dateiinfo Textformatter
* '''InputfieldMarkupCKEditor''' - Text in Formbuilder Formularen einfügen

== Social Functionality Community Stuff ==
* '''NewsletterSubscription''' - Double Opt In Funktionalität für Newsletter etc.
* '''LoginRegister''' - Ryans Self Registration Beispiel

== SEO Module ==
* SEOMaestro - Quasi Nachfolger von MarkupSEO ?
* ProcessJumplinks - Manage Referers Basiert auf dem älteren
* MarkupRSS
* MarkupSitemap Erweiterte Version von MarkupSitemapXML. Kann auch Multilanguage Sites Managen.
* Process404Page - Load search results into 404 page using terms from the failed URL
* https://modules.processwire.com/modules/profields-autolinks/ - Generiert automatisch Links
* SearchEngineReferrerTracker - speichert Keywords über die Besucher von Suchmaschinen gekommen sind. Matomo kann das auch, dies wäre aber eine einfache Lösung.

== DSGVO ==
* MarkupCookieConsent - noch nicht getestet

== Structured Data - Schema.org ==
* MarkupJsonLDSchema

== Mal Testen ==
* '''ProcessCustomUploadNames''' - Renaming Rulse for Pages and other fields.
* '''ProcessBlog''' - Blog Modul von Ryan (für das Blog Profile entwickelt)
* '''MarkupSocialShareButtons'''
* '''MarkupPlyrMediaPlayer'''
* '''InstagramFeed'''
* '''MediaLibrary''' - Medienzugriff über Libraries. Auswahl in übergeordneten Seiten möglich.
* '''FrontEndEditLightbox''' - Frontend Editing der aktuellen Seite in einer Lightbox
* '''Sassify''' - Kompiliert Sass/SCSS/Compass - evtl. praktisch während der Entwicklungsphase
* '''Oauth2Login'''
* '''MarkupSitemap'''
* '''Blackhole''' - Lockt Bots die robots.txt missachten in ein Blackhole -> werden gebannt
* '''AdminThemeBoss''' - Platzsparendes zurückhaltendes uikit 3 Theme. Setzt auf dem Standard Theme auf
* '''MillSite''' - Milligram SiteProfile mit einigen Zusatzfeatures
* '''MillBlog''' - Milligram Framework Blog SiteProfile
* '''SeoMaestro''' - SEO Tool noch Alpha (2019-02)

ProcessWire - Nützliche Module

2020-10-28T08:21:25Z

84.155.186.35: /* Social Functionality Community Stuff */

== Mal anschauen ==
https://modules.processwire.com/modules/process-cache-control/
https://modules.processwire.com/modules/inputfield-selector-select-id/ SeitenID über Seitenbaum in Modalwindow holen
https://modules.processwire.com/modules/markup-sitemap-xml/
https://modules.processwire.com/modules/process-page-field-select-creator/
https://modules.processwire.com/modules/pro-cache/
https://modules.processwire.com/modules/fieldtype-page-table-extended/
https://modules.processwire.com/modules/fieldtype-rock-awesome/ FontAwsome Icons einfügen
https://modules.processwire.com/modules/rest-api/ REST
https://modules.processwire.com/modules/process-graph-ql/
https://modules.processwire.com/modules/maintenance-mode/
https://modules.processwire.com/modules/fieldtype-secure-file/
https://modules.processwire.com/modules/mobile-detect/ mal schauen wie es gemacht ist
https://modules.processwire.com/modules/search-engine/
https://modules.processwire.com/modules/cronjob-empty-trash/ schauen wie es gemacht ist
https://modules.processwire.com/modules/process-general-settings/ anschauen
https://modules.processwire.com/modules/file-validator-svg-sanitizer/
https://modules.processwire.com/modules/download-guard/ Download Link
https://modules.processwire.com/modules/payment-stripe/ Stripe Erweiterung für Payment Modul
https://modules.processwire.com/modules/payment-module/
https://modules.processwire.com/modules/payment-paypal/ Papal Erweiterung für Payment Modul

Dies ist keine vollständige Liste aber mal eine kleine Hilfe auch um Kunden Module anbieten zu können...
* Cool
** Sehr Hilfreich - Killerfeatures für Kunden
*** Musthave Ohne geht's nicht
== Development ==
* '''ProcessAdminActions''' *** - Musthave bei komplexen Projekten. Kann viele Dinge als Batch erledigen und spart unendlich Zeit.
* '''GithubConnect'''
* '''ConnectPageFields''' 2 Wege Verbindung für Datenfelder. Kein richtiges m:n, hält aber die Felder synchron
* '''jQueryDataTables''' - Datatables in eigenen Modulen verwenden https://modules.processwire.com/modules/jquery-data-tables/
* '''HelperFieldLinks''' - Infos zu Feldern anzeigen und Shortcuts zu den Templates und Felddefinitionen die dazugehören.

=== Debugging ===
* '''TracyDebugger''' *** - für programmierlastige Projekte das Debugger Tool der Wahl

=== Daten Im- / Exportieren ===
* '''ImportPagesCSV''' *** - Importiert CSV Daten als Seiten in ProcessWire
* '''TableCsvImportExport''' - Importiert CSV Daten in Table Fields
* '''[[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

== Administration / Verwaltung ==
* '''AdminRestrictBranch''' - Redakteure auf einen Seitenzweig beschränken
* '''ModulesManager''' - Zugriff auf das offizielle Modulverzeichnis aus dem Backend heraus
* '''PageReferencesTab''' - Seitenverwaltung "Welche Seiten verweisen auf diese mittels PageReference Field"
* '''EmailNewUser''' - User über seinen Account Informieren. Nutzen mit '''PasswordForceChange'''
* '''ProcessWireUpgrade''' ** - Informiert über Upgrades - nützlich wenn man Updates als kostnpfl. Service anbieten möchte
* '''ProcessJumplinks''' * - Redirects verwalten
* '''PageRenameOptions''' - Ändert den Seitennamen bei Änderung des Titels. Am besten mit PagePathHistory verwenden wg. broken Links.
* '''RestrictRepeaterMatrix''' Zugriff auf Repeater Matrix Felder regulieren [[RestrictRepeaterMatrix (ProcessWire Modul)]]
* '''TemplatesChildPages''' Zugriff auf Kindseiten einschränken - erweitert Zugriffsregeln auf Seitenbasis, statt nur auf Templatebasis
* '''CronjobDatabaseBackup''' Automatische Datenbank Backups - nutzt LazyCron
* '''AdminPageFieldEditLinks''' - Anlegen und Verändern von Seiten die auf diese Zeigen
* '''ConnectPageFields''' - Zweiwege Verbindung von Page References (jede Seite zeigt auf die andere)
* '''ProcessPageFieldSelectCreator''' - Erzeugt Templates, Seiten und Felder für Select Strukturen z.B. Parentseite RoomTypes und Kindseiten Single Double Suite.
* '''AdminLinksInFrontend''' - Einstellbare Admin Links für das Bearbeiten der Seite + User Switcher...
* '''Duplicator''' - Duplizieren von Installationen inklusive Datenbank. Gut für regelmäßige Backups auch Crongesteuert und in die Cloud. Vorsicht beim Duplizieren für andere Websites, das Salz für die Verschlüsselung bleibt dann gleich.

== Navigation / Menüs ==
* '''ProcessMenuBuilder''' - Manuelle Custom Menu Erstellung - sinnvoll bei sehr individuellen Navigationen.

== Hilfe für Redakteure ==
* '''AssistedURL''' - Linkhilfe Adrians Fork ist oft weiter (https://github.com/adrianbj/processwire-fieldtype-assisted-url)
* '''PrevNextTabs''' - Abkürzung zur nächsten / vorigen Seite im Backend. Sinnvoll wenn viele Seiten bearbeitet werden müssen.
* '''CkeLinkFiles''' - Dateilinks leichter im Editor einfügen
* '''SchedulePages''' - Seiten auf Termin veröffentlichen
* '''ImageCropRatios''' - Super nützlich für Bildcropping mit Aspect Ratio (vorgegebene Seitenverhältnisse)

== Sicherheit und Recht ==
* '''EmailObfuscation''' **
* '''MarkupCookieConsent'''
* '''CookieManagementBanner''' - von Adrian

== Bedienungshilfen / Backend / Fieldtypes==
* '''AssistedUrl'''
* '''MinimalFieldset''' - läßt flexiblere Gestaltung der Felder im Backend zu.
* '''PageListSelectMultipleQuickly''' Mehrere Seiten auwählen ohne jedesmal den Baum neu zu öffnen
* '''PageFieldInfo''' - zusätzliche Infos bei Page Select Checkboxen anzeigen (bei hover und wenn gecheckt)
* '''FieldtypeTime''' - Feld zum Speichern von Zeit und Zeitintervallen, Es gibt noch ein weiteres schickes Zeitfeld mit Eingabehilfe (Genbänkle oder Yoga Namaste ? - TODO)
* '''RuntimeMarkup''' - Feld das PHP Code ausführen und das Ergebnis im Backend anzeigen kann. So kann man dynamischen Inhalt im Backend anzeigen z.B. Informationen aus Kindseiten etc.
* '''FieldtypeSelectExtOption''' - Select Felder bei dem die Optionen aus einer externen Quelle kommen können (z.B. eine Tabelle)

== Markup etc. erzeugen ==
* '''Pages2Pdf''' - Wrapper für mPdf Library zur PDF Erzeugung
* '''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/)
* '''TextformatterHannaCode''' ** - Snippets für den Editor erstellen, die dann komplexeren Markup erzeugen können (Killer für Wordpress-Lovers)
* '''TextformatterAutoAnchor''' - Erzeugt automatisch Ids und Slugs in den Überschrift Elementen
* '''TextformatterSoundmanager''' - Formatter für den Soundmanager2 Player - kann auch Multitrack und krasse Visualisierungen
* '''FieldtypePhone''' - Standard Telefonformatierung (https://github.com/adrianbj/FieldtypePhone)
* '''TextformatterFileInfo''' - Dateiinfo Textformatter
* '''InputfieldMarkupCKEditor''' - Text in Formbuilder Formularen einfügen

== Social Functionality Community Stuff ==
* '''NewsletterSubscription''' - Double Opt In Funktionalität für Newsletter etc.
* '''LoginRegister''' - Ryans Self Registration Beispiel

== SEO Module ==
* SEOMaestro - Quasi Nachfolger von MarkupSEO ?
* ProcessJumplinks - Manage Referers Basiert auf dem älteren
* MarkupRSS
* MarkupSitemap Erweiterte Version von MarkupSitemapXML. Kann auch Multilanguage Sites Managen.
* Process404Page - Load search results into 404 page using terms from the failed URL
* https://modules.processwire.com/modules/profields-autolinks/ - Generiert automatisch Links
* SearchEngineReferrerTracker - speichert Keywords über die Besucher von Suchmaschinen gekommen sind. Matomo kann das auch, dies wäre aber eine einfache Lösung.

== DSGVO ==
* MarkupCookieConsent - noch nicht getestet

== Structured Data - Schema.org ==
* MarkupJsonLDSchema

== Mal Testen ==
* '''ProcessCustomUploadNames''' - Renaming Rulse for Pages and other fields.
* '''ProcessBlog''' - Blog Modul von Ryan (für das Blog Profile entwickelt)
* '''MarkupSocialShareButtons'''
* '''MarkupPlyrMediaPlayer'''
* '''InstagramFeed'''
* '''MediaLibrary''' - Medienzugriff über Libraries. Auswahl in übergeordneten Seiten möglich.
* '''FrontEndEditLightbox''' - Frontend Editing der aktuellen Seite in einer Lightbox
* '''Sassify''' - Kompiliert Sass/SCSS/Compass - evtl. praktisch während der Entwicklungsphase
* '''Oauth2Login'''
* '''MarkupSitemap'''
* '''Blackhole''' - Lockt Bots die robots.txt missachten in ein Blackhole -> werden gebannt
* '''AdminThemeBoss''' - Platzsparendes zurückhaltendes uikit 3 Theme. Setzt auf dem Standard Theme auf
* '''MillSite''' - Milligram SiteProfile mit einigen Zusatzfeatures
* '''MillBlog''' - Milligram Framework Blog SiteProfile
* '''SeoMaestro''' - SEO Tool noch Alpha (2019-02)

ProcessWire - Navigation Snippets

2020-10-28T07:53:03Z

84.155.186.35: /* Nested List ausgehend von einer Seite (meistens Homepage) */

== TODO Seite aufräumen ==
== Siehe auch ==
[[Processwire Module: MarkupSimpleNavigation]] automatisch Navigation aus Seitenbaum erstellen
[[Aligator (ProcessWire)]] - automatische Navigation, gut wenn manipuliert werden muss.
[[Menu Builder (ProcessWire)]] - Menüs im Backend erstellen (Wordpress like)

== Navigation in Pagewire - Einführung ==
=== Navigationstypen allgemein ===
Es gibt verschiedene '''Typen von Navigationen'''. In Processwire hat man ein '''Pages Objekt''', indem auch Zugriff auf Kind- und Elternseiten möglich sind. Es bildet also immer die Sitestruktur ab. Daher übergibt man an die unten aufgeführten Funktionen entweder die Homepage oder die aktuelle Seite.

Unter dem Aspekt auf welcher Seite man sich befindet kann man unterscheiden zwischen:
* '''absolute Navigation''' normalerweise ausgehend von der Rootseite. diese ist dann auf allen Seiten gleich.
** z.B. alle Seiten des ersten Levels stehen in der Hauptnavigation egal auf welcher Seite ich im Moment bin
** z.B. verschachtelte Liste mit 2 oder mehr Leveln für Dropdown Navigationen wie Superfish, Megamenüs (mit zusätzlichen Infos...) oder Bootstrap Navigationen.
** Sitemap
* '''Navigation relativ zur Seite''' Diese kann sich von Seite zu Seite unterscheiden.
** Alle '''Seiten der aktuellen Ebene''' (oft kombiniert mit Breadcrumb / Hier-bin-ich) )
** Hauptebene '''und''' aktueller Level
** Alle Ebenen '''bis zur aktuellen Seite + deren Unterseiten''' falls vorhanden.
In letzten Fall könnte man auch Varianten bauen in denen eine Verschachtelte Liste erzeugt wird aber nur bestimmte Teile absolut Positioniert angezeigt werden und andere versteckt werden. Manchmal möchte man bestimmte Level aber auch an anderer Position zeigen (z.B. Sidebar)
In der Praxis hat man in der Regel
* Mindestens eine Hauptnavigation mit allen Seiten der 1. Ebene oder eine Hauptnavigation mit mehreren Ebenen für Dropdown Navigationen, mobile Navigation oder auch Sitemapartige Navigationen für den Footer (oft mit kleinen Beschreibungen).
* Eine Metanavigation mit Service Seiten wie Kontakt, Impressum etc. oft ist diese im Footer.

=== Unterschiede zwischen Verstecken, Veröffentlichen, Sperren ===
In Processwire sind diese Begriffe mit Userrechten verknüpft. Eine unveröffentlichte Seite kann also durchaus im Frontend aufgerufen werden (es sei denn man regelt das anders.) Vielmehr geht es darum das man User Rollen so gestalten kann, dass man z.B. einem User nur erlaubt unveröffentlichte Seiten zu editieren.

Denoch gibt es auch ein paar weitere Unterschiede.

Gesperrt -> Man kann die Seite nicht zum Editieren aufrufen. Über die Url kann Sie aufgerufen werden.

Unpublished -> Die Seite kann sobald sie gespeichert ist auch aufgerufen werden, WENN der User berechtigt ist. Nicht für Guest User (der normale Viewer)

TODO checken ob die Tabelle so für nicht angemeldete User stimmt.
{| class="wikitable"
|-
! !! Im Menü ($pages->find) !! Über URL erreichbar($pages->get) !! Ausgabe im Frontend !!
|-
| Unpublished / Unveröffentlicht || Nein || Nur User mit passenden Rechten. Gäste -> leere Seite ||
|-
| Hidden / Versteckt || Nein || Ja || Ja - leere Seite (keine Feldausgabe)
|-
| Locked / Gesperrt || Ja || Ja || Ja
|-
| Trash || Nein || Nein ||
|}
==== Seiten auf unveröffentlicht stellen ====
https://processwire.com/talk/topic/29-how-to-unpublish-a-page-without-deleting-it/

Was soll man tun wenn man eine Seite tatsächlich nicht mehr anzeigen will, sie aber noch nicht wegwerfen will?
Ryan schlägt folgendes vor:
* Mülleimer
* Remove Guest Role in Template
*

== Basics ==
=== Basic Navigation ===
<pre>
<?php
// get the homepage object
$homePage = $pages->get("/");
// get PageArray of homepage object and child page objects
$navItems = $homePage->and($homePage->children);
?>
Now you have a PageArray with the required items, you can iterate over them one at a time, and print the title of the page and the link to the page itself and wrap the whole thing in your list tag.

<ul class="nav">

<?php
// get the homepage object
$homePage = $pages->get("/");
// get PageArray of homepage object and child page objects
$navItems = $homePage->and($homePage->children);
// or if you don't want the home link
// $navItems = $homePage->children;
// iterate over the $navItems PageArray
foreach ($navItems as $navItem):
?>

<li class="nav-item">
<a class="nav-link" href="<?php echo $navItem->url; ?>"><?php echo $navItem->title; ?></a>
</li>

<?php endforeach; ?>

</ul>
</pre>
==== Basic mit active Class ====
<pre>
<ul class="nav">

<?php
// get the homepage object
$homePage = $pages->get("/");
// get PageArray of homepage object and child page objects
$navItems = $homePage->and($homePage->children);
// or if you don't want the home link
// $navItems = $homePage->children;
// iterate over the $navItems PageArray
foreach ($navItems as $navItem):

// if the id of the page currently being
// iterated equals the id of the current page
$activeClass = ($navItem->id == $page->id) ? " active" : "";
?>

<li class="nav-item">
<a class="nav-link<?php echo $activeClass; ?>" href="<?php echo $navItem->url; ?>"><?php echo $navItem->title; ?></a>
</li>

<?php endforeach; ?>

</ul>
</pre>
==== Child Menu ====
<pre>

<ul class="sub-menu">

<?php
// get children of the parent of the current page
$childPages = $page->parent->children;

// iterate over the $navItems PageArray
foreach ($childPages as $childPage):

// if the id of the page currently being
// iterated equals the id of the current page
$activeClass = ($navItem->id == $page->id) ? " active" : "";
?>

<li class="nav-item">
<a class="nav-link<?php echo $activeClass; ?>" href="<?php echo $childPage->url; ?>"><?php echo $childPage->title; ?></a>
</li>

<?php endforeach; ?>

</ul>
</pre>

=== Page Level ===
In which level in page tree we are?
$level = count($page->parents);

=== Link to Subpage und Platzhalter (Spacer) ===
Kann man gut für Superfish Menüs etc. benutzen. Bildet das Verhalten von Shortcuts und Spacern aus TYPO3 nach.

Anpassung der renderNavTree() Funktion von Ryan Cramer. Options Field Installieren und als globales Feld "navigation_type" mit den Optionen
<pre>
1=normal|Normal
2=doNotLink|Do not link
3=linkToFirstChild|Link to first childpage
</pre>
konfigurieren. Dann Funktion etwa so anpassen:
<pre>
...
// cycle through all the items
foreach($items as $item) {

// markup for the list item...
// if current item is the same as the page being viewed, add a "current" class to it
$out .= $item->id == wire('page')->id ? "<li class='current'>" : "<li>";

// markup for the link
$navigation_type = $item->navigation_type->id;
switch ( $navigation_type ) {
case 2: // do not link
$out .= "<span class='spacer'>$item->title</span>";
break;
case 3: // link to subpage
if( $item->hasChildren() ){
$out .= '<a href="'.$item->child->url.'">'.$item->title.'</a>';
}else{
$out .= "<span class='spacer'>$item->title</span>";
}
break;
default:
$out .= "<a href='$item->url'>$item->title</a>";
break;
}
...
</pre>

=== Redirect (301) ===
==== Redirect zu erster Unterseite ====
https://processwire.com/talk/topic/15-how-do-i-create-a-page-that-redirects-to-its-first-child/

Field ''redirects_to_first_child'' erstellen und im Template einfügen.
<syntaxhighlight lang="php">
<?php
if($page->numChildren && $page->redirects_to_first_child)
$session->redirect($page->child()->url);
?>
</syntaxhighlight>
Erzeugt 301 Weiterleitung

Anderer Ansatz wäre evtl. den Link bei der Menügenerierung direkt zu generieren. finde ich persönlich besser siehe ''Link to subpage und Platzhalter'' Beispiel. Allerdings sollte man dann vielleicht die Seite trotzdem per 301 Weiterleiten, falls die URL mal direkt aufgerufen wird oder bei Google gelistet ist.

==== Redirect zu anderer Seite in der Navigation ====
https://processwire.com/talk/topic/762-howto-menu-item-that-links-to-another-page/

1. Create a new field and call it 'redirect_url' or something like that, and use the 'URL' fieldtype.

2. Add that field to your template where you'd want to use it, or create a new template just for the purpose, like a template named 'redirect'.

3. Edit the page that you want to be a symlink and populate the 'redirect_url' field with the URL you want it to redirect to.

4. In your nav-generation code that links to the pages, do something like this:

<syntaxhighlight lang="php">
<?php
$url = $subpage->get("redirect_url|url"); // use redirect_url if there, otherwise use url
echo "<a href='$url'>{$subpage->title}</a>";
</syntaxhighlight>
5. You might also want to add this to your template that has the 'redirect_url' field: just in case there's anything linking to it directly. That way it'll send people to the right place either way:

<?php
if($page->redirect_url) $session->redirect($page->redirect_url);

=== Breadcrumb ===
<pre>

<div class='breadcrumbs'><?php
// breadcrumbs are the current page's parents
foreach($page->parents() as $item) {
echo "<span><a href='$item->url'>$item->title</a></span> ";
}
// optionally output the current page as the last item
echo "<span>$page->title</span> ";
?></div>
</pre>

=== One Level Navigation Bar ===
[[ProcessWire - One Level Navigation]]
=== Nächste Seite / Next Page Navigation ===
Beispiel 1
<syntaxhighlight lang="php">
if($page->next->id){
$next = '
<div class="next">
<i>Next:</i> 
<a class="ajax-link" name="'.$page->next->title.'" href="'. $page->next->url .'">
'. $page->next->title .'<span class="fa fa-arrow-right"><span>
</a>
</div>';
}
</syntaxhighlight>

Beispiel 2 (mit zurück zur Elternseite)
<syntaxhighlight lang="php">
$next = '';
if($page->next->id){
$next = '
<a href="'.$page->next->url.'">
<i class="fa fa-angle-right"></i>
</a>
';
}

$prev = '';
if($page->prev->id){
$prev = '
<a href="'.$page->prev->url.'" class="w-inline-block paginaton-but">
<i class="fa fa-angle-left"></i>
</a>';
}

$pagination = '
<div class="container pagination">
<div class="row">

<div class="col col-md-4">
<div class="align-center">
'.$prev.'
</div>
</div>

<div class="col col-md-4">
<div class="align-center">
<a href="'.$page->parent->url.'">
<i class="fa fa-th"></i>
</a>
</div>
</div>

<div class="col col-md-4">
<div class="align-right center">
'.$next.'
</div>
</div>
</div>

</div>
';

echo $pagination;
</syntaxhighlight>

=== Zurück zur Elternseite ===
<syntaxhighlight lang="php">
<div class="back"><a href="'.$page->parent()->url.'">zurück</a></div>
</syntaxhighlight>

=== Kindseiten mit $page->children ===
<?=$page->children?>
Output
5723,4958,5937

Beispiel
<syntaxhighlight lang="php">
<ul>
<?php
foreach($page->children as $child)
echo "<li><a href='{$child->url}'>{$child->title}</a></li>";
?> 
</ul>
</syntaxhighlight>
Ergebnis:
<pre>
<ul> 
<li><a href='/about/contact/'>Contact Us</a></li>
<li><a href='/about/press/'>Press Releases</a></li>
<li><a href='/about/staff/'>Our Staff</a></li> 
</ul>
</pre>
=== Children Tree ===
<syntaxhighlight lang="php">
function listChildrenTree($children, $current, $w) {

echo "<ul>";

foreach($children as $page) {

$class = '';
if($page === $current || $current->parents->slice(1)->has($page) ) {
$class = "class='on' style='font-weight:bold'";
}

$rootid = $w->pages->get("/")->id;

echo "<li><a href='{$page->url}' $class>";
if($page->id == $rootid) echo "<img src='" . $w->config->urls->templates . "styles/images/home.png' width='24' height='28' alt='' />";
echo "{$page->title}</a> ";

if($page->numChildren && $page->id != $rootid) listChildrenTree($page->children, $current, $w);

echo "</li>";
}
echo "</ul>";
}

$children = $pages->get("/")->children();
$children->prepend($pages->get("/"));

listChildrenTree($children, $page, $wire);
</syntaxhighlight>

== Bootstrap Navigation ==
<syntaxhighlight lang="php">
<?php namespace ProcessWire;
// Markup to use wicht navigation_type field (normal=1, no-link=2,subpage=3)
?>

<?php

// bundle up the first level pages and prepend the root home page
$homepage = $pages->get(1);
$pa = $homepage->children;
$pa = $pa->prepend($homepage);

// Set the ball rolling...
$myMenu = renderChildrenOf($pa);
$wrapper = '
<nav class="navbar navbar-default">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar-collapse-1" aria-expanded="false">
<span class="sr-only">Menü</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
</div>
<div class="collapse navbar-collapse" id="navbar-collapse-1">
|
</div>
</div>
</div>';
$myMenu = wrap($myMenu,$wrapper);
echo $myMenu;

/*
Navigation for ProcessWire using the Bootstrap 2.2.2 markup
This menu was written by Soma based on work by NetCarver and a bit thrown in by Joss
Bootstrap 3 update by Damienov, with multi level dropdown support fix
*/
function renderChildrenOf($pa, $output = '', $level = 0)
{
$output = '';
$level++;

foreach ($pa as $child) {
$atoggle = '';
$class = '';

if ($child->numChildren && count($child->parents) == 1) {
$class .= 'dropdown';
$atoggle .= ' class="dropdown-toggle" data-toggle="dropdown"';
} else if ($child->numChildren && count($child->parents) > 1 ) {
$class .= 'dropdown-submenu';
$atoggle .= ' class="dropdown-toggle"';
} else if ($child->numChildren && $child->id != 1) {
$class .= 'dropdown-menu';
}

// Makes the current page and it's top level parent add an active class
$class .= ($child === wire("page") || $child === wire("page")->rootParent) ? " active" : '';
$class = strlen($class) ? " class='" . trim($class) . "'" : '';

if ($child->numChildren && count($child->parents) == 1) {
// Add Caret if have children
$output .= "<li$class><a href='$child->url'$atoggle>$child->title <b class='caret'></b></a>";
} else if ($child->numChildren && count($child->parents) > 1) {
$output .= "<li$class><a tabindex='-1' href='$child->url'$atoggle>$child->title</a>";
} else {
$output .= "<li$class><a href='$child->url'$atoggle>$child->title</a>";
}

// If this child is itself a parent and not the root page, then render it's children in their own menu too...
if ($child->numChildren && $child->id != 1) {
$output .= renderChildrenOf($child->children, $output, $level);
}
$output .= '</li>';
}
$outerclass = ($level == 1) ? "nav navbar-nav" : 'dropdown-menu';
return "<ul class='$outerclass'>$output</ul>";
}

?>
</syntaxhighlight>

== Modul: MarkupSimpleNavigation==
[[Processwire Modul - MarkupSimpleNavigation]]

== Weitere Menübeispiele ==
=== Standard Tree Navigation ===
Für viele Zwecke ausreichend und leicht anpassbar, die klassische verschachtelte Liste.

=== Menüauswahl Hauptmenü / Metamenü / Footer-Navigation ===
Beispiel 1
Backend Feld menus anlegen Options:

1=Main Menu
2=Meta Menu

topnav.inc
<syntaxhighlight lang="php">
$pa = $homepage->and($homepage->children("menus.id=1"));//only if main menu is checked
$options = array('level' => '1', 'ulClass' => 'sf-menu', 'liClass' => '');
echo "<div>".renderNavTreeType($pa, $maxDepth = 1, $fieldNames = '', $options)."</div>";
</syntaxhighlight>

'''Beispiel 2 (älter)'''

Checkbox anlegen (footer_nav), und dann das Seitenarray etwa so modifizieren.
<pre>
$footer_nav = $pages->find("parent=1, footer_checkbox=1");
$main_nav = $pages->find("parent=1, footer_checkbox!=1");
</pre>

=== Zweispaltige Navigation aus Kindseiten ===
Verbesserungsvorschlag: Anstatt if lieber zwei for Schleifen -> bessere Performance
<syntaxhighlight lang="php">
// Childrens
$n = count($page->children);
$m = ceil($n/2);
$c = 0;

// NAVIGATION & SLIDER Items
$listItem = '';
$navList = '';
$col1 = '<ul class="nav-list col1">';
$col2 = '<ul class="nav-list col2">';
foreach ($page->children as $item) {
if($item->id == $page->rootParent->id) {
$listItem = '<li class="current">';
} else {
$listItem = '<li>';
}
$listItem .= '<a class="ajax-link" href="'.$item->url.'">'.$item->title.'</a></li>';
($c < $m) ? $col1 .= $listItem : $col2 .= $listItem;
$c++;
}
$col1 .= '</ul>';
$col1 .= '</ul>';
$navList = $col1.$col2;
</syntaxhighlight>

=== Pushy Menu ===
<syntaxhighlight lang="php">
/**
* Given a group of pages, render a <ul> navigation tree
*
* This is here to demonstrate an example of a more intermediate level
* shared function and usage is completely optional. This is very similar to
* the renderNav() function above except that it can output more than one
* level of navigation (recursively) and can include other fields in the output.
* Assumes there is a field navigation_type to decide how a list item is
* rendered
*
* @param array|PageArray $items
* @param int $maxDepth How many levels of navigation below current should it go?
* @param string $fieldNames Any extra field names to display (separate multiple fields with a space)
* @param array $options extra options for classes configuration etc.
* @return string
*
*/
function renderPushyMenu($items, $maxDepth = 0, $fieldNames = '', $options = array('level' => 0, 'ulClass' => '', 'liClass' => '', 'aClass' => '') ) {

// if we were given a single Page rather than a group of them, we'll pretend they
// gave us a group of them (a group/array of 1)
if($items instanceof Page) $items = array($items);
$out = '';
$c = 0;
$liClasses = array();
$ulClasses = array();
$level = 0;
$liClass = '';
$ulClass = '';

if(!empty($options['level'])) $level = $options['level'];
if(!empty($options['ulClass'])) {
$ulClasses[] = $options['ulClass'];
$ulClass = $options['ulClass'];
}

if(!empty($options['liClass'])) {
$liClasses[] = $options['liClass'];
$liClass = $options['liClass'];
}

// cycle through all the items
foreach($items as $item) {
//$level = count($page->parents);
// LI ITEM
$classes = $liClasses;
//if($item->id == wire('page')->id) $classes[] = 'cur';
if($item->hasChildren) {
// BUTTON instead of Link
$out .= '<li class="pushy-submenu"><button>'.$item->title.'</button>';
}else{
$classes[] = 'level-'.$level;
$out .= '<li class="'.implode($classes,' ').'">';
unset($classes);

// A ITEM
$navigation_type = $item->navigation_type->id;
$classes = $liClasses;
switch ( $navigation_type ) {
case 2: // do not link
$out .= '<span class="spacer">'.$item->title.'</span>';
break;
case 3: // link to subpage
if( $item->hasChildren() ){
$out .= '<a href="'.$item->child->url.'" class="ajax-link">'.$item->title.'</a>';
}else{
$out .= "<span class='spacer'>$item->title</span>";
}
break;
default:
$out .= '<a href="'.$item->url.'" class="ajax-link">'.$item->title.'</a>';
break;
}
unset($classes);
}
// if there are extra field names specified, render markup for each one in a <div>
// having a class name the same as the field name
if($fieldNames) foreach(explode(' ', $fieldNames) as $fieldName) {
$value = $item->get($fieldName);
if($value) $out .= " <div class='$fieldName'>$value</div>";
}

// if the item has children and we're allowed to output tree navigation (maxDepth)
// then call this same function again for the item's children
if($item->hasChildren() && $maxDepth) {
//if($class == 'nav') $class = 'nav nav-tree';
$nextLevelOptions = array('level' => $level+1, 'ulClass' => '', 'liClass' => $liClass);
$out .= renderNavTreeType($item->children, $maxDepth-1, $fieldNames, $nextLevelOptions);
}

// close the list item
$out .= "</li>\n";
}

// if output was generated above, wrap it in a <ul>

if($out) $out = "\n".'<ul class="'.implode($ulClasses,' ').'">'."\n".$out.'</ul>'."\n";

// return the markup we generated above
return $out;
}

</syntaxhighlight>

== Do not link / link to subpage ==
=== MarkupSimpleNavigation XTemplate + Redirect Beispiel ===

https://github.com/s...default-options

'''Menü Platzhalter'''
<syntaxhighlight lang="php">
"xtemplate" => "folder|placeholder", // specify one or more templates
"xitem_tpl" => "<span>{title}</span>", // default markup for page with this template
"xitem_current_tpl" => "<span>{title}</span>"
echo $nav->render(array(
'max_levels'=>2,
'selector'=>"limit=10",
'xtemplates' => 'placeholder|folder'
));
</syntaxhighlight>

'''Redirect Template'''

You could also have a template "redirect" with only a title and a page field (single page) to select any page you want to go.

Then in the code you should be able to write
<syntaxhighlight lang="php">
array('item_tpl' => '<a href="{redirect_page|url}">{title}</a>')
</syntaxhighlight>
So it would take the url of the referenced page in the page field if found, or if not it takes the url of the page itself. Assuming the page field is named "redirect_page".

=== In der Navi ===
Zusätzliches Feld (Options) im Backend mit Namen navigation_type

Beispiel
<syntaxhighlight lang="php">
/**
* Given a group of pages, render a <ul> navigation tree
* If there is a field navigation_type the vals have following meaning
* 1 = Normal
* 2 = Do not link
* 3 = Link to subpage
*
* @param array|PageArray $items
* @param int $maxDepth How many levels of navigation below current should it go?
* @param string $fieldNames Any extra field names to display (separate multiple fields with a space)
* @param string $class CSS class name for containing <ul>
* @return string
*
*/
function renderNavTreeType($items, $maxDepth = 0, $fieldNames = '', $options = array('level' => 0, 'ulClass' => 'nav', 'liClass' => '', 'aClass' => '') ) {

// if we were given a single Page rather than a group of them, we'll pretend they
// gave us a group of them (a group/array of 1)
if($items instanceof Page) $items = array($items);

// $out is where we store the markup we are creating in this function
$out = '';
$c = 0;
$liClasses = array();
$ulClasses = array();
$level = 0;
$liClass = '';
$ulClass = '';

if(!empty($options['level'])) $level = $options['level'];
if(!empty($options['ulClass'])) {
$ulClasses[] = $options['ulClass'];
$ulClass = $options['ulClass'];
}

if(!empty($options['liClass'])) {
$liClasses[] = $options['liClass'];
$liClass = $options['liClass'];
}

// cycle through all the items
foreach($items as $item) {
//$level = count($page->parents);
// LI ITEM
$classes = $liClasses;
if($item->id == wire('page')->id) $classes[] = 'cur';
if($item->hasChildren) $classes[] = 'has_children';
$classes[] = 'level-'.$level;
$out .= '<li class="'.implode($classes,' ').'">';
unset($classes);

// markup for the link
$navigation_type = $item->navigation_type->id;
$classes = $liClasses;
switch ( $navigation_type ) {
case 2: // do not link
$out .= '<span class="spacer">'.$item->title.'</span>';
break;
case 3: // link to subpage
if( $item->hasChildren() ){
$out .= '<a href="'.$item->child->url.'" class="ajax-link">'.$item->title.'</a>';
}else{
$out .= "<span class='spacer'>$item->title</span>";
}
break;
default:
$out .= '<a href="'.$item->url.'" class="ajax-link">'.$item->title.'</a>';
break;
}
unset($classes);
// if there are extra field names specified, render markup for each one in a <div>
// having a class name the same as the field name
if($fieldNames) foreach(explode(' ', $fieldNames) as $fieldName) {
$value = $item->get($fieldName);
if($value) $out .= " <div class='$fieldName'>$value</div>";
}

// if the item has children and we're allowed to output tree navigation (maxDepth)
// then call this same function again for the item's children
if($item->hasChildren() && $maxDepth) {
//if($class == 'nav') $class = 'nav nav-tree';
$nextLevelOptions = array('level' => $level+1, 'ulClass' => '', 'liClass' => $liClass);
$out .= renderNavTreeType($item->children, $maxDepth-1, $fieldNames, $nextLevelOptions);
}

// close the list item
$out .= "</li>\n";
}

// if output was generated above, wrap it in a <ul>

if($out) $out = "\n".'<ul class="'.implode($ulClasses,' ').'">'."\n".$out.'</ul>'."\n";

// return the markup we generated above
return $out;
}
</syntaxhighlight>

=== Redirect über das Template ===
Sinnvoll wenn die URL direkt aufgerufen wird:

$session->redirect($page->redirect_page->url);
or how about "redirect-to-firstchild".

$session->redirect($page->children->first()->url);

== Beispiele für Funktionen (z.B. in _func.php)==
'''Beispiele für Funktionen die Navigationen erzeugen. '''
=== One Level ===
==== Original ProcessWire Demo Beispiel ====

=== Nested List ausgehend von einer Seite (meistens Homepage) ===
<syntaxhighlight lang="php">
<?php namespace ProcessWire;

/**
* Given a group of pages, render a ONE LEVEL NAVBAR
*
* @param array|PageArray $items
* @return string
*
*/
function renderNavMain($pa,$pageId){
if($pa instanceof Page) $pa = array($pa);
$out = '<nav class="menu menu--ferdinand"><ul class="nav navbar-nav menu__list">';
foreach($pa as $item) {
if($item->id == $pageId) {
$out .= "<li class=\"menu__item menu__item--current cur\">";
} else {
$out .= "<li class=\"menu__item\">";
}
// if template isotope-parent add first isotope-child name as hash
if($item->template->name == 'isotope-parent'){
$out .= '<a class="menu__link" href="'.$item->url.'#'.$item->child->name.'">'.$item->title.'</a></li>';
}else $out .= '<a class="menu__link" href="'.$item->url.'">'.$item->title.'</a></li>';
}
$out .= "</ul></nav>";
return $out;
}

/**
* Given a group of pages render a standard ISOTOP MARKUP
*
* @param array|PageArray $items
* @return string
*
*/
function renderNavIsotope($pa){
if($pa instanceof Page) $pa = array($pa);
$out = '<ul class="submenu">';
foreach($pa as $item){
$out .= '<li><a href="#'.$item->name.'" class="isotope-link">'.$item->title.'</a></li>';
}
$out .= "</ul>";
return $out;
}

/**
* Given a group of pages, render a simple <ul> navigation
*
* This is here to demonstrate an example of a simple shared function.
* Usage is completely optional.
*
* @param PageArray $items
* @return string
*
*/
function renderNav(PageArray $items) {

// $out is where we store the markup we are creating in this function
$out = '';

// cycle through all the items
foreach($items as $item) {

// render markup for each navigation item as an <li>
if($item->id == wire('page')->id) {
// if current item is the same as the page being viewed, add a "current" class to it
$out .= "<li class='current'>";
} else {
// otherwise just a regular list item
$out .= "<li>";
}

// markup for the link
$out .= "<a href='$item->url'>$item->title</a> ";

// if the item has summary text, include that too
if($item->summary) $out .= "<div class='summary'>$item->summary</div>";

// close the list item
$out .= "</li>";
}

// if output was generated above, wrap it in a <ul>
if($out) $out = "<ul class='nav'>$out</ul>\n";

// return the markup we generated above
return $out;
}

/**
* Given a group of pages, render a <ul> navigation tree
*
* This is here to demonstrate an example of a more intermediate level
* shared function and usage is completely optional. This is very similar to
* the renderNav() function above except that it can output more than one
* level of navigation (recursively) and can include other fields in the output.
*
* @param array|PageArray $items
* @param int $maxDepth How many levels of navigation below current should it go?
* @param string $fieldNames Any extra field names to display (separate multiple fields with a space)
* @param string $class CSS class name for containing <ul>
* @return string
*
*/
function renderNavTree($items, $maxDepth = 0, $fieldNames = '', $class = 'nav') {

// if we were given a single Page rather than a group of them, we'll pretend they
// gave us a group of them (a group/array of 1)
if($items instanceof Page) $items = array($items);

// $out is where we store the markup we are creating in this function
$out = '';

// cycle through all the items
foreach($items as $item) {

// markup for the list item...
// if current item is the same as the page being viewed, add a "current" class to it
$out .= $item->id == wire('page')->id ? "<li class='current'>" : "<li>";

// markup for the link
$out .= "<a href='$item->url'>$item->title</a>";

// if there are extra field names specified, render markup for each one in a <div>
// having a class name the same as the field name
if($fieldNames) foreach(explode(' ', $fieldNames) as $fieldName) {
$value = $item->get($fieldName);
if($value) $out .= " <div class='$fieldName'>$value</div>";
}

// if the item has children and we're allowed to output tree navigation (maxDepth)
// then call this same function again for the item's children
if($item->hasChildren() && $maxDepth) {
if($class == 'nav') $class = 'nav nav-tree';
$out .= renderNavTree($item->children, $maxDepth-1, $fieldNames, $class);
}

// close the list item
$out .= "</li>";
}

// if output was generated above, wrap it in a <ul>
if($out) $out = "<ul class='$class'>$out</ul>\n";

// return the markup we generated above
return $out;
}

</syntaxhighlight>

== Komplette Beispiele ==
[[ProcessWire - Navigation Beispiele]]

ProcessWire - Navigation Beispiele

2020-10-28T07:48:09Z

84.155.186.35:

== Siehe auch ==
[[ProcessWire - Navigation Snippets]]
http://wiki.zone30.info/wikizone/index.php?title=Aligator_(ProcessWire)#Komplettes_Beispiel_1

== MarkupSimpleNavigation Modul Navigation ==
Hinweis: Oft tun's auch kleine Navigationssnippets anstatt der Module.
=== Multilevel Navigation mit diversen Klassen ===
<syntaxhighlight lang="php">
<?php namespace ProcessWire;

$prependHomepage = 0;
foreach($homepage->menus as $item) {
if($item->id == 1) $prependHomepage = 1;
}
if($prependHomepage) {
$pa = $homepage->and($homepage->children("menus.id=1"));
}else $pa = $homepage->children("menus.id=1");
// additional MarkupSimpleNavigation Filter
$selector = 'menus.id=1'; // filter works only for first level because markup simple navigation renders children by itself. This is why we need extra selector

$outer_tpl = '<ul class=" ul-nav">||</ul>';
$inner_tpl = '<ul>||</ul>';
$list_tpl = '<li%s>||</li>';//%s is where classes form parent_class etc. goes
$item_tpl = '<a href="{url}" class="nav-link">{headline|title}</a>';
$item_current_tpl ='<a href="{url}" class="current nav-link">{headline|title}</a>';

$myMenu = $modules->get("MarkupSimpleNavigation"); // load the module
$options = array(
'parent_class' => 'parent', // goes in li classes
'current_class' => 'current', // goes in li classes
'has_children_class' => 'has_children', // goes in li classes
'levels' => true,
'levels_prefix' => 'l-',//goes in li classes
'max_levels' => 4,
'firstlast' => true,
'collapsed' => false,
'show_root' => false,
'outer_tpl' => $outer_tpl, // usually the ul part
'inner_tpl' => $inner_tpl, // usually inner ul tags
'list_tpl' => $list_tpl,
'list_field_class' => '',
'item_tpl' => $item_tpl,
'item_current_tpl' => $item_current_tpl,
'xtemplates' => '',
'selector' => $selector,
'date_format' => 'd.m.Y',
'code_formatting' => false,
'debug' => false
);
$out = '
<nav>
'.$myMenu->render($options,null,$pa).'
</nav>
';
echo $out;
</syntaxhighlight>

=== Sidebar Navigation für MaterializeCSS ===
Beispiel orig. aus prantner.de. Nutzt ein Selectfeld um im Backen zu bestimmen ob eine Seite aufgeführt wird.

<syntaxhighlight lang="php">
<?php namespace ProcessWire;

$pages->get(1001)->my_selector = "template=projects";
$pa = $homepage->and($homepage->children("menus.id=1"));

$outer_tpl = '<ul id="slide-out" class="sidenav">||</ul>';
//if($configpage->nav_type->value == 1) $outer_tpl = '<ul id="slide-out" class="sidenav sidenav-fixed">||</ul>';
$sideMenu = $modules->get("MarkupSimpleNavigation"); // load the module
$options = array(
'parent_class' => 'parent',
'current_class' => 'current',
'has_children_class' => 'has_children',
'levels' => true,
'levels_prefix' => 'l-',
'max_levels' => 4,
'firstlast' => true,
'collapsed' => false,
'show_root' => false,
'selector' => '',
'selector_field' => 'nav_selector',
'outer_tpl' => $outer_tpl,
'inner_tpl' => '<ul>||</ul>',
'list_tpl' => '<li%s>||</li>',
'list_field_class' => '',
'item_tpl' => '<a href="{url}">{title}</a>',
'item_current_tpl' => '<a class="cur" href="{url}">{title}</a>',
'xtemplates' => '',
'xitem_tpl' => '<a href="{url}">{title}</a>',
'xitem_current_tpl' => '<span class="cur">{title}</span>',
'date_format' => 'd.m.Y',
'code_formatting' => false,
'debug' => false
);
$out = $sideMenu->render($options,null,$pa);

$out .= '
<a href="#" data-target="slide-out" class="sidenav-trigger" style="margin-left:0;"><i class="material-icons">menu</i></a>';
echo $out;
</syntaxhighlight>

== Previous Next Navigation mit Auswahlfeld im Backend ==
'''Main Template'''
<syntaxhighlight lang="php">

<?php include("partials/nav/nav-page.inc"); ?>
</syntaxhighlight>

'''nav-page.inc'''
<syntaxhighlight lang="php">
<?php namespace ProcessWire;

/*
* Page Prev Next Navigation
*/
$next = '';
$prev = '';
$navPageMarkup = '';
if($page->show_prev_next){
if($page->next->id){
$next = '
<span class="page-title next table-cell">
<a href="'.$page->next->url.'">
'.$page->next->title.'
</a>
</span>

<span class="nav-icon next table-cell">
 
<a href="'.$page->next->url.'">
<i class="fa fa-chevron-right" aria-hidden="true"></i>
</a>
</span>
</span>
';
}

if($page->prev->id){
$prev = '
<span class="nav-icon prev table-cell">
<a href="'.$page->prev->url.'">
<i class="fa fa-chevron-left" aria-hidden="true"></i>
</a>
 
</span>
<span class="page-title prev table-cell">
<a href="'.$page->prev->url.'">
'.$page->prev->title.'
</a>
</span>
';
}

$navPageMarkup = '
<div class="section v2 nav-page hide-on-small-only">
<div class="row container no-margin-bot">
<div class="col s12 nav-page">
<div class="page-nav-wrap table" style="">
<div class="table-row">
'.$prev.$next.'
</div>

</div>
</div>
</div>
</div>
';
}
echo $navPageMarkup;

</syntaxhighlight>

== Megamenu ==
Ab 3.0.119 gibt es eine neue Funktion WireArray->slice mit der man geschickt mehrspaltige Ausgaben realisieren kann.
https://processwire.com/blog/posts/processwire-3.0.119-and-new-site-updates/#new-wirearray-slices-method

Beispiel:
<syntaxhighlight lang="php">
$categories = $pages->get('/about/sites/categories/')->children();
foreach($categories->slices(3) as $items) {
echo "<div class='uk-width-1-3'><ul>";
echo $items->each("<li><a href='{url}'>{title}</a>");
echo "</ul></div>";
}
</syntaxhighlight>

ProcessWire - Selectors

2020-10-18T11:21:54Z

84.155.186.35: /* Beispiele */

== Operatoren ==
http://cheatsheet.processwire.com/selectors/selector-operators/
Selector Operators

=
Equal to (any_field=any_value)

!=
Not equal to (any_field!=any_value)

<
Less than (any_field

>
Greater than any_field>any_value

<=
Less than or equal to (any_field<=any_value)

>=
Greater than or equal to (any_field>=any_value)

*=
Contains the exact word or phrase (any_field*=any_value)

~=
Contains all the words (any_field~=any_value)

%=
Contains the exact word or phrase (using slower SQL LIKE) [v2.1] (any_field%=any_value)

^=
Contains the exact word or phrase at the beginning of the field [v2.1] (any_field^=any_value)

$=
Contains the exact word or phrase at the end of the field [v2.1] (any_field$=any_value)

=== Neue Operatoren ab 3.0.160 ===
List of new operators available as of ProcessWire 3.0.160

Here's a list of new operators available as of 3.0.160, along with brief explanation of what each operator does and how it differs from other similar operators.

Contains words partial (~*=)
Like existing match words (~=) operator, except that this one matches partial words as well.

Contains words live (~~=)
Like match words, except that the last word in the query is treated as a partial match.

Contains words like (~%=)
Matches all words in the query, in full or in part.

Contains words and expand (~+=)
Like match words operator, but with the added power of the query expansion feature supported by MySQL fulltext indexes.

Contains any words (~|=)
One or more of the words must match; this is similar to splitting the query with pipe (|) characters, but often easier to use, and better optimized.

Contains any partial words (~|*=)
Similar to the previous operator, except that this one also provides partial matches.

Contains any words like (~|%=)
Similar to the previous two operators, but uses LIKE query behind the scenes instead of the fulltext index.

Contains phrase and expand (*+=)
Variation of the phrase match operator (*=) with added query expansion support.

Contains match (**=)
This operator works much like the MATCH/AGAINST feature of MySQL fulltext indexes.

Contains match and expand (**+=)
Otherwise identical to previous operator, except for the added query expansion.

Advanced text search (#=)
This operator adds support for special characters, such as "+" for "must match", "-" for "must not match", and "*" for specifying partial matches.

== Owner Attribut ==
Nützlich bei Pagereferences, wenn auf die Seite verweisende Seiten gefunden und gleichzeitig gefiltert werden sollen.
https://processwire.com/blog/posts/processwire-3.0.95-core-updates/
<syntaxhighlight lang="php">
$members = $pages->find("template=member, age>50");
foreach($members as $m) {
$items = $m->memberships->find("club='Golf Club X', mtype=GOLD");
foreach($items as $membership) {
// add to excel or other export, etc.
}
}
</syntaxhighlight>
Ineffektiv bei vielen Datensätzen ->
<syntaxhighlight lang="php">
$items = $pages->find("club='Golf Club X', mtype=GOLD, memberships.owner.age>50");
foreach($items as $membership) {
// add to excel or other export, etc.
}
</syntaxhighlight>

== Beispiele ==
=== Sortiere Seiten nach Reihenfolge im Seitenbaum ===
Das funktioniert mit der Sortierung "sort".
$categories = pages('template=template_name,sort=sort');
=== Große Datenmenge mit findMany() durchsuchen ===
[[findMany() - ProcessWire API]]

=== Suche nach Seiten die Verweise auf bestimmte andere Seiten enthalten ===
https://processwire.com/talk/topic/5414-selector-find-page-reference-help/

Es sollen Seiten gefunden werden die mit einer Page Reference auf eine andere Seite verweisen. Am einfachsten geht das wenn man nicht wie man zuerst vermutet nach der Seiten ID sucht, sondern wenn man direkt nach der Seite sucht
team_name=$page

=== Suche nach Phrasen in Daten die in Seitenverweise enthalten sind ===
https://processwire.com/talk/topic/570-searching-page-reference-fields/

Es sollen Seiten gefunden werden, die Verweise auf andere Seiten enthalten. Beispielsweise enthalten Personen (Eltern) Links zu Notfalladressen die separat angelegt sind. Nun soll Nach Eltern gesucht werden, die eine bestimmte Notfalladresse enthalten. Gesucht wird nach einer Phrase im Notfalladrdessen Namen).

Lösung: Es wird in zwei Schritten gesucht.

1. Suche nach Kontakten mit dem Search Term im body und die dem template emergency-contact entsprechen
$contacts = $pages->find("body*='search term', template=emergency-contact");
2. Seiten die diesen Kontakten entsprechen
$parents = $pages->find("emergency-contacts=$contacts");

=== Selektoren in Option Fieldtypes ===
<syntaxhighlight lang="php">
$optionsfield // return id (string)
$optionsfield->id; // return id (int)
$optionsfield->title; // return string USE THIS or
$optionsfield->value; // return empty string or value (if your option settings like '1=value|title')

// dot syntax in selector string
$pages->find('optionsfield.id=2');
</syntaxhighlight>
=== Seiten finden ===
<pre>
$skyscrapers = $pages->find("template=skyscraper, sort=-modified");
foreach($skyscrapers as $skyscraper) {
echo "<li><a href='$skyscraper->url'>$skyscraper->title</a></li>";
}
</pre>
=== Page Reference auf diese Seite ===
https://processwire.com/talk/topic/1071-page-fieldtype-two-way-relation/
echo $pages->find("field1=$page")->render();
If the page isn't part of the front-end site, then I'll remove view access from its template. Or if it is part of the front-end, but I don't want to show the relations, then this:

if($page->editable()) echo $pages->find("field1=$page")->render();

Though I almost always integrate these relation-revealing pages into the site structure, as it's rare that this information doesn't have some value to the site's users too. This is an example of one that locates all pages referencing it in a field called 'country':
https://www.tripsite.com/countries/croatia/

=== Suche in PageReference Feldern ===
https://processwire.com/talk/topic/1224-selector-and-page-reference-field/
Finde Felder mit
* Template = POI
* poi_type.type = "zoo" (PageReference)
Der Filter
$poi = $pages->find(template=poi, poi_type.title='Zoo');
Funktioniert nicht.

Stattdessen
- holt man zuerst alle Seiten mit dem Titel Zoo und
- nimmt diese Menge als Filter für eine Suche im PageReference Feld (poi_type)

$pr = $pages->get("title=Zoo");
$poi = $pages->find("template=poi, poi_type=$pr");

=== Punkt Syntax ===
$architects = $pages->find("template=architect, city.title=Chicago");
$buildings = $pages->find("architect=$architects");
That's easy enough, but wouldn't it be nicer if you could just do this?
$buildings = $pages->find("architect.city.title=Chicago");

$buildings = $pages->find("architect.city.state.abbr=IL");
Broadening further, perhaps we want buildings from all architects in the USA:

$buildings = $pages->find("architect.city.state.country.abbr=USA");
Or perhaps both USA and Canada:

$buildings = $pages->find("architect.city.state.country.abbr=USA|CA");

=== User ===
http://cheatsheet.processwire.com/users/users-methods/users-find-selector/
Find all users whose email address ENDS with processwire.com and create a link to email them
<pre>
$items = $users->find("email$=processwire.com");
foreach($items as $item) {
echo "<li><a href='mailto:{$item->email}'>{$item->name}</a></li>";
}
</pre>
Find all users who have "fred" anywhere in their name

$items = $users->find("name*=fred");
Find all users who have the "superuser" role

$items = $users->find("roles=superuser");

== Array Selectors ==
https://processwire.com/blog/posts/processwire-3.0.13-selector-upgrades-and-new-form-builder-version/#building-a-selector-string-with-user-input-example

=== Selektoren als assoziative Arrays ===

Anstatt von Selector Strings kann man seit PW 3.0.13 auch Arrays nutzen.:d of a string:
<syntaxhighlight lang="php">
$results = $pages->find([
'template' => ['basic-page', 'product'],
'title|body%=' => $sanitizer->text($input->get('q')),
'categories' => $sanitizer->intArray($input->get('categories')),
'sort' => '-created'
]);
</syntaxhighlight>
Erläuterung:

Die ''$sanitizer->selectorValue()'' Methode um Text zu sanitizen der in Selektoren geht ist nicht mehr notwendig. Du solltest immer noch User Input sanitizen, aber man kann sich die sanierung für die Selektoren sparen.
Werte können Arrays sein. Im Beispiel werden Arrays für 'template' and 'categories' items genutzt.

Der "=" Operator wird für alle Selektoren Elemente angenommen, solange man nicht einen anderen Operator anhängt. Wie bei '''title|body%=''' zu sehen.

=== Selektoren als reguläre Arrays ===
Man kann auch ein reguläres (nicht assoziatives Array nutzen:
<syntaxhighlight lang="php">
$results = $pages->find([
['template', ['basic-page', 'product']],
['title|body', '%=', $input->get('q'), 'text'],
['categories', '=', $input->get('categories'), 'int'],
['sort', '-created']
]);
</syntaxhighlight>
Hier werden die Selektorenteile als Array im Array übergeben. Das Format ist folgendes:f those arrays can use any of the following formats:
<pre>
[field, value]
[field, operator, value]
[field, operator, value, sanitizer]
[field, operator, value, whitelist]
</pre>

The field element can be specified as a single field name, pipe "|" separated field names, or an array of field name(s).

The operator can be any operator. If none is specified, then equals "=" is assumed (which you can do if only specifying a field and value).

The value can be a string, number or array of either.

The sanitizer can be any $sanitizer method name that you want the value to pass through before being used in the selector.

When a whitelist (array) is specified for the sanitizer, the selector will throw an Exception if the given value (or values) are not present in the whitelist array.

Beide Array Formate (assoziativ, regulär) kann man theoretisch sogar mischen.