Jump to content

SnipWire - Snipcart integration for ProcessWire


Gadgetto

Recommended Posts

On 1/7/2021 at 5:41 PM, palacios000 said:

Are you planning to support Snipcart v.3 any soon? Thank you for this great peace of work.

Compared to v2, there is still one feature missing in v3 of Snipcart:

  • Recurring subscriptions

As soon as v3 is feature complete I'll starting development on v3 support.

  • Like 1
Link to comment
Share on other sites

  • 1 month later...
On 4/21/2020 at 11:22 AM, Gadgetto said:

If you are using another profile or output strategy, you'll need to rewrite the template source.

I'm using the Beginner profile, any chance I could convince one of you coding wizards to show me some example code for snipcart-product.php, snipcart-shop.php, and snipcart-cart.php? I'm definitely not a PHP expert but I'm feeling more and more comfortable in PW every day... I'd really like to get this working but my entire site is already built using the Beginner profile and is currently public, I can't rebuild it using the markup regions output strategy. I have my Snipcart account created, the API test is validated but I have the same issue as reported above by @fruid:

Call to undefined function ProcessWire\ukIcon()

Note: this project is for a non-profit association and I'm currently donating my time but I would 100% not mind paying someone for their help, feel free to PM me if that's preferred 😃 

Link to comment
Share on other sites

This thread isn’t my place at all, but Gadgetto’s post you quoted tells me you need to copy the file _uikit.php from the regular site profile and somewhere at the top of your own template call include_once('./_uikit.php');. Should be a safe fix for that specific error.

  • Like 1
Link to comment
Share on other sites

9 minutes ago, Jan Romero said:

This thread isn’t my place at all, but Gadgetto’s post you quoted tells me you need to copy the file _uikit.php from the regular site profile and somewhere at the top of your own template call include_once('./_uikit.php');. Should be a safe fix for that specific error.

Thanks for jumping in @Jan Romero!

This will work but can have side effects.

Link to comment
Share on other sites

30 minutes ago, Ben Sayers said:

I'm using the Beginner profile, any chance I could convince one of you coding wizards to show me some example code for snipcart-product.php, snipcart-shop.php, and snipcart-cart.php? I'm definitely not a PHP expert but I'm feeling more and more comfortable in PW every day... I'd really like to get this working but my entire site is already built using the Beginner profile and is currently public, I can't rebuild it using the markup regions output strategy. I have my Snipcart account created, the API test is validated but I have the same issue as reported above by @fruid:

Call to undefined function ProcessWire\ukIcon()

Note: this project is for a non-profit association and I'm currently donating my time but I would 100% not mind paying someone for their help, feel free to PM me if that's preferred 😃 

You'll need to have a look at the snipcart-shop and snip cart-product templates and modify them so they use the preferred rendering method.

Link to comment
Share on other sites

11 minutes ago, Jan Romero said:

Should be a safe fix for that specific error.

Yup, that worked. Thanks so much @Jan Romero! I can see the demo products now.

2 minutes ago, Gadgetto said:

This will work but can have side effects.

Oh no! Hi @Gadgetto, can you elaborate on the side effects? Basically, I'm trying to add a way for this association to offer paid memberships. I initially tried doing this with @ryan's FormBuilder and Stripe Payment Processor modules but it quickly became too complex for that route. The association's board came up with 9 different membership plans they'd like to offer, some with one user, others with potentially hundreds or more. For instance, when a school registers, they'd like to be able to offer a coupon code to their students so they can register for free, using the school's plan that they paid for. I think the only way I can really make this work is using a cart system so I can enable coupon codes. If you're interested, I can PM you links to the mock-ups I've created that might help shed some light on what I'm trying to do.

Link to comment
Share on other sites

@Ben Sayers:

Hey Ben,

that's what I meant - simply including _uikit.php won't do the job. The whole templates are built using UIKit CSS framework.

You'll need to write your own templates for product overview and product-details. If you have a look at the two sample templates which are installed by SnipWire installer, you will see how it works. Please have a look at the comments in the php files.

I currently don't have the time to write sample code based on your rendering method. But if you are familiar with ProcessWire development this should be an easy job.

Having a look at the snipcart-shop template, all in all, that's all you need:
(please note this is a quick composition of the required code and might not fully work. And you need to use your own CSS classes based on your framework)

