README

Simple package that helps add advert to Laravel 5 websites. What is more it allows to see every advert clicks and views count for some statistics.

Installation

First require package with composer:

$ composer require adumskis/laravel-advert dev-master

Then add service provider to config/app.php:

Laravel 5.5 uses Package Auto-Discovery, so doesn't require you to manually add the ServiceProvider

'providers' => [
    ...
    Adumskis\LaravelAdvert\AdvertServiceProvider::class,
],

Facade to aliases:

'aliases' => [
    ...
    'AdvMng'    => Adumskis\LaravelAdvert\AdvertFacade::class,
],

Publish config:

$ php artisan vendor:publish --provider="Adumskis\LaravelAdvert\AdvertServiceProvider" --tag=config

Publish Advert view:

$ php artisan vendor:publish --provider="Adumskis\LaravelAdvert\AdvertServiceProvider" --tag=views

Lastly publish the migrations if you want to edit them and migrate

$ php artisan vendor:publish --provider="Adumskis\LaravelAdvert\AdvertServiceProvider" --tag=migrations
$ php artisan migrate

AdvertCategory model

Simple Eloquent model with variables:

type - (string) used for getting advert in specific category
width - (int) size in pixel to resize advert
height - (int) same as width

If width or height is set to 0 then advert image will be resized with [aspectRatio][1] method.

Advert model

Eloquent model, variables:

alt - (string) alt parameter tag
url - (string) url address where advert should redirect on click
image_url - (string) url addres of advert image
image_path - (string) path to image (from base path)
views - (int) count of views
clicks - (int) count of clicks
active - (bool) advert state
advert_category_id - (int) advert category model id
viewed_at - (timestamp) datetime of last advert view

Advert model has make method that helps to create new record in database also handles image resize and storing stuff. Method requires array with advert variables values and UploadedFile object. Simple example:

Advert::make(
    $request->only(['alt', 'url', 'active']), 
    $request->file('image')
);

It will return Advert object

Usage in view

    {{ AdvMng::getHTML('type') }}

It will take the that with lowest viewed_at parameter. getHTML method allow add second (bool) parameter and if it's true then it will not check if advert was already taken.

    {{ AdvMng::getHTML('type', true) }}

Advert image storage

    'default_file_system' => 'public',

To use the inbuilt ability of laravels multiple filesystems change this to another public facing service provider such as s3.

ToDo/Ideas

Add limit to advert views/clicks
Advert Campaigns
Advert Cost per click and cost per view?
Video Adverts.
Time of day adverts
Multiple adverts per campaign
Multiple images / videos per advert.
Follow Ad galley guide and create different size ads for different regions of the page.

mannysoft / laravel-advert

Maintainers

Details