Jump to content
Mats

Module: Leaflet Map

Recommended Posts

On 30/01/2017 at 2:01 PM, swampmusic said:

Does anyone know how you can populate the address field from another field on the template ? 

Eg; the title field is holding a country name, therefore would be nice if user does not need to type in country again, map just populates automagically.

Thx,

 

I see at least three options:

  1. An auto-load module (might be an overkill though) that will copy the title to the address
  2. JavaScript via a module like RuntimeMarkup, which you could then hide from being visible on the page. Or even better, the module AdminCustomFiles
  3. Copying and modifying the Leaflet module itself to suit this need

So yes, it is possible :).

Edited by kongondo
  • Like 2

Share this post


Link to post
Share on other sites
On 31/01/2017 at 3:01 AM, swampmusic said:

Does anyone know how you can populate the address field from another field on the template ?

If it's the title field you want to populate the address from, you could use a hook to set the address when a new page is added. In /site/ready.php:

$this->pages->addHookAfter('added', function($event) {
    $page = $event->arguments('page');
    if($page->template != 'my_map_template') return;
    $page->my_leaflet_map->address = $page->title;
    $page->save();
});

 

  • Like 3

Share this post


Link to post
Share on other sites

v2.8.0 is out. It's a trivial fix for a problem with the PW3 FileCompiler (it was inserting the Processwire namespace into PHP-generated js code used on the front end).

NB: The js class now used in the code is jsMarkupLeafletMap instead of MarkupLeafletMap. You may need to adjust your js code to allow for this.

I've also taken the opportunity to bump the field numbers to bring some continuity across the files.

  • Like 1

Share this post


Link to post
Share on other sites

Thanks @dab,

I have the big map working with this code (quite basic)

$items = $page->children;
$map = $modules->get('MarkupGoogleMap');

$content .= $map->render($items, 'map');

 

For the page with turtles I want to have the current turtle on that page to be visible on the map. I have made the following code:

if($page->hasChildren) {
    $results = $page->children("limit=9, sort=-created");

    $pagination = $results->renderPager();

    $content .= $pagination;
   $content .= renderSchildpadden($results);
    $content .= $pagination;
}


foreach ($results as $result){
    foreach ($result->verspreidingen as $verspreiding) {
    $out .= $verspreiding . "|";
    }
    }
//$item = $out;
$sidebar_bottom = $out;

$map = $modules->get('MarkupGoogleMap');

$sidebar_bottom .= $map->render($out, 'map');

The part for the sidebar_bottom gives the following error:

Error: Uncaught Error: Call to a member function first() on string in /home/deb26781n3/domains/chrysemys.nl/public_html/site/modules/FieldtypeMapMarker/MarkupGoogleMap.module:209
Stack trace:
#0 /home/deb26781n3/domains/chrysemys.nl/public_html/site/templates/schildpadden.php(32): MarkupGoogleMap->render('1213|1198|1199|...', 'map')
#1 /home/deb26781n3/domains/chrysemys.nl/public_html/wire/core/TemplateFile.php(268): require('/home/deb26781n...')
#2 [internal function]: ProcessWire\TemplateFile->___render()
#3 /home/deb26781n3/domains/chrysemys.nl/public_html/wire/core/Wire.php(374): call_user_func_array(Array, Array)
#4 /home/deb26781n3/domains/chrysemys.nl/public_html/wire/core/WireHooks.php(549): ProcessWire\Wire->_callMethod('___render', Array)
#5 /home/deb26781n3/domains/chrysemys.nl/public_html/wire/core/Wire.php(399): ProcessWire\WireHooks->runHooks(Object(ProcessWire\TemplateFile), 'render', Array)
#6 /home/deb26781n3/domains/chrysemys.nl/public_html/wire/modules/PageRender.mod (line 209 of /home/deb26781n3/domains/chrysemys.nl/public_html/site/modules/FieldtypeMapMarker/MarkupGoogleMap.module) 

This error message was shown because: you are logged in as a Superuser. Error has been logged.

 

The input for the big map are the pages that contain the field 'map'.

foreach ($results as $result){ foreach ($result->verspreidingen as $verspreiding) { $out .= $verspreiding . "|"; } }