<!--
The content element holds your products catalogue.
-->
<div id="content">
    <?php
    $products = page()->children('limit=9');
    echo productOverview($products); 
    ?>
</div>

<?php
/**
 * Render a shop product overview
 *
 * @param PageArray $products
 * @return string
 *
 */
function productOverview(PageArray $products) {

    if (!$products->count) return '';
    
    $out = '<div class="product>';

    foreach ($products as $product) {
        
        // We use the first image in snipcart_item_image field for demo
        $imageMedia = '';
        if ($image = $product->snipcart_item_image->first()) {
            $productImageMedium = $image->size(600, 0, array('quality' => 70));
            $imageDesc = $productImageMedium->description ? $productImageMedium->description : $product->title;
            $imageMedia = '<img src="' . $productImageMedium->url . '" alt="' . $imageDesc . '">';
        } else {
            $imageMedia = 
            '<div title="' . __('No product image available') . '">' . 
                ukIcon('image', array('ratio' => 3)) . // you need to use your own image output function here because ukIcon is based on UIKit CSS
            '</div>';
        }
        
        // This is the part where we render the Snipcart anchor (buy button)
        // with all data-item-* attributes required by Snipcart.
        // The anchor method is provided by MarkupSnipWire module and can be called 
        // via custom API variable: $snipwire->anchor()
        $options = array(
            'label' => ukIcon('cart'), // use your own image output function
            'class' => 'button button-primary',
            'attr' => array('aria-label' => __('Add item to cart')),
        );
        $anchor = wire('snipwire')->anchor($product, $options);
        
        // Get the formatted product price.
        // The getProductPriceFormatted method is provided by MarkupSnipWire module and can be called 
        // via custom API variable: $snipwire->getProductPriceFormatted()
        $priceFormatted = wire('snipwire')->getProductPriceFormatted($product);

        $out .=
        '<a href="' . $product->url . '">' .
            '<div class="product-detail">' .
                '<div class="media-top">' .
                    $imageMedia .
                '</div>' .
                '<div class="card-body">' .
                    '<h3 class="card-title">' . $product->title . '</h3>' .
                    '<p>' . $product->snipcart_item_description . '</p>' .
                '</div>' .
                '<div class="card-footer">' .
                    $anchor .
                    '<span class="align-right text-primary">' . $priceFormatted . '</span>' .
                '</div>' .
            '</div>' .
        '</a>';
    }

    $out .= '</div>';

    return $out;
}
?>

 

  • Like 1
Link to comment
Share on other sites

8 minutes ago, Gadgetto said:

Having a look at the snipcart-shop template, all in all, that's all you need:
(please note this is a quick composition of the required code and might not fully work. And you need to use your own CSS classes based on your framework)

@Gadgetto thank you very much for taking your time to provide that example. I'll kick it around and see what I can do. Cheers 🍻

Link to comment
Share on other sites

Hi @Gadgetto, I finally have a working demo (see it here) using the Beginner Profile that is incorporated with my custom design but I have a few questions:

  1. Where is the data saved for custom fields? I added some custom fields and completed a transaction but I don't see any of the custom field data saved anywhere in Setup -> SnipWire -> Customers or in my Snipcart account.
  2. Is there a hook I can use to replace the "Order Info" with "Member Info" in the tab label?
  3. I'm using SnipWire to sell Membership plans and I'm hoping to have them renew automatically using the subscription option, I don't see any information in your documentation on this, can you provide an example?
  4. Is there a way to set a default option on a select field in the Billing Address? This association is only for Michigan (US) so I'd like to set that as the default under the State/Province field.
  5. Is there a way to use conditional custom fields depending on the product that is selected? I'm hoping to be able to add/hide certain *required* & optional fields on the Order Info and Billing Address tabs as some membership plans are for businesses and others are for individuals. Each product will likely have custom requirements so if I can create some sort of if/else statement, that would be great.

EDIT: Is there anyone out there that can help? All suggestions are welcome! 🙏

Edited by Ben Sayers
Need Help
Link to comment
Share on other sites

On 5/15/2019 at 4:17 PM, Gadgetto said:

Snipcart 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.

