Jump to content
Gadgetto

SnipWire - Snipcart integration for ProcessWire

Recommended Posts

SnipWire - Snipcart integration for ProcessWire

snipwire-logo.png.feda01eced6c5fdf0f113e7e7282ba6e.pngSnipcart is a powerful 3rd party, developer-first HTML/JavaScript shopping cart platform. SnipWire is the missing link between Snipcart and the content management framework ProcessWire.
With SnipWire, you can quickly turn any ProcessWire site into a Snipcart online shop. The SnipWire plugin helps you to get your store up and running in no time. Detailed knowledge of the Snipcart system is not required.

SnipWire is free and open source licensed under Mozilla Public License 2.0! A lot of work and effort has gone into development. It would be nice if you could donate an amount to support further development:

btn_donate_LG.gif.c8f4961c98cd4b5e8f81d517f5e68864.gif

Status update links (inside this thread) for SnipWire development

  • 2020-07-03 -- SnipWire 0.8.7 (beta) released! Fixes some small bugs and adds an indicator for TEST mode
  • 2020-04-06 -- SnipWire 0.8.6 (beta) released! Adds support for Snipcart subscriptions and also fixes some problems
  • 2020-03-21 -- SnipWire 0.8.5 (beta) released! Improves SnipWires webhooks interface and provides some other fixes and additions
  • 2020-03-03 -- SnipWire 0.8.4 (beta) released! Improves compatibility for Windows based Systems.
  • 2020-03-01 -- SnipWire 0.8.3 (beta) released! The installation and uninstallation process has been heavily revised.
  • 2020-02-08 -- SnipWire 0.8.2 (beta) released! Added a feature to change the cart and catalogue currency by GET, POST or SESSION param
  • 2020-02-03 -- SnipWire 0.8.1 (beta) released! All custom classes moved into their own namespaces.
  • 2020-02-01 -- SnipWire is now available via ProcessWire's module directory!
  • 2020-01-30 -- SnipWire 0.8.0 (beta) first public release! (module just submitted to the PW modules directory)
  • 2020-01-28 -- added Custom Order Fields feature (first SnipWire release version is near!)
  • 2020-01-21 -- Snipcart v3 - when will the new cart system be implemented?
  • 2020-01-19 -- integrated taxes provider finished (+ very flexible shipping taxes handling)
  • 2020-01-14 -- new date range picker, discount editor, order notifiactions, order statuses, and more ...
  • 2019-11-15 -- orders filter, order details, download + resend invoices, refunds
  • 2019-10-18 -- list filters, REST API improvements, new docs platform, and more ...
  • 2019-08-08 -- dashboard interface, currency selector, managing Orders, Customers and Products, Added a WireTabs, refinded caching behavior
  • 2019-06-15 -- taxes provider, shop templates update, multiCURL implementation, and more ...
  • 2019-06-02 -- FieldtypeSnipWireTaxSelector
  • 2019-05-25 -- SnipWire will be free and open source

Plugin Key Features

  • Fast and simple store setup
  • Full integration of the Snipcart dashboard into the ProcessWire backend (no need to leave the ProcessWire admin area)
  • Browse and manage orders, customers, discounts, abandoned carts, and more
  • Multi currency support
  • Custom order and cart fields
  • Process refunds and send customer notifications from within the ProcessWire backend
  • Process Abandoned Carts + sending messages to customers from within the ProcessWire backend
  • Complete Snipcart webhooks integration (all events are hookable via ProcessWire hooks)
  • Integrated taxes provider (which is more flexible then Snipcart own provider)

Useful Links

 

SnipWire-dashboard.thumb.png.a6344a9a024d6a39ef786a5705b332aa.png

 

---- INITIAL POST FROM 2019-05-25 ----

Spoiler

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 (open spoiler):
(Please note: these screenshots are from an early development state of SnipWire. To see actual screens please have a look at later posts below!)

