Promocodes

Promotional Codes Generator for Laravel 5.1

Table of Contents

• Installation
  • Composer
  • Laravel
• Usage
  • Recomendations
  • Methods
• Config
• License

Installation

Composer

Run composer command in your terminal.

composer require zgabievi/promocodes

Laravel

Open config/app.php and find the providers key. Add PromocodesServiceProvider to the array.

Gabievi\Promocodes\PromocodesServiceProvider::class

Find the aliases key and add Facade to the array.

'Promocodes' => Gabievi\Promocodes\Facades\Promocodes::class

Usage

Recomendations

Run php artisan make:migration create_promocodes_table --create=promocodes and update up method of created migration:

Schema::create('promocodes', function (Blueprint $table) {
    $table->increments('id');

    $table->string('code', 32)->unique();
    $table->boolean('is_used')->default(false);
});

Then, run php artisan make:model Promocode and update app/Promocode.php as following:

/**
 * @var bool
 */
public $timestamps = false;

/**
 * @var array
 */
protected $fillable = [
    'code',
    'is_used',
];

/**
 * @var array
 */
protected $casts = [
    'is_used' => 'boolean',
];

Methods

You can generate Promotional codes using generate method.

The only parameter is amount of codes to generate.

Promocodes::generate(5);

This method will return array of codes with 5 element

You can generate and save codes instantly in your database using:

Promocodes::save(5);

This will generate 5 codes and insert in your DB.

Check code using method check.

Method returns boolean.

$valid = Promocodes::check('TEST-CODE');

Laslty use code using method apply.

Method returns boolean.

$applied = Promocodes::apply('TEST-CODE');

If method returns false, code was already used or it wasn't valid

Config

Publish Promocodes config file using command:

php artisan vendor:publish

Created file config\promocodes.php. Inside you can change configuration as you wish.

License

Promocodes is an open-sourced laravel package licensed under the MIT license

TODO

• [ ] Create migration for vendor publish
• [ ] Create Promocode Model trait