| Package Data | |
|---|---|
| Maintainer Username: | khaledkhamis |
| Maintainer Contact: | support@amsgames.com (Amsgames, LLC) |
| Package Create Date: | 2017-01-25 |
| Package Last Update: | 2017-03-22 |
| Language: | PHP |
| License: | MIT |
| Last Refreshed: | 2024-11-19 03:04:37 |
| Package Statistics | |
|---|---|
| Total Downloads: | 48 |
| Monthly Downloads: | 0 |
| Daily Downloads: | 0 |
| Total Stars: | 3 |
| Total Watchers: | 2 |
| Total Forks: | 1 |
| Total Open Issues: | 0 |
Laravel Shop is flexible way to add shop functionality to Laravel 5.1. Aimed to be the e-commerce solution for artisans.
Laravel shop adds shopping cart, orders and payments to your new or existing project; letting you transform any model into a shoppable item.
Supports
Current version includes:
On the horizon:
With composer
composer require amsgames/laravel-shop
Or add
"amsgames/laravel-shop": "0.2.*"
to your composer.json. Then run composer install or composer update.
Then in your config/app.php add
Amsgames\LaravelShop\LaravelShopProvider::class,
in the providers array.
Then add
'Shop' => Amsgames\LaravelShop\LaravelShopFacade::class,
in the aliases array.
Set the configuration values in the config/auth.php file. This package will use them to refer to the user table and model.
Publish the configuration for this package to further customize table names, model namespaces, currencies and other values. Run the following command:
php artisan vendor:publish
A shop.php file will be created in your app/config directory.
Generate package migration file:
php artisan laravel-shop:migration
The command below will generate a new migration file with database commands to create the cart and item tables. The file will be located in database/migrations. Add additional fields if needed to fill your software needs.
The command will also create a database seeder to fill shop catalog of status and types.
Create schema in database:
php artisan migrate
Add the seeder to database/seeds/DatabaseSeeder.php:
class DatabaseSeeder extends Seeder
{
public function run()
{
Model::unguard();
$this->call('LaravelShopSeeder');
Model::reguard();
}
}
Run seeder (do composer dump-autoload first):
php artisan db:seed
The following models must be created for the shop to function, these models can be customizable to fir your needs.
Create a Item model:
php artisan make:model Item
This will create the model file app/Item.php, edit it and make it look like (take in consideration your app's namespace):
<?php
namespace App;
use Amsgames\LaravelShop\Models\ShopItemModel;
class Item extends ShopItemModel
{
}
The Item model has the following main attributes:
id — Item id.sku — Stock Keeping Unit, aka your unique product identification within your store.price — Item price.tax — Item tax. Defaulted to 0.shipping — Item shipping. Defaulted to 0.currency — Current version of package will use USD as default.quantity — Item quantity.class — Class reference of the model being used as shoppable item. Optional when using array data.reference_id — Id reference of the model being used as shoppable item. Optional when using array data.user_id — Owner.displayPrice — Price value formatted for shop display. i.e. "$9.99" instead of just "9.99".displayTax — Tax value formatted for shop display. i.e. "$9.99" instead of just "9.99".displayShipping — Tax value formatted for shop display. i.e. "$9.99" instead of just "9.99".displayName — Based on the model's item name property.shopUrl — Based on the model's item route property.wasPurchased — Flag that indicates if item was purchased. This base on the status set in config file.created_at — When the item record was created in the database.updated_at — Last time when the item was updated.Business definition: Item used as a cart item or an order item.
Create a Cart model:
php artisan make:model Cart
This will create the model file app/Cart.php, edit it and make it look like (take in consideration your app's namespace):
<?php
namespace App;
use Amsgames\LaravelShop\Models\ShopCartModel;
class Cart extends ShopCartModel
{
}
The Item model has the following main attributes:
id — Cart id.user_id — Owner.items — Items in cart.count — Total amount of items in cart.totalPrice — Total price from all items in cart.totalTax — Total tax from all items in cart, plus global tax set in config.totalShipping — Total shipping from all items in cart.total — Total amount to be charged, sums total price, total tax and total shipping.displayTotalPrice — Total price value formatted for shop display. i.e. "$9.99" instead of just "9.99".displayTotalTax — Total tax value formatted for shop display. i.e. "$9.99" instead of just "9.99".displayTotalShipping — Total shipping value formatted for shop display. i.e. "$9.99" instead of just "9.99".displayTotal — Total amount value formatted for shop display. i.e. "$9.99" instead of just "9.99".created_at — When the cart record was created in the database.updated_at — Last time when the cart was updated.Create a Order model:
php artisan make:model Order
This will create the model file app/Order.php, edit it and make it look like (take in consideration your app's namespace):
<?php
namespace App;
use Amsgames\LaravelShop\Models\ShopOrderModel;
class Order extends ShopOrderModel
{
}
The Order model has the following main attributes:
id — Order id or order number.user_id — Owner.items — Items in order.transactions — Transactions made on order.statusCode — Status code.count — Total amount of items in order.totalPrice — Total price from all items in order.totalTax — Total tax from all items in order, plus global tax set in config.totalShipping — Total shipping from all items in order.total — Total amount to be charged, sums total price, total tax and total shipping.displayTotalPrice — Total price value formatted for shop display. i.e. "$9.99" instead of just "9.99".displayTotalTax — Total tax value formatted for shop display. i.e. "$9.99" instead of just "9.99".displayTotalShipping — Total shipping value formatted for shop display. i.e. "$9.99" instead of just "9.99".displayTotal — Total amount value formatted for shop display. i.e. "$9.99" instead of just "9.99".created_at — When the order record was created in the database.updated_at — Last time when the order was updated.Create a Transaction model:
php artisan make:model Transaction
This will create the model file app/Transaction.php, edit it and make it look like (take in consideration your app's namespace):
<?php
namespace App;
use Amsgames\LaravelShop\Models\ShopTransactionModel;
class Transaction extends ShopTransactionModel
{
}
The Order model has the following main attributes:
id — Order id or order number.order — Items in order.gateway — Gateway used.transaction_id — Transaction id returned by gateway.detail — Detail returned by gateway.token — Token for gateway callbacks.created_at — When the order record was created in the database.updated_at — Last time when the order was updated.Use the ShopUserTrait trait in your existing User model. By adding use Amsgames\LaravelShop\Traits\ShopUserTrait and use ShopUserTrait like in the following example:
<?php
use Amsgames\LaravelShop\Traits\ShopUserTrait;
class User extends Model {
use Authenticatable, CanResetPassword, ShopUserTrait;
}
This will enable the relation with Cart and shop needed methods and attributes.
cart — User's cart.items — Items (either order or cart).orders — User's orders.Laravel Shop package lets you convert any existing Eloquent model to a shoppable item that can be used within the shop without sacrificing any existing functionality. This feature will let the model be added to carts or orders. The will require two small steps:
Use the ShopItemTrait in your existing model. By adding use Amsgames\LaravelShop\Traits\ShopItemTrait and use ShopItemTrait like in the following example:
<?php
use Amsgames\LaravelShop\Traits\ShopItemTrait;
class MyCustomProduct extends Model {
use ShopItemTrait;
// MY METHODS AND MODEL DEFINITIONS........
}
Add sku (string) and price (decimal, 20, 2) fields to your model's table. You can also include name (string), tax (decimal, 20, 2) and shipping (decimal, 20, 2), although these are optional. You can do this by creating a new migration:
php artisan make:migration alter_my_table
Define migration to look like the following example:
<?php
class AlterMyTable extends Migration {
public function up()
{
Schema::table('MyCustomProduct', function($table)
{
$table->string('sku')->after('id');
$table->decimal('price', 20, 2)->after('sku');
$table->index('sku');
$table->index('price');
});
}
public function down()
{
// Restore type field
Schema::table('MyCustomProduct', function($table)
{
$table->dropColumn('sku');
$table->dropColumn('price');
});
}
}
Run the migration:
php artisan migrate
By default, Laravel Shop will look for the name attribute to define the item's name. If your exisintg model has a different attribute assigned for the name, simply define it in a property within your model:
<?php
use Amsgames\LaravelShop\Traits\ShopItemTrait;
class MyCustomProduct extends Model {
use ShopItemTrait;
/**
* Custom field name to define the item's name.
* @var string
*/
protected $itemName = 'product_name';
// MY METHODS AND MODEL DEFINITIONS........
}
You can define the URL attribute of the item by setting itemRouteName and itemRouteParams class properties. In the following example the url defined to show the product's profile is product/{slug}, the following changes must be applied to the model:
<?php
use Amsgames\LaravelShop\Traits\ShopItemTrait;
class MyCustomProduct extends Model {
use ShopItemTrait;
/**
* Name of the route to generate the item url.
*
* @var string
*/
protected $itemRouteName = 'product';
/**
* Name of the attributes to be included in the route params.
*
* @var string
*/
protected $itemRouteParams = ['slug'];
// MY METHODS AND MODEL DEFINITIONS........
}
Dump composer autoload
composer dump-autoload
Installed payment gateways can be configured and added in the gateways array in the shop.php config file, like:
'gateways' => [
'paypal' => Amsgames\LaravelShopGatewayPaypal\GatewayPayPal::class,
'paypalExpress' => Amsgames\LaravelShopGatewayPaypal\GatewayPayPalExpress::class,
],
Laravel Shop comes with PayPal support out of the box. You can use PayPal's Direct Credit Card or PayPal Express payments.
To configure PayPal and know how to use the gateways, please visit the PayPal Gateway Package page.
Install Omnipay Gateway to enable other payment services like 2Checkout, Authorize.net, Stripe and to name a few.
You might need to get some extra understanding about how Omnipay works.
Shop methods to consider:
Format prices or other values to the price format specified in config:
$formatted = Shop::format(9.99);
// i.e. this will return $9.99 or the format set in the config file.
With Laravel Shop you can customize things to work your way, although we recommend standarize your purchase or checkout flow as following (will explain how to use the shop methods below):
Before any shop method is called, a payment gateway must be set:
// Select the gateway to use
Shop::setGateway('paypal');
echo Shop::getGateway(); // echos: paypal
You can access the gateway class object as well:
$gateway = Shop::gateway();
echo $gateway; // echos: [{"id":"paypal"}]
Once a payment gateway has been selected, you can call cart to checkout like this:
// Checkout current users' cart
$success = Shop::checkout();
// Checkout q specific cart
$success = Shop::checkout($cart);
This will call the onCheckout function in the payment gateway and perform validations. This method will return a bool flag indication if operation was successful.
Once a payment gateway has been selected and user has checkout, you can call order placement like:
// Places order based on current users' cart
$order = Shop::placeOrder();
// Places order based on a specific cart
$order = Shop::placeOrder($cart);
NOTE: placeOrder() will create an order, relate all the items in cart to the order and empty the cart. The Order model doen't include methods to add or remove items, any modification to the cart must be done before the order is placed. Be aware of this when designing your checkout flow.
This will call the onCharge function in the payment gateway and charge the user with the orders' total amount. placeOrder() will return an Order model with which you can verify the status and retrieve the transactions generated by the gateway.
Payments are handled gateways, this package comes with PayPal out of the box.
You can use PayPal's Direct Credit Card or PayPal Express payments.
To configure PayPal and know how to use its gateways, please visit the PayPal Gateway Package page.
If checkout or placeOrder had errores, you can call and see the exception related:
// On checkout
if (!Shop::checkout()) {
$exception = Shop::exception();
echo $exception->getMessage(); // echos: error
}
// Placing order
$order = Shop::placeOrder();
if ($order->hasFailed) {
$exception = Shop::exception();
echo $exception->getMessage(); // echos: error
}
Critical exceptions are stored in laravel's log.
Carts are created per user in the database, this means that a user can have his cart saved when logged out and when he switches to a different device.
Let's start by calling or creating the current user's cart:
// From cart
$cart = Cart::current();
// Once a cart has been created, it can be accessed from user
$user->cart;
Note: Laravel Shop doen not support guest at the moment.
Get the cart of another user:
$userId = 1;
$cart = Cart::findByUser($userId);
Lest add one item of our test and existing model MyCustomProduct:
$cart = Cart::current()->add(MyCustomProduct::find(1));
By default the add method will set a quantity of 1.
Instead lets add 3 MyCustomProduct;
$cart = Cart::current();
$cart->add(MyCustomProduct::find(1), 3);
Only one item will be created per sku in the cart. If an item of the same sku is added, just on item will remain but its quantity will increase:
$product = MyCustomProduct::find(1);
// Adds 1
$cart->add($product);
// Adds 3
$cart->add($product, 3);
// Adds 2
$cart->add($product, 2);
echo $cart->count; // echos: 6
$second_product = MyCustomProduct::findBySKU('TEST');
// Adds 2 of product 'TEST'
$cart->add($second_product, 2);
// Count based on quantity
echo $cart->count; // echos: 8
// Count based on products
echo $cart->items->count(); // echos: 2
We can reset the quantity of an item to a given value:
// Add 3
$cart->add($product, 3);
echo $cart->count; // echos: 3
// Reset quantity to 4
$cart->add($product, 4, $forceReset = true);
echo $cart->count; // echos: 4
You can add unexistent items by inserting them as arrays, each array must contain sku and price keys:
// Adds unexistent item model PROD0001
$cart->add(['sku' => 'PROD0001', 'price' => 9.99]);
// Add 4 items of SKU PROD0002
$cart->add(['sku' => 'PROD0002', 'price' => 29.99], 4);
Lest remove our test and existing model MyCustomProduct from cart:
$product = MyCustomProduct::find(1);
// Remove the product from cart
$cart = Cart::current()->remove($product);
The example below will remove the item completly, but it is possible to only remove a certain quantity from the cart:
// Removes only 2 from quantity
// If the quantity is greater than 2, then 1 item will remain in cart
$cart->remove($product, 2);
Arrays can be used to remove unexistent model items:
// Removes by sku
$cart->remove(['sku' => 'PROD0001']);
To empty cart:
$cart->clear();
These methods can be chained:
$cart->add($product, 5)
->add($product2)
->remove($product3)
->clear();
// Checks if cart has item with SKU "PROD0001"
$success = $cart->hasItem('PROD0001');
You can place an order directly from the cart without calling the Shop class, although this will only create the order record in the database and no payments will be processed. Same ad when using Shop, the cart will be empty after the order is placed.
// This will create the order and set it to the status in configuration
$order = $cart->placeOrder();
Status can be forced in creation as well:
$order = $cart->placeOrder('completed');
Hew is an example of how to display the cart in a blade template:
Items count in cart:
<span>Items in cart: {{ $cart->count }}</span>
Items in cart:
<table>
@foreach ($cart->items as $item) {
<tr>
<td>{{ $item->sku }}</td>
<td><a href="{{ $item->shopUrl }}">{{ $item->displayName }}</a></td>
<td>{{ $item->price }}</td>
<td>{{ $item->displayPrice }}</td>
<td>{{ $item->tax }}</td>
<td>{{ $item->quantity }}</td>
<td>{{ $item->shipping }}</td>
</tr>
@endforeach
</table>
Cart amount calculations:
<table>
<tbody>
<tr>
<td>Subtotal:</td>
<td>{{ $cart->displayTotalPrice }}</td>
<td>{{ $cart->totalPrice }}</td>
</tr>
<tr>
<td>Shipping:</td>
<td>{{ $cart->displayTotalShipping }}</td>
</tr>
<tr>
<td>Tax:</td>
<td>{{ $cart->displayTotalTax }}</td>
</tr>
</tbody>
<tfoot>
<tr>
<th>Total:</th>
<th>{{ $cart->displayTotal }}</th>
<th>{{ $cart->total }}</th>
</tr>
</tfoot>
</table>
Models or arrays inserted in a cart or order are converted into SHOP ITEMS, model Item is used instead within the shop.
Model objects can be retrieved from a SHOP ITEM:
// Lets assume that the first Cart item is MyCustomProduct.
$item = $cart->items[0];
// Check if item has model
if ($item->hasObject) {
$myproduct = $item->object;
}
$item->object is MyCustomProduct model already loaded, we can access its properties and methods directly, like:
// Assuming MyCustomProduct has a types relationship.
$item->object->types;
// Assuming MyCustomProduct has myAttribute attribute.
$item->object->myAttribute;
The following shop methods apply to model Item or exiting models that uses ShopItemTrait:
$item = Item::findBySKU('PROD0001');
$item = MyCustomProduct::findBySKU('PROD0002');
// Quering
$item = Item::whereSKU('PROD0001')->where('price', '>', 0)->get();
Find a specific order number:
$order = Order::find(1);
Find orders form user:
// Get orders from specific user ID.
$orders = Order::findByUser($userId);
// Get orders from specific user ID and status.
$canceled_orders = Order::findByUser($userId, 'canceled');
You can place a transaction directly from the order without calling the Shop class, although this will only create the transaction record in the database and no payments will be processed.
// This will create the order and set it to the status in configuration
$transaction = $order->placeTransaction(
$gateway = 'my_gateway',
$transactionId = 55555,
$detail = 'Custom transaction 55555'
);
$completed = $order->isCompleted
// Checks if order is in a specific status.
$success = $order->is('completed');
// Quering
// Get orders from specific user ID.
$orders = Order::whereUser($userId)->get();
// Get orders from specific user ID and status.
$completed_orders = Order::whereUser($userId)
->whereStatus('completed')
->get();
Status codes out of the box:
in_creation — Order status in creation. Or use $order->isInCreation.pending — Pending for payment. Or use $order->isPending.in_process — In process of shipping. In process of revision. Or use $order->isInProcess.completed — When payment has been made and items were delivered to client. Or use $order->isCompleted.failed — When payment failed. Or use $order->hasFailed.canceled — When an order has been canceled by the user. Or use $order->isCanceled.You can use your own custom status codes. Simply add them manually to the order_status database table or create a custom seeder like this:
class MyCustomStatusSeeder extends Seeder
{
public function run()
{
DB::table('order_status')->insert([
[
'code' => 'my_status',
'name' => 'My Status',
'description' => 'Custom status used in my shop.',
],
]);
}
}
Then use it like:
$myStatusCode = 'my_status';
if ($order->is($myStatusCode)) {
echo 'My custom status work!';
}
Laravel Shop follows Laravel 5 guidelines to fire events, create your handlers and listeners like you would normally do to use them.
| Event | Description | Data passed |
| ------------- | ------------- | ------------- |
| Cart checkout | Event fired after a shop has checkout a cart. | id - Cart Id success - Checkout result (boolean) |
| Order placed | Event fired when an order has been placed. | id - Order Id |
| Order completed | Event fired when an order has been completed. | id - Order Id |
| Order status changed | Event fired when an order's status has been changed. | id - Order Id statusCode - New status previousStatusCode - Prev status |
Here are the events references:
| Event | Reference |
| ------------- | ------------- |
| Cart checkout | Amsgames\LaravelShop\Events\CartCheckout |
| Order placed | Amsgames\LaravelShop\Events\OrderPlaced |
| Order completed | Amsgames\LaravelShop\Events\OrderCompleted |
| Order status changed | Amsgames\LaravelShop\Events\OrderStatusChanged |
An example of how to use an event in a handler:
<?php
namespace App\Handlers\Events;
use App\Order;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Contracts\Queue\ShouldQueue;
use Amsgames\LaravelShop\Events\OrderCompleted;
class NotifyPurchase implements ShouldQueue
{
use InteractsWithQueue;
/**
* Handle the event.
*
* @param OrderPurchased $event
* @return void
*/
public function handle(OrderCompleted $event)
{
// The order ID
echo $event->id;
// Get order model object
$order = Order::find($event->id);
// My code here...
}
}
Remember to register your handles and listeners at the Event Provider:
'Amsgames\LaravelShop\Events\OrderCompleted' => [
'App\Handlers\Events\NotifyPurchase',
],
Laravel Shop has been developed for customization in mind. Allowing the community to expand its capabilities.
Missing payment gateways can be easily developed as external packages and then be configured in the config file.
Make this proyect a required dependency of your package or laravel's setup and simply extend from Laravel Shop core class, here a PayPal example:
<?php
namespace Vendor\Package;
use Amsgames\LaravelShop\Core\PaymentGateway;
use Amsgames\LaravelShop\Exceptions\CheckoutException;
use Amsgames\LaravelShop\Exceptions\GatewayException;
class GatewayPayPal extends PaymentGateway
{
/**
* Called on cart checkout.
* THIS METHOD IS OPTIONAL, DONE FOR GATEWAY VALIDATIONS BEFORE PLACING AN ORDER
*
* @param Order $order Order.
*/
public function onCheckout($cart)
{
throw new CheckoutException('Checkout failed.');
}
/**
* Called by shop to charge order's amount.
*
* @param Order $order Order.
*
* @return bool
*/
public function onCharge($order)
{
throw new GatewayException('Payment failed.');
return false;
}
}
The gateway will require onCharge method as minimun. You can add more depending your needs.
Once created, you can add it to the shop.php config file, like:
'gateways' => [
'paypal' => Vendor\Package\GatewayPaypal::class,
],
And use it like:
Shop::setGateway('paypal');
To properly generate the transaction there are 3 properties you must consider on setting during onCharge:
public function onCharge($order)
{
// The transaction id generated by the provider i.e.
$this->transactionId = $paypal->transactionId;
// Custom detail of 1024 chars.
$this->detail = 'Paypal: success';
// Order status after method call.
$this->statusCode = 'in_process';
return true;
}
transactionId — Provider's transaction ID, will help identify a transaction.detail — Custom description for the transaction.statusCode — Order status code with which to update the order after onCharge has executed. By default is 'completed'.Laravel Shop supports gateways that require callbacks. For this, you will need to add 2 additional functions to your gateway:
<?php
namespace Vendor\Package;
use Amsgames\LaravelShop\Core\PaymentGateway;
use Amsgames\LaravelShop\Exceptions\CheckoutException;
use Amsgames\LaravelShop\Exceptions\GatewayException;
class GatewayWithCallbacks extends PaymentGateway
{
/**
* Called by shop to charge order's amount.
*
* @param Order $order Order.
*
* @return bool
*/
public function onCharge($order)
{
// Set the order to pending.
$this->statusCode = 'pending';
// Sets provider with the callback for successful transactions.
$provider->setSuccessCallback( $this->callbackSuccess );
// Sets provider with the callback for failed transactions.
$provider->setFailCallback( $this->callbackFail );
return true;
}
/**
* Called on callback.
*
* @param Order $order Order.
* @param mixed $data Request input from callback.
*
* @return bool
*/
public function onCallbackSuccess($order, $data = null)
{
$this->statusCode = 'completed';
$this->detail = 'successful callback';
$this->transactionId = $data->transactionId;
// My code...
}
/**
* Called on callback.
*
* @param Order $order Order.
* @param mixed $data Request input from callback.
*
* @return bool
*/
public function onCallbackFail($order, $data = null)
{
$this->detail = 'failed callback';
// My code...
}
}
In the example above, onCharge instead of creating a completed transaction, it is creating a pending transaction and indicating the provider to which urls to call back with the payment results.
The methods onCallbackSuccess and onCallbackFail are called by Shop when the provider calls back with its reponse, the proper function will be called depending on the callback url used by the provider.
The method onCallbackSuccess will create a new transaction for the order it ends.
callbackSuccess — Successful url callback to be used by the provider.callbackFail — i.e. Failure url callback to be used by the provider.token — i.e. Validation token.Laravel Shop provides several exceptions you can use to report errors.
For onCheckout:
CheckoutException
GatewayException
StoreException — This exception will be logged in laravel, so use it only for fatal errores.For onChange, onCallbackSuccess and onCallbackFail:
GatewayException
StoreException — This exception will be logged in laravel, so use it only for fatal errores.NOTE: Laravel Shop will not catch any other exception. If a normal Exception or any other exceptions is thrown, it will break the method as it normally would, this will affect your checkout flow like in example when you want to get the order from placeOrder().
You can see the PayPal gateways we made as examples.
GatewayPayPal - Processes credit cards, uses onCheckout and onCharge.
GatewayPayPalExpress - Processes callbacks, uses onCallbackSuccess and onCharge.
Laravel Shop is free software distributed under the terms of the MIT license.
This package's architecture and design was inpired by the Zizaco/entrust package, we'll like to thank their contributors for their awesome woek.