SnipWire_Settings.jpg

SnipWire_Dashboard1.jpg

Snipcart_Shop.jpg

Snipcart_Shop_Cart.jpg

 

  • Like 24
  • Thanks 4

Share this post


Link to post
Share on other sites

Hi @Gadgetto, this looks great!

I've played around with Snipcart and Foxycart quite a lot and then built my own solution (which was quite a pain as well 🤪 ). Snipcart definitely looked best IMHO but it is also quite expensive. But it may be worth that price if we have a good working module that integrates well and saves us lots of time during development.

20 hours ago, Gadgetto said:

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!

Well... free sounds great 🙂 No idea how much money one can make by selling a pro module to the community - I've never heard any numbers and there have been several discussions about that. So I'm not even sure if it makes sense at all to sell anything to the pw community. It's also more effort to setup some kind of selling process, api key verificaton etc. (well, maybe not for you now that you can use SnipWire for that 😄 ); I decided to release RockGrid free for example so that others can use it easily in their modules (didn't happen as far as I know), but I stated that extended support is not for free. But RockGrid is totally different. A shopping cart is of course much more mainstream and has a broader audience for sure. I could be a possible customer one day 😉 

 

  • Like 1

Share this post


Link to post
Share on other sites

This looks great! I've set up my fair share of Snipcart sites, but never bothered to abstract any of it into a module. So thanks for making this available in whichever form you're comfortable with, free or paid.

My Snipcart styles have usually been very tightly linked to the site stylesheets (shared SASS variables and mixins) and ended up in the global site stylesheet. Maybe the stylesheet URL input shouldn't be mandatory for sites that already have the Snipcart CSS embedded? Just a thought.

  • Like 2

Share this post


Link to post
Share on other sites
13 hours ago, d'Hinnisdaël said:

This looks great! I've set up my fair share of Snipcart sites, but never bothered to abstract any of it into a module. So thanks for making this available in whichever form you're comfortable with, free or paid.

My Snipcart styles have usually been very tightly linked to the site stylesheets (shared SASS variables and mixins) and ended up in the global site stylesheet. Maybe the stylesheet URL input shouldn't be mandatory for sites that already have the Snipcart CSS embedded? Just a thought.

Done! 🙂

1775980080_Bildschirmfoto2019-05-25um11_16_44.thumb.png.7519ed0e0449add26e92ca3fc9a355a8.png

  • Like 3

Share this post


Link to post
Share on other sites

UPDATE

OK, after I've faced that for and against again, I've decided to make the module freely available.

If you are interested, you can test the current state of development. I already put the module on GitHub. Please note that the software is not yet intended for use in a production system. (Alpha version). For example, the configuration and handling of the VAT rates are still missing. Also the dashboard is still incomplete. And many other things needs to be improved and implemented... 🙂

If you like, you can also submit feature requests and suggestions for improvement. I also accept pull requests.

https://github.com/gadgetto/SnipWire

  • Like 13

Share this post


Link to post
Share on other sites

ANOTHER UPDATE

SnipWires Taxes (VAT) configurator is ready!

I added a new custom Fieldtype FieldtypeSnipWireTaxSelector based on an idea of @BitPoet - thanks for that!

Also I created a full featured repeater for module config editor including drag&drop handling. Have a look at the animated GIF below. The taxes you configure here will be available as select option list in product page editor. The first tax in the configured list will be used a s the default tax in the custom field.

taxes-repeater.thumb.gif.75d243e965efeae179a1c794fe0564ba.gif

  • Like 9

Share this post


Link to post
Share on other sites
On 5/25/2019 at 10:35 AM, Gadgetto said:

OK, after I've faced that for and against again, I've decided to make the module freely available.

Thank you.

  • Like 4

Share this post


Link to post
Share on other sites

UPDATE 2019-06-15

