<h1 class="title">CMS Form additions for Compassion</h1> <p><a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/CompassionCH/compassion-modules/tree/10.0/cms_form_compassion"><img alt="CompassionCH/compassion-modules" src="https://img.shields.io/badge/github-CompassionCH%2Fcompassion--modules-lightgray.png?logo=github" /></a></p> <p>This module adds some generic forms and form widgets to the module cms_form. It adds:</p> <ul class="simple"> <li>A form that can match the partner given address or create a new one if no one is found.</li> <li>A form that can redirect to payment</li> <li>Ability to display forms in modal dialogs</li> <li>Hidden widgets</li> <li>Payment widgets</li> </ul> <p><strong>Table of contents</strong></p> <div class="contents local topic" id="contents"> <ul class="simple"> <li><a class="reference internal" href="#configuration" id="id1">Configuration</a></li> <li><a class="reference internal" href="#usage" id="id2">Usage</a></li> <li><a class="reference internal" href="#bug-tracker" id="id3">Bug Tracker</a></li> <li><a class="reference internal" href="#credits" id="id4">Credits</a><ul> <li><a class="reference internal" href="#authors" id="id5">Authors</a></li> <li><a class="reference internal" href="#contributors" id="id6">Contributors</a></li> <li><a class="reference internal" href="#maintainers" id="id7">Maintainers</a></li> </ul> </li> </ul> </div> <a name="configuration"></a> <h2><a class="toc-backref" href="#id1">Configuration</a></h2> <p>The payment routes should work with several payment acquirers, however it was only tested with Stripe and Postfinance. Others acquirers may not work or require adaptations.</p> <p>To make sure the payment routes are working, at least one payment acquirer should be activated in the Accounting settings.</p> <a name="usage"></a> <h2><a class="toc-backref" href="#id2">Usage</a></h2> <p>The payment adds several routes for redirecting to payment providers after a form submission.</p> <p>One route is /compassion/payment/&lt;invoice_id&gt; that can contain following GET parameters:</p> <ul class="simple"> <li>accept_url: the redirection url after successful payment</li> <li>decline_url: the redirection url after declined payment</li> </ul> <p>The redirection page is /compassion/payment/validate</p> <p>If no accept_url and decline_url were passed, it will render the default confirmation page, otherwise it will redirect the user accordingly.</p> <p>The second route is /compassion/payment/&lt;transaction_id&gt; and is similar to the first one, except that one can use a transaction id instead of an invoice. The transaction should however be connected to an invoice otherwise it will display an error.</p> <a name="bug-tracker"></a> <h2><a class="toc-backref" href="#id3">Bug Tracker</a></h2> <p>Bugs are tracked on <a class="reference external" href="https://github.com/CompassionCH/compassion-modules/issues">GitHub Issues</a>. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us smashing it by providing a detailed and welcomed <a class="reference external" href="https://github.com/CompassionCH/compassion-modules/issues/new?body=module:%20cms_form_compassion%0Aversion:%2010.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p> <p>Do not contact contributors directly about support or help with technical issues.</p> <a name="credits"></a> <h2><a class="toc-backref" href="#id4">Credits</a></h2> <a name="authors"></a> <h3><a class="toc-backref" href="#id5">Authors</a></h3> <ul class="simple"> <li>Compassion CH</li> </ul> <a name="contributors"></a> <h3><a class="toc-backref" href="#id6">Contributors</a></h3> <ul class="simple"> <li>Emanuel Cino &lt;<a class="reference external" href="mailto:ecino&#64;compassion.ch">ecino&#64;compassion.ch</a>&gt;</li> <li>Benoît Schopfer &lt;<a class="reference external" href="mailto:bschopfer&#64;compassion.ch">bschopfer&#64;compassion.ch</a>&gt;</li> </ul> <a name="maintainers"></a> <h3><a class="toc-backref" href="#id7">Maintainers</a></h3> <p>This module is maintained by Compassion Switzerland.</p> <a class="reference external image-reference" href="https://www.compassion.ch"><img alt="Compassion Switzerland" src="https://upload.wikimedia.org/wikipedia/en/8/83/CompassionInternationalLogo.png" /></a> <p>Compassion Switzerland is a nonprofit organization whose mission is to release children from extreme poverty in Jesus name.</p> <p>This module is part of the <a class="reference external" href="https://github.com/CompassionCH/compassion-modules/tree/10.0/cms_form_compassion">CompassionCH/compassion-modules</a> project on GitHub.</p>