Jump to content

SnipWire - Snipcart integration for ProcessWire


Gadgetto

Recommended Posts

Well, the first thing that springs to mind is: Can I add a quantity in the frontend? I don't see a possibility to change the quantity either in the cart (select or number input field, or stepper).

btw: I got a JS error re: jQuery - I had to remove the jQuery integrity hash from the module settings

Link to comment
Share on other sites

2 minutes ago, dragan said:

Well, the first thing that springs to mind is: Can I add a quantity in the frontend? I don't see a possibility to change the quantity either in the cart (select or number input field, or stepper).

btw: I got a JS error re: jQuery - I had to remove the jQuery integrity hash from the module settings

?

1793549077_Bildschirmfoto2020-02-07um13_33_37.thumb.png.70d1a3fba0cb0fdb504259121012ff0a.png

3 minutes ago, dragan said:

I got a JS error re: jQuery - I had to remove the jQuery integrity hash from the module settings

Could you please post the complete JS error?

Link to comment
Share on other sites

5 minutes ago, dragan said:

OK, I guess it has to do with what you mentioned earlier: I am using delayed output... Guess I have to rewrite the test templates.

It should be no matter which output strategy you use.

Link to comment
Share on other sites

hmmm, so I rewrote the templates, and made sure the three required frontend assets are loaded (Snipcart JS + CSS  + jQuery), but it looks completely un-styled, and there is no quantity-stepper anywhere.

1957351695_Screenshot_2020-02-07AxolotlJuicer.thumb.png.aaf349c6ef6f45f7816c5ac40561eccc.png

582391400_Screenshot_2020-02-07AxolotlJuicer(1).png.030abcec2b0703a9b9829e19538b7fd5.png

I've even added UIKit CSS + JS now... it looks a bit different, but still... far from the screens you posted. Maybe I'll try on a new PW installation with the regular profile. While it's certainly nice that you provided such a test-setup with templates and dummy products, I think it shouldn't be dependant on what site profile you used when installing PW. If I inspect certain elements that have classed, I don't see any style definitions.

But maybe the problem is elsewhere... here are the (probably) relevant settings on the product page:

593721225_Screenshot_2020-02-07EditPageAxolotlJuicerpwbigtest.thumb.png.f83e22820a36ca63431ea84d47f10fd6.png

But I guess what I see is "stackable" variety... When I inspect the button, I see:

<button class="snipcart-add-item uk-button uk-button-primary" title="Add to cart" aria-label="Add item to cart" data-item-name="Axolotl Juicer" data-item-id="JUICER_123" data-item-price="{&quot;chf&quot;:&quot;10&quot;,&quot;eur&quot;:&quot;8.50&quot;,&quot;usd&quot;:&quot;10&quot;}" data-item-url="http://pw.test/en/snipcart-shop/axolotl-juicer/" data-item-description="Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur." data-item-image="http://pw.test/site/assets/files/23131/beer3.65x65-hidpi.jpg" data-item-metadata="{&quot;id&quot;:23131,&quot;created&quot;:1581076192,&quot;modified&quot;:1581078285,&quot;published&quot;:1581076192,&quot;created_users_id&quot;:41,&quot;modified_users_id&quot;:41}" data-item-quantity="1" data-item-quantity-step="1" data-item-stackable="false" data-item-taxable="true" data-item-taxes="CH" data-item-has-taxes-included="true" data-item-shippable="true"><span uk-icon="icon: cart" class="uk-icon"></span> Add to cart</button>

but no quantity stepper markup anywhere.

Link to comment
Share on other sites

4 hours ago, dragan said:

But I guess what I see is "stackable" variety... When I inspect the button, I see:


<button class="snipcart-add-item uk-button uk-button-primary" title="Add to cart" aria-label="Add item to cart" data-item-name="Axolotl Juicer" data-item-id="JUICER_123" data-item-price="{&quot;chf&quot;:&quot;10&quot;,&quot;eur&quot;:&quot;8.50&quot;,&quot;usd&quot;:&quot;10&quot;}" data-item-url="http://pw.test/en/snipcart-shop/axolotl-juicer/" data-item-description="Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur." data-item-image="http://pw.test/site/assets/files/23131/beer3.65x65-hidpi.jpg" data-item-metadata="{&quot;id&quot;:23131,&quot;created&quot;:1581076192,&quot;modified&quot;:1581078285,&quot;published&quot;:1581076192,&quot;created_users_id&quot;:41,&quot;modified_users_id&quot;:41}" data-item-quantity="1" data-item-quantity-step="1" data-item-stackable="false" data-item-taxable="true" data-item-taxes="CH" data-item-has-taxes-included="true" data-item-shippable="true"><span uk-icon="icon: cart" class="uk-icon"></span> Add to cart</button>