The taxes repeater field in module config editor was updated:

  • changed to a grid view for more flexibility
  • added field validation
  • prepared the taxes-repeater field code to become a standalone flexible Inputfield module for general use (Array/JSON repeater input field which stores its values in a single text field)

The taxes handling is completed! SnipWire now acts as a full flexible taxes-provider for Snipcart (we use Webhooks for this). No configuration needed in Snipcart dashboard. SnipCart orders are now fully working (except shipping handling).

The sample shop templates got an update:

  • customer login/logout
  • customer dashboard link/button to view orders history and subscriptions
  • editing of customer profile

Other updates and fixes:

  • The SnipWire Dashboard was updated (Charts, Orders, Customers, ...) --> see screenshot below.
    The Dashboard fetches its data from Snipcart via CURL multi - the response time for a fresh load is now under 2 seconds
  • The Webhooks handler now supports all Snipcart events via hookable methods.
  • Snipwire now supports all major Admin themes (Uikit, Reno and Default)
  • All module classes/files are more structured (e.g. separate helper and service classes)
  • Under the hood many bugs are fixed and code is updated to prevent unexpected errors.
  • Added a crispy SVG logo for all SnipCart back-end pages 🙂

Screen-recording of updated taxes-repeater:

Taxes-Repeater-Update.thumb.gif.44ecf707f735f142c43a9df47e7a7980.gif

 

Screenshot of SnipWire Dashboard:

SnipWire-Dashboard.thumb.png.51584acdbcfdaaf95c6fac2f6fcccc0d.png

  • Like 11

Share this post


Link to post
Share on other sites

Looking great! Thx!

Nice to see apex charts in action. Did you build it as a module (or have thought about that) or is it implemented manually?

Share this post


Link to post
Share on other sites
8 hours ago, bernhard said:

Did you build it as a module (or have thought about that) or is it implemented manually?

Hi Bernhard,

currently integrated directly. But having this as module is a nice idea. The problem is, this thing has over 150 config parameters so packing it into a module will be quite a bit of work...

Share this post


Link to post
Share on other sites

You mean the config of the chart? Like type of chart, data, colors etc?

Of course it would not make sense to put all that into the module config. But it could make sense to have a fieldtype (or at least an inputfield) that can easily be added to a process module (or page edit screen) and that makes it easier and more streamlined to build those charts. In RockGrid (which also has lots of options) I use a PHP file to get the data (via RockFinder) and a JS file for the grid config.

I've started building a Chart module earlier this year, but did not release it: https://github.com/BernhardBaumrock/FieldtypeRockCharts Maybe you want to have a look and grab some ideas?

 

Share this post


Link to post
Share on other sites
23 minutes ago, bernhard said:

Of course it would not make sense to put all that into the module config. But it could make sense to have a fieldtype (or at least an inputfield) that can easily be added to a process module (or page edit screen) and that makes it easier and more streamlined to build those charts. In RockGrid (which also has lots of options) I use a PHP file to get the data (via RockFinder) and a JS file for the grid config.

I've started building a Chart module earlier this year, but did not release it: https://github.com/BernhardBaumrock/FieldtypeRockCharts Maybe you want to have a look and grab some ideas?

 

I'll first need to release SnipWire and in the phase of fine-tuning I would like to move some of the functionality into separate modules. A chart module could be such a candidate. I'm gonna check out your module and see how you were thinking of implementing that. Thanks for your hint!

The first separate module will be a fully configurable array/json repeater Inputfield which stores its values in a single text field. 

  • Like 1

Share this post


Link to post
Share on other sites

UPDATE 2019-08-08

The module has made hug steps forward and we are nearing a first beta release version. So for those of you who are interested, I wanted to let you know what happened in the meantime 🙂

  • The dashboard interface was refined.
  • Currency selector for switching dashboard currency (based on your currency fields)
  • Added dashboard sections for managing Orders, Customers and Products
  • Added a WireTabs interface to easily switch between the different dashboard sections.
  • Orders, Customers and Product-details are opened and edited in ProcessWire Panels
  • Added further properties to SnipCart product anchors like: categories, product dimensions, weight, and so on.
  • Added field selector to SnipWire settings for choosing the desired field (FieldtypePage) to be used for categories handling.
  • Refinded caching behavior. *)

