Jump to content
MidRo

Help with process and configurable modules

Recommended Posts

Hey, thanks for taking the time to read! So I'm new to module development and I'm having trouble understanding how to pass data in my module. The module I am making extends process and implements ConfigurableModule.( A lot of the module aspect of the code is copied from other modules.) It's purpose is to download a report that contains a list of people from a permalink and then parse and create a page for each person on the list. That part works fine, if I just run it as a script or hard code the default values into my module.

What I am having a hard time understanding is how do I access the fields that are in the module via the admin page interface? I can't seem to actually get a hold of the data that is saved in the two fields of my module. I have my module show up under the setup tab with a submit button and the module itself with the two configurable fields are under site->modules. When I press submit I need it to get the data from the two fields. 

Is the best way to create global variables in my module?(Which I have tried) Or is there some other preferred way. I really am stumped on how to get it working.

My Module:

<?php 
class MemberImporter extends Process implements Module, ConfigurableModule {
    public static function getModuleInfo() {
        return array(
            'title' => 'LGL Members Importer',
            'author' => 'Tyler Williams, Sam Fleming', 
            'summary' => 'Import a list of LGL members who have an active website.',
            'version' => .001,
            'singular' => true, 
        );
    }

//Get the module config data
protected $data;

/**
* Name used for the page created in the admin
*
*/
const adminPageName = 'member-importer';



/**
* Instance of Template, used for imported pages
*
*/
protected $template = null;

/**
* Instance of Page, representing the parent Page for imported pages
*
*/
protected $parent = null;

protected static $defaults = array(
'permalinkURL' => 'link-removed-for-privacy',
'membersPath' => '/Members'
);

protected $link = null;
protected $memPath = null;
static public function getDefaultData() {
  return array(
  'permalinkURL' => 'link-removed-for-privacy',
'membersPath' => '/Members'
  );
}
public function __construct() {
//set defaults
  foreach(self::getDefaultData() as $key => $value) {
  $this->$key = $value;
  }
}

public function init() {
       parent::init();
       ini_set('auto_detect_line_endings', true);
    }

public static function getModuleConfigInputfields(array $data) {
$data = array_merge(self::getDefaultData(), $data);

$fields = new InputfieldWrapper();       

$head = new InputfieldMarkup;
$head->label = __('Member Import Configuration');
$head->description = __('Set the permalink to the LGL report file and set the parent page for the Member Profiles');
        $fields->add($head);

//permalink url for report
        $field = wire('modules')->get('InputfieldText');
        $field->attr('name', 'permalinkURL');
        $field->attr('value', $data['permalinkURL']); 
        $field->label = "The permalink URL that downloads the LGL report";         
        $fields->add($field); 

      //members parent page
        $field = wire('modules')->get('InputfieldPageListSelect');
        $field->attr('name', 'membersPath');
        $field->attr('value', $data['membersPath']); 
        $field->label = "Path to Members' profiles"; 

        $fields->add($field);  

        return $fields; 

    }
public function getConfig(){
return ($this->get($key)) ? $this->get($key) : self::$defaults[$key];

}

protected function getInstalledPage() {

$admin = $this->pages->get($this->config->adminRootPageID); 
$parent = $admin->child("name=setup"); 
if(!$parent->id) $parent = $admin;
$page = $parent->child("name=" . self::adminPageName); 

if(!$page->id) {  
$page = new Page();
$page->parent = $parent; 
$page->template = $this->templates->get('admin');
$page->name = self::adminPageName; 
$page->title = "Member Importer";
$page->process = $this; 
$page->sort = $parent->numChildren;
$page->save();
}

return $page;  
}

public function ___execute() {

if($this->input->get->import == "Import"){

//run the importer and then redirect back to page tree
$this->ImportMembers();
$this->session->redirect(wire('config')->urls->admin);

}else{

$form = $this->modules->get("InputfieldForm");
$form->method = 'get';
$form->action = './';

$head = new InputfieldMarkup;
$head->label = __('Import Members from Little Green Light');
$head->description = __('Imports members from the LGL Database that have active website URLs. List from LGL is updated daily. Press submit to update the website Members list to match that of the LGL members list.');
$form->add($head); 

// add submit button
$field = $this->modules->get("InputfieldButton");
$field->type = 'submit';
$field->value = 'Import';
$field->name = 'import';
$form->add($field);

return $form->render(); 

}

}
public function ___ImportMembers(){

$this->ClearAllMemberProfiles();

$this->GetMemberList(); 
}

private function GetMemberList(){ 

//download the csv report from the permalink 
$link = $this->getConfig('permalinkURL');
$f = fopen($this->link, 'r');
$members = stream_get_contents($f);
fclose($f);
$members = str_replace('"','', $members);
$rows = explode("\n", $members);

array_shift($rows);

foreach($rows as $row => $members)
{
$row_data = explode(',', $members);

if(trim($row_data[0]) !=''){
$info[$row]['id'] = trim($row_data[0]);
$info[$row]['name'] = trim($row_data[1]) .' '. trim($row_data[2]); 
$info[$row]['website']  = trim($row_data[3]);
   }
} 

$this->GenerateMemberProfiles($info, $memPath);

}

private function GenerateMemberProfiles($info, $memPath){
foreach($info as $mem)
{
if(!empty($mem['website'])){ 
$p = new Page(); 
$p->template = 'member'; 
$p->parent = $this->getConfig('membersPath');
$p->name = $mem['name']; 
$p->title =$mem['name']; 

$p->save(); 
$p->memID = $mem['id'];  
$p->memWebsite = $mem['website'];

$p->save();
}

}
}
private function ClearAllMemberProfiles(){
$members = wire('pages')->get('/members')->children();
foreach($members as $mem){
wire('pages')->delete($mem, true);
}
}

public function ___install()
    {
wire('modules')->saveModuleConfigData($this, self::getDefaultData());
        $p = new Page();
        $p->template = $this->templates->get("admin");
        $p->parent = $this->pages->get("template=admin, name=setup");
        $p->title = $this->_('Member Importer');
        $p->name  = __CLASS__;
        $p->process = $this;
        $p->save();
    }



