PHP Classes

Phalcon Cashier: Access subscription services provided by Stripe

Recommend this page to a friend!
  Info   View files Example   View files View files (43)   DownloadInstall with Composer Download .zip   Reputation   Support forum   Blog    
Ratings Unique User Downloads Download Rankings
Not enough user ratingsTotal: 113 All time: 9,590 This week: 206Up
Version License PHP version Categories
phalcon-cashier 1.0.0MIT/X Consortium ...5PHP 5, E-Commerce, Web services, Traits
Description 

Author

This package can access subscription services provided by Stripe.

It accesses the Stripe API to provide basic subscription management, handle coupons, swapping subscription, update subscription "quantities", cancellation grace periods, and generate invoice in PDF format.

Innovation Award
PHP Programming Innovation award nominee
June 2016
Number 12
Stripe is a well known Internet based payment system that can handle single or recurring payments.

This package can perform several types of operations to manage recurring payments using the Stripe API.

Manuel Lemos
Picture of Thien Tran
  Performance   Level  
Name: Thien Tran <contact>
Classes: 1 package by
Country: Viet Nam Viet Nam
Age: 33
All time rank: 437529 in Viet Nam Viet Nam
Week rank: 280 Up2 in Viet Nam Viet Nam Up
Innovation award
Innovation award
Nominee: 1x

Example

<?php
/**
 *
 * Licensed under The GNU License
 * For full copyright and license information, please see the LICENSE.txt
 * Redistributions of files must retain the above copyright notice.
 *
 * @link http://phanbook.com Project
 * @since 1.0.0
 * @license http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt
 */
use Phalcon\DI;
use
Phalcon\Crypt;
use
Phalcon\Security;
use
Phalcon\Mvc\Router;
use
Phalcon\Flash\Session;
use
Phalcon\DI\FactoryDefault;
use
Phalcon\Http\Response\Cookies;
use
Phalcon\Mvc\Collection\Manager as CollectionManager;
use
Phalcon\Cache\Frontend\Data;
use
Phalcon\Cache\Frontend\None as FrontendNone;
use
Phalcon\Cache\Frontend\Output as FrontendOutput;
use
Phalcon\Db\Adapter\Pdo\Mysql;
use
Phalcon\Cache\Backend\Memcache;
use
Phalcon\Cache\Backend\Memory as MemoryBackend;
use
Phalcon\Cache\Backend\File as FileCache;
use
Phalcon\Mvc\Url as UrlResolver;
use
Phalcon\Translate\Adapter\NativeArray;
use
Phalcon\Mvc\Model\Manager as ModelsManager;
use
Phalcon\Events\Manager as EventsManager;
use
Phalcon\Mvc\Dispatcher;
use
Phalcon\Mvc\View\Engine\Volt;
use
Phalcon\Queue\Beanstalk;
use
Phalcon\Config\Adapter\Php as AdapterPhp;
use
Phalcon\Logger\Adapter\File as FileLogger;
use
Phalcon\Mvc\Model\Metadata\Redis as MetadataRedis;
use
Phalcon\Security\Random;
use
App\Mail\Mail;
use
App\Auth\Auth;
use
App\Acl\Acl;
use
App\Utils\App as UtilsApp;
use
App\Markdown\ParsedownExtra;
use
App\Filesystem\FlysystemServiceProvider;



/**
 * The FactoryDefault Dependency Injector automatically register the right services providing a full stack framework
 */
$di = new FactoryDefault();

// Create an event manager
$eventsManager = new EventsManager();

/**
 * Register the configuration itself as a service
 */
$config = include __DIR__ . '/config.php';
if (
file_exists(__DIR__ . '/config.global.php')) {
   
$overrideConfig = include __DIR__ . '/config.global.php';
   
$config->merge($overrideConfig);
}

if (
file_exists(__DIR__ . '/config.' . APPLICATION_ENV . '.php')) {
   
$overrideConfig = include __DIR__ . '/config.' . APPLICATION_ENV . '.php';
   
$config->merge($overrideConfig);
}
$di->set('config', $config, true);


/**
 * The URL component is used to generate all kind of urls in the application
 */
$di->set(
   
'url',
    function () use (
$di) {
       
$url = new UrlResolver();
       
$config = $di->get('config');
       
$url->setBaseUri($config->application->baseUri);
        if (!
$config->application->debug) {
           
$url->setStaticBaseUri($config->application->production->staticBaseUri);
        } else {
           
$url->setStaticBaseUri($config->application->development->staticBaseUri);
        }
        return
$url;
    }
);