Could anybody having experience with this module please explain what the module EXACTLY does? I don't really get it from the description. And SnipCart itself claims this:

Quote

Add a shopping cart to any website

Start accepting international payments in minutes.

As I understood it's as simple as adding custom button markup to the site and you are up and running your snipcart site. The dashboard in this case would obviously be hosted at snipcart and not inside my processwire project, but is that the only reason for this module? I have the feeling that I must be missing something 🙂 

Thx for your insights!

Quote

With SnipWire, you can quickly turn any ProcessWire site into a Snipcart online shop

As far as I understood I don't need SnipWire for that?!

Quote

The SnipWire plugin helps you to get your store up and running in no time.

Well... what exactly takes time if I am NOT using SnipWire? Isn't it just adding snipcart buttons?

Quote

SnipWire is the missing link between Snipcart and the content management framework ProcessWire.

Which link is missing? I thought the missing link were just some data-attributes?

<button class="snipcart-add-item"
  data-item-id="starry-night"
  data-item-price="79.99"
  data-item-url="/paintings/starry-night"
  data-item-description="High-quality replica of The Starry Night by the Dutch post-impressionist painter Vincent van Gogh."
  data-item-image="/assets/images/starry-night.jpg"
  data-item-name="The Starry Night">
  Add to cart
</button>

https://docs.snipcart.com/v3/setup/products

Link to comment
Share on other sites

1 hour ago, bernhard said:

As I understood it's as simple as adding custom button markup to the site and you are up and running your snipcart site. The dashboard in this case would obviously be hosted at snipcart and not inside my processwire project, but is that the only reason for this module? I have the feeling that I must be missing something 🙂 

  • SnipWire integrates the Snipcart dashboard into your ProcessWire backend
  • SnipWire installs all necessary fields for setting up your products editor (> 22 different fields)
  • it automatically generates the necessary Snipcart anchor markup based on those fields
  • SnipWire provides an easy way to integrate the Snipcart shopping cart into your project (including cart button, customer profile, login, logout, ...)
  • provides sample templates to setup your online shop.
  • handles and calculates all of the different VAT handlings worldwide
  • handles multi currency
  • process refunds right from your ProcessWire back-end
  • process abandoned carts and send messages to customers right from the ProcessWire back-end
  • provides hookable ProcessWire events for orders, customer registration, ...
  • ...

How would you handle the custom data attributes markup without an engine generating it? If you only have a handful products this might be possible by writing the markup by hand but if your client should be able to manage a shop, SnipWire is the best way to do it.

As a sample - how would you do this manually?

<button
  class="snipcart-add-item uk-button uk-button-primary"
  title="Add to cart"
  aria-label="Add item to cart"
  data-item-name="Festish Wet Warmer"
  data-item-id="1713"
  data-item-price='{"usd":"22.20","eur":"19.90"}'
  data-item-url="http://domain.com/snipcart-shop/festish-wet-warmer/"
  data-item-description="A short product description..."
  data-item-image="http://domain.com/site/assets/files/1713/beer2.65x65-hidpi.jpg"
  data-item-categories="Beer"
  data-item-metadata='{"id":1713,"created":1563363120,"modified":1580402487,"published":1563363120,"created_users_id":41,"modified_users_id":41}'
  data-item-quantity="1"
  data-item-quantity-step="1"
  data-item-stackable="true"
  data-item-taxable="true"
  data-item-taxes="10% VAT"
  data-item-has-taxes-included="true"
  data-item-shippable="true">
      <span uk-icon="icon: cart"></span> Add to cart
</button>

 

I probably don’t get your message, but as an experienced developer you should get the benefit.

  • Like 1
  • Thanks 1
Link to comment
Share on other sites

Thx @Gadgetto

my message was not meant as criticism. I just don't get WHY SnipWire does all that. Ok, I get that you need to setup some fields that hold necessary data (vat, description, image) and then you need to create the markup. That should be quite simple though without using SnipWire (for example using RockMigrations which you can guess I'm using in every project 😉 ). The cart-button could then look somewhat like this:

