Introduction
Introduction
- Introduction to backend admin slots
- Introduction to collections for developers
- Introduction to permissions for developers
- Introduction to transformers
- Introduction to events for developers
- Introduction to pipelines
- Introduction to the account area
- Introduction to response builders
- Introduction to listings and search
- Introduction to payment drivers
- What is an Aero Commerce Agora account and why do I need it?
- How do I obtain package repository credentials?
- Introduction to the admin
- Introduction to resource lists
- Introduction to Laravel PHP Framework
Introduction to backend admin slots
Slots allow for a module to include its own view on existing admin pages.
See our section on backend admin slots for more information.
Introduction to collections for developers
Collections are not what the developer might associate with Laravel’s immutable structure, but a collection of rules being applied to the listing on the store’s frontend.
Aero has a variety of collection rules which can alter the filters, more specifically, the search filters that usually would be modified by the customer where products are listed. These include:
Collection rules
For more information about collections please see our admin documentation for collections
Introduction to permissions for developers
As an agency, you will likely need to restrict the information and actions of admin accounts belonging to the retailer.
This is easily set up using our user configuration page. For more information please see "How do I set permissions for users?"
As a developer you can expand on these permissions in order to add anything else you may need;
Introduction to transformers
Transformers are used by the admin on some edit pages to transform data from PHP into an json encoded array that can be passed to Vue.
See our section on admin transformers for more information.
Introduction to events for developers
Events are a method of notifying different parts of Aero of tasks that have either been completed or need completing right after something has occurred. Events are only fired when a specified listener has been assigned to it and appropriately notified.
The events are always declared first in any Service Provider, while the listeners are wrapped within the event class. This is because we might need a number of listeners for a given event, each responsible for carrying out different tasks.
See our section on events for more information.
Example of an event:
<?php
namespace Aero\Account\Events;
use Aero\Account\Models\Customer;
use Aero\Events\ManagedEvent;
class CustomerUpdated extends ManagedEvent
{
public $customer;
public $customerName;
public $customerEmail;
public static $variables = [
'customer',
'customerName',
'customerEmail',
];
public function __construct(Customer $customer)
{
$this->customer = $customer;
$this->customerName = $customer->name;
$this->customerEmail = $customer->email;
}
public function getNotifiable()
{
return $this->customer;
}
}
Introduction to pipelines
Pipelines provide a convenient way to manipulate a given payload. This payload can be an object or a simple string.
See our section on pipelines for more information
Introduction to the account area
The account area provides an extendable area where your customers can view their orders and manage their accounts.
See our section on the account area for more information.
Introduction to response builders
Response builders are Aero's unique solution to serving storefront pages. Based on the concept of pipelines used in Laravel middleware
See our section on response builders for more information.
Introduction to listings and search
Aero offers out-of-the-box listings and search system which is powered by Elasticsearch
Please note the Elasticsearch version is 6.8.
See our section on listings and search for more information.
Introduction to payment drivers
A payment driver is the brain behind the payment method and serves as a bridge to the payment gateway. Whilst there are several integrations that are maintained by the Aero team, a store may require a bespoke integration in order to meet the requirements of a retailer.
See our section on payment drivers for more information.
What is an Aero Commerce Agora account and why do I need it?
To get started you'll need an Agora account.
Your Agora account is used to download the platform and create projects. You can register for an account here
Projects are assigned unique credentials which allows them to purchase themes and modules. These credentials must not be shared between projects as doing so will invalidate them.
Without valid credentials, a project cannot receive platform updates and security fixes.
How do I obtain package repository credentials?
Once logged in to Agora, head over to the projects section and click the New project button. You'll need to give the project a name, for example, the website name or your client's company. In the example below, we've used a fictional company of "Acme Inc".
A domain is optional at this point; you can enter this later when the project is ready to go live. Click the "create new project" button to create the project.
Your new project now appears in the list of projects along with the package repository credentials.
Introduction to the admin
The backend admin (the "admin") is the password-protected back office where administrative tasks can be performed. This includes managing the store's catalog (products, categories, manufacturers, etc.), viewing and processing orders, managing discounts, viewing reports, editing the content of the storefront (promotional imagery, menus and SEO content, etc.), and much more.
Introduction to resource lists
Resource lists allow a table to be extended through additional columns, filters, or sort bys and for bulk actions to be applied.
Please see our section on resource lists for more information.
Introduction to Laravel PHP Framework
The Aero platform is built using the Laravel PHP framework
Before developing with Aero, we recommend that you become acquainted with the core concepts of Laravel. We recommend the following resources:
The official Laravel documentation is a great place to start.
Laracasts offer an on‑demand library of screencast video tutorials.