/**
 * Start the session the first time some component request the session service
 */
$di->set(
   
'session',
    function () use (
$di) {
       
$sessionAdapter = $di->get('config')->application->session->adapter;
       
$session = new $sessionAdapter($di->get('config')->application->session->options->toArray());
       
$session->start();

        return
$session;
    },
   
true
);

/**
 * This service controls the initialization of models, keeping record of relations
 * between the different models of the application.
 */
$di->setShared(
   
'collectionManager',
    function () use (
$eventsManager) {
       
$collectionManager = new CollectionManager();
       
$collectionManager->setEventsManager($eventsManager);

        return
$collectionManager;
    }
);
$di->setShared(
   
'modelsManager',
    function () use (
$eventsManager) {
       
$modelsManager = new ModelsManager();
       
$modelsManager->setEventsManager($eventsManager);

        return
$modelsManager;
    }
);

// Set the views cache service
$di->set(
   
'viewCache',
    function () use (
$di) {
       
$config = $di->get('config');
        if (
$config->application->debug) {
            return new
MemoryBackend(new FrontendNone());
        } else {
           
// Cache data for one day by default
           
$frontCache = new FrontendOutput(['lifetime' => $config->cache->lifetime]);
            return new
FileCache(
               
$frontCache,
                [
                   
'cacheDir' => $config->cache->cacheDir,
                   
'prefix' => $config->cache->prefix
               
]
            );
        }
    }
);


// Register the flash service with custom CSS classes
$di->set(
   
'flashSession',
    function () {
       
$flash = new Session(
            [
               
'error' => 'alert alert-danger',
               
'success' => 'alert alert-success',
               
'notice' => 'alert alert-info',
               
'warning' => 'alert alert-warning'
           
]
        );

        return
$flash;
    }
);

// Database connection is created based in the parameters defined in the configuration file
$di->set(
   
'db',
    function () use (
$di) {
       
$connection = new Mysql(
            [
               
'host' => $di->get('config')->database->mysql->host,
               
'username' => $di->get('config')->database->mysql->username,
               
'password' => $di->get('config')->database->mysql->password,
               
'dbname' => $di->get('config')->database->mysql->dbname,
               
//'schema' => $di->get('config')->database->mysql->schema,
                // 'options' => [
                // // \PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES ' . $di->get('config')->database->mysql->charset
                // ]
           
]
        );
       
$debug = $di->get('config')->application->debug;
        if (
$debug) {
           
$eventsManager = new EventsManager();
           
$logger = new FileLogger(ROOT_DIR . '/logs/db.txt');
           
//Listen all the database events
           
$eventsManager->attach(
               
'db',
                function (
$event, $connection) use ($logger) {
                   
/** @var Phalcon\Events\Event $event */
                   
if ($event->getType() == 'beforeQuery') {
                       
/** @var DatabaseConnection $connection */
                       
$variables = $connection->getSQLVariables();
                        if (
$variables) {
                           
$logger->log($connection->getSQLStatement() . ' [' . join(',', $variables) . ']', \Phalcon\Logger::INFO);
                        } else {
                           
$logger->log($connection->getSQLStatement(), \Phalcon\Logger::INFO);
                        }
                       
//d($connection->getSQLStatement(), false) ;
                   
}
                }
            );
           
//Assign the eventsManager to the db adapter instance
           
$connection->setEventsManager($eventsManager);
        }
        return
$connection;
    },
   
true // shared
);

$di->set(
   
'cookies',
    function () {
       
$cookies = new Cookies();
       
$cookies->useEncryption(false);
        return
$cookies;
    },
   
true
);

$di->set(
   
'crypt',
    function () use (
$di) {
       
$crypt = new Crypt();
       
$crypt->setKey($di->get('config')->application->cryptSalt); //Use your own key!

       
return $crypt;
    }
);

$di->set(
   
'security',
    function () {

       
$security = new Security();
       
//Set the password hashing factor to 12 rounds
       
$security->setWorkFactor(12);

        return
$security;
    },
   
true
);

//Set the models cache service
$di->set(
   
'modelsCache',
    function () {
       
// Cache data for one day by default
       
$frontCache = new Data(['lifetime' => 86400]);

       
// Memcached connection settings
       
$cache = new Memcache(
           
$frontCache,
            [
               
'host' => 'localhost',
               
'port' => 11211
           
]
        );

        return
$cache;
    }
);