The code above produces also an array of pages that contain the field 'map'. But this time the same function strugles on this part of the code in the module:

if($options['useMarkerSettings'] && (count($pageArray) == 1 || !$lat)) {
   // single marker overrides lat, lng and zoom settings
   $marker = $pageArray->first()->get($fieldName); << this line and on first() returns the error
          $lat = $marker->lat;
   $lng = $marker->lng; 
   if($marker->zoom > 0) $zoom = (int) $marker->zoom;
}

What am I doing wrong here?

 

Sanne

 

 

 

Share this post


Link to post
Share on other sites

@webhoes

Are you sure you're posting this issue in the correct place? This thread deals with the Leaflet maps module, but your code looks like it is using the Google maps module.

Share this post


Link to post
Share on other sites
On 02/02/2017 at 1:09 PM, kongondo said:

I see at least three options:

  1. An auto-load module (might be an overkill though) that will copy the title to the address
  2. JavaScript via a module like RuntimeMarkup, which you could then hide from being visible on the page. Or even better, the module AdminCustomFiles
  3. Copying and modifying the Leaflet module itself to suit this need

So yes, it is possible :).

Thanks, went with (2), worked great.

Share this post


Link to post
Share on other sites

Is it possible to make this module work like a Choropleth map?

An interactive (vector based) map of all the regions in the world. The coloring should be darker as more pages (are linked) belong to a certain region.

Sanne

Share this post


Link to post
Share on other sites
25 minutes ago, webhoes said:

Is it possible to make this module work like a Choropleth map?

An interactive (vector based) map of all the regions in the world. The coloring should be darker as more pages (are linked) belong to a certain region.

Sanne

http://leafletjs.com/examples/choropleth/

Another awesome option for chloropleth maps is: http://datamaps.github.io/

  • Like 2

Share this post


Link to post
Share on other sites

I haven't used this module, so not sure how to best integrate chloropleth into it, but I am sure someone who has will chime in.

Datamaps works great with PW - no need for a module - just use the dataUrl option and point it to a PW bootstrapped php file which uses PW selectors to grab the required data (Profields Table field works great as a data source, but not necessary), populate an array, and the run json_encode on it. I would recommend starting with a manually populated json file first to make sure you have datamaps working properly, and then work on the dynamically generated file. It's not difficult, but might be a little tricky your first time.

PS Of course if your data is in a non-PW database table, you can do direct SQL queries to build up the array/json

Share this post


Link to post
Share on other sites

@adrian, I don't fully understand the workflow (yet).

This is an example what I would really like (they have taken it a few steps beyond my initial thoughts which is even nicer).

https://theturtleroom.com/education/native-species-maps/

Can an array be populated with something pages->find() for a big map. And put the Datamaps code in the template for the big map.

 

I have pages with turtles and linked them to other pages that are a country/state. Can I use the same method to creat a map with this instead of google like I have now?

My working example - http://chrysemys.nl/schildpadden/trachemys-scripta-scripta/

 

 

Share this post


Link to post
Share on other sites
2 minutes ago, webhoes said:

Can an array be populated with something pages->find() for a big map. And put the Datamaps code in the template for the big map.

Absolutely! 

7 minutes ago, webhoes said:

I have pages with turtles and linked them to other pages that are a country/state. Can I use the same method to creat a map with this instead of google like I have now?

Datamaps supports chloropleth and bubbles. I often use the bubbles options for the markers at various locations. You can color and size them as needed and also add a tooltip with more info. You can even add click events to trigger display of further information on the page - perhaps a chart related to turtle info at the click site.

The other great thing about datamaps is that because it outputs as SVG (via D3JS), you can manipulate the elements with css and js very easily. It really is a pleasure to work with. It also works great with AngularJS and I expect it will integrate nicely with VueJS as well (something I plan on trying soon).

You can also use your own map data rather than relying on the built-in world / country maps. You just need to convert ESRI shape files to the topojson format, which is awesome for the web. As you can tell, I am a huge fan of the datamaps library :)

Perhaps you should dive in and ask more detailed questions as they come up - probably time to start a new topic though.

 

Share this post


Link to post
Share on other sites

Does anybody know how to customize the map's javascript options when displaying the map on the frontend?

