tatter / stripe
Stripe SDK integration for CodeIgniter 4
Fund package maintenance!
tattersoftware
paypal.me/tatter
Installs: 4 695
Dependents: 0
Suggesters: 0
Security: 0
Stars: 11
Watchers: 3
Forks: 5
Open Issues: 1
Requires
- php: ^7.4 || ^8.0
- stripe/stripe-php: ^7.14 || ^8.0
Requires (Dev)
- codeigniter4/framework: ^4.1
- tatter/tools: ^2.0
This package is auto-updated.
Last update: 2024-11-17 17:57:31 UTC
README
Stripe SDK integration for CodeIgniter 4
Quick Start
- Install with Composer:
> composer require tatter/stripe
- Set the environment keys: .env >
stripe.apiKey
andstripe.apiSecret
- Load the service:
$stripe = service('stripe');
Description
This is a CodeIgniter 4 integration of the Stripe PHP SDK
Installation
Install easily via Composer to take advantage of CodeIgniter 4's autoloading capabilities and always be up-to-date:
> composer require tatter/stripe
Or, install manually by downloading the source files and adding the directory to
app/Config/Autoload.php
.
Configuration
The library's default behavior can be altered by extending its config file. Copy examples/Stripe.php to app/Config/ and follow the instructions in the comments. If no config file is found in app/Config then the library will use its own.
In addition to the configuration you must set your apiSecret
in your .env file
in your project root. API keys and secrets are available from the
Stripe Dashboard. E.g.:
#--------------------------------------------------------------------
# STRIPE
#--------------------------------------------------------------------
stripe.apiKey = pk_test_6pRNASCoBOKtIshFeQd4XMUh
stripe.apiSecret = sk_test_BQokikJOvBiI2HlWgH4olfQ2
WARNING Make sure you never include credentials in your repository!
Usage
Load the Stripe service:
$stripe = service('stripe');
At this point you have a working StripeClient
and can use any of the methods described
in the Stripe API Docs. Note that API endpoints
are version-specific. See Configuration above on how to use the example config file to
override the module default if you want to set a specific version.