ProcessWire - Module schreiben

Links

https://webdesign.tutsplus.com/tutorials/a-beginners-introduction-to-writing-modules-in-processwire--cms-26862
https://processwire.com/api/ref/module/
https://processwire.com/blog/posts/new-module-configuration-options/
https://processwire.com/talk/topic/778-module-dependencies/
http://somatonic.github.io/Captain-Hook/ // Hook Cheatsheet

Beispiele

Frontend Rendering Module

A bit old but working

<?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;
	}
}
?>

ProcessWire Hello World Modul

Beispiel Modul mit Hooks (liegt immer in der Standardinstallation)

<?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; 
	}
	
}

ProcessWire Admin Bereich mit eigener Funktionalität erweitern (Modul)

https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863

<?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);
	}
}

ProcessWire Textformatter Modul

https://webdesign.tutsplus.com/tutorials/extending-the-processwire-admin-using-custom-modules--cms-26863

<?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;
	}
}
?>

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 installed in PW (i.e. LazyCron).

<?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;
			}
		}
	}
}

Inputfield / Fieldtype

ProcessWire - Fieldtype erstellen (Module)