Download the PHP package tenstone/laravel-shop without Composer

LARAVEL SHOP (Laravel 5.1 Package)

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

Contents

• Scope
• Installation
• Configuration
  • Database Setup
  • Models Setup
    • Item
    • Cart
    • Order
    • Transaction
    • User
    • Existing Model Conversion
  • Dump Autoload
  • Payment Gateways
    • PayPal
    • Omnipay
• Usage
  • Shop
    • Purchase Flow
    • Payment Gateway
    • Checkout
    • Order placement
    • Payments
    • Exceptions
  • Shopping Cart
    • Adding Items
    • Removing Items
    • Placing Order
    • Cart Methods
    • Displaying
  • Item
  • Order
    • Placing Transactions
    • Order Methods
  • Events
    • Handler Example
• Payment Gateway Development
  • Transaction
  • Callbacks
  • Exceptions
• License
• Additional Information
• Change Log

Scope

Current version includes:

• Shop Items (transforms existing models into shoppable items that can be added to cart and orders)
• Cart
• Orders
• Transactions
• Payment gateways support
• PayPal
• Events

On the horizon:

• Guest user cart
• Shipping orders
• Coupons
• Product and variations solution
• Backend dashboard
• Frontend templates

Installation

With composer

Or add

to your composer.json. Then run composer install or composer update.

Then in your config/app.php add

in the providers array.

Then add

in the aliases array.

Configuration

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:

A shop.php file will be created in your app/config directory.

Database Setup

Generate package migration file:

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:

Add the seeder to database/seeds/DatabaseSeeder.php:

Run seeder (do composer dump-autoload first):

Models

The following models must be created for the shop to function, these models can be customizable to fir your needs.

Item

Create a Item model:

This will create the model file app/Item.php, edit it and make it look like (take in consideration your app's namespace):

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.

Cart

Create a Cart model:

This will create the model file app/Cart.php, edit it and make it look like (take in consideration your app's namespace):

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.

Order

Create a Order model:

This will create the model file app/Order.php, edit it and make it look like (take in consideration your app's namespace):

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.

Transaction

Create a Transaction model:

This will create the model file app/Transaction.php, edit it and make it look like (take in consideration your app's namespace):

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.

User

Use the ShopUserTrait trait in your existing User model. By adding use Amsgames\LaravelShop\Traits\ShopUserTrait and use ShopUserTrait like in the following example:

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.

Existing Model Conversion

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:

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:

Define migration to look like the following example:

Run the migration:

Item name

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:

Item url

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:

Dump Autoload

Dump composer autoload

Payment Gateways

Installed payment gateways can be configured and added in the gateways array in the shop.php config file, like:

PayPal

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.

Omnipay

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.

Usage

Shop

Shop methods to consider:

Format prices or other values to the price format specified in config:

Purchase Flow

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):

• (Step 1) - User views his cart.
• (Step 2) - Continues into selecting the gateway to use.
• (Step 3) - Continues into feeding the gateway selected with required information.
• (Step 4) - Checkouts cart and reviews cart before placing order.
• (Step 5) - Places order.

Payment Gateway

Before any shop method is called, a payment gateway must be set:

You can access the gateway class object as well:

Checkout

Once a payment gateway has been selected, you can call cart to checkout like this:

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.

Order Placement

Once a payment gateway has been selected and user has checkout, you can call order placement like:

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

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.

Exceptions

If checkout or placeOrder had errores, you can call and see the exception related:

Critical exceptions are stored in laravel's log.

Shopping Cart

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:

Note: Laravel Shop doen not support guest at the moment.

Get the cart of another user:

Adding Items

Lest add one item of our test and existing model MyCustomProduct:

By default the add method will set a quantity of 1.

Instead lets add 3 MyCustomProduct;

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:

We can reset the quantity of an item to a given value:

Adding Unexistent Model Items

You can add unexistent items by inserting them as arrays, each array must contain sku and price keys:

Removing Items

Lest remove our test and existing model MyCustomProduct from cart:

The example below will remove the item completly, but it is possible to only remove a certain quantity from the cart:

Arrays can be used to remove unexistent model items:

To empty cart:

These methods can be chained:

Cart Methods

Placing Order

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.

Status can be forced in creation as well:

Displaying

Hew is an example of how to display the cart in a blade template:

Items count in cart:

Items in cart:

Cart amount calculations:

Item

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:

$item->object is MyCustomProduct model already loaded, we can access its properties and methods directly, like:

The following shop methods apply to model Item or exiting models that uses ShopItemTrait:

Order

Find a specific order number:

Find orders form user:

Placing Transactions

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.

Order Methods

Order Status Codes

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:

Then use it like:

Events

Laravel Shop follows Laravel 5 guidelines to fire events, create your handlers and listeners like you would normally do to use them.

Here are the events references:

Event Handler Example

An example of how to use an event in a handler:

Remember to register your handles and listeners at the Event Provider:

Payment Gateway Development

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:

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:

And use it like:

Transaction

To properly generate the transaction there are 3 properties you must consider on setting during onCharge:

• 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'.

Callbacks

Laravel Shop supports gateways that require callbacks. For this, you will need to add 2 additional functions to your gateway:

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.

Exceptions

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().

Examples

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.

License

Laravel Shop is free software distributed under the terms of the MIT license.

Additional Information

This package's architecture and design was inpired by the Zizaco/entrust package, we'll like to thank their contributors for their awesome woek.

Change Log

• v0.2.8