Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 1.97 KB

UPGRADING.md

File metadata and controls

49 lines (34 loc) · 1.97 KB
Raw

Upgrade Guide

From v2 to v3

Because there are many breaking changes an upgrade is not that easy. There are many edge cases this guide does not cover. We accept PRs to improve this guide.

Find and replace:

  • Find all Cog\Ban\Contracts\Ban and replace with Cog\Contracts\Ban\Ban
  • Find all Cog\Ban\Contracts\HasBans and replace with Cog\Contracts\Ban\Bannable
  • Find all Cog\Ban\Contracts\BanService and replace with Cog\Contracts\Ban\BanService
  • Find all Cog\Ban\Traits\HasBans and replace with Cog\Laravel\Ban\Traits\Bannable
  • Find all Cog\Ban and replace with Cog\Laravel\Ban

In classes which works with bans:

  • Find Ban::whereOwnedBy replace with Ban::whereBannable
  • Find calls of methods or attributes on the Ban model like ownedBy, owner, getOwner and replace them with bannable

These database changes should be performed:

  • Rename ban table to bans
  • Rename bans database column owned_by_id to bannable_id
  • Rename bans database column owned_by_type to bannable_type
  • Update name of migration file in migrations table from 2017_03_04_000000_create_ban_table to 2017_03_04_000000_create_bans_table

To make all changes in MySQL you could run these 3 commands one by one:

ALTER TABLE `ban` RENAME TO `bans`;

  ALTER TABLE `bans` 
CHANGE COLUMN `owned_by_id` `bannable_id` INT(10) UNSIGNED NOT NULL,
CHANGE COLUMN `owned_by_type` `bannable_type` VARCHAR(255) NOT NULL,
   DROP INDEX `ban_owned_by_id_owned_by_type_index`,
    ADD INDEX `ban_bannable_id_bannable_type_index` (`bannable_id` ASC, `bannable_type` ASC);

UPDATE `migrations`
   SET `migration` = '2017_03_04_000000_create_bans_table'
 WHERE `migration` = '2017_03_04_000000_create_ban_table'
 LIMIT 1;

Migration files:

  • Delete database/migrations/2017_03_04_000000_create_ban_table.php migration file (from v3 service provider automatically loading migration files or republish it if custom changes are required to be done).