    public function ___uninstall()
    {
        $p = $this->pages->get('template=admin, name=' . __CLASS__);
        if ($p->id > 0) {
            $p->delete();
        }
    }

}

?>

**Updated to reflect current version

Edited by MidRo
possible private link removed.
  • Like 2

Share this post


Link to post
Share on other sites

So I got it worked out thanks to my friend, he directed me to this post https://processwire.com/talk/topic/648-storing-module-config-using-api/ I just added this line: 

$data = wire('modules')->getModuleConfigData('ModuleClassName');

 to the top of the getModuleConfigInputfields(array $data) method and it worked.

I called the variables using $this->permalinkURL and $this->membersPath. I'm leaving this up in case anyone else has similar issues.

Thanks again to all who took time to look at it.

  • Like 2

Share this post


Link to post
Share on other sites

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

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By MoritzLost
      This module allows you to integrate hCaptcha bot / spam protection into ProcessWire forms. hCaptcha is a great alternative to Google ReCaptcha, especially if you are in the EU and need to comply with privacy regulations.

      The development of this module is sponsored by schwarzdesign.
      The module is built as an Inputfield, allowing you to integrate it into any ProcessWire form you want. It's primarily intended for frontend forms and can be added to Form Builder forms for automatic spam protection. There's a step-by-step guide for adding the hCaptcha widget to Form Builder forms in the README, as well as instructions for API usage.
      Features
      Inputfield that displays an hCaptcha widget in ProcessWire forms. The inputfield verifies the hCaptcha response upon submission, and adds a field error if it is invalid. All hCaptcha configuration options for the widget (theme, display size etc) can be changed through the inputfield configuration, as well as programmatically. hCaptcha script options can be changed through a hook. Error messages can be translated through ProcessWire's site translations. hCaptcha secret keys and site-keys can be set for each individual inputfield or globally in your config.php. Error codes and failures are logged to help you find configuration errors. Please check the README for setup instructions.
      Links
      Github Repository and documentation InputfieldHCaptcha in the module directory (pending approval) Screenshots (configuration)

      Screenshots (hCaptcha widget)

       
       

       
    • By joshua
      This module is (yet another) way for implementing a cookie management solution.
      Of course there are several other possibilities:
      - https://processwire.com/talk/topic/22920-klaro-cookie-consent-manager/
      - https://github.com/webmanufaktur/CookieManagementBanner
      - https://github.com/johannesdachsel/cookiemonster
      - https://www.oiljs.org/
      - ... and so on ...
      In this module you can configure which kind of cookie categories you want to manage:

      You can also enable the support for respecting the Do-Not-Track (DNT) header to don't annoy users, who already decided for all their browsing experience.
      Currently there are four possible cookie groups:
      - Necessary (always enabled)
      - Statistics
      - Marketing
      - External Media
      All groups can be renamed, so feel free to use other cookie group names. I just haven't found a way to implement a "repeater like" field as configurable module field ...
      When you want to load specific scripts ( like Google Analytics, Google Maps, ...) only after the user's content to this specific category of cookies, just use the following script syntax:
      <script type="text/plain" data-type="text/javascript" data-category="statistics" data-src="/path/to/your/statistic/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="marketing" data-src="/path/to/your/mareketing/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="external_media" data-src="/path/to/your/external-media/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="marketing">console.log("Inline scripts are also working!");</script> The type has to be "optin" to get recognized by PrivacyWire, the data-attributes are giving hints, how the script shall be loaded, if the data-category is within the cookie consents of the user. These scripts are loaded asynchronously after the user made the decision.
      If you want to give the users the possibility to change their consent, you can use the following Textformatter:
      [[privacywire-choose-cookies]] It's planned to add also other Textformatters to opt-out of specific cookie groups or delete the whole consent cookie.
      You can also add a custom link to output the banner again with a link / button with following class:
      <a href="#" class="privacywire-show-options">Show Cookie Options</a> <button class="privacywire-show-options">Show Cookie Options</button> This module is still in development, but we already use it on several production websites.
      You find it here: PrivacyWire Git Repo
      Download as .zip
      I would love to hear your feedback 🙂
      CHANGELOG
      0.1.1 Debugging: fixed error during uninstall 0.1.0 Added new detection of async scripts for W3C Validation 0.0.6 CSS-Debugging for hiding unused buttons, added ProCache support for the JavaScript tag 0.0.5 Multi-language support included completely (also in TextFormatter). Added possibility to async load other assets (e.g. <img type="optin" data-category="marketing" data-src="https://via.placeholder.com/300x300">) 0.0.4 Added possibility to add an imprint link to the banner 0.0.3 Multi-language support for module config (still in development) 0.0.2 First release 0.0.1 Early development
    • By bernhard
      --- Please use RockFinder3 ---
    • By MoritzLost
      Cacheable Placeholders
      This module allows you to have pieces of dynamic content inside cached output. This aims to solve the common problem of having a mostly cacheable site, but with pieces of dynamic output here and there.  Consider this simple example, where you want to output a custom greeting to the current user:
      <h1>Good morning, <?= ucfirst($user->name) ?></h1> This snippet means you can't use the template cache (at least for logged-in users), because each user has a different name. Even if 99% of your output is static, you can only cache the pieces that you know won't include this personal greeting. A more common example would be CSRF tokens for HTML forms - those need to be unique by definition, so you can't cache the form wholesale.
      This module solves this problem by introducing cacheable placeholders - small placeholder tokens that get replaced during every request. The replacement is done inside a Page::render hook so it runs during every request, even if the response is served from the template cache. So you can use something like this:
      <h1>Good morning, {{{greeting}}}</h1> Replacement tokens are defined with a callback function that produces the appropriate output and added to the module through a simple hook:
      // site/ready.php wire()->addHookAfter('CachePlaceholders::getTokens', function (HookEvent $e) { $tokens = $e->return; $tokens['greeting'] = [ 'callback' => function (array $tokenData) { return ucfirst(wire('user')->name); } ]; $e->return = $tokens; }); Tokens can also include parameters that are parsed and passed to the callback function. There are more fully annotated examples and step-by-step instructions in the README on Github!
      Features
      A simple and fast token parser that calls the appropriate callback and runs automatically. Tokens may include multiple named or positional parameters, as well as multi-value parameters. A manual mode that allows you to replace tokens in custom pieces of cached content (useful if you're using the $cache API). Some built-in tokens for common use-cases: CSRF-Tokens, replacing values from superglobals and producing random hexadecimal strings. The token format is completely customizable, all delimiters can be changed to avoid collisions with existing tag parsers or template languages. Links
      Github Repository & documentation Module directory (pending approval) If you are interested in learning more, the README is very extensive, with more usage examples, code samples and usage instructions!
    • By Craig
      I've been using Fathom Analytics for a while now and on a growing number of sites, so thought it was about time there was a PW module for it.
      WayFathomAnalytics
      WayFathomAnalytics is a group of modules which will allow you to view your Fathom Analytics dashboard in the PW admin panel and (optionally) automatically add and configure the tracking code on front-end pages.
      Links
      GitHub Readme & documentation Download Zip Modules directory Module settings screenshot What is Fathom Analytics?
      Fathom Analytics is a simple, privacy-focused website analytics tool for bloggers and businesses.

      Stop scrolling through pages of reports and collecting gobs of personal data about your visitors, both of which you probably don't need. Fathom is a simple and private website analytics platform that lets you focus on what's important: your business.
      Privacy focused Fast-loading dashboards, all data is on a single screen Easy to get what you need, no training required Unlimited email reports Private or public dashboard sharing Cookie notices not required (it doesn't use cookies or collect personal data) Displays: top content, top referrers, top goals and more
×
×
  • Create New...