*) the proper caching of SnipCart data fetched through their REST API is giving me headaches. I'm still not sure what to cache and how long. For example, think of retrieving the list of purchase orders and creating a pagination. Every single page has to be cached. What if new orders are added when flipping backwards? Then the page numbers could get out of hand. (this only as an example).

As SnipCart has relativ slow API response times (about 1.8-2.5 seconds for a request), I'm even thinking about developing a separate background job runner which continuously fetches data from SnipCart and caches it locally. Our SnipWire module could then only use locally stored data only.

What needs to be done:

  • As SnipCart has a totally broken presentation of multi currency values in it's dashboard (for example: they simply sum up order values in different currencies!) I need to calculate performance values manually. And this will be a huge job as the data comes from different REST API calls...
  • Orders, Customers and Products detail editors (order status update, setting the order tracking number, add metadata information, creating notifications on the specified orders, ...)
  • Order refunds handling through the SnipWire dashboard
  • Integration of external shipping providers
  • Integration of external taxes providers
  • Subscription handling through the SnipWire dashboard
  • Discount creation and handling through the SnipWire dashboard
  • Documentation, documentation, documentation!
  • and much more ...

Here are some fresh screens:

Spoiler

1-SnipWire-Dashboard.thumb.png.69ff1a7167f554302a321584289c0907.png

2-SniWire-Orders.thumb.png.6d3d9b11d0b5999e0906299d8e2374ab.png

3-SnipWire-Customers.thumb.png.65fcb3c61a51a98c2f07525640823c55.png

4-SnipWire-Products.thumb.png.4bb91757649570fe38e6c77b407c94a8.png

5-SnipWire-Settings.thumb.png.7a26e5422ffad6620b4f038a860b7dc9.png

6-SnipWire-Dashboard-daterangepicker.thumb.png.a3984e5c48da8e430391d545d3b10992.png

 

 

 

  • Like 10

Share this post


Link to post
Share on other sites

Very nice — I'm really impressed about how this is coming along. I particularly like how you manage to pack as many features into it while successfully staying within ProcessWire's visual language.

I wish I had a little more time on my hands to try it out in depth and give useful feedback.

Quote

As SnipCart has relativ slow API response times (about 1.8-2.5 seconds for a request), I'm even thinking about developing a separate background job runner which continuously fetches data from SnipCart and caches it locally. Our SnipWire module could then only use locally stored data only.

That sounds like a logical next step to me: using LazyCron to auto-fetch certain data. While it will increase complexity in the short term, it will probably make your job a lot easier in the long run and make for a better experience using the module.

  • Like 1

Share this post


Link to post
Share on other sites
5 minutes ago, d'Hinnisdaël said:

Very nice — I'm really impressed about how this is coming along. I particularly like how you manage to pack as many features into it while successfully staying within ProcessWire's visual language.

Thank your for the kind words! 🙂

6 minutes ago, d'Hinnisdaël said:

That sounds like a logical next step to me: using LazyCron to auto-fetch certain data. While it will increase complexity in the short term, it will probably make your job a lot easier in the long run and make for a better experience using the module.

I don't know if this will make it into the first release version but it seems to be a necessary step.

LazyCron, on the other hand, does not seem to be well suited. This would cause delays for website visitors. I was thinking more of a separate worker process, or multiple parallel processes, running asynchronously and externally triggered by a cron job or by Javascript runner. I have already implemented something like this for a newsletter module for MODX.

  • Like 3

Share this post


Link to post
Share on other sites
1 hour ago, Gadgetto said:

LazyCron, on the other hand, does not seem to be well suited. This would cause delays for website visitors.

