Skip to content

Latest commit

 

History

History
123 lines (78 loc) · 4.02 KB

UPGRADING.md

File metadata and controls

123 lines (78 loc) · 4.02 KB
Raw

Upgrade Guide

Upgrading from 2.1.0 to 2.2.0

Update config file

If you have published the config file of this package, you will have to copy the following snippet to your config file:

/*
|--------------------------------------------------------------------------
| Session Configuration
|--------------------------------------------------------------------------
*/
'session' => [

    /*
     * Everthing will be stored under the following key.
     */
    'key' => 'cyrildewit.eloquent-viewable.session',

],

Take a look at the original file to find the right location.

Upgrading from 2.0.0 to 2.1.0

There are no manual changes needed.

Upgrading from 1.0.5 to 2.0.0

The package has been renamed from Laravel Page View Counter to Eloquent Viewable.

PHP

While v1.0.5 already required PHP 7.0 and higher, it is now added to the composer.json file.

License

The license has been changed from MIT to Apache 2.0.

Require the new composer package

You can install the new package via composer using:

composer require cyrildewit/eloquent-viewable

Update your config/app.php

Replace CyrildeWit\PageViewCounter\PageViewCounterServiceProvider::class with CyrildeWit\EloquentViewable\EloquentViewableServiceProvider::class in providers.

Update database tables

If your app is in development, you can publish the new migration file with:

php artisan vendor:publish --provider="CyrildeWit\EloquentViewable\EloquentViewableServiceProvider" --tag="migrations"

Otherwise you can use the update_views_table migration to upgrade. It can be found at resources/database/.

Update the config file

First you have to publish the new config file with:

php artisan vendor:publish --provider="CyrildeWit\EloquentViewable\EloquentViewableServiceProvider" --tag="config"

Read this config file and update the fields if needed!

Prepare your viewable models again

  • Replace use CyrildeWit\PageViewCounter\Traits\HasPageViewCounter; with use CyrildeWit\EloquentViewable\Viewable;.
  • Replace use HasPageViewCounter; with use Viewable;.

For example:

use Illuminate\Database\Eloquent\Model;
use CyrildeWit\EloquentViewable\Viewable;

class Post extends Model
{
    use Viewable;

    // ...
}

Viewable model methods

Change ->addPageView() to ->addView()

  • Find all usages of addPageView() and replace it with addView().

Change ->addPageViewThatExpiresAt() to ->addView()

Note: this feature has been made available again in v2.1.0! See the README!

  • Find all usages of addPageViewThatExpiresAt(<DateTime>) and replace it with addView().

Change all ->getPageViews<suffix>() to ->getViews()

  • Find all usages of getPageViews() and replace it with getViews().
  • Find all usages of getPageViewsFrom(<DateTime>)and replace it with getViews(Period::since(<DateTime>)).
  • Find all usages of getPageViewsBefore(<DateTime>)and replace it with getViews(Period::upto(<DateTime>)).
  • Find all usages of getPageViewsBetween(<DateTime>)and replace it with getViews(Period::create(<DateTime>, <DateTime>)).
  • Find all usages of getUniquePageViews() and replace it with getUniqueViews().
  • Find all usages of getUniquePageViewsFrom(<DateTime>)and replace it with getUniqueViews(Period::since(<DateTime>)).
  • Find all usages of getUniquePageViewsBefore(<DateTime>)and replace it with getUniqueViews(Period::upto(<DateTime>)).
  • Find all usages of getUniquePageViewsBetween(<DateTime>)and replace it with getUniqueViews(Period::create(<DateTime>, <DateTime>)).

DateTransformer

The DateTransformers feature has been removed from v2.0.0.