but no quantity stepper markup anywhere.

You need to activate the field "Product is stackable" otherwise there will be added a separate item each time you click the "Add to cart" button.

Link to comment
Share on other sites

I don't know your setup for the frontend templates and what you changed in the samples, but if you use the plain "Regular" site profile from PW installation it should work like in the screenshots.

I decided to use the "Regular" profile for the samples because it has easy understandable templates and the most modern output strategy. Also with its replaceable markup regions, it was very easy to implement a shop interface without changing too much.

SnipWire is built with the ProcessWire philosophy: To be as flexible as possible and to absolutely let the site developer decide what will be outputted in the front-end.

  • Like 1
Link to comment
Share on other sites

UPDATE 2020-02-08

SnipWire 0.8.2 (beta) released!

Its now possible to change the cart and catalogue currency by GET, POST or SESSION param via form submit or by adding an URL param or setting a session variable!

  • Like 1
Link to comment
Share on other sites

@Gadgetto OK, since I don't really need any kind of shop solution, I decided to uninstall SnipWire. That was... an unpleasant experience. This took me about half an hour. The regular module uninstall routine didn't work for anything SnipWire-related. There were warning about pages or fields or templates having the system-flag. The page under admin > setup was undeleteable. In the end I had to delete two pages that were in the trash directly in the database. I hope there is nothing else left in the PW installation now in some hidden corners...

Link to comment
Share on other sites

Thank you @dragan, very constructive critic! Sorry you didn't like SnipWire...

28 minutes ago, dragan said:

There were warning about pages or fields or templates having the system-flag.

There is a single page under admin > setup which has the system flag (I decided to use the system flag because if this page is deleted SnipWire won't work). I just have not yet implemented the uninstall routine for this special page in the beta. #todo

If you have a look at the docs: https://docs.bitego.com/snipwire/getting-started/install-uninstall/ the following is stated:

Quote

In addition to the 4 module packages it is highly recommended to also install the Snipcart products package!
The products package contains product templates, files, fields and some demo pages required to build a Snipcart product catalogue. This additional step is needed to prevent unintended deletion of your Snipcart products catalogue when the main module is uninstalled. These resources need to be removed manually if you like to completely uninstall SnipWire!

All other SnipWire components are uninstalled perfectly here (just tested)!

  • Like 3
Link to comment
Share on other sites

23 minutes ago, Gadgetto said:

very constructive critic!

Sorry, I know it's beta, I read (and can only imagine) how much work was involved. And as I stated before, it really is a nice touch to have that luxury of installing a few test pages instead of having to create them manually from scratch - just with a few clicks. And I was seriously impressed by the feature-set, the dashboard etc. However, uninstalling a PW module (no matter how big, if free or commercial) shouldn't be something that takes more than 2-3 minutes. I'm probably spoiled, but I just thought I'd mention it here anyway.

Link to comment
Share on other sites

38 minutes ago, dragan said:

Sorry, I know it's beta, I read (and can only imagine) how much work was involved. And as I stated before, it really is a nice touch to have that luxury of installing a few test pages instead of having to create them manually from scratch - just with a few clicks. And I was seriously impressed by the feature-set, the dashboard etc. However, uninstalling a PW module (no matter how big, if free or commercial) shouldn't be something that takes more than 2-3 minutes. I'm probably spoiled, but I just thought I'd mention it here anyway.

No problem, 🙃 I know the uninstaller needs some work to be perfect. Uninstalling a shop system and such a huge plugin is nothing trivial. Page<->field<->template dependencies needs to be resolved and you need to be very careful to prevent unintended deletion of your whole products catalogue and templates.

I'm just thinking about a "fire-and-forget" uninstaller which can only be called via URL param...

  • Like 2
Link to comment
Share on other sites

I haven't tried snipwire yet, but regarding the uninstall I have two suggestions/ideas:

1) Maybe SnipWire could state clearly before installation, that it is not trivial to uninstall this module and it might be the best option to restore a backup in case you want to get rid of snipwire. That would of course be not possible on a live system when some data has changed. In that case it might be the easiest solution to provide step by step instructions to uninstall everything manually.

2) Maybe https://github.com/BernhardBaumrock/RockMigrations have some helpful code snippets that you can use for the uninstall routine?

2RlhR6S.png

RockMigrations are built in a way that they do NOT ask for any confirmations. That means if you delete a template all related pages that use that template are also deleted. That can be too destructive in some situations but can be exactly what you want in others...