Doesn't LazyCron hook into ProcessPageView::finished to avoid this exact problem? What I've done in the past to avoid long-running requests is to merely use LazyCron to trigger the time-intensive action via curl or wget, making it asynchronous.

Share this post


Link to post
Share on other sites
12 hours ago, d'Hinnisdaël said:

Doesn't LazyCron hook into ProcessPageView::finished to avoid this exact problem? What I've done in the past to avoid long-running requests is to merely use LazyCron to trigger the time-intensive action via curl or wget, making it asynchronous.

To my best knowledge it is still same request and visitor has to wait before actual content is ready to be served. Lazycron is (in my opinion) usable for very quick cleanup type of things only. Much better to use actual cron or other background process to do that kind of stuff.

SnipWire looks fantastic! Great that PW will have multiple e-commerce options available!

  • Like 1

Share this post


Link to post
Share on other sites
1 hour ago, apeisa said:

To my best knowledge it is still same request and visitor has to wait before actual content is ready to be served. Lazycron is (in my opinion) usable for very quick cleanup type of things only. Much better to use actual cron or other background process to do that kind of stuff.

You are right, it's a single process. Hooking into any method will still be in the same process and the visitor will need to consume the request time. I'll need to "launch" a new (background) process which will do the heavy lifting.

  • Like 1

Share this post


Link to post
Share on other sites
On 5/15/2019 at 7:47 PM, Gadgetto said:

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)

 

SnipWire_Settings.jpg

SnipWire_Dashboard1.jpg

Snipcart_Shop.jpg

Snipcart_Shop_Cart.jpg

This is really amazing work you have done. Congrats and keep it up 

Share this post


Link to post
Share on other sites

UPDATE 2019-10-18

Some time has passed since the last update. But don't worry I've been working on it!

A good back of time devoured the development of our new documentation platform.

The new docs website can be found here:
https://docs.bitego.com (of course it runs under ProcessWire)

Most contents of existing projects are already imported. And I just started with the documentation for SnipWire.

Of course development on SnipWire itself has been continued as well:

  • the stability of the REST queries and their processing has been significantly improved
  • the filter (search) functions for the list views (orders, customers, products) have been implemented.
  • native ProcessWire pagination for list views has been implemented
  • more snipcart fields have been added to the product definition
  • several bugs have been fixed

169252132_Bildschirmfoto2019-10-18um21_48_35.thumb.png.367c614a4cf4ca657312e5c8e0bc99e0.png

Next steps:

  • finishing detail-views for Customers, Products and Orders
  • development of a parallel process that continuously fetches data from Snipcart and makes it available as a local cache. (this should significantly minimize the waiting time for REST queries)
  • implementation of Abandoned Carts Handling
  • implementation of Refunds Handling

Thats it for now! I also hope some of you will find the time and testing the current status. I would be very grateful for your feedback.

  • Like 9

Share this post


Link to post
Share on other sites

What I forgot to tell:

Snipcart recently became even more interesting in terms of cost!

Snipcart removed the Pro Pack bundle (70 USD/month) from their pricing. All Pro features will be available on Standard plan:

  • Abandoned carts recovery
  • Real-time shipping estimates
  • Inventory management
  • Custom email templates
  • TaxCloud & TaxJar integrations
  • Like 7

Share this post


Link to post
Share on other sites
12 hours ago, Gadgetto said:

Snipcart removed the Pro Pack bundle (70 USD/month) from their pricing. All Pro features will be available on Standard plan

Looks like they went back to their previous pricing model without a premium plan. This will make it a lot easier to suggest Snipcart in the future — paying 70$ a month for custom email templates was really limiting the number of customers that were a good fit for it.

Share this post


Link to post
Share on other sites

@Gadgetto Snipwire looks awesome. Many many thanks. I will give it a test run. May I ask you two questions.

- with snipcart/snipwire is it easily posible to calculate price reductions before checkout. let's say you buy two t-shirts and like to reduce the second shirt by 10%?