<button
  class="snipcart-add-item uk-button uk-button-primary"
  title="Add to cart"
  aria-label="Add item to cart"
  data-item-name="<?= $page->title ?>"
  data-item-id="<?= $page->id ?>"
  data-item-price='<?= $page->price ?>'
  data-item-url="<?= $page->httpUrl ?>"
  data-item-description="<?= $page->description ?>"
  ...>
  <span uk-icon="icon: cart"></span> Add to cart
</button>

Ok... I get that's quite tedious and having a helper method for that could for sure be handy. What I still don't get is why you took all that effort to get all (or at least many?) of the features of snipcart into the pw backend? Wouldn't it be a lot easier if the clients just managed their snipcart shop via the snipcart website? As far as I understood the client has to register an account there and then gets a login where he/she can manage their products/sold items etc?

It's obvious that SnipWire can do a lot and I'm quite impressed - I'm just not getting the WHY behind all that. Maybe it's just because I don't know anything of the PAIN you are solving because I've never setup a snipcart store manually...

Link to comment
Share on other sites

5 hours ago, bernhard said:

Thx @Gadgetto

my message was not meant as criticism. I just don't get WHY SnipWire does all that. Ok, I get that you need to setup some fields that hold necessary data (vat, description, image) and then you need to create the markup. That should be quite simple though without using SnipWire (for example using RockMigrations which you can guess I'm using in every project 😉 ). The cart-button could then look somewhat like this:


<button
  class="snipcart-add-item uk-button uk-button-primary"
  title="Add to cart"
  aria-label="Add item to cart"
  data-item-name="<?= $page->title ?>"
  data-item-id="<?= $page->id ?>"
  data-item-price='<?= $page->price ?>'
  data-item-url="<?= $page->httpUrl ?>"
  data-item-description="<?= $page->description ?>"
  ...>
  <span uk-icon="icon: cart"></span> Add to cart
</button>

Ok... I get that's quite tedious and having a helper method for that could for sure be handy. What I still don't get is why you took all that effort to get all (or at least many?) of the features of snipcart into the pw backend? Wouldn't it be a lot easier if the clients just managed their snipcart shop via the snipcart website? As far as I understood the client has to register an account there and then gets a login where he/she can manage their products/sold items etc?

It's obvious that SnipWire can do a lot and I'm quite impressed - I'm just not getting the WHY behind all that. Maybe it's just because I don't know anything of the PAIN you are solving because I've never setup a snipcart store manually...

If you only need/want to render the Snipcart anchors/buttons then you could do it by simply using php and ProcessWire output (but for example handling VAT splitting and multi currency will be another thing).

For all other things I listed above, SnipWire will do the job for you. 

Link to comment
Share on other sites

  • 1 month later...