I'm trying to turn the mouse scrollzoom off.

http://leafletjs.com/reference.html#map-scrollwheelzoom

Also for anybody else having trouble when using this with the TemplateEngineFactory and TemplateEngineTwig modules, I had to do the following because my map wasn't showing on the frontend.  No errors where displayed and the leaflet assets where loaded on the page.  The map just didn't get initialized without the $page->inlineScript.

In my controller.php, note how I had to add the $page->inlineScript:
$leafletHeaderLines = $map->getLeafletMapHeaderLines() . $page->inlineScript;
$view->set('leafletHeaderLines', $leafletHeaderLines );

In my view.twig
{{ leafletHeaderLines }}

Hope that helps someone.

Share this post


Link to post
Share on other sites

Hi all,

Leaflet is working fine on test pages I made in PW 3.0.58.

Now I have 3 questions:

  1. Did anyone upgrade this module to leaflet 1.0.3 ? 
  2. As a basemap with eventual layers I'm requested to use WMS ( http://geoservices.informatievlaanderen.be/raadpleegdiensten/GRB-basiskaart/wms) Does the module support wms? I tried but I'm doing something wrong it seems ..
  3. On top of that I should use either a .dbf, shx or shp file of which then I can link each row to a page in Processwire. Can this be done?

I have to get started and am hesitating whether PW will be the ideal platform to do this. So, on the first 3 points, is there anyone who could inform me?

 

Edited by Pretobrazza
For clarity

Share this post


Link to post
Share on other sites

@Pretobrazza trying to answer your questions:

1. As stated in the MarkupLeaflet.module file, you are required to add the link to leaflet.js yourself. You can change the version to 1.0.3. Then you also have to change the link to the leaflet css in the same file line 106.
If you decide to use the getLeafletMapHeaderLines method for injecting JS and CSS then you need to change lines  168 and 173.

2. This module does not support wms layers out of the box. You would need to expand the JS logic to use them. Over at leafletjs.com they have a tutorial on how to implement wms layers.
The relevant code section in the module can be found in MarkupLeafletMap.js line 47. Following the tutorial on leaflet.js you might have to alter some other code in that file, too.

3. There is a shapefile plugin for leaflet.js that you could use to draw layers from your shape file. You can use the PW API and some PHP logic to create that shape file from the data in your pages, but I'm afraid this goes beyond the scope of this thread.

This module is designed to draw markers of locations on a map where you can choose different map tile providers and assign custom fontawesome icons to your markers.

All in all I think ProcessWire fits the job very well. But you might be better off just using the inputfield from this module on your pages to input the location data. And then setup the map rendering from scratch in your template file rather then using the render method that MarkupLeaflet.module provides. This should be easier than tweaking the render logic that this module provides.

I can definitly encourage you trying to do this with PW and leaflet.js.

 

  • Like 3

Share this post


Link to post
Share on other sites
On 9/4/2017 at 2:20 PM, gebeer said:

1. As stated in the MarkupLeaflet.module file, you are required to add the link to leaflet.js yourself. You can change the version to 1.0.3. Then you also have to change the link to the leaflet css in the same file line 106.
If you decide to use the getLeafletMapHeaderLines method for injecting JS and CSS then you need to change lines  168 and 173.

@gebeer

Thank you for all the info! I already prepared long reply but I first want to sort out a little problem I'm having when going to v 1.0.3. The admin side works perfectly but on the front-end the map remains blank and an error is being thrown. In the console I read:

Uncaught TypeError: L.MarkerClusterGroup is not a constructor at new jsMarkupLeafletMap (MarkupLeafletMap.js:54)  -->

var markers = new L.MarkerClusterGroup({polygonOptions: {color: 'teal', weight: 1, opacity: .39, lineJoin: 'round'}});
    var marker = '';

When I cancel out these 2 lines the map shows up but obviously without the markers.

Did anyone encounter the same problem?

ProcessWire 3.0.58  -

 

Share this post


Link to post
Share on other sites

I think I tried a quick test not to long ago to update the external libraries, and I believe I ran into the problem with the map not showing and javascript errors displayed in the console.  I haven't had any time to investigate further.

Share this post


Link to post
Share on other sites

@Pretobrazza I just installed latest version of this module on PW 3.0.47

