Developer Documentation

The following classes are in the Aero\AccountArea\Http\Responsesnamespace. Class Route Descriptio...

The following classes are in the Aero\AccountArea\Http\Responsesnamespace. Class Method Route Acc...

The following classes are in the Aero\AccountArea\Http\Formsnamespace. Class Description AccountA...

You can inject into account area slots using the Aero\AccountArea\AccountAreaSlot::injectmethod. ...

ENV Variables Variable Default Description AERO_ACCOUNT_AREA_THEME aerocommerce/account-area Defi...

To create and register a custom account area page you need to use the **Aero\AccountArea\AccountA...

Forms can be extended using a pipeline from your modules service providers setup method or your p...

Sets are used for POST/PUT/DELETE requests. To create and register a custom account area set you ...

Account Area Pages/Sets are Response Builders (link) which means that they can be extended using ...

You can add a custom CSS file to the account area by creating a file named account-area.cssin yo...

To create a form you need to create a class that extends the AccountAreaFormclass. The $section...

The following slots can be injected into. orders.order.card.header- orders.order.card.dispatched...

The default dashboard lenses are stored in the admin configuration file as an array called dashbo...

Dashboard lenses are the blocks of content that make up the interactive part of the admin dashboa...

To create a dashboard lens you need to create a class that extends Aero\Admin\AdminLensand imple...

You can optionally make your dashboard lens use a custom view. To do this you need to set the pro...

To add your custom dashboard lens to the dashboard you need to register it with the admin and the...

You are able to extend Aero\Admin\Http\Responses\AdminDashboardPageand use the removeLensmethod. ...

Admin filters are the filters that populate the sidebars of reports and resource lists. As the na...

To create a custom admin filter you need to create a class that extends Aero\Admin\Filters\AdminF...

To create a checkbox list admin filter you need to create a class that extends Aero\Admin\Filters...

The options date range admin filter works in the same way as the date range admin filter but disp...

To create an options date range admin filter you need to create a class that extends Aero\Admin\F...

To create a date range admin filter you need to create a class that extends Aero\Admin\Filters\Da...

To create an options date range admin filter you need to create a class that extends Aero\Admin\F...

The Product Picker provides a modal that lets users select a single or many products/variants wit...

Prop Type Description get-products-url String This is the only required prop. This is the URL for...