- I've seen the dashboard has links for bills. Are those in PDF Format and in case can one customize the PDF template?

Much Kudos again! Great working and sharing!

Share this post


Link to post
Share on other sites

Thanks for the kind words!

1 hour ago, toni said:

- with snipcart/snipwire is it easily posible to calculate price reductions before checkout. let's say you buy two t-shirts and like to reduce the second shirt by 10%?

Snipcart has a lot of different discount features! Here is a cut out from my process module which should show what's possible:

$this->discountsTypes = array(
    'FixedAmount' => $this->_('Fixed amount deducted from order total'),
    'Rate' => $this->_('Percentage rebate on order total'),
    'AlternatePrice' => $this->_('Discount price provided by alternate price list'),
    'Shipping' => $this->_('Discount on shipping'),
    'FixedAmountOnItems' => $this->_('Fixed amount deducted on specified products'),
    'RateOnItems' => $this->_('Rate deducted on specified products'),
    'FixedAmountOnCategory' => $this->_('Fixed amount deducted on items of specified categories'),
    'RateOnCategory' => $this->_('Rate deducted on products of specified categories'),
    'GetFreeItems' => $this->_('Free products when customer buys specified quantity of product'),
    'AmountOnSubscription' => $this->_('Fixed amount on subscription'),
    'RateOnSubscription' => $this->_('Rate on subscription'),
);
$this->discountsTriggers = array(
    'Code' => $this->_('Enter discount code'),
    'Product' => $this->_('Specific product added'),
    'Total' => $this->_('Order reaches specific amount'),
    'QuantityOfAProduct' => $this->_('Product added a number of times'),
    'CartContainsOnlySpecifiedProducts' => $this->_('Cart only contains specified products'),
    'CartContainsSomeSpecifiedProducts' => $this->_('Cart contains some of specified products'),
    'CartContainsAtLeastAllSpecifiedProducts' => $this->_('Cart contains at least all specified products'),
);
1 hour ago, toni said:

- I've seen the dashboard has links for bills. Are those in PDF Format and in case can one customize the PDF template?

