Jump to content

Create your first Module with configuration settings and a overview page.


Harmster
 Share

Recommended Posts

Hey PW,

I am only a starting developer and I am still in school and my experience with processwire is quite small but recently I've created my own module for Processwire and I kind of had to ask and copy a lot from other sources, now I want to create a small walk through tutorial for people with the same lack of knowledge as me :) And as a guide for myselfs in the future :)

1) Setting up the file.
Okay, so we start of by making a new document in the Module root folder and call it Harmster.module for this example, we dont need to add the .php extension.

Now every module in Processwire needs to extends the classes and methods from Processwire itselfs so we start off by typing

class Harmster extends Process{
}

You can also extend WireData, I don't really understand the difference but both work for me :)

A module contains 2 standart classes, init() and getModuleInfo()

init()
This is kind of, or the same as a __construct() method, this always executes and is executed almost at creation.

getModuleInfo()
This is a method that is used to show the information in the Processwire CMS.

We both need to add these to our fresh class like following:


class Harmster extends WireData
{
public static function getModuleInfo()
{
return array(
'title' => 'Harmster',
'version' => 100,
'summary' => 'Harmster module'
'singular' => true,
);
}

public function init()
{
$this->setFuel("harmster", $this);
}


This is where I, as a starting developer, get really excited about this little code in the init() method
$this->setFuel("harmster", $this);

Basically creates your class in every template you are going to use and it is callable by $harmster

Woah! awesome right!

Now this is where I got stuck on, I the user to configure some options in the module :\ hmm... Well I just went asking on the forums and the super nice community of PW came to help me, Wanze in this case (no emoticon because its not allowed)
(Check it for yourselfs, http://processwire.c...lds-for-module/)

And basically you need to implement some methods from an another object, you should replace this,
class Harmster extends WireData implements Module

with
class Harmster extends Process implements Module, ConfigurableModule

But when you add that and try to use your module you'll see you get an error, we need to add one more method to the class called getModuleConfigInputfields add
static public function getModuleConfigInputfields(array $data)
{
}


2) Adding a configurable and usable textbox

But now you want to add some input fields, now this is pretty hmm complicated
For a simple textbox you put this inside the method you just made:

$modules = Wire::getFuel('modules');
$fields = new InputfieldWrapper();
$field = $modules->get("InputfieldText");
$field->attr('name+id', ''some_text_field_saved_name'');
$field->attr('value', $data['some_text_field_saved_name']);
$field->label = "Hamsters rule!";
$field->description = 'Enter a nice sentance here if you like hamsters';
$fields->append($field);


Now you've created a input field and you can use it with $this->get(''some_text_field_saved_name''); in all your methods in this class (no emoticon because its not allowed)

If you're lazy

Now what you've created is a configurable module, heres a I am lazy and i want to pastey (no emoticon because its not allowed)
class Harmster extends Process implements Module, ConfigurableModule {
public static function getModuleInfo() {
return array(
'title' => 'Harmster',
'version' => 001,
'summary' => '',
'href' => '',
'singular' => true,
'autoload' => true,
);
}
public function init()
{
$this->fuel->set("harmster", $this);
}
static public function getModuleConfigInputfields(array $data)
{
}
}


Now if you want to add a overview page, much like the setup, pages, acces and module tab in Processwire CMS default you can easily do this by adding 2 new methods in your class, install and uninstall :)

3) Creating your install and uninstall

So you want to get a nice overview for your module now eh? Well we can do that because Processwire is awesome like that :)
module.png
I did this for my module :)
Now, we need to add 2 methods to our class, ___install and ___uninstall (yes, 3 underscores)
So add this to your class:
public function ___install() {
}
public function ___uninstall() {
}


I think that these are kind of self explaing, the one method gets executed when the user installs the module and the other one gets executed when the user deinstalls the module.

Now we want to add a page to PW CMS, but how (no emoticon because its not allowed)
Thats actually really easy,
$page = $this->pages->get('template=admin,name='.self::PAGE_NAME);
if (!$page->id) {
$page = new Page();
$page->template = $this->templates->get('admin');
$page->parent = $this->pages->get($this->config->adminRootPageID);
$page->title = 'MailChimp';
$page->name = self::PAGE_NAME;
$page->process = $this;
$page->save();
}

This is how you install a page, notice that we name the page to self::PAGE_NAME therefor you want to add
const PAGE_NAME = 'harmster-module';

with the name of your module :)

BUT BUT now everyone can look in to this module D:< i dont want that!

Ofcourse you dont want that. Clients are famous for breaking everything where they put their hands on, so we need to create permissions!

Now the way you make permissions is just genius and so easy, you just add this to your ___install method,