I updated the getLeafletMapHeaderLines method for injecting JS and CSS then lines  168 and 173 to load @1.0.3.

Then I got a JS error about the MarkerCluster.

I updated all 3 files in the module's assets/leaflet-markercluster/ folder to the latest 1.0.4 versions. You can find them here: https://github.com/Leaflet/Leaflet.markercluster/tree/v1.0.4/dist

After that the map is showing up fine with no errors.

Pls let us know how it goes for you.

  • Like 1

Share this post


Link to post
Share on other sites

Does anyone has tried to show a Leaflet map inside a UIKit modal? The problem is that the map will not be rendered properly.

Screenshot_1.jpg.240c0365f46335f89b596408ff21499f.jpg

I have searched the web but didnt found a working solution. The only one that I have found was https://yootheme.com/support/question/80769 but I cannot adapt it to get it work.

Maybe someone had the same problem and found a working solution.

Best regards

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 Robin S
      First a note about my other modules...
      I have three existing modules that are similar in that they allow restrictions to be placed on repeating inputfields: Limit Repeater, Limit PageTable, Limit Table
      Restrict Repeater Matrix takes a different approach to the module configuration from those other modules. The module settings for Restrict Repeater Matrix are applied in the field settings rather in a module config screen. I think this new approach is better, but it means that it isn't practical to create different settings for different roles via the admin interface. Instead the module has a hookable method, allowing roles to be targeted and other advanced usages to be achieved via a hook. The result is that the module is more flexible.
      I intend to transition my other modules to the same approach over the coming weeks, but because this will result in breaking changes I will be releasing the updated modules under new names ("Restrict Repeater", etc) to avoid users upgrading via the Upgrades module without full awareness of the changes. The old modules will be marked as deprecated.
      Restrict Repeater Matrix
      A module for ProcessWire CMS/CMF. Allows restrictions and limits to be placed on Repeater Matrix fields. Requires ProcessWire >= v3.0.0 and FieldtypeRepeaterMatrix >= v0.0.5.
      For any matrix type in a Repeater Matrix field you have the option to:
      Disable settings for items (cannot change matrix type) Prevent drag-sorting of items Prevent cloning of items Prevent toggling of the published state of items Prevent trashing of items Limit the number of items that may be added to the inputfield. When the limit is reached the "Add new" button for the matrix type will be removed and the matrix type will not be available for selection in the "Type" dropdown of other matrix items. Please note that restrictions and limits are applied with CSS/JS so should not be considered tamper-proof.
      Usage
      Install the Restrict Repeater Matrix module.
      For each matrix type created in the Repeater Matrix field settings, a "Restrictions" fieldset is added at the bottom of the matrix type settings:

      For newly added matrix types, the settings must be saved first in order for the Restrictions fieldset to appear. Set restrictions for each matrix type as needed. A limit of zero means that no items of that matrix type may be added to the inputfield.
      Setting restrictions via a hook
      Besides setting restrictions in the field settings, you can also apply or modify restrictions by hookingRestrictRepeaterMatrix::checkRestrictions. This allows for more focused restrictions, for example, applying restrictions depending on the template of the page being edited or depending on the role of the user.
      The checkRestrictions() method receives the following arguments:
      $field This Repeater Matrix field $inputfield This Repeater Matrix inputfield $matrix_types An array of matrix types for this field. Each key is the matrix type name and the value is the matrix type integer. $page The page that is open in ProcessPageEdit The method returns a multi-dimensional array of matrix types and restrictions for each of those types. An example of a returned array:

      Example hooks
      Prevent the matrix type "images_block" from being added to "my_matrix_field" in a page with the "basic-page" template:
      $wire->addHookAfter('RestrictRepeaterMatrix::checkRestrictions', function(HookEvent $event) { $field = $event->arguments('field'); $page = $event->arguments('page'); $type_restrictions = $event->return; if($field->name === 'my_matrix_field' && $page->template->name === 'basic-page') { $type_restrictions['images_block']['limit'] = 0; } $event->return = $type_restrictions; }); Prevent non-superusers from trashing any Repeater Matrix items in "my_matrix_field":
      $wire->addHookAfter('RestrictRepeaterMatrix::checkRestrictions', function(HookEvent $event) { $field = $event->arguments('field'); $type_restrictions = $event->return; if($field->name === 'my_matrix_field' && !$this->user->isSuperuser()) { foreach($type_restrictions as $key => $value) { $type_restrictions[$key]['notrash'] = true; } } $event->return = $type_restrictions; }); http://modules.processwire.com/modules/restrict-repeater-matrix/
      https://github.com/Toutouwai/RestrictRepeaterMatrix
    • By BitPoet
      Here's a little text formatter module that redirects all external links found in a textarea (e.g. for hit counting) to a given URL.
      TextformatterExternalRedirect
      GitHub repo
      As TextFormatters do, this module modifies the contents of the textarea (HTML) at rendering time. It prepends the given URL to the link address for external links (http and https), optionally makes sure that the link is opened in a new window and allows you to add css classes to such links.
      All options can be configured in the module's configuration settings.
      Usage:
      Download the zip archive and extract it to site/modules, the rename the top folder to TextformatterExternalRedirect Go to the backend and select "Modules" -> "Refresh", then click "Install" for "External Link Redirect" Click "Settings" and configure the module
      Go into the field configuration for the field(s) you want this formatter to apply to and add it from the dropdown
      Done, now any external links in the configured fields will have the configured settings applied Feel free to leave feedback and post and questions you have here.
       
    • By teppo
      Hey folks!
      Took a couple of late nights, but managed to turn this old gist of mine into a proper module. The name is SearchEngine, and currently it provides support for indexing page contents (into a hidden textarea field created automatically), and also includes a helper feature ("Finder") for querying said contents. No fancy features like stemming here yet, but something along those lines might be added later if it seems useful (and if I find a decent implementation to integrate).
      Though the API and selector engine make it really easy to create site search pages, I pretty much always end up duplicating the same features from site to site. Also – since it takes a bit of extra time – it's tempting to skip over some accessibility related things, and leave features like text highlighting out. Overall I think it makes sense to bundle all that into a module, which can then be reused over and over again 🙂
      Note: markup generation is not yet built into the module, which is why the examples below use PageArray::render() method to produce a simple list of results. This will be added later on, as a part of the same module or a separate Markup module. There's also no fancy JS API or anything like that (yet).
      This is an early release, so be kind – I got the find feature working last night (or perhaps this morning), and some final tweaks and updates were made just an hour ago 😅
      GitHub repository: https://github.com/teppokoivula/SearchEngine Modules directory: https://modules.processwire.com/modules/search-engine/ Demo: https://wireframe-framework.com/search/ Usage
      Install SearchEngine module. Note: the module will automatically create an index field install time, so be sure to define a custom field (via site config) before installation if you don't want it to be called "search_index". You can change the field name later as well, but you'll have to update the "index_field" option in site config or module settings (in Admin) after renaming it.
      Add the site search index field to templates you want to make searchable. Use selectors to query values in site search index. Note: you can use any operator for your selectors, you will likely find the '=' and '%=' operators most useful here. You can read more about selector operators from ProcessWire's documentation.
      Options
      By default the module will create a search index field called 'search_index' and store values from Page fields title, headline, summary, and body to said index field when a page is saved. You can modify this behaviour (field name and/or indexed page fields) either via the Module config screen in the PocessWire Admin, or by defining $config->SearchEngine array in your site config file or other applicable location:
      $config->SearchEngine = [ 'index_field' => 'search_index', 'indexed_fields' => [ 'title', 'headline', 'summary', 'body', ], 'prefixes' => [ 'link' => 'link:', ], 'find_args' => [ 'limit' => 25, 'sort' => 'sort', 'operator' => '%=', 'query_param' => null, 'selector_extra' => '', ], ]; You can access the search index field just like any other ProcessWire field with selectors:
      if ($q = $sanitizer->selectorValue($input->get->q)) { $results = $pages->find('search_index%=' . $query_string . ', limit=25'); echo $results->render(); echo $results->renderPager(); } Alternatively you can delegate the find operation to the SearchEngine module as well:
      $query = $modules->get('SearchEngine')->find($input->get->q); echo $query->resultsString; // alias for $query->results->render() echo $query->pager; // alias for $query->results->renderPager() Requirements
      ProcessWire >= 3.0.112 PHP >= 7.1.0 Note: later versions of the module may require Composer, or alternatively some additional features may require installing via Composer. This is still under consideration – so far there's nothing here that would really depend on it, but advanced features like stemming most likely would.
      Installing
      It's the usual thing: download or clone the SearchEngine directory into your /site/modules/ directory and install via Admin. Alternatively you can install SearchEngine with Composer by executing composer require teppokoivula/search-engine in your site directory.
    • By teppo
      MarkupMenu is a markup module for generating menu trees. When provided a root page as a starting point, it generates a navigation tree (by default as a HTML "<ul>" element wrapped by a "<nav>" element) from that point onwards. If you've also provided it with current (active) page, the menu will be rendered accordingly, with current item highlighted and items rendered up to that item and its children (unless you disable the "collapsed" option, in which case the full page tree will be rendered instead).
      Modules directory: https://modules.processwire.com/modules/markup-menu/ GitHub repository: https://github.com/teppokoivula/MarkupMenu Usage
      As a markup module, MarkupMenu is intended for front-end use, but you can of course use it in a module as well. Typically you'll only need the render() method, which takes an array of options as its only argument:
      echo $modules->get('MarkupMenu')->render([ 'root_page' => $pages->get(1), 'current_page' => $page, ]); Note: if you omit root_page, site root page is used by default. If you omit current_page, the menu will be rendered, but current (active) page won't be highlighted etc.
      A slightly more complex example, based on what I'm using on one of my own sites to render a (single-level) top menu:
      echo $modules->get('MarkupMenu')->render([ 'current_page' => $page, 'templates' => [ 'nav' => '<nav class="{classes} menu--{menu_class_modifier}" aria-label="{aria_label}">%s</nav>', 'item_current' => '<a class="menu__item menu__item--current" href="{item.url}" tabindex="0" aria-label="Current page: {item.title}">{item.title}</a>', ], 'placeholders' => [ 'menu_class_modifier' => 'top', 'aria_label' => 'Main navigation', ], 'include' => [ 'root_page' => true, ], 'exclude' => [ 'level_greater_than' => 1, ], ]); Note: some things you see above may not be entirely sensible, such as the use of {menu_class_modifier} and {aria_label} placeholders. On the actual site the "nav" template is defined in site config, so I can define just these parts on a case-by-case basis while actual nav markup is maintained in one place.
      Please check out the README file for available render options. I'd very much prefer not to keep this list up to date in multiple places. Basically there are settings for defining "templates" for different parts of the menu (list, item, etc.), include array for defining rules for including in the menu and exclude array for the opposite effect, classes and placeholders arrays for overriding default classes and injecting custom placeholders, etc. 🙂
      MarkupMenu vs. MarkupSimpleNavigation
      TL;DR: this is another take on the same concept. There are many similarities, but also some differences – especially when it comes to the supported options and syntax. If you're currently using MarkupSimpleNavigation then there's probably no reason to switch over.
      I'd be surprised if someone didn't draw lines between this module and Soma's awesome MarkupSimpleNavigation. Simply put I've been using MSN (...) for years, and it's been great – but there are some issues with it, particularly in the markup generation area, and it also does some things in a way that doesn't quite work for me – the xtemplates thing being one of these. In some ways less about features, and more about style, I guess 🙂
      Anyhow, in MarkupMenu I've tried to correct those little hiccups, modernise the default markup, and allow for more flexibility with placeholder variables and additional / different options. MarkupMenu was built for ProcessWire 3.0.112+ and with PHP 7.1+ in mind, it's installable with Composer, and I have a few additional ideas (such as conditional placeholders) still on my todo list.
      One more small(ish) difference is that MarkupMenu supports overriding default options via $config->MarkupMenu. I find myself redefining the default markup for every site, which until now meant that each site had a wrapper function for MarkupSimpleNavigation (to avoid code / config repetition), and this way I've been able to leave that out 🙂
      Requirements
      ProcessWire >= 3.0.112 PHP >= 7.1.0 If you're working on an earlier version of ProcessWire or PHP, use MarkupSimpleNavigation instead.
    • By teppo
      Hey folks!
      I'm happy to finally introduce a project I've been working on for quite a while now: it's called Wireframe, and it is an output framework for ProcessWire.
      Note that I'm posting this in the module development area, maily because this project is still in rather early stage. I've built a couple of sites with it myself, and parts of the codebase have been powering some pretty big and complex sites for many years now, but this should still be considered a soft launch 🙂
      --
      Long story short, Wireframe is a module that provides the "backbone" for building sites (and apps) with ProcessWire using an MVC (or perhaps MVVM – one of those three or four letter abbreviations anyway) inspired methodology. You could say that it's an output strategy, but I prefer the term "output framework" since in my mind the word "strategy" means something less tangible. A way of doing things, rather than a tool that actually does things.
      Wireframe (the module) provides a basic implementation for some familiar MVC concepts, such as Controllers and a View layer – the latter of which consists of layouts, partials, and template-specific views. There's no "model" layer, since in this context ProcessWire is the model. As a module Wireframe is actually quite simple – not even nearly the biggest one I've built – but there's still quite a bit of stuff to "get", so I've put together a demo & documentation site for it at https://wireframe-framework.com/.
      In addition to the core module, I'm also working on a couple of site profiles based on it. My current idea is actually to keep the module very light-weight, and implement most of the "opinionated" stuff in site profiles and/or companion modules. For an example MarkupMenu (which I released a while ago) was developed as one of those "companion modules" when I needed a menu module to use on the site profiles.
      Currently there are two public site profiles based on Wireframe:
      site-wireframe-docs is the demo&docs site mentioned above, just with placeholder content replaced with placeholder content. It's not a particularly complex site, but I believe it's still a pretty nice way to dig into the Wireframe module. site-wireframe-boilerplate is a boilerplate (or starter) site profile based on the docs site. This is still very much a work in progress, but essentially I'm trying to build a flexible yet full-featured starter profile you can just grab and start building upon. There will be a proper build process for resources, it will include most of the basic features one tends to need from site to site, etc. --
      Requirements and getting started:
      Wireframe can be installed just like any ProcessWire module. Just clone or download it to your site/modules/ directory and install. It doesn't, though, do a whole lot of stuff on itself – please check out the documentation site for a step-by-step guide on setting up the directory structure, adding the "bootstrap file", etc. You may find it easier to install one of the site profiles mentioned above, but note that this process involves the use of Composer. In the case of the site profiles you can install ProcessWire as usual and download or clone the site profile directory into your setup, but after that you should run "composer install" to get all the dependencies – including the Wireframe module – in place. Hard requirements for Wireframe are ProcessWire 3.0.112 and PHP 7.1+. The codebase is authored with current PHP versions in mind, and while running it on 7.0 may be possible, anything below that definitely won't work. A feature I added just today to the Wireframe module is that in case ProcessWire has write access to your site/templates/ directory, you can use the module settings screen to create the expected directories automatically. Currently that's all, and the module won't – for an example – create Controllers or layouts for you, so you should check out the site profiles for examples on these. (I'm probably going to include some additional helper features in the near future.)
      --
      This project is loosely based on an earlier project called pw-mvc, i.e. the main concepts (such as Controllers and the View layer) are very similar. That being said, Wireframe is a major upgrade in terms of both functionality and architecture: namespaces and autoloader support are now baked in, the codebase requires PHP 7, Controllers are classes extending \Wireframe\Controller (instead of regular "flat" PHP files), implementation based on a module instead of a collection of drop-in files, etc.
      While Wireframe is indeed still in a relatively early stage (0.3.0 was launched today, in case version numbers matter) for the most part I'm happy with the way it works, and likely won't change it too drastically anytime soon – so feel free to give it a try, and if you do, please let me know how it went. I will continue building upon this project, and I am also constantly working on various side projects, such as the site profiles and a few unannounced helper modules.
      I should probably add that while Wireframe is not hard to use, it is more geared towards those interested in "software development" type methodology. With future updates to the module, the site profiles, and the docs I hope to lower the learning curve, but certain level of "developer focus" will remain. Although of course the optimal outcome would be if I could use this project to lure more folks towards that end of the spectrum... 🙂
      --
      Please let me know what you think – and thanks in advance!
×
×
  • Create New...