Jump to content
Harmster

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

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

Share this post


Link to post
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

Share this post


Link to post
Share on other sites

> Posted 06 December 2012 - 04:42 PM
> Updating this tutorial very soon, its horrible and incorrect
 

The update newer happened.

I suggest this post is deleted.

Share this post


Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By gebeer
      I am happy to present my new fieldtype FieldtypeImageFromPage. It is made up of 2 modules:
      Fieldtype Image Reference From Another Page is a Fieldtype that stores a reference to a single image from another page. The image can be selected with the associated Inputfield.
      Inputfield Select Image From Page is an Inputfield to select a single image from images on a predefined page and it's children.
      And there also is a helper module that takes care of cleanup tasks.
      This module evolved out of a discussion about my other Module FieldtypeImagePicker.  It caters for use cases where a set of images is being reused multiple times across a site. With this fieldtype these images can be administered through a chosen page. All images uploaded to that page will be available in the inputfield.
      When to use ?
      Let editors choose an image from a set of images that is being used site-wide. Ideal for images that are being re-used across the site.
      Suited for images that are used on multiple pages throughout the site (e.g. icons).
      Other than the native ProcessWire images field, the images here are not stored per page. Only references to images on another page are stored. This has several advantages:
      one central place to organize images when images change, you only have to update them in one place. All references will be updated, too. (Provided the name of the image that has changed stays the same) Features
      Images can be manipulated like native ProcessWire images (resizing, cropping etc.) Image names are fully searchable through the API Accidental image deletion is prevented. When you want to delete an image from one of the pages that hold your site-wide images, the module searches all pages that use that image. If any page contains a reference to the image you are trying to delete, deletion will be prevented. You will get an error message to help you edit those pages and remove references there before you can finally delete the image. How to install and setup
      Download and install this module like any other modules in ProcessWire Create a page in the page tree that will hold your images. This page's template must have an images field Upload some images to the page you created in step 2 Create a new field. As type choose 'Image Reference From Another Page'. Save the field. In 'Details' Tab of the field choose the page you created in step 2 Click Save button Choose the images field name for the field that holds your images (on page template from step 2) Click Save button again Choose whether you want to include child pages of page from step 2 to supply images Add the field to any template You are now ready to use the field View of the inputfield on the page edit screen:

      View of the field settings

      The module can be installed from this github repo. Some more info in the README there, too.
      In my tests it was fairly stable. After receiving your valued feedback, I will eventually add it to the modules directory.
      My ideas for further improvement:
      - add ajax loading of thumbnails
      Happy to hear your feedback!
       
    • By gebeer
      Although the PW backend is really intuitive, ever so often my clients need some assistance. Be it they are not so tech savvy or they are not working in the backend often.
      For those cases it is nice to make some help videos available to editors. This is what this module does.
      ProcessHelpVideos Module
      A Process module to display help videos for the ProcessWire CMS. It can be used to make help videos (screencasts) available to content editors.
      This module adds a 'Help Videos" section to the ProcessWire backend. The help videos are accessible through an automatically created page in the Admin page tree. You can add your help videos as pages in the page tree. The module adds a hidden page to the page tree that acts as parent page for the help video pages. All necessary fields and templates will be installed automatically. If there are already a CKEditor field and/or a file field for mp4 files installed in the system, the module will use those. Otherwise it will create the necessary fields. Also the necessary templates for the parent help videos page and it's children are created on module install. The module installs a permission process-helpvideos. Every user role that should have access to the help video section, needs this permission. I use the help video approach on quite a few production sites. It is stable so far and well received by site owners/editors. Up until now I installed required fields, templates and pages manually and then added the module. Now I added all this logic to the install method of the module and it should be ready to share.
      The module and further description on how to use it is available on github: https://github.com/gebeer/ProcessHelpVideos
      If you like to give it a try, I am happy to receive your comments/suggestions here.
    • By Robin S
      A module created in response to the topic here:
      Page List Select Multiple Quickly
      Modifies PageListSelectMultiple to allow you to select multiple pages without the tree closing every time you select a page.
      The screencast says it all:

       
      https://github.com/Toutouwai/PageListSelectMultipleQuickly
      https://modules.processwire.com/modules/page-list-select-multiple-quickly/
    • By gebeer
      Hello all,
      sharing my new module FieldtypeImagePicker. It provides a configurable input field for choosing any type of image from a predefined folder.
      The need for it came up because a client had a custom SVG icon set and I wanted the editors to be able to choose an icon in the page editor.
      It can also be used to offer a choice of images that are used site-wide without having to upload them to individual pages.
      There are no image manipulation methods like with the native PW image field.
      Module and full description can be found on github https://github.com/gebeer/FieldtypeImagePicker
      Kudos to @Martijn Geerts. I used his module FieldTypeSelectFile as a base to build upon.
      Here's how the input field looks like in the page editor:

      Hope it can be of use to someone.
      If you like to give it a try, I'm happy to hear your comments or suggestions for improvement. Eventually this will go in the module directory soon, too.
    • By bernhard
      @Sergio asked about the pdf creation process in the showcase thread about my 360° feedback/survey tool and so I went ahead and set my little pdf helper module to public.
      Description from PW Weekly:
       
      Modules Directory: https://modules.processwire.com/modules/rock-pdf/
      Download & Docs: https://github.com/BernhardBaumrock/RockPDF
       
      You can combine it easily with RockReplacer: 
      See also a little showcase of the RockPdf module in this thread:
       
×
×
  • Create New...