$permission = $this->permissions->get(self::PERMISSION_NAME);
if (!$permission->id) {
$p = new Permission();
$p->name = self::PERMISSION_NAME;
$p->title = $this->_('View Harmster Page statistics and synchronize pages with lists');
$p->save();
}

And you create a permission constant just like PAGE_NAME like this

const PERMISSION_NAME = 'hr-view';


And of course you can create more permissions, just genius!

Now what our install method should look like is this:

public function ___install() {
$page = $this->pages->get('template=admin,name='.self::PAGE_NAME);
if (!$page->id) {
$page = new Page();
$page->template = $this->templates->get('admin');
$page->parent = $this->pages->get($this->config->adminRootPageID);
$page->title = 'Harmster';
$page->name = self::PAGE_NAME;
$page->process = $this;
$page->save();
}
$permission = $this->permissions->get(self::PERMISSION_NAME);
if (!$permission->id) {
$p = new Permission();
$p->name = self::PERMISSION_NAME;
$p->title = $this->_('View Harmster Page statistics and synchronize pages with lists');
$p->save();
}
}


This will set a module page up for you :)

And we create an uninstall method, this basicly reverts your installed permissions and pages.
public function ___uninstall() {
$permission = $this->permissions->get(self::PERMISSION_NAME);
if ($permission->id) {
$permission->delete();
}
$page = $this->pages->get('template=admin, name='.self::PAGE_NAME);
if ($page->id) {
$page->delete();
}
}


Now you are might be wondering, how do i get to display content in my page :S
Well, I kinda stole this from other modules and it does work, but I am open for suggestions.

the method ___execute gets executed when you click on your page in the PWCMS.
What i wrote in there is
public function ___execute()
{
return $this->_renderInterface();
}


and in renderInterface() i put the next code:
private function _renderInterface()
{
$this->setFuel('processHeadline', 'MailChimp synchronize tool');
$form = $this->modules->get('InputfieldForm');
$form->attr('id','ga_form');
$wrapper_audience = new InputfieldWrapper();
$field = $this->modules->get("InputfieldMarkup");
$field->label = $this->_("Gebruikers");
$field->columnWidth = 100;
$members = $this->list_members($this->get_apikey());
$html = "<table class='AdminDataTable AdminDataList AdminDataTableSortable'>";
foreach($members['data'] as $member)
{
$html .= "<tr><td>" . $member['email'] . "</td><td>" . $member['timestamp'] . "</td></tr>";
}
$html .= "</table>";
$field->attr('value',$html);
$wrapper_audience->append($field);
$form->append($wrapper_audience);
return $form->render();
}

Bascily you create a form and you render the form and that displays it for you, just play around with it for a bit and you'll get into it, as i am still getting into it.

I am lazy, here a copy, pastey (no emoticon because its not allowed)

<?php
class Harmster extends Process implements Module, ConfigurableModule {

const PAGE_NAME = 'harmster-module';

const PERMISSION_NAME = 'hr-view';

public static function getModuleInfo() {
return array(
'title' => 'Harmster',
'version' => 001,
'summary' => '',
'href' => '',
'singular' => true,
'autoload' => true,
);
}
public function init()
{
$this->fuel->set("harmster", $this);
}
static public function getModuleConfigInputfields(array $data)
{
}
public function ___install() {
$page = $this->pages->get('template=admin,name='.self::PAGE_NAME);
if (!$page->id) {
$page = new Page();
$page->template = $this->templates->get('admin');
$page->parent = $this->pages->get($this->config->adminRootPageID);
$page->title = 'Harmster';
$page->name = self::PAGE_NAME;
$page->process = $this;
$page->save();
}
$permission = $this->permissions->get(self::PERMISSION_NAME);
if (!$permission->id) {
$p = new Permission();
$p->name = self::PERMISSION_NAME;
$p->title = $this->_('View Harmster Page statistics and synchronize pages with lists');
$p->save();
}
}
public function ___uninstall() {
$permission = $this->permissions->get(self::PERMISSION_NAME);
if ($permission->id) {
$permission->delete();
}
$page = $this->pages->get('template=admin, name='.self::PAGE_NAME);
if ($page->id) {
$page->delete();
}
}

public function ___execute()
{
return $this->_renderInterface();
}

private function _renderInterface()
{
$this->setFuel('processHeadline', 'MailChimp synchronize tool');
$form = $this->modules->get('InputfieldForm');
$form->attr('id','ga_form');
$wrapper_audience = new InputfieldWrapper();
$field = $this->modules->get("InputfieldMarkup");
$field->label = $this->_("Gebruikers");
$field->columnWidth = 100;
$members = $this->list_members($this->get_apikey());
$html = "<table class='AdminDataTable AdminDataList AdminDataTableSortable'>";
foreach($members['data'] as $member)
{
$html .= "<tr><td>" . $member['email'] . "</td><td>" . $member['timestamp'] . "</td></tr>";
}
$html .= "</table>";
$field->attr('value',$html);
$wrapper_audience->append($field);
$form->append($wrapper_audience);
return $form->render();
}
}