Hi I'm curious if there are any developers out there that have experience with SnipWire who might be available to hire? I already have the module installed and integrated with the client's Stripe account. This is a non-profit company that would like to offer 9 different membership plans. Everything is working for the basic plan but there are some advanced options that I'll need some assistance with. I've reached out to the developer and I had someone that was going to help but that didn't work out - I do have a description/overview of the project written out which I can forward to you in a DM. From what I understand, this shouldn't be too terribly difficult for an experienced programmer. Thank you! 🙏

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 MarkE
      This fieldtype and inputfield bundle was built for storing measurement values within a field, rendering them in a variety of formats and converting them to other units or otherwise modifying them via the API.
      The API consists of a number of predefined functions, some of which include...
      render() for rendering the measurement object, valueAs() for converting the value to another unit value, convertTo() for converting the whole measurement object to different units, and add() and subtract() for for modifying the stored value by the value (converted as required) in another measurement. In the admin the inputfield includes a checkbox (which can be optionally disabled) for converting values on page save. For an example if a value was typed in as centimeters, the unit was changed to metres, and the page saved with this checkbox selected, said value would be automatically converted so that e.g. 170 cm becomes 1.7 m.

      A simple length field using Fieldtype Measurement and Inputfield Measurement.
      Combination units (e.g. feet and inches) are also supported.
      Please note that this module is 'proof of concept' at the moment - there are limited units available and quite a lot of code tidying to do. More units will be added shortly.
      See the GitHub at https://github.com/MetaTunes/FieldtypeMeasurement for full details and updates.
    • By tcnet
      File Manager for ProcessWire is a module to manager files and folders from the CMS backend. It supports creating, deleting, renaming, packing, unpacking, uploading, downloading and editing of files and folders. The integrated code editor ACE supports highlighting of all common programming languages.
      https://github.com/techcnet/ProcessFileManager

      Warning
      This module is probably the most powerful module. You might destroy your processwire installation if you don't exactly know what you doing. Be careful and use it at your own risk!
      ACE code editor
      This module uses ACE code editor available from: https://github.com/ajaxorg/ace

      Dragscroll
      This module uses the JavaScript dragscroll available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability to drag the table horizontally with the mouse pointer.
      PHP File Manager
      This module uses a modified version of PHP File Manager available from: https://github.com/alexantr/filemanager
       
    • By tcnet
      This module implements the website live chat service from tawk.to. Actually the module doesn't have to do much. It just need to inserted a few lines of JavaScript just before the closing body tag </body> on each side. However, the module offers additional options to display the widget only on certain pages.
      Create an account
      Visit https://www.tawk.to and create an account. It's free! At some point you will reach a page where you can copy the required JavaScript-code.

      Open the module settings and paste the JavaScript-code into the field as shown below. Click "Submit" and that's all.

      Open the module settings
      The settings for this module are located int the menu Modules=>Configure=>LiveChatTawkTo.

       
    • By tcnet
      Session Viewer is a module for ProcessWire to list session files and display session data. This module is helpful to display the session data of a specific session or to kick out a logged in user by simply delete his session file. After installation the module is available in the Setup menu.

      The following conditions must be met for the module to work properly:
      Session files
      Session data must be stored in session files, which is the default way in ProcessWire. Sessions stored in the database are not supported by this module. The path to the directory where the session files are stored must be declared in the ProcessWire configuration which is by default: site/assets/sessions.
      Serialize handler
      In order to transform session data easier back to a PHP array, the session data is stored serialized. PHP offers a way to declare a custom serialize handler. This module supports only the default serialize handlers: php, php_binary and php_serialize. WDDX was dropped in PHP 7.4.0 and is therefore not supported by this module as well as any other custom serialize handler. Which serialize handler is actually used you can find out in the module configuration which is available under Modules=>Configure=>SessionViewer.

      Session data
      The session data can be displayed in two different ways. PHP's default output for arrays print_r() or by default for this module nice_r() offered on github: https://github.com/uuf6429/nice_r. There is a setting in the module configuration if someone prefers print_r(). Apart from the better handling and overview of the folded session data the output of nice_r() looks indeed nicer.

      Links
      ProcessWire module directory
      github.com
    • By Robin S
      Repeater Easy Sort
      Adds a compact "easy-sort" mode to Repeater and Repeater Matrix, making those fields easier to sort when there are a large number of items.
      The module also enhances Repeater Matrix by allowing a colour to be set for each matrix type. This colour is used in the item headers and in the "add new" links, to help visually distinguish different matrix types in the inputfield.
      Screencasts
      A Repeater field

      A Repeater Matrix field with custom header colours

      Easy-sort mode
      Each Repeater/Matrix item gets an double-arrow icon in the item header. Click this icon to enter easy-sort mode.
      While in easy-sort mode:
      The items will reduce in width so that more items can be shown on the screen at once. The minimum width is configurable in the field settings. Any items that were in an open state are collapsed, but when you exit easy-sort mode the previously open items will be reopened. You can drag an item left/right/up/down to sort it within the items. The item that you clicked the icon for is shown with a black background. This makes it easier to find the item you want to move in easy-sort mode. You can click an item header to open the item. An "Exit easy-sort mode" button appears at the bottom of the inputfield. Configuration
      In the field settings for Repeater and Repeater Matrix fields you can define a minimum width in pixels for items in easy-sort mode. While in easy-sort mode the items will be sized to neatly fill the available width on any screen size but will never be narrower than the width you set here.
      In the field settings for Repeater Matrix you can define a custom header colour for each matrix type using an HTML "color" type input. The default colour for this type of input is black, so when black is selected in the input it means that no custom colour will be applied to the header.
      Exclusions
      The easy-sort mode is only possible on Repeater/Matrix fields that do not use the "item depth" option.
       
      https://github.com/Toutouwai/RepeaterEasySort
      https://processwire.com/modules/repeater-easy-sort/
×
×
  • Create New...