cometcult / credit-bundle
User credit bundle for use with Symfony2
Installs: 275
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 5
Forks: 2
Open Issues: 0
Type:symfony-bundle
Requires
- php: >=5.3.2
Requires (Dev)
- doctrine/mongodb-odm: 1.0.*@dev
- doctrine/mongodb-odm-bundle: 3.0.*@dev
- phpspec/phpspec: dev-master
- symfony/framework-bundle: >=2.2,<2.3-dev
This package is not auto-updated.
Last update: 2024-12-17 05:48:23 UTC
README
Symfony 2 Bundle for storing user credits/points
Currently supports only Doctrine MongoDB
Installation
Composer
Just add to your composer.json file:
{ "require": { "cometcult/credit-bundle": "dev-master" } }
Application Kernel
Add the bundle to your application's kernel:
// app/AppKernel.php public function registerBundles() { return array( // ... new CometCult\CreditsBundle\CometCultCreditsBundle(), // ... ); }
Usage
CometCultCreditsBundle should be operated from CreditsManager
Create credit instance
$creditsManager = $this->get('comet_cult_credits.manager'); $credit = $creditsManager->createCredit(200, 'abc123');
Then persist credit instance with updateCredit() method
$creditsManager->updateCredit($credit);
Basic operations should be performed providing {ownerId} and amount of credit if needed
$creditsManager->addCredit(100, 'abc123'); $creditsManager->subtractCredit(42, 'abc123');
You can always check the balance of a user with the BalanceChecker
$creditBalanceChecker = $this->get('comet_cult_credits.balance_checker'); $creditBalanceChecker->getCreditBalance('abc123');
Or check against a configurable threshold. By default the minimum threshold is 0 and maximum threshold is 100
$creditBalanceChecker->hasLowCreditBalance('abc123');
Configuration
You can configure your own threshold values. To do that just add to your Symfony config:
comet_cult_credit: min_threshold: 0 # min value of your choice max_threshold: 100 # max value of your choice