PHPackages                             cgm/zf2-tip-me - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Payment Processing](/categories/payments)
4. /
5. cgm/zf2-tip-me

ActiveLibrary[Payment Processing](/categories/payments)

cgm/zf2-tip-me
==============

ZF2 module for accepting tips/donations with Stripe

6321PHP

Since Jan 17Pushed 10y ago1 watchersCompare

[ Source](https://github.com/cgmartin/ZF2TipMe)[ Packagist](https://packagist.org/packages/cgm/zf2-tip-me)[ RSS](/packages/cgm-zf2-tip-me/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

ZF2TipMe
========

[](#zf2tipme)

[![No Maintenance Intended](https://camo.githubusercontent.com/d904056147052e22d8e1c7f46bb50293ed2aeb4c43ead9a2d0cf7a48b46d0562/687474703a2f2f756e6d61696e7461696e65642e746563682f62616467652e737667)](http://unmaintained.tech/)

Version 1.0.0 / Created by Christopher Martin / [BSD-3-Clause](https://github.com/cgmartin/ZF2TipMe/blob/master/LICENSE.txt) License

Introduction
------------

[](#introduction)

Accept donations directly on your site with [Zend Framework 2](http://framework.zend.com)and a [free Stripe account](https://stripe.com).

[![ZF2TipMe example screenshot](https://github.com/cgmartin/ZF2TipMe/raw/master/screenshot.png)](https://github.com/cgmartin/ZF2TipMe/raw/master/screenshot.png)

Features
--------

[](#features)

- Notification emails can be sent after successful payments.
- Test mode toggle, with a list of test credit cards for various testing scenarios.
- Designed for easy customization. Donation items are configurable. Event hooks available.
- Failed transactions are logged.
- No PCI data is sent to or stored on your server, thanks to Stripe.

**Stripe currently is only available in United States and Canada.**

Get notified of when Stripe is [available in your country](https://stripe.com/global).

Installation
------------

[](#installation)

### Composer / Packagist Install

[](#composer--packagist-install)

Add `"minimum-stability": "dev"` to your composer.json file, and run:

```
# From project's base directory...
% composer.phar require cgm/zf2-tip-me
Please provide a version constraint for the cgm/config-admin requirement: dev-master
```

### Enable the ZF2TipMe Module

[](#enable-the-zf2tipme-module)

Edit your `application.config.php` and enable the `ZfcBase` and `ZF2TipMe` modules:

```
return array(
    'modules' => array(
        // ...
        'ZfcBase',
        'ZF2TipMe',
    ),
    // ...
);
```

### Create Directories and Symbolic Links

[](#create-directories-and-symbolic-links)

Out of the box, this module is configured to write log files to `./data/log` and `./data/mail`. The mail logs are used when you have chosen not to use a mail server.

```
# From project's base directory...
% cd data
% mkdir log mail
% chmod 777 log mail
# Or set the appropriate group permissions to be writable by the webserver
```

There is an asset folder with CSS and JavaScript files. You can link them to `./public/tip-me-assets`, or potentially use a asset management module:

```
# From the project's base dir...
% cd public
% ln -s ../vendor/cgm/zf2-tip-me/public tip-me-assets
```

### Edit the Configuration

[](#edit-the-configuration)

Copy the .global and .local dist files from the module config directory:

```
# From project's base directory...
% cd config/autoload
% cp ../../vendor/cgm/zf2-tip-me/config/zf2tipme.global.php.dist ./zf2tipme.global.php
% cp ../../vendor/cgm/zf2-tip-me/config/zf2tipme.local.php.dist ./zf2tipme.local.php
```

Edit the `zf2tipme.global.php` file to taste:

```