davidjeddy/yii2-stripe

This package is abandoned and no longer maintained. The author suggests using the https://github.com/ruskid/yii2-stripe package instead.

Yii2 Stripe Wrapper

1.2.5 2016-06-27 15:34 UTC

This package is auto-updated.

Last update: 2019-02-20 19:25:37 UTC


README

Badges

SensioLabsInsight

Installation

The preferred way to install this extension is through http://getcomposer.org/download/.

Either run

php composer.phar require davidjeddy/yii2-stripe "dev-master"

or add

"davidjeddy/yii2-stripe": "~1.0"

to the require section of your composer.json file.

Usage

Add a new component in main.php

'components' => [
...
'stripe' => [
    'class' => 'davidjeddy\stripe\Stripe',
    'publicKey' => "pk_test_xxxxxxxxxxxxxxxxxxx",
    'privateKey' => "sk_test_xxxxxxxxxxxxxxxxxx",
],
...

To render simple checkout form just call the widget in the view, it will automatically register the scripts. Check stripe documentation for more options.

use davidjeddy\stripe\StripeCheckout;

<?= 
StripeCheckout::widget([
    'action' => '/',
    'name' => 'Demo test',
    'description' => '2 widgets ($20.00)',
    'amount' => 2000,
    'image' => '/128x128.png',
]);
?>

Custom checkout form is an extended version of simple form, but you can customize the button (see buttonOptions) and handle token as you want (tokenFunction).

use davidjeddy\stripe\StripeCheckoutCustom;

<?= 
StripeCheckoutCustom::widget([
    'action' => '/',
    'name' => 'Demo test',
    'description' => '2 widgets ($20.00)',
    'amount' => 2000,
    'image' => '/128x128.png',
    'buttonOptions' => [
        'class' => 'btn btn-lg btn-success',
    ],
    'tokenFunction' => new JsExpression('function(token) { 
                alert("Here you should control your token."); 
    }'),
    'openedFunction' => new JsExpression('function() { 
                alert("Model opened"); 
    }'),
    'closedFunction' => new JsExpression('function() { 
                alert("Model closed"); 
    }'),
]);
?>

Example of a custom form. StripeForm is an extended ActiveForm so you can perform validation of amount and other attributes you want. Use of Jquery Payment library is optional, you can disable format and validation and write your own implementation. You can also change JsExpression for response and request handlers.

use davidjeddy\stripe\StripeForm;

 <?php
 $form = StripeForm::begin([
             'tokenInputName' => 'stripeToken',
             'errorContainerId' => 'payment-errors',
             'brandContainerId' => 'cc-brand',
             'errorClass' => 'has-error',
             'applyJqueryPaymentFormat' => true,
             'applyJqueryPaymentValidation' => true,
             'options' => ['autocomplete' => 'on']
 ]);
 ?>

 <div class="form-group">
     <label for="number" class="control-label">Card number</label>
     <span id="cc-brand"></span>
     <?= $form->numberInput() ?>
 </div>

 <div class="form-group">
     <label for="cvc" class="control-label">CVC</label>
     <?= $form->cvcInput() ?>
 </div>

 <!-- Use month and year in the same input. -->
 <div class="form-group">
     <label for="exp-month-year" class="control-label">Card expiry</label>
     <?= $form->monthAndYearInput() ?>
 </div>

 <!-- OR in two separate inputs. -->
 <div class="form-group">
     <label for="exp-month" class="control-label">Month</label>
     <?= $form->monthInput() ?>
 </div>

 <div class="form-group">
     <label for="exp-year" class="control-label">Year</label>
     <?= $form->yearInput() ?>
 </div>

 <div id="payment-errors"></div>
 
 <?= Html::submitButton('Submit'); ?>
 
 <?php StripeForm::end(); ?>

Contribution / Credit

Forked From: https://github.com/ruskid/yii2-stripe I would like to give the original author all due credit, great package.