Thx for all your efforts @Gadgetto - as I said I haven't tried it yet, but it seems you are doing a great job!

  • Like 2
Link to comment
Share on other sites

  • 2 weeks later...

Hey, @bernhard,

sorry for my late response! Just stumbled across your post.

Thanks for your hints! I've updated the installer page to clearly state which resources will be installed and why the extended installer is necessary and why it's a good idea to backup. I also put a lot of effort into the install/uninstall process and greatly improved the thing.

Link to comment
Share on other sites

  • 2 weeks later...

UPDATE 2020-03-01

SnipWire 0.8.3 (beta) released!

In this new release the installation and uninstallation process has been heavily revised! The module and its submodules should now uninstall perfectly. To preserve the full products catalogue and products data, all fields with the custom field type FieldtypeSnipWireTaxSelector are now converted to FieldtypeText on uninstall. If yo want to reinstall SnipWire and reuse your previous products catalogue, you simply need to change the taxes field back to FieldtypeSnipWireTaxSelector.

Here is the complete list of changes:

  • Updated products package installer to add specific module config on install
  • The uninstallation process is now much more reliable
  • FieldtypeSnipWireTaxeSelector is now uninstalled properly (existing fields are converted to FieldtypeText)
  • Refactored ExtendedInstaller class to be more reliable
  • Extended resources installer page is now more user friendly
  • Fixed product price JSON output if a currency field is missing
  • Small fixes and code enhancements
  • Updated apexcharts.js vendor plugin to version 3.15.6
  • Like 3
Link to comment
Share on other sites

9 hours ago, bernhard said:

Could any of the Windows users please confirm that the installation shows the following error

It works fine here with PW 3.0.148 (almost a fresh installation). No errors.

image.thumb.png.8c3689f92af380fd73808bb0c3be45c3.png

  • Like 2
Link to comment
Share on other sites

Has anyone here worked with SnipCart's webhooks yet?

I can't find an example in their docs of a fully formed webhook file, nor am I quite sure how I would imitate their examples along with the PW API to call things so I don't have to manually enter every product, for example. Their webhook examples also seem to contain hardcoded info that should be drawn from the session?

I'm trying to set up both gift cards, and extra notifications for subscription events.

https://snipcart.com/blog/creating-a-gift-card-application-with-snipcart-php

https://docs.snipcart.com/v2/webhooks/subscription-events

Link to comment
Share on other sites

Hi @creativejay,

you can hook into SnipWire‘s predefined webhook methods. Please have a look into the Webhooks class starting at this lines: 

https://github.com/gadgetto/SnipWire/blob/8d38ced82bbfc5633a3d6de7cae6217fcd408c39/services/Webhooks.php#L312

For creating/importing products it would be best to write a small importer using the PW API which creates SnipWire (ProcessWire) pages.

  • Like 1
Link to comment
Share on other sites

Ah, thanks!

Now... Could I please get some help with the hook?

  • I've written the following (site/ready.php) but see nothing in the logs and no email arrives
  • I suspect I'm starting wrong in how I retrieve the SnipWire/SnipCart order data
  • SnipCart is currently in TEST mode
  • I've confirmed the SMTP settings in the WireMail SMTP module configuration
  • I'm operating on the assumption that the $event returned for this Hook contains the subscription information as shown on: https://docs.snipcart.com/v2/webhooks/subscription-events
$wire->addHookAfter('SnipWire::handleSubscriptionCreated', function($event) { 
	
    $snip_input = $event->arguments(0); 
	$event_json = json_decode($snip_input); 
    
    $mail = $wire->modules('WireMailSmtp'); // calling WireMail SMTP to send a notification since SnipCart doesn't
    $clientEmail = $snip_input->getChildByName('user')->email->value; // Fetching customer's email
    $clientName = $snip_input->getChildByName('user')->fullName->value; // Fetching customer's Full Name
    $products = $snip_input->getChildByName('items'); // Fetching an array of the items in the cart
    
    foreach($products as $p) {
		// For each product in the cart, we send the corresponding coach an email
        $coach = $p->getChildByName('Coach')->value;  // The coach selected at checkout
   		$kvcoach = $wire->pages->get("title=$coach"); // Coach will have a matching page on the site
    	$coachEmail = $kvcoach->email; // get email from that page's fields

		$to = array('user@domain.com'); // including the admin (me) in the TO for testing
		array_push($to,$coachEmail); // add coach's email to array
             
	    $cart = $p->getChildByName('name'); // product name from this order item

		try { 
	        $body = $coach . ", you have a new client! " . $clientName . " (". $clientEmail.") has subscribed to: " . $cart . "<br /><br />" . "<pre>" . var_export($event_json, true) . "</pre>";
	        $subject = $clientName . " (". $clientEmail.") has signed up for ". $cart;
	        $mail->to($to);
	        $mail->from('no-reply@domain.com');
	        $mail->subject($subject);
	        $mail->bodyHTML($body);
	        $mail->send();
		}
		catch (\Exception $e) {
	     $error = "Email not sent: " . $e->getMessage();
	     $mail->log($error);   
		} 
    } 
});

 

