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 Gadgetto
      Status update links (inside this thread) for SnipWire development will be always posted here:
      2019-08-08
      2019-06-15
      2019-06-02
      2019-05-25
      If you are interested, you can test the current state of development:
      https://github.com/gadgetto/SnipWire
      Please note that the software is not yet intended for use in a production system (alpha version).
      If you like, you can also submit feature requests and suggestions for improvement. I also accept pull requests.
      ---- INITIAL POST FROM 2019-05-25 ----
      I wanted to let you know that I am currently working on a new ProcessWire module that fully integrates the Snipcart Shopping Cart System into ProcessWire. (this is a customer project, so I had to postpone the development of my other module GroupMailer).
      The new module SnipWire offers full integration of the Snipcart Shopping Cart System into ProcessWire.
      Here are some highlights:
      simple setup with (optional) pre-installed templates, product fields, sample products (quasi a complete shop system to get started immediately) store dashboard with all data from the snipcart system (no change to the snipcart dashboard itself required) Integrated REST API for controlling and querying snipcart data webhooks to trigger events from Snipcart (new order, new customer, etc.) multi currency support self-defined/configurable tax rates etc. Development is already well advanced and I plan to release the module in the next 2-3 months.
      I'm not sure yet if this will be a "Pro" module or if it will be made available for free.
      I would be grateful for suggestions and hints!
      (please have a look at the screenshots to get an idea what I'm talking about)
       




    • By apeisa
      Update 31.7.2019: AdminBar is now maintained by @teppo. Modules directory entry has been updated, as well as the "grab the code" link below.
      ***
      Latest screencast: http://www.screencas...73-ab3ba1fea30c
      Grab the code: https://github.com/teppokoivula/AdminBar
      ***
      I put this Adminbar thingy (from here: http://processwire.c...topic,50.0.html) to modules section and to it's own topic.
      I recorded quick and messy screencast (really, my first screencast ever) to show what I have made so far. You can see it from here: http://www.screencas...18-1bc0d49841b4
      When the modal goes off, I click on the "dark side". I make it so fast on screencast, so it might seem a little bit confusing. Current way is, that you can edit, go back to see the site (without saving anything), continue editing and save. After that you still have the edit window, but if you click "dark side" after saving, then the whole page will be reloaded and you see new edits live.
      I am not sure if that is best way: there are some strengths in this thinking, but it is probably better that after saving there shouldn't be a possibility to continue editing. It might confuse because then if you make edits, click on dark side -> *page refresh* -> You lose your edits.
      ***
      When I get my "starting module" from Ryan, I will turn this into real module. Now I had to make some little tweaks to ProcessPageEdit.module (to keep modal after form submits). These probably won't hurt anything:
      if($this->redirectUrl) $this->session->redirect($this->redirectUrl); if(!empty($_GET['modal'])) $this->session->redirect("./?id={$this->page->id}&modal=true"); // NEW LINE else $this->session->redirect("./?id={$this->page->id}");   and...
      if(!empty($_GET['modal'])) { $form->attr('action', './?id=' . $this->id . '&modal=true'); } else { $form->attr('action', './?id=' . $this->id); // OLD LINE }  
    • By Mike Rockett
      Jumplinks for ProcessWire
      Release: 1.5.54
      Composer: rockett/jumplinks
      Jumplinks is an enhanced version of the original ProcessRedirects by Antti Peisa.
      The Process module manages your permanent and temporary redirects (we'll call these "jumplinks" from now on, unless in reference to redirects from another module), useful for when you're migrating over to ProcessWire from another system/platform. Each jumplink supports wildcards, shortening the time needed to create them.
      Unlike similar modules for other platforms, wildcards in Jumplinks are much easier to work with, as Regular Expressions are not fully exposed. Instead, parameters wrapped in curly braces are used - these are described in the documentation.
      Under Development: 2.0, to be powered by FastRoute
      As of version 1.5.0, Jumplinks requires at least ProcessWire 2.6.1 to run.
      View on GitLab
      Download via the Modules Directory
      Read the docs
      Features
      The most prominent features include:
      Basic jumplinks (from one fixed route to another) Parameter-based wildcards with "Smart" equivalents Mapping Collections (for converting ID-based routes to their named-equivalents without the need to create multiple jumplinks) Destination Selectors (for finding and redirecting to pages containing legacy location information) Timed Activation (activate and/or deactivate jumplinks at specific times) 404-Monitor (for creating jumplinks based on 404 hits) Additionally, the following features may come in handy:
      Stale jumplink management Legacy domain support for slow migrations An importer (from CSV or ProcessRedirects) Feedback & Feature Requests
      I’d love to know what you think of this module. Please provide some feedback on the module as a whole, or even regarding smaller things that make it whole. Also, please feel free to submit feature requests and their use-cases.
      Note: Features requested so far have been added to the to-do list, and will be added to 2.0, and not the current dev/master branches.
      Open Source

      Jumplinks is an open-source project, and is free to use. In fact, Jumplinks will always be open-source, and will always remain free to use. Forever. If you would like to support the development of Jumplinks, please consider making a small donation via PayPal.
      Enjoy! :)
    • By nbcommunication
      I've spent the last while experimenting with srcset implementation - and PageimageSrcset is the result:
      PageimageSrcset
      Provides configurable srcset and sizes properties/methods for Pageimage.
      Overview
      The main purpose of this module is to make srcset implementation as simple as possible in your template code. It does not handle images rendered in CKEditor or similar fields.
      For an introduction to srcset and sizes, please read this Mozilla article about responsive images.
      Pageimage::srcset()
      // The property, which uses the set rules in the module configuration $srcset = $image->srcset; // A method call, using a set rules string // Delimiting with a newline (\n) would also work, but not as readable $srcset = $image->srcset("320, 480, 640x480 768w, 1240, 2048 2x"); // The same as above but using an indexed/sequential array $srcset = $image->srcset([ "320", "480", "640x480 768w", "1240", "2048 2x", ]); // The same as above but using an associative array // No rule checking is performed $srcset = $image->srcset([ "320w" => [320], "480w" => [480], "768w" => [640, 480], "1240w" => [1240], "2x" => [2048], ]); // Use the default set rules with portrait images generated for mobile/tablet devices $srcset = $image->srcset(true); // Return the srcset using all arguments $srcset = $image->srcset("320, 480, 640x480 768w, 1240, 2048 2x", [ "portrait" => "320, 640", ]); // The set rules above are a demonstration, not a recommendation! Image variations are only created for set rules which require a smaller image than the Pageimage itself. On large sites this may still result in a lot of images being generated. If you have limited storage, please use this module wisely.
      Portrait Mode
      In many situations, the ratio of the image does not need to change at different screen sizes. However, images that cover the entire viewport are an exception to this and are often the ones that benefit most from srcset implementation.
      The main problem with cover images is that they need to display landscape on desktop devices and portrait when this orientation is used on mobile and tablet devices.
      You can automatically generate portrait images by enabling portrait mode. It is recommended that you use this in combination with Pageimage::focus() so that the portrait variations retain the correct subject.
      The generated variations are HiDPI/Retina versions. Their height is determined by the portrait ratio (e.g. 9:16). Variations are always generated, regardless of whether the original image is smaller. Upscaling is disabled though, so you may find that some variations are actually smaller than they say they are in their filename.
      The sizes attribute should be used when portrait mode is enabled. Pageimage::sizes will return (orientation: portrait) and (max-width: {maxWidth}px) 50vw by default, which handles the use of these images for retina devices. The maximum width used in this rule is the largest set width.
      Pageimage::sizes()
      There is no option to configure default sizes because in most cases 100vw is all you need, and you do not need to output this anyway as it is inferred when using the srcset attribute. You can use the method for custom sizes though:
      // The property $sizes = $image->sizes; // Returns 100vw in most cases // Returns '(orientation: portrait) and (max-width: {maxWidth}px)50vw' if portrait mode enabled // A method call, using a mixture of integer widths and media query rules // Integer widths are treated as a min-width media query rule $sizes = $image->sizes([ 480 => 50, "(orientation: portrait) and (max-width: 640px)" => 100, 960 => 25, ]); // (min-width: 480px) 50vw, (orientation: portrait) and (max-width: 640px) 100vw, (min-width: 960px) 25vw // Determine widths by UIkit 'child-width' classes $sizes = $image->sizes([ "uk-child-width-1-2@s", "uk-child-width-1-3@l", ]); // (min-width: 640px) 50vw, (min-width: 1200px) 33.33vw // Determine widths by UIkit 'width' classes $sizes = $image->sizes([ "uk-width-1-2@m", "uk-width-1-3@xl", ]); // (min-width: 960px) 50vw, (min-width: 1600px) 33.33vw // Return the portrait size rule $sizes = $image->sizes(true); // (orientation: portrait) and (max-width: {maxWidth}px) 50vw // The arguments above are a demonstration, not a recommendation! Pageimage::render()
      This module extends the options available to this method with:
      srcset: When the module is installed, this will always be added, unless set to false. Any values in the formats described above can be passed. sizes: Only used if specified. Any values in the formats described above can be passed. uk-img: If passed, as either true or as a valid uk-img value, then this attribute will be added. The srcset attribute will also become data-srcset. Please refer to the API Reference for more information about this method.
      // Render an image using the default set rules echo $image->render(); // <img src='image.jpg' alt='' srcset='{default set rules}'> // Render an image using custom set rules echo $image->render(["srcset" => "480, 1240x640"]); // <img src='image.jpg' alt='' srcset='image.480x0-srcset.jpg 480w, image.1240x640-srcset.jpg 1240w'> // Render an image using custom set rules and sizes // Also use the `markup` argument echo $image->render("<img class='image' src='{url}' alt='Image'>", [ "srcset" => "480, 1240", "sizes" => [1240 => 50], ]); // <img class='image' src='image.jpg' alt='Image' srcset='image.480x0-srcset.jpg 480w, image.1240x640-srcset.jpg 1240w' sizes='(min-width: 1240px) 50vw'> // Render an image using custom set rules and sizes // Enable uk-img echo $image->render([ "srcset" => "480, 1240", "sizes" => ["uk-child-width-1-2@m"], "uk-img" => true, ]); // <img src='image.jpg' alt='' data-uk-img data-srcset='image.480x0-srcset.jpg 480w, image.1240x640-srcset.jpg 1240w' sizes='(min-width: 960px) 50vw'> // Render an image using portrait mode // Default rule sets used: 320, 640, 768, 1024, 1366, 1600 // Portrait widths used: 320, 640, 768 // Original image is 1000px wide // Not possible to use portrait mode and custom sets or portrait widths in render() // Sizes attribute automatically added echo $image->render(["srcset" => true]); // <img src='image.jpg' alt='' srcset='image.320x569-srcset-hidpi.jpg 320w, image.640x1138-srcset-hidpi.jpg 640w, image.768x1365-srcset-hidpi.jpg 768w, image.jpg 1024w' sizes='(orientation: portrait) and (max-width: 768px) 50vw'> Configuration
      To configure this module, go to Modules > Configure > PageimageSrcset.
      Set Rules
      These are the default set rules that will be used when none are specified, e.g. when calling the property: $image->srcset.
      Each set rule should be entered on a new line, in the format {width}x{height} {inherentwidth}w|{resolution}x.
      Not all arguments are required - you will probably find that specifying the width is sufficient for most cases. Here's a few examples of valid set rules and the sets they generate:
      Set Rule Set Generated Arguments Used 320 image.320x0-srcset.jpg 320w {width} 480x540 image.480x540-srcset.jpg 480w {width}x{height} 640x480 768w image.640x480-srcset.jpg 768w {width}x{height} {inherentwidth}w 2048 2x image.2048x0-srcset.jpg 2x {width} {resolution}x How you configure your rules is dependent on the needs of the site you are developing; there are no prescriptive rules that will meet the needs of most situations. This article gives a good overview of some of the things to consider.
      When you save your rules, a preview of the sets generated and an equivalent method call will be displayed to the right. Invalid rules will not be used, and you will be notified of this.
      Portrait Mode
      Set Widths
      A comma limited list of widths to create HiDPI/Retina portrait variations for.
      Crop Ratio
      The portrait ratio that should be used to crop the image. The default of 9:16 should be fine for most circumstances as this is the standard portrait ratio of most devices. However, you can specify something different if you want. If you add a landscape ratio, it will be switched to portrait when used.
      Any crops in the set rules ({width}x{height}) are ignored for portrait mode variations as this ratio is used instead.
      UIkit Widths
      If your website theme uses UIkit, you can pass an array of UIkit width classes to Pageimage::sizes to be converted to sizes. The values stored here are used to do this. If you have customised the breakpoints on your theme, you should also customise them here.
      Please note that only 1- widths are evaluated by Pageimage::sizes, e.g. uk-width-2-3 will not work.
      Remove Variations
      If checked, the image variations generated by this module are cleared on Submit. On large sites, this may take a while. It makes sense to run this after you have made changes to the set rules.
      Image Suffix
      You will see this field when Remove Variations is checked. The value is appended to the name of the images generated by this module and is used to identify variations. You should not encounter any issues with the default suffix, but if you find that it conflicts with any other functionality on your site, you can set a custom suffix instead.
      Debug Mode
      When this is enabled, a range of information is logged to pageimage-srcset.
      PageimageSrcsetDebug.js is also added to the <head> of your HTML pages. This will console.log a range of information about the images and nodes using srcset on your page after a window.onresize event is triggered. This can assist you in debugging your implementation.
      The browser will always use the highest resolution image it has loaded or has cached. You may need to disable browser caching to determine whether your set rules are working, and it makes sense to work from a small screen size and up. If you do it the other way, the browser is going to continue to use the higher resolution image it loaded first.
      UIkit Features
      This module implements some additional features that are tailored towards UIkit being used as the front-end theme framework, but this is not required to use the module.
      Installation
      Download the zip file at Github or clone the repo into your site/modules directory. If you downloaded the zip file, extract it in your sites/modules directory. In your admin, go to Modules > Refresh, then Modules > New, then click on the Install button for this module. ProcessWire >= 3.0.123 is required to use this module.
×
×
  • Create New...