dlds/yii2-mlm

Yii2 Multi Level Marketing component

Tuesday, July 3, 2018
by dlds
Repository
1 Watchers
2 Stars
2,081 Installations

PHP
0 Dependents
0 Suggesters
7 Forks
1 Open issues
39 Versions
4 % Grown

The README.md

Multi level marketing rewrds module

Module handles rewards generating from appropriate subjects., _(*1)

Installation

composer require dlds/yii2-mlm, _(*2)

What is MLM?

MLM is referal marketing system where user get reward for succesfull produc sharing/solding. It is similar to Affiliate marketing but has more then one rewards level. In MLM you build your own structure (own team) of users., _(*3)

Exmaple:, _(*4)

In this scenario you will get some reward when any of 6 users in your structure buy a product., _(*6)

Entities in Module

Folowing naming and entities are used in MLM module., _(*7)

Subject, _(*8)

Class which is used as source for reward generation. It is usually some sort of ProductOrder or other entity which works with user payments., _(*9)

Participant, _(*10)

Class which represents user identity among MLM structure., _(*11)

Reward, _(*12)

Class which represents single rewards entry., _(*13)

Implementation of module

First of you have to prepare your database. There is MySQL Workbench schema / SQL import script showing simple example of DB structure required for implementation in app/data folder., _(*14)

There are following tables:, _(*15)

subject
participant
rwd_basic
rwd_extra
rwd_custom

As you can see there are 3 types of rewards. There is no need to use all 3 types. Standart rewards are held in table rwd_basic. More about rewards types in secrion Reward Types., _(*16)

Then you have to implement following interfaces into your application., _(*17)

MlmSubjectInterface, _(*18)

This interfaces is usually implemented by something like ProductOrder.php, _(*19)

MlmParticipantInterface, _(*20)

This interfaces is usually implemented by something like UsrIdentityModel.php, _(*21)

MlmRewardInterface, _(*22)

This interfaces is usually implemented by something like OrderReward.php, _(*23)

How module works?

After required implementation the rewards generation and verification is processed automatically by cron and console commands., _(*24)

When Subject is ready to generate rewards module will automatically generate appropiate amount of rewards based on module setup., _(*25)

During creation each participant is verified if is eligible to take rewards., _(*26)

After then each of this rewards is verified when reach the end of protection period of time (e.g. 14 days in which the subject order can be cancelled by user), _(*27)

After that reward is approved and is ready to pay off. Paying off handling is not part of this module yet., _(*28)

Module Setup

Module provides bunch of setup options which can change the rewards generation., _(*29)

rules array, _(*30)

Defines procentual amount of subject price will be used for each level of reward., _(*31)

Example showing 40% of subject price is pushed into rewards and spread among 5 levels: php [ 1 => 20, 2 => 10, 3 => 5, 4 => 3, 5 => 2 ], _(*32)

limitRules int, _(*33)

Restriction for rules configuration. Defines maximal procentual sum of all rules. In example above 40 will be suitable., _(*34)

delayPending int (unix format), _(*35)

Indicates how long will every single reward be in protection state. During this time the reward will have PENDING state. After this delay the APPROVED/DENY state will be used., _(*36)

For 1 day the value 86400 must be used. It is unix value for one day: 14 * 24 * 60 * 60 = 86400, _(*37)

roundPrecision int, _(*38)

Number of decimal places for reward value., _(*39)

roundMode enum (Mlm::MLM_ROUND_UP | Mlm::MLM_ROUND_DOWM), _(*40)

Indicates if reward value will be rounded up or down., _(*41)

skipWorthlessRewards boolean, _(*42)

When true the zero reward or rewards which value is 0.0000... after rounding will be ignored., _(*43)

clsParticipant string, _(*44)

Participant model class name in your application., _(*45)

clsRewardBasic string, _(*46)

Basic Rewards model class name in your application., _(*47)

clsSubjects array, _(*48)

Class names of all subjects in your application. You can have 1 to N subjects defined in this array and all will get rewards., _(*49)

isCreatingActive boolean, _(*50)

Enables / disables reward creation., _(*51)

isVerifyingActive boolean, _(*52)

Enables / disables reward verification. Verification is processed after protection period., _(*53)

isLevelRestrictionAllowed, _(*54)

When true the rewards will be created with special verification on participant. As default the participant is verified only if is eligible to take rewards. But when Level Restriction is Allowed the participant will be verified if is eligible to take reward of specific level in structure., _(*55)

This means that you can restrict some participant to be able to take only 1st and 2nd level of rewards and another participant to be able to take all levels of rewards., _(*56)

The Versions

03/07 2018

2.0.14

2.0.14.0

Yii2 Multi Level Marketing component

yii2-extension yii2-mlm

Yii2 Multi Level Marketing component

dlds/yii2-mlm

The README.md

Multi level marketing rewrds module

Installation

What is MLM?

Entities in Module

Implementation of module

How module works?

Module Setup

The Versions

2.0.14

The Requires

The Development Requires

by Jiri Svoboda

2.0.13

The Requires

The Development Requires

by Jiri Svoboda

2.0.12

The Requires

The Development Requires

by Jiri Svoboda

2.0.11

The Requires

The Development Requires

by Jiri Svoboda

2.0.10

The Requires

The Development Requires

by Jiri Svoboda

dev-master

The Requires

The Development Requires

by Jiri Svoboda

2.0.9

The Requires

The Development Requires

by Jiri Svoboda

2.0.8

The Requires

The Development Requires

by Jiri Svoboda

2.0.7

The Requires

The Development Requires

by Jiri Svoboda

2.0.6

The Requires

The Development Requires

by Jiri Svoboda

2.0.5

The Requires

The Development Requires

by Jiri Svoboda

2.0.4

The Requires

The Development Requires

by Jiri Svoboda

2.0.3

The Requires

The Development Requires

by Jiri Svoboda

2.0.2

The Requires

The Development Requires

by Jiri Svoboda

2.0.1

The Requires

The Development Requires

by Jiri Svoboda

2.0.0

The Requires

The Development Requires

by Jiri Svoboda

1.1.4

The Requires

by Jiri Svoboda

1.1.3