I'll update this tutorial in the near future as i am still working my way up (no emoticon because its not allowed)


Aww, i get an error when i save it, thats not nice.

You have posted a message with more emoticons than this community allows. Please reduce the number of emoticons you've added to the message


Thanks for reading (no emoticon because its not allowed)

EDIT
 

Updating this tutorial very soon, its horrible and incorrect

  • Like 14
Link to comment
Share on other sites

Cool thanks for writing.

Extending "Process" in a module is meant for admin pages. Each admin page has the admin template and a process attached.

For normal modules you extend "Wire" or "WireData", if you want to create hooks and all sort of helper modules.

For more infos look at what Ryan wrote here: http://wiki.processwire.com/index.php/Module_Creation

  • Like 2
Link to comment
Share on other sites

  • 2 years later...

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
 Share

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By Robin S
      This module lets you add some custom menu items to the main admin menu, and you can set the dropdown links dynamically in a hook if needed.
      Sidenote: the module config uses some repeatable/sortable rows for the child link settings, similar to the ProFields Table interface. The data gets saved as JSON in a hidden textarea field. Might be interesting to other module developers?
      Custom Admin Menus
      Adds up to three custom menu items with optional dropdowns to the main admin menu.
      The menu items can link to admin pages, front-end pages, or pages on external websites.
      The links can be set to open in a new browser tab, and child links in the dropdown can be given an icon.
      Requires ProcessWire v3.0.178 or newer.
      Screenshots
      Example of menu items

      Module config for the menus

      Link list shown when parent menu item is not given a URL

      Advanced
      Setting child menu items dynamically
      If needed you can set the child menu items dynamically using a hook.
      Example:
      $wire->addHookAfter('CustomAdminMenus::getMenuChildren', function(HookEvent $event) { // The menu number is the first argument $menu_number = $event->arguments(0); if($menu_number === 1) { $colours = $event->wire()->pages->findRaw('template=colour', ['title', 'url', 'page_icon']); $children = []; foreach($colours as $colour) { // Each child item should be an array with the following keys $children[] = [ 'icon' => $colour['page_icon'], 'label' => $colour['title'], 'url' => $colour['url'], 'newtab' => false, ]; } $event->return = $children; } }); Create multiple levels of flyout menus
      It's also possible to create multiple levels of flyout submenus using a hook.

      For each level a submenu can be defined in a "children" item. Example:
      $wire->addHookAfter('CustomAdminMenus::getMenuChildren', function(HookEvent $event) { // The menu number is the first argument $menu_number = $event->arguments(0); if($menu_number === 1) { $children = [ [ 'icon' => 'adjust', 'label' => 'One', 'url' => '/one/', 'newtab' => false, ], [ 'icon' => 'anchor', 'label' => 'Two', 'url' => '/two/', 'newtab' => false, 'children' => [ [ 'icon' => 'child', 'label' => 'Red', 'url' => '/red/', 'newtab' => false, ], [ 'icon' => 'bullhorn', 'label' => 'Green', 'url' => '/green/', 'newtab' => false, 'children' => [ [ 'icon' => 'wifi', 'label' => 'Small', 'url' => '/small/', 'newtab' => true, ], [ 'icon' => 'codepen', 'label' => 'Medium', 'url' => '/medium/', 'newtab' => false, ], [ 'icon' => 'cogs', 'label' => 'Large', 'url' => '/large/', 'newtab' => false, ], ] ], [ 'icon' => 'futbol-o', 'label' => 'Blue', 'url' => '/blue/', 'newtab' => true, ], ] ], [ 'icon' => 'hand-o-left', 'label' => 'Three', 'url' => '/three/', 'newtab' => false, ], ]; $event->return = $children; } }); Showing/hiding menus according to user role
      You can determine which menu items can be seen by a role by checking the user's role in the hook.
      For example, if a user has or lacks a role you could include different child menu items in the hook return value. Or if you want to conditionally hide a custom menu altogether you can set the return value to false. Example:
      $wire->addHookAfter('CustomAdminMenus::getMenuChildren', function(HookEvent $event) { // The menu number is the first argument $menu_number = $event->arguments(0); $user = $event->wire()->user; // For custom menu number 1... if($menu_number === 1) { // ...if user does not have some particular role... if(!$user->hasRole('foo')) { // ...do not show the menu $event->return = false; } } });  
      https://github.com/Toutouwai/CustomAdminMenus
      https://processwire.com/modules/custom-admin-menus/
    • By tcnet
      This module for ProcessWire sends a notification email for each failed login attempt. Similar modules exists already in the module directory of ProcessWire. However, this module is designed to notify, even if specified user doesn't exist.
      Settings
      The settings for this module are located in the menu Modules=>Configure=>LoginFailNotifier.
      Notification email
      Specifies the email address to which the notification emails should be sent.
        Email subject
      Specifies the subject line for the notification email.
        Post variables
      Specifies the $_POST variables to be included in the notification email. Each variable must be separated by a comma. For example: login_name,login_pass
        Server variables
      Specifies the $_SERVER variables to be included in the notification email. Each variable must be separated by a comma. For example: REMOTE_ADDR,HTTP_USER_AGENT
      Link to ProcessWire module directory:
      https://processwire.com/modules/login-fail-notifier/
      Link to github.com:
      https://github.com/techcnet/LoginFailNotifier
    • By Fokke
      ProcessWire 3.x markup module for rendering meta tags in HTML document head section. Note that this module is not a full-blown SEO solution, but rather a simple tool for rendering meta tags based on module configuration. Adding custom meta tags is also supported.
      Built-in meta tags
      The following meta tags are supported out-of-the-box:
      Document title consisting of page title and site name Character set Canonical Viewport Description Keywords Hreflang tags Open Graph og:title og:site_name og:type og:url og:description og:image og:image:width og:image:height Twitter meta tags twitter:card twitter:site twitter:creator twitter:title twitter:description twitter:image Facebook meta tags fb:app_id The full documentation with configurable options can be found here: https://github.com/Fokke-/MarkupMetadata
       
      Requirements:
      ProcessWire>=3.0.0 PHP >=7.1 Installation using Composer
      composer require fokke/markup-metadata Manual installation
      Download latest version from https://github.com/Fokke-/MarkupMetadata/archive/master.zip Extract module files to site/modules/MarkupMetadata directory.
    • By m.sieber
      ITRK-Service for ProcessWire
      Module for the automated transfer of imprint, data protection declaration and terms and conditions from IT-Recht Kanzlei to your ProcessWire installation
      What is ITRK Service for ProcessWire?
      ITRK-Service for ProcessWire is a free module for ProcessWire CMS. It provides an interface to the update service of IT-Recht Kanzlei, via which the legal texts of your online presence are automatically updated. In this way, the texts remain legally secure and warning-proof in the long term. Imprint, data protection declaration, revocation and general terms and conditions are currently supported.
      You can find our documentation (in german language) here: https://www.pupit.de/itrk-service-for-processwire/dokumentation/

      Download: https://www.pupit.de/itrk-service-for-processwire/
      Github: https://github.com/pupit-de/pwItrkServiceConnector
    • By LuisM
      Symprowire is a PHP MVC Framework based and built on Symfony using ProcessWire 3.x as DBAL and Service-Provider
      It acts as a Drop-In Replacement Module to handle the Request/Response outside the ProcessWire Admin. Even tough Symfony or any other mature MVC Framework could be intimidating at first, Symprowire tries to abstract Configuration and Symfony Internals away as much as possible to give you a quick start and lift the heavy work for you.
      The main Goal is to give an easy path to follow an MVC Approach during development with ProcessWire and open up the available eco-system.
      You can find the GitHub Repo and more Information here: https://github.com/Luis85/symprowire
      Documentation
      The Symprowire Wiki https://github.com/Luis85/symprowire/wiki How to create a simple Blog with Symprowire https://github.com/Luis85/symprowire/wiki/Symprowire-Blog-Tutorial Last Update
      16.07.2021 // RC 1 v0.6.0 centralized ProcessWire access trough out the Application by wrapping to a Service https://github.com/Luis85/symprowire/releases/tag/v0.6.0-rc-1 Requirements
      PHP ^7.4 Fresh ProcessWire ^3.0.181 with a Blank Profile Composer 2 (v1 should work, not recommended) The usual Symfony Requirements Features
      Twig Dependency Injection Monolog for Symprowire Support for .env YAML Configuration Symfony Console and Console Commands Symfony Webprofiler Full ProcessWire access inside your Controller and Services Webpack Encore support Caveats
      Symfony is no small Framework and will come with a price in terms of Memory Usage and added Overhead. To give you a taste I installed Tracy Debugger alongside to compare ProcessWire profiling with the included Symfony Webprofiler

      So in a fresh install Symprowire would atleast add another 2MB of Memory usage and around 40ms in response time, should be less in production due to the added overhead of the Webprofiler in dev env
       
×
×
  • Create New...