Yes, invoices can be downloaded in PDF format and the layout is customizable via the Snipcart dashboard!

  • Like 1

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 David Karich
      ProcessWire InputfieldRepeaterMatrixDuplicate
      Thanks to the great ProModule "RepeaterMatrix" I have the possibility to create complex repeater items. With it I have created a quite powerful page builder. Many different content modules, with many more possible design options. The RepeaterMatrix module supports the cloning of items, but only within the same page. Now I often have the case that very design-intensive pages and items are created. If you want to use a content module on a different page (e.g. in the same design), you have to rebuild each item manually every time.
      This module extends the commercial ProModule "RepeaterMatrix" by the function to duplicate repeater items from one page to another page. The condition is that the target field is the same matrix field from which the item is duplicated. This module is currently understood as proof of concept. There are a few limitations that need to be considered. The intention of the module is that this functionality is integrated into the core of RepeaterMatrix and does not require an extra module.
      Check out the screencast
      What the module can do
      Duplicate multible repeater items from one page to another No matter how complex the item is Full support for file and image fields Multilingual support Support of Min and Max settings Live synchronization of clipboard between multiple browser tabs. Copy an item and simply switch the browser tab to the target page and you will immediately see the past button Support of multiple RepeaterMatrix fields on one page Configurable which roles and fields are excluded Configurable dialogs for copy and paste Duplicated items are automatically pasted to the end of the target field and set to hidden status so that changes are not directly published Automatic clipboard update when other items are picked Automatically removes old clipboard data if it is not pasted within 6 hours Delete clipboard itself by clicking the selected item again Benefit: unbelievably fast workflow and content replication What the module can't do
      Before an item can be duplicated in its current version, the source page must be saved. This means that if you make changes to an item and copy this, the old saved state will be duplicated Dynamic loading is currently not possible. Means no AJAX. When pasting, the target page is saved completely No support for nested repeater items. Currently only first level items can be duplicated. Means a repeater field in a repeater field cannot be duplicated. Workaround: simply duplicate the parent item Dynamic reloading and adding of repeater items cannot be registered. Several interfaces and events from the core are missing. The initialization occurs only once after the page load event Changelog
      2.0.0
      Feature: Copy multiple items at once! The fundament for copying multiple items was created by @Autofahrn - THX! Feature: Optionally you can disable the copy and/or paste dialog Bug fix: A fix suggestion when additional and normal repeater fields are present was contributed by @joshua - THX! 1.0.4
      Bug fix: Various bug fixes and improvements in live synchronization Bug fix: Items are no longer inserted when the normal save button is clicked. Only when the past button is explicitly clicked Feature: Support of multiple repeater fields in one page Feature: Support of repeater Min/Max settings Feature: Configurable roles and fields Enhancement: Improved clipboard management Enhancement: Documentation improvement Enhancement: Corrected few typos #1 1.0.3
      Feature: Live synchronization Enhancement: Load the module only in the backend Enhancement: Documentation improvement 1.0.2
      Bug fix: Various bug fixes and improvements in JS functions Enhancement: Documentation improvement Enhancement: Corrected few typos 1.0.1
      Bug fix: Various bug fixes and improvements in the duplication process 1.0.0
      Initial release Support this module
      If this module is useful for you, I am very thankful for your small donation: Donate 5,- Euro (via PayPal – or an amount of your choice. Thank you!)
      Download this module (Version 2.0.0)
      > Github: https://github.com/FlipZoomMedia/InputfieldRepeaterMatrixDuplicate
      > PW module directory: https://modules.processwire.com/modules/inputfield-repeater-matrix-duplicate/
      > Old stable version (1.0.4): https://github.com/FlipZoomMedia/InputfieldRepeaterMatrixDuplicate/releases/tag/1.0.4
    • By Robin S
      A new module that hasn't had a lot of testing yet. Please do your own testing before deploying on any production website.
      Custom Paths
      Allows any page to have a custom path/URL.
      Note: Custom Paths is incompatible with the core LanguageSupportPageNames module. I have no experience working with LanguageSupportPageNames or multi-language sites in general so I'm not in a position to work out if a fix is possible. If anyone with multi-language experience can contribute a fix it would be much appreciated!
      Screenshot

      Usage
      The module creates a field named custom_path on install. Add the custom_path field to the template of any page you want to set a custom path for. Whatever path is entered into this field determines the path and URL of the page ($page->path and $page->url). Page numbers and URL segments are supported if these are enabled for the template, and previous custom paths are managed by PagePathHistory if that module is installed.
      The custom_path field appears on the Settings tab in Page Edit by default but there is an option in the module configuration to disable this if you want to position the field among the other template fields.
      If the custom_path field is populated for a page it should be a path that is relative to the site root and that starts with a forward slash. The module prevents the same custom path being set for more than one page.
      The custom_path value takes precedence over any ProcessWire path. You can even override the Home page by setting a custom path of "/" for a page.
      It is highly recommended to set access controls on the custom_path field so that only privileged roles can edit it: superuser-only is recommended.
      It is up to the user to set and maintain suitable custom paths for any pages where the module is in use. Make sure your custom paths are compatible with ProcessWire's $config and .htaccess settings, and if you are basing the custom path on the names of parent pages you will probably want to have a strategy for updating custom paths if parent pages are renamed or moved.
      Example hooks to Pages::saveReady
      You might want to use a Pages::saveReady hook to automatically set the custom path for some pages. Below are a couple of examples.
      1. In this example the start of the custom path is fixed but the end of the path will update dynamically according to the name of the page:
      $pages->addHookAfter('saveReady', function(HookEvent $event) { $page = $event->arguments(0); if($page->template == 'my_template') { $page->custom_path = "/some-custom/path-segments/$page->name/"; } }); 2. The Custom Paths module adds a new Page::realPath method/property that can be used to get the "real" ProcessWire path to a page that might have a custom path set. In this example the custom path for news items is derived from the real ProcessWire path but a parent named "news-items" is removed:
      $pages->addHookAfter('saveReady', function(HookEvent $event) { $page = $event->arguments(0); if($page->template == 'news_item') { $page->custom_path = str_replace('/news-items/', '/', $page->realPath); } }); Caveats
      The custom paths will be used automatically for links created in CKEditor fields, but if you have the "link abstraction" option enabled for CKEditor fields (Details > Markup/HTML (Content Type) > HTML Options) then you will see notices from MarkupQA warning you that it is unable to resolve the links.
      Installation
      Install the Custom Paths module.
      Uninstallation
      The custom_path field is not automatically deleted when the module is uninstalled. You can delete it manually if the field is no longer needed.
       
      https://github.com/Toutouwai/CustomPaths
      https://modules.processwire.com/modules/custom-paths/
    • 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 acronyms 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!
    • By tcnet
      PageViewStatistic for ProcessWire is a module to log page visits of the CMS. The records including some basic information like IP-address, browser, operating system, requested page and originate page. Please note that this module doesn't claim to be the best or most accurate.
      Advantages
      One of the biggest advantage is that this module doesn't require any external service like Google Analytics or similar. You don't have to modify your templates either. There is also no JavaScript or image required.
      Disadvantages
      There is only one disadvantage. This module doesn't record visits if the browser loads the page from its browser cache. To prevent the browser from loading the page from its cache, add the following meta tags to the header of your page:
      <meta http-equiv="Cache-Control" content="no-cache, no-store, must-revalidate" /> <meta http-equiv="Pragma" content="no-cache" /> <meta http-equiv="Expires" content="0" /> How to use
      The records can be accessed via the Setup-menu of the CMS backend. The first dropdown control changes the view mode. There are 4 different view modes.
      View mode "Day" shows all visits of the selected day individually with IP-address, browser, operating system, requested page and originate page. Click the update button to see new added records. View mode "Month" shows the total of all visitors per day from the first to the last day of the selected month. View mode "Year" shows the total of all visitors per month from the first to the last month of the selected year. View mode "Total" shows the total of all visitors per year for all recorded years. Please note that multiple visits from the same IP address within the selected period are counted as a single visitor.
      Settings
      You can access the module settings by clicking the Configuration button at the bottom of the records page. The settings page is also available in the menu: Modules->Configure->ProcessPageViewStat.
      IP2Location
      This module uses the IP2Location database from: http://www.ip2location.com. This database is required to obtain the country from the IP address. IP2Location updates this database at the begin of every month. The settings of ProcessPageViewStat offers the ability to automatically download the database monthly. Please note, that automatically download will not work if your webspace doesn't allow allow_url_fopen.
      Dragscroll
      This module uses DragScroll. A JavaScript available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability in view mode "Day" to drag the records horizontally with the mouse pointer.
      parseUserAgentStringClass
      This module uses the PHP class parseUserAgentStringClass available from: http://www.toms-world.org/blog/parseuseragentstring/. This class is required to filter out the browser type and operating system from the server request.
      Special Feature
      PageViewStatistic for ProcessWire can record the time a visitor viewed the page. This feature is deactivated by default. To activate open the module configuration page and activate "Record view time". If activated you will find a new column "S." in the records which means the time of view in seconds. With every page request, a Javascript code is inserted directly after the <body> tag. Every time the visitor switches to another tab or closes the tab, this script reports the number of seconds the tab was visible. The initial page request is recorded only as a hyphen (-).
       
    • 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 Screenshots (configuration)

      Screenshots (hCaptcha widget)

       
       

       
×
×
  • Create New...