ReferralSystemDemoBundle Documentation

Transcription

1 ReferralSystemDemoBundle Documentation Release 0.1 Vyacheslav Enis June 14, 2014

2

3 Contents 1 Installation Prerequisites Installation Configuration Full Configuration Options Getting Started Create your User class Configure the FOSUserBundle Update your database schema Whats next? i

4 ii

5 ReferralSystemDemoBundle Documentation, Release 0.1 Contents: Contents 1

6 ReferralSystemDemoBundle Documentation, Release Contents

7 CHAPTER 1 Installation 1.1 Prerequisites PHP 5.3 and Symfony 2.1 are needed to make this bundle work. Also FOSUserBundle needs to be installed and configured beforehand. Please follow all steps described here 1.2 Installation Add bundle requirement to composer.json "require": {... "venis/referral-system-demo-bundle": "dev-master"... } Run composer to download library and it s dependencies php composer.phar update Register the bundle in app/appkernel.php: <?php $bundles = array( //... new VEnis\Bundle\ReferralSystemDemoBundle\VEnisReferralSystemDemoBundle(), ); 3

8 ReferralSystemDemoBundle Documentation, Release Chapter 1. Installation

9 CHAPTER 2 Configuration Configuration options v_enis_referral_system_demo query_param_name : Name of the referral code query parameter in the URI cookie_param_names : * code : Name of the cookie param that stores referral code * ip : Name of the cookie param that stores visitors ip-address * date : Name of the cookie param that stores referral uri visit date and time * referer : Name of the cookie param that stores referer 2.1 Full Configuration Options v_enis_referral_system_demo: # Name of the referral code query parameter in the URI query_param_name: ref # Example: refid cookie_param_names: # Name of the cookie param that stores referral code code: ref_code # Example: myrefcode # Name of the cookie param that stores visitors ip-address ip: ref_ip # Example: myrefip # Name of the cookie param that stores referral uri visit date and time date: ref_date # Example: myrefdate # Name of the cookie param that stores referer referer: ref_referer # Example: myrefreferer 5

10 ReferralSystemDemoBundle Documentation, Release Chapter 2. Configuration

11 CHAPTER 3 Getting Started 3.1 Create your User class The goal of this bundle is to extend FOSUserBundle powered user class with possibility to: For each user unique referral code will be generated Adding this referral code as a get parameter to the any site URI will store some referral information in the cookies on the client side. If user who has referral cookies will register - referral information together with information about user, which referral code was used for setting cookies, will be attached to the registered user. Warning: Only Doctrine ORM-based users from FOSUserBundle currently supported. The bundle provides base class which is already mapped for most fields to make it easier to create your entity. Here is how you use it: Extend the base User class. Map the id field. It must be protected as it is inherited from the parent class. Map the referraluser field. Note: When you extend from the mapped superclass provided by the bundle, don t redefine the mapping for the other fields as it is provided by the bundle. In the following section, you ll see example of how your User class should look. Your User class can live inside any bundle in your application. For example, if you work at Acme company, then you might create a bundle called AcmeUserBundle and place your User class in it. Warning: If you override the construct() method in your User class, be sure to call parent::construct(), as the base User class depends on this to initialize some fields Doctrine ORM User class Your User class should live in the Entity namespace of your bundle and look like this to start: 7

12 ReferralSystemDemoBundle Documentation, Release 0.1 <?php // src/acme/userbundle/entity/user.php namespace Acme\UserBundle\Entity; use VEnis\Bundle\ReferralSystemDemoBundle\Entity\User as BaseUser; use Doctrine\ORM\Mapping as ORM; /** */ class User extends BaseUser { /** */ protected $id; /** * Referral user (his referral code was used in URI) * referencedcolumnname="id", ondelete="set NULL") * \FOS\UserBundle\Model\UserInterface */ protected $referraluser; } public function construct() { parent:: construct(); // your own logic } 3.2 Configure the FOSUserBundle Next You must configure FOSUserBundle to use You User class and Form Handler, provided by Bundle. # app/config/config.yml fos_user: user_class:acme\userbundle\entity\user registration: form: handler: venis_referral_system_demo.form.handler.registration 3.3 Update your database schema Now that the bundle is configured, the last thing you need to do is update your database schema because you have added a new entity, the User class. 8 Chapter 3. Getting Started

13 ReferralSystemDemoBundle Documentation, Release 0.1 Run the following command. $ php app/console doctrine:schema:update --force 3.4 Whats next? You now can login, logout, create users as with general FOSUserBundle. But each new user will have autogenerated unique referral code, which can be appended to any site URI as a get parameter. Site visitor, who will follow similar link and then register on the site, will be linked with user, which referral code was used. Additional referral information like Date/Ip/Referrer will be also stored Whats next? 9