Skip to content

Latest commit

 

History

History
229 lines (137 loc) · 7.79 KB

UPDATES.md

File metadata and controls

229 lines (137 loc) · 7.79 KB
Raw

Updates

Updating from 1.0.* to 1.1.*

1.1.* brings automatic SKU generation for better item management. This adds some new functions, traits, and a new database table. Nothing has been removed.

You will need to republish the configuration files for any upgrade path to enable SKU generation.

Once you have run the migrations with one of the paths shown below, you will have to create the new InventorySku model shown in the I need to customize my models installation if you have created your own models.

Once you have done that, you will need to add the sku() relationship method on your Inventory model:

public function sku()
{
    return $this->hasOne('InventorySku', 'inventory_id', 'id');
}

Now you're all set for the migrations.

I did not customize my migrations

If you have not modified the migrations and installed inventory from the supplied command, all you need to run is:

php artisan inventory:run-migrations

This will run the new migration.

I customized my migrations

If you have modified the migrations and ran them yourself, you will have to republish the migrations using:

Laravel 4:
php artisan migrate:publish --package="trexology/laravel-inventory"
Laravel 5:
php artisan vendor:publish

Don't worry, laravel won't overwrite migrations that already exist, and then run:

php artisan migrate

This will run the new available migration.

Updating from 1.1.* to 1.2.*

1.2.* combines the the prefix and code column on the inventory_skus table. This allows for easier searching and maintainability. Nothing has been removed besides the prefix column on the included migration.

A new configuration option named sku_separator is now included. This means you can now choose what separates the prefix from the code. For example, a sku_separator with a hyphen (-) inserted, the SKU generated might look like this:

DRI-00001

Due to the removal of the database column, all you should need to do is remove the prefix column from the inventory_skus database table. However this means you'll need to regenerate all of your SKU's unfortunately. You can perform this by looping through your inventory items and using the method regenerateSku():

$items = Inventory::all();

foreach($items as $item)
{
    $item->regenerateSku();
}

Updating from 1.2.* to 1.3.*

1.3.* brings inventory suppliers. This is a basic informational upgrade, meaning all this update brings is more information to your inventory.

If you're using the prebuilt models, you won't have to do anything besides run the new migration using the command:

php artisan inventory:run-migrations

However if you're using custom models, you will have to create a new model named Supplier with the information supplied in the install process, as well as add the new relationship method to your Inventory model below:

public function suppliers()
{
    return $this->belongsToMany('Supplier', 'inventory_suppliers', 'inventory_id')->withTimestamps();
}

If you're using custom migrations you will need to re-publish the inventory migrations using:

Laravel 4:
php artisan migrate:publish --package="trexology/laravel-inventory"
Laravel 5:
php artisan vendor:publish

Then run the migration using:

php artisan migrate

Updating from 1.3.* to 1.4.*

1.4.* beings inventory transactions. This offers a large amount of useful functionality for managing your inventory effectively.

If you're using the prebuilt models, you won't have to do anything besides run the new migration using the command:

php artisan inventory:run-migrations

However if you've created/customized your own models, you'll have to follow the installation process and create the new InventoryTransaction and InventoryTransactionHistory models shown here.

Then, if you haven't customized the database tables you'll have to run the migrations using:

php artisan inventory:run-migrations

If you have customized the included migrations, you'll have to publish the new ones using:

Laravel 4:
php artisan migrate:publish --package="trexology/laravel-inventory"
Laravel 5:
php artisan vendor:publish

Then run the migration using:

php artisan migrate

On your InventoryStock model, you'll have to add another hasMany relationship named transactions() shown here:

public function transactions()
{
    return $this->hasMany('InventoryTransaction', 'stock_id', 'id');
}

Now you're good to go to use the new update!

Updating from 1.4.* to 1.5.*

No migrations were added to this release, you can jump to 1.5.* with no issues.

However, the exception Trexology\Inventory\Exceptions\StockIsSufficientException has been removed.

It is no longer thrown when there is enough stock for a back-order. Simply remove it from your try/catch statement.

Updating from 1.5.* to 1.6.*

A new migration and trait was added to this release. This migration adds the column parent_id to your inventories database table. When rolled back, it will remove the parent_id column. The column parent_id is defaulted to null, so this migration is completely non-destructive.

Follow standard update migration procedure:

Laravel 4:
php artisan migrate:publish --package="trexology/laravel-inventory"
Laravel 5:
php artisan vendor:publish

Then run the migration using:

php artisan migrate

If you're using your own models, be sure to insert the new trait on your Inventory model:

use Trexology\Inventory\Traits\InventoryVariantTrait;

class Inventory extends Eloquent {
    use InventoryVariantTrait;
}

If you're using the built in models, it's already included.

Updating from 1.6.* to 1.7.*

In update 1.7, assembly functionality has been added. This update comes with 2 new migrations, and a new trait.

The new trait added is named Trexology\Inventory\Traits\AssemblyTrait. This trait will need to be inserted into your Inventory model if you wish to use the assembly functionality.

The first migration adds the column is_assembly (bool) to your inventories table. It is defaulted to false.

The second migration, adds the database pivot table inventory_assemblies. Be sure to modify this schema if you require extra pivot table attributes, or would prefer not to have timestamps included on the pivot table.

These migrations are non-destructive, so follow the standard update procedure:

Laravel 4:
php artisan migrate:publish --package="trexology/laravel-inventory"
Laravel 5:
php artisan vendor:publish

Then run the migration using:

php artisan migrate

Once you've ran the migrations, insert the new Assembly trait into your inventory model:

use Trexology\Inventory\Traits\AssemblyTrait;
use Trexology\Inventory\Traits\InventoryVariantTrait;
use Trexology\Inventory\Traits\InventoryTrait;

class Inventory extends Eloquent
{
    use InventoryTrait;
    use InventoryVariantTrait;
    use AssemblyTrait;

And add the new assemblies() belongsToMany relationship:

public function assemblies()
{
    return $this->belongsToMany($this, 'inventory_assemblies', 'inventory_id', 'part_id')->withPivot(['quantity'])->withTimestamps();
}

You're all set!

Upcoming Updates

1.8.* will bring Inventory Kits. Inventory Kit's are very similar to assemblies. Kits will allow you to bundle inventory items together and perform stock transactions on them. Stock from item's inside the kit will be automatically be updated when a transaction is performed on the kit, for example selling a kit would automatically remove stock from each kit item.