Event Description products-selected This event emits when the action button is clicked (bottom ri...

To create and register a custom report you need to use the Aero\Admin\AdminReportfacade inside of...

You need to create a class for your lens that extends Aero\Admin\Reports\ReportLensand implements...

You need to create a class for your table that extends Aero\Admin\Reports\ReportTableand implemen...

To add an exporter to your report you need to ensure the report uses the Aero\Admin\Reports\Trait...

Reports can be extended using a pipeline from your modules service providers setup method or your...

You need to create an Admin Filter class as shown in the article "How do I create a custom report...

For more information about using backend admin slots please see our article "How do I inject a vi...

Any view you wish to inject into a slot should be defined in a Service Provider. If the code is u...

The following classes are in the Aero\Admin\Transformersnamespace. Class Description AttributeTra...

To add custom data you need to use the static **add()**method on the relevant transformer. This m...

Clips is a plugin for the Redactor editor that allows you to create a list of frequently used cod...

When in an admin's Blade view file you can use any Vue directive (such as v-for, v-if, @clicke...

This repo (https://github.com/aerocargo/admin-example-vue You need to add the assetLinksfunction...

In order to export content blocks, we will require an Aero package. To install this package, type...

In order to export content blocks, we require an Aero package. To install this package, type the ...

Whilst the layout of the storefront is dictated by the theme, the displayed content is managed th...

// add a single permission \Aero\Admin\Permissions::add('custom'); // add multiple permissions \A...

When checking for permission, you should always be as explicit as you can. For example, checking ...

You can set an order reference generator to define how order references are generated. To do this...

The robots.txt file provides instructions for web crawlers and bots that index your store. Aero a...

You need to configure and set up your Laravel project for the S3 storage driver. You can read mor...

By default if a product name doesn’t contain the manufacturer name already, the manufacturer name...

The manufacturer name is automatically prepended to the product slug (its URL). If you wish for t...

Yes, Homestead is supported on Windows, Mac or Linux provided your Vagrant box configuration meet...

No, Credentials must not be shared between projects.

Yes, the Aero platform is built on top of the Laravel framework. Knowledge of Laravel is not esse...

Aero supports both Elasticsearch 6.x and 7.x. Support for Elasticsearch 6.x is provided by the 0....

Aero requires PHP Version 7.2 and above.

Due to the number of fields that are sometimes present in the admin, it may be necessary to adjus...

To create a new listener class for one of our events, we can use Artisan to scaffold the listener...

Account AddressCreated - AddressDeleted - AddessUpdated - CustomerManualylCreated - CustomerRegis...

Laravel events provide an observer implementation, allowing you to listen and observe for specifi...

Event listeners, as the name suggests, listen to events that have been assigned to them. This mea...

To create a new event, we first have to scaffold the class using Artisan in the project root dire...

To create an event that shows up in the Mail Notifications part of the admin your event needs to ...

All models provided as part of the Aero core platform are Eloquent models For example, if a modul...

In this mini tutorial we will add a notes field to the product new and edit page for the product ...

php artisan make:module This command scaffolds a module for you (you need to provide a valid name...

This short tutorial will walk you through adding an address line 3 field to all of the address fo...

Aero has address forms in the checkout, account-area, and admin that can be extended. Storefront ...

This tutorial will explain the steps required to add settings to your model and assumes you have ...

In this mini tutorial we will add some checkboxes to the product page that when checked add an ad...

You can control if a collection of slugs is valid or not by setting your own validator: \Aero\Sto...

If you do not want your route to require a valid CSRF token Code To add a route to the exceptions...

Queues are used so that HTTP requests can remain snappy and more intensive code can be executed l...

By default the page title for every admin page is generated from the route name. If you would lik...

Generating the taxonomy Generating the taxonomy table is a required task after we’ve initially in...

Google categories can be assigned to categories, or directly to the product. It can be set up eit...

To export the feed we need to navigate into the module’s section in the admin, and then to Google...

In order to generate a Google Shopping feed, it is necessary to install an Aero dependency in for...

Before continuing, please ensure your Mac is running macOS Mojave (10.14) or newer. There are a c...

Homestead We are currently unable to offer support for the configuration of Homestead, or any iss...

Your system must satisfy the following requirements: PHP (>= 7.2) with BCMath, Ctype, JSON, Mbstr...

Slots allow for a module to include its own view on existing admin pages. See our section on back...

Collections are not what the developer might associate with Laravel’s immutable structure, but a ...

As an agency, you will likely need to restrict the information and actions of admin accounts belo...

Transformers are used by the admin on some edit pages to transform data from PHP into an json enc...

Events are a method of notifying different parts of Aero of tasks that have either been completed...

Pipelines provide a convenient way to manipulate a given payload. This payload can be an object o...

The account area provides an extendable area where your customers can view their orders and manag...

Response builders are Aero's unique solution to serving storefront pages. Based on the concept of...

Aero offers out-of-the-box listings and search system which is powered by Elasticsearch Please no...

A payment driver is the brain behind the payment method and serves as a bridge to the payment gat...

To get started you'll need an Agora account. Your Agora account is used to download the platform ...

Once logged in to Agora, head over to the projects section and click the New project button. You'...

The backend admin (the "admin") is the password-protected back office where administrative tasks ...

Resource lists allow a table to be extended through additional columns, filters, or sort bys and ...

The Aero platform is built using the Laravel PHP framework Before developing with Aero, we recomm...

When you set the sort get parameter in a listing pages url (e.g. ?sort=name-az), a method is call...

There are 2 documents available: Aero\Search\Elastic\Documents\ListingsDocument This document is ...

Aero automatically manages indexing changes to documents. For example, if a product's stock level...

Faceted navigation in eCommerce allows customers the ability to refine down a catalog of products...

Firstly, you should ensure that the Elasticsearch host information is defined in the store's .env...

At times (especially during the development phase of a store build), it may be necessary to delet...

One of the most useful features of the listings and search system is the ability to add custom da...

There may be occasions where you need to pre-filter listings. For example, you may want to ensure...

The Aero\Search\Elastic\Models\Listingmodel is built up from an array of data returned from elas...

To register a Vue component for our module, we will need to create a JavaScript file for our comp...

└─ module └─ database └─ migrations └─ public └─ resources ...

When interacting with the admin, especially when making a custom module, it is important to requi...

There are a few necessary steps to create and properly configure module routing. Creating routes ...

All payment gateway drivers must implement the Aero\Payment\Contracts\PaymentDriverinterface. Th...

here are two types of capturing methods: Automatic– the payment is both authorised and captured w...

If capturing of the payment is done at a later stage to the initial authorisation, the payment ga...

If the gateway provides the option to defer capturing the payment (authorising and capturing are ...

If the payment gateway provides the ability to externally make refund requests, the payment drive...

There are two modes a gateway can operate: ECOM– a standard ecommerce online transaction, typical...

If the payment gateway stores customer information, this can be used to populate the contact info...

It is likely that a payment gateway could have restrictions on when it can be used. For example, ...

To unify all payment gateway driver communication, an Aero\Payment\Responses\PaymentResponseclas...

When a payment method is selected that uses the gateway driver, the registermethod is called. Wi...

Once the payment gateway has handled the customer inputting their secure details (such as card in...

To improve brand awareness of the payment provider during the checkout process, a label view can ...

It is likely that a payment gateway could have restrictions on when it can be used. For example, ...

A cash payment method is provided out of the box, which allows developers to complete orders thro...

There may be circumstances where a retailer wishes to restrict the payment methods that are avail...

This trait can be added to a model class. When added your model will have the ability to have fil...

This trait can be added to a model class. This trait provides a way of defining attributes that s...

This trait can be added to a model class. The trait adds a relationship to Aero\Store\Models\Slug...

This trait can be added to a model class. The trait adds the ability to add tags to the model. Th...

This trait can be added to a model class. When added your model will have the ability to have add...

This trait can be added to a model class. This trait adds prices to the model. The trait adds the...

This trait can be added to a model class. The trait adds a relationship to ​​Aero\Store\Models\Se...

This trait can be added to a response builder class. It adds useful methods for managing sections...

This trait adds the ability to add permissions to a class easily. The trait adds the following me...

This trait can be added to a class. This trait can be used on Pipelines (more information "introd...

Class Description Payload CartItemBuilder The process that occurs when adding an item to the cart...

The payload data can be altered using the **extend()**method. This is typically done from within ...

If we wish to add a new bulk action to a screen within the admin, all we have to do is create the...

The following classes are in the Aero\Admin\ResourceListsnamespace and any class that doesn’t hav...

To create a resource list you need a normal Laravel controller and a class that extends Aero\Admi...

Adding a New Column To add columns to a resource list you can use the addColumn, addColumnBefore,...

A bulk action allows for the selection of multiple values from a list, and apply some logic to it...

As the products list is a resource list you can add a custom column like this: More information o...

As the orders list is a resource list you can add a custom column like this: More information on ...

All response builders hold properties that were assigned to them upon creation from the request. ...

The most common task performed when extending responses, is setting additional data. Typically, f...

Sometimes you may wish to redirect the user to another location, either to an external site or wi...

There may be situations where the HTTP response status needs to be altered. By default, the retur...

When extending the response builder, you can set HTTP headers to be sent with the response: \Aero...

Since Aero does not expose the underlying routes and controllers, middleware can be attached dire...

Adding additional code to run on the response is as simple as calling the **extend()**method on t...

For responses that return HTML, a Twig view file is used. Whilst these are originally defined, th...

Core Class Description View Homepage The homepage of the store. homepage.twig ProductPage The pro...

Settings allow you to add dynamic values to your modules that can be modified by admin users easi...

You can add a default value to any setting by using the defaultmethod and passing your default va...

To register settings you need to use the Aero\Common\Facades\Settingsfacade from the setupmethod ...

You can access a setting by using the settingfunction that is available in PHP, Blade, and Twig. ...

Setting Description $group->array(‘allow_list’); Returns an array. $group->boolean(‘enabled’); Re...

By default your setting group is editable through the admin by a generated edit page. You cannot ...

When defining your setting groups title/summary, or a settings label/hint you can make use of Lar...

Using the same syntax as when you create settings <?php namespace Acme\MyModule; use Aero\Catalog...

To create a custom validation request, we need to extend the AeroRequestabstract class that’s loc...

To use a custom validation request, we have to replace the request that is passed to the controll...

There are multiple ways of displaying your validation errors. From the backend perspective, the r...

Example: <?php namespace Aero\Store\Http\Requests; use Aero\Common\Requests\AeroRequest; class Up...

You can define logic that will be used to confirm if a shipping method is available for a specifi...

You can override the default logic that decides whether a shipping rate is applicable to an order...

Setting a custom item price totalizer allows you to define the logic used to get the total price ...

Setting a custom item weight totalizer allows you to define the logic used to get the total weigh...