//Set mail swift
$di->set(
   
'mail',
    function () {
        return new
Mail();
    }
);
$di->set(
   
'markdown',
    function () {
        return new
ParsedownExtra();
    }
);
$di->set(
   
'dispatcher',
    function () use (
$di) {
       
$eventsManager = new EventsManager;
       
//$eventsManager->attach('dispatch:beforeDispatch', new SecurityPlugin);
        //$eventsManager->attach('dispatch:beforeException', new NotFoundPlugin);
       
$dispatcher = new Dispatcher;
       
$dispatcher->setEventsManager($eventsManager);

        return
$dispatcher;
    }
);
$di->set(
   
'auth',
    function () {
        return new
Auth();
    }
);
$di->set(
   
'acl',
    function () {
        return new
Acl();
    }
);


//Translation application
$di->set(
   
'translation',
    function () use (
$di) {
       
$language = $di->get('language');
       
$path = ROOT_DIR . 'data/messages/' . $language . '.php';
        if (!
file_exists($path)) {
            throw new \
Exception("You must specify a language file for language '$language'");
        }
       
$messages = require_once $path;
       
//Return a translation object
       
return new NativeArray([
           
'content' => $messages
       
]);
    },
   
true
);
$di->set(
   
'language',
    function() use (
$di, $config) {
       
$cookies = $di->get('cookies');
       
$language = $config->defaultLang;
        if (
$cookies->has('language')) {
           
$language = $cookies->get('language');
        }
        return
$language;
    },
   
true
);
$di->set(
   
'currency',
    function() use (
$di, $config) {
       
$cookies = $di->get('cookies');
       
$currency = $config->currency;
        if (
$cookies->has('currency')) {
           
$currency = unserialize($cookies->get('currency'));
        }
        return
$currency;
    },
   
true
);

$di->set(
   
'filesystem',
    function () use (
$di) {
        return new
FlysystemServiceProvider($di);
    }
);
$di->set(
   
'random',
    function () {
        return new
Random();
    }
);
//Stores model meta-data in the Redis
// $di->set(
// 'modelsMetadata',
// function () use ($di) {
// $redis = $di->get('config')->redis;
// $metaData = new MetadataRedis([
// 'host' => $redis->host,
// 'port' => $redis->port,
// 'prefix' => $redis->prefix,
// 'lifetime' => $redis->lifetime,
// 'persistent' => $redis->persistent
// ]);

// return $metaData;
// },
// true
// );
/**
 * Setting up volt
 */
$di->set(
   
'volt',
    function (
$view, $di) use ($config) {
       
$volt = new Volt($view);
       
$volt->setOptions(
            [
               
'compiledPath' => $config->application->view->compiledPath,
               
'compiledSeparator' => $config->application->view->compiledSeparator,
               
'compiledExtension' => $config->application->view->compiledExtension,
               
'compileAlways' => true,
            ]
        );
       
$compiler = $volt->getCompiler();
       
$compiler->addExtension(new \App\Tools\VoltFunctions());
        return
$volt;
    },
   
true
);

/**
 * The logger component
 */
$di->set(
   
'logger',
    function () use (
$di) {
       
$logger = ROOT_DIR. 'logs/' . date('Y-m-d') . '.log';
        return new
FileLogger($logger, ['model' => 'a+']);
    },
   
true
);
$di->set(
   
'app',
    function () {
        return new
UtilsApp();
    },
   
true
);
/**
 * Translation function call anywhere
 *
 * @param $string
 *
 * @return mixed
 */
if (!function_exists('t')) {
    function
t($string)
    {
       
$translation = DI::getDefault()->get('translation');
        return
$translation->_($string);
    }
}
//Phalcon Debugger
if ($config->application->debug) {
    (new \
Phalcon\Debug)->listen();
    if (!
function_exists('d')) {
        function
d($object, $kill = true)
        {
            echo
'<pre style="text-aling:left">', print_r($object, true), '</pre>';
           
$kill && exit(1);
        }
    }
}
//setup timezone
//date_default_timezone_set(!empty($di->get('auth')->getAuth()['timezone']) ? $di->get('auth')->getAuth()['timezone'] :'UTC');


Details

Build Status and Join chats us:

Build Status Slack

Introduction

Phalcon Cashier provides an expressive, fluent interface to Stripe's subscription billing services. It handles almost all of the boilerplate subscription billing code you are dreading writing. In addition to basic subscription management, Cashier can handle coupons, swapping subscription, subscription "quantities", cancellation grace periods, and even generate invoice PDFs.

Test Setup

You will need to set the following details locally and on your Stripe account in order to test:

Local