Link to comment
Share on other sites

@creativejay I must admit, now I've gotten myself into a bit of a mess. Unfortunately, most of the hookable methods are not yet ready. I am currently working on the final implementation. Sorry, you'll have to be patient. i’ll let you know when it is ready.

  • Like 3
Link to comment
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 Robin S
      This module lets you add some custom menu items to the main admin menu, and you can set the dropdown links dynamically in a hook if needed.
      Sidenote: the module config uses some repeatable/sortable rows for the child link settings, similar to the ProFields Table interface. The data gets saved as JSON in a hidden textarea field. Might be interesting to other module developers?
      Custom Admin Menus
      Adds up to three custom menu items with optional dropdowns to the main admin menu.
      The menu items can link to admin pages, front-end pages, or pages on external websites.
      The links can be set to open in a new browser tab, and child links in the dropdown can be given an icon.
      Requires ProcessWire v3.0.178 or newer.
      Screenshots
      Example of menu items

      Module config for the menus

      Link list shown when parent menu item is not given a URL

      Advanced
      Setting child menu items dynamically
      If needed you can set the child menu items dynamically using a hook.
      Example:
      $wire->addHookAfter('CustomAdminMenus::getMenuChildren', function(HookEvent $event) { // The menu number is the first argument $menu_number = $event->arguments(0); if($menu_number === 1) { $colours = $event->wire()->pages->findRaw('template=colour', ['title', 'url', 'page_icon']); $children = []; foreach($colours as $colour) { // Each child item should be an array with the following keys $children[] = [ 'icon' => $colour['page_icon'], 'label' => $colour['title'], 'url' => $colour['url'], 'newtab' => false, ]; } $event->return = $children; } }); Create multiple levels of flyout menus
      It's also possible to create multiple levels of flyout submenus using a hook.

      For each level a submenu can be defined in a "children" item. Example:
      $wire->addHookAfter('CustomAdminMenus::getMenuChildren', function(HookEvent $event) { // The menu number is the first argument $menu_number = $event->arguments(0); if($menu_number === 1) { $children = [ [ 'icon' => 'adjust', 'label' => 'One', 'url' => '/one/', 'newtab' => false, ], [ 'icon' => 'anchor', 'label' => 'Two', 'url' => '/two/', 'newtab' => false, 'children' => [ [ 'icon' => 'child', 'label' => 'Red', 'url' => '/red/', 'newtab' => false, ], [ 'icon' => 'bullhorn', 'label' => 'Green', 'url' => '/green/', 'newtab' => false, 'children' => [ [ 'icon' => 'wifi', 'label' => 'Small', 'url' => '/small/', 'newtab' => true, ], [ 'icon' => 'codepen', 'label' => 'Medium', 'url' => '/medium/', 'newtab' => false, ], [ 'icon' => 'cogs', 'label' => 'Large', 'url' => '/large/', 'newtab' => false, ], ] ], [ 'icon' => 'futbol-o', 'label' => 'Blue', 'url' => '/blue/', 'newtab' => true, ], ] ], [ 'icon' => 'hand-o-left', 'label' => 'Three', 'url' => '/three/', 'newtab' => false, ], ]; $event->return = $children; } }); Showing/hiding menus according to user role
      You can determine which menu items can be seen by a role by checking the user's role in the hook.
      For example, if a user has or lacks a role you could include different child menu items in the hook return value. Or if you want to conditionally hide a custom menu altogether you can set the return value to false. Example:
      $wire->addHookAfter('CustomAdminMenus::getMenuChildren', function(HookEvent $event) { // The menu number is the first argument $menu_number = $event->arguments(0); $user = $event->wire()->user; // For custom menu number 1... if($menu_number === 1) { // ...if user does not have some particular role... if(!$user->hasRole('foo')) { // ...do not show the menu $event->return = false; } } });  
      https://github.com/Toutouwai/CustomAdminMenus
      https://processwire.com/modules/custom-admin-menus/
    • By tcnet
      This module for ProcessWire sends a notification email for each failed login attempt. Similar modules exists already in the module directory of ProcessWire. However, this module is designed to notify, even if specified user doesn't exist.
      Settings
      The settings for this module are located in the menu Modules=>Configure=>LoginFailNotifier.
      Notification email
      Specifies the email address to which the notification emails should be sent.
        Email subject
      Specifies the subject line for the notification email.
        Post variables
      Specifies the $_POST variables to be included in the notification email. Each variable must be separated by a comma. For example: login_name,login_pass
        Server variables
      Specifies the $_SERVER variables to be included in the notification email. Each variable must be separated by a comma. For example: REMOTE_ADDR,HTTP_USER_AGENT
      Link to ProcessWire module directory:
      https://processwire.com/modules/login-fail-notifier/
      Link to github.com:
      https://github.com/techcnet/LoginFailNotifier
    • By Fokke
      ProcessWire 3.x markup module for rendering meta tags in HTML document head section. Note that this module is not a full-blown SEO solution, but rather a simple tool for rendering meta tags based on module configuration. Adding custom meta tags is also supported.
      Built-in meta tags
      The following meta tags are supported out-of-the-box:
      Document title consisting of page title and site name Character set Canonical Viewport Description Keywords Hreflang tags Open Graph og:title og:site_name og:type og:url og:description og:image og:image:width og:image:height Twitter meta tags twitter:card twitter:site twitter:creator twitter:title twitter:description twitter:image Facebook meta tags fb:app_id The full documentation with configurable options can be found here: https://github.com/Fokke-/MarkupMetadata
       
      Requirements:
      ProcessWire>=3.0.0 PHP >=7.1 Installation using Composer
      composer require fokke/markup-metadata Manual installation
      Download latest version from https://github.com/Fokke-/MarkupMetadata/archive/master.zip Extract module files to site/modules/MarkupMetadata directory.
    • By m.sieber
      ITRK-Service for ProcessWire
      Module for the automated transfer of imprint, data protection declaration and terms and conditions from IT-Recht Kanzlei to your ProcessWire installation
      What is ITRK Service for ProcessWire?
      ITRK-Service for ProcessWire is a free module for ProcessWire CMS. It provides an interface to the update service of IT-Recht Kanzlei, via which the legal texts of your online presence are automatically updated. In this way, the texts remain legally secure and warning-proof in the long term. Imprint, data protection declaration, revocation and general terms and conditions are currently supported.
      You can find our documentation (in german language) here: https://www.pupit.de/itrk-service-for-processwire/dokumentation/

      Download: https://www.pupit.de/itrk-service-for-processwire/
      Github: https://github.com/pupit-de/pwItrkServiceConnector
    • By LuisM
      Symprowire is a PHP MVC Framework based and built on Symfony using ProcessWire 3.x as DBAL and Service-Provider
      It acts as a Drop-In Replacement Module to handle the Request/Response outside the ProcessWire Admin. Even tough Symfony or any other mature MVC Framework could be intimidating at first, Symprowire tries to abstract Configuration and Symfony Internals away as much as possible to give you a quick start and lift the heavy work for you.
      The main Goal is to give an easy path to follow an MVC Approach during development with ProcessWire and open up the available eco-system.
      You can find the GitHub Repo and more Information here: https://github.com/Luis85/symprowire
      Documentation
      The Symprowire Wiki https://github.com/Luis85/symprowire/wiki How to create a simple Blog with Symprowire https://github.com/Luis85/symprowire/wiki/Symprowire-Blog-Tutorial Last Update
      16.07.2021 // RC 1 v0.6.0 centralized ProcessWire access trough out the Application by wrapping to a Service https://github.com/Luis85/symprowire/releases/tag/v0.6.0-rc-1 Requirements
      PHP ^7.4 Fresh ProcessWire ^3.0.181 with a Blank Profile Composer 2 (v1 should work, not recommended) The usual Symfony Requirements Features
      Twig Dependency Injection Monolog for Symprowire Support for .env YAML Configuration Symfony Console and Console Commands Symfony Webprofiler Full ProcessWire access inside your Controller and Services Webpack Encore support Caveats
      Symfony is no small Framework and will come with a price in terms of Memory Usage and added Overhead. To give you a taste I installed Tracy Debugger alongside to compare ProcessWire profiling with the included Symfony Webprofiler

      So in a fresh install Symprowire would atleast add another 2MB of Memory usage and around 40ms in response time, should be less in production due to the added overhead of the Webprofiler in dev env
       
×
×
  • Create New...