Add some parameter in config.php such as like below

'stripe' => [
    'model'      => 'App\Models\Users',
    'secretKey'  => null,
    'publishKey' => null
]

Stripe

Plans

* monthly-10-1 ($10)
* monthly-10-2 ($10)

Coupons

* coupon-1 ($5)

Official Documentation

You can how to using it at here. Also it is inspiring by Laravel so you can take look on the Laravel website.

Contributing

Thank you for considering contributing to the Cashier. You can read the contribution guide lines here.

License

Phalcon Cashier is open-sourced software licensed under the MIT license


  Files folder image Files  
File Role Description
Files folder imagesrc (7 files)
Files folder imagetests (7 files, 7 directories)
Accessible without login Plain text file .editorconfig Data Auxiliary data
Accessible without login Plain text file .travis.yml Data Auxiliary data
Accessible without login Plain text file changes.md Data Auxiliary data
Accessible without login Plain text file codeception.yml Data Auxiliary data
Accessible without login Plain text file composer.json Data Auxiliary data
Accessible without login Plain text file composer.lock Data Auxiliary data
Accessible without login Plain text file contributing.md Data Auxiliary data
Accessible without login Plain text file LICENSE.txt Lic. License
Accessible without login Plain text file readme.md Doc. Documentation

  Files folder image Files  /  src  
File Role Description
  Plain text file Billable.php Class Class source
  Plain text file Cashier.php Class Class source
  Accessible without login Plain text file CashierServiceProvider.php Aux. Auxiliary script
  Plain text file Invoice.php Class Class source
  Plain text file InvoiceItem.php Class Class source
  Plain text file Subscription.php Class Class source
  Plain text file SubscriptionBuilder.php Class Class source

  Files folder image Files  /  tests  
File Role Description
Files folder imageacceptance (2 files)
Files folder imagebuild (3 files)
Files folder imagefunctional (2 files)
Files folder imagemodels (1 file)
Files folder imageunit (4 files)
Files folder image_data (1 file)
Files folder image_support (3 files, 2 directories)
  Accessible without login Plain text file acceptance.suite.yml Data Auxiliary data
  Accessible without login Plain text file bootstrap.php Example Example script
  Accessible without login Plain text file config.php Conf. Configuration script
  Accessible without login Plain text file functional.suite.yml Data Auxiliary data
  Accessible without login Plain text file service.phalcon.php Example Example script
  Accessible without login Plain text file unit.suite.yml Data Auxiliary data
  Accessible without login Plain text file _bootstrap.php Aux. Auxiliary script

  Files folder image Files  /  tests  /  acceptance  
File Role Description
  Plain text file AcceptanceTester.php Class Class source
  Accessible without login Plain text file _bootstrap.php Aux. Auxiliary script

  Files folder image Files  /  tests  /  build  
File Role Description
  Accessible without login Plain text file config.php Example Example script
  Accessible without login Plain text file install-phalcon.sh Data Auxiliary data
  Accessible without login Plain text file nginx.conf Data Auxiliary data

  Files folder image Files  /  tests  /  functional  
File Role Description
  Plain text file FunctionalTester.php Class Class source
  Accessible without login Plain text file _bootstrap.php Aux. Auxiliary script

  Files folder image Files  /  tests  /  models  
File Role Description
  Plain text file Users.php Class Class source

  Files folder image Files  /  tests  /  unit  
File Role Description
  Plain text file CashierTest.php Class Class source
  Plain text file UnitTestCase.php Class Class source
  Plain text file UnitTester.php Class Class source
  Accessible without login Plain text file _bootstrap.php Aux. Auxiliary script

  Files folder image Files  /  tests  /  _data  
File Role Description
  Accessible without login Plain text file dump.sql Data Auxiliary data

  Files folder image Files  /  tests  /  _support  
File Role Description
Files folder imageHelper (1 file)
Files folder image_generated (3 files)
  Plain text file AcceptanceTester.php Class Class source
  Plain text file FunctionalTester.php Class Class source
  Plain text file UnitTester.php Class Class source

  Files folder image Files  /  tests  /  _support  /  Helper  
File Role Description
  Plain text file Functional.php Class Class source

  Files folder image Files  /  tests  /  _support  /  _generated  
File Role Description
  Plain text file AcceptanceTesterActions.php Class Class source
  Plain text file FunctionalTesterActions.php Class Class source
  Plain text file UnitTesterActions.php Class Class source

 Version Control Unique User Downloads Download Rankings  
 100%
Total:113
This week:0
All time:9,590
This week:206Up