626 results
for “install a theme”
Sorted by relevance
Developer Documentation / Payment Drivers
How do I capture a payment in my payment driver?
If the gateway provides the option to defer capturing the payment (authorising and capturing are performed at different times), the
capturemethod should be implemente ...d. This captured amount may be equal to or less than the authorised amount, and is ...
Developer Documentation / Php Traits
Aero\\Common\\Traits\\CastsToJavaScript
This trait can be added to a model class. This trait provides a way of defining attributes that should be kept when casting to javascript. You can define these attributes in a protected $castsToJsarray. The trait adds the following methods:
static addCastToJs Method
This stat...
Order Management / Orders
How do I create a new return or refund?
...rn things, sometimes for legitimate reasons, other times well, we’re no ...t here to talk about that.
Fortunately, Aero is ready to handle even the most complex refun ...ds and returns. In order to process a refund of return we start by heading over to the orders...
Developer Documentation / Payment Drivers
How do I return a payment response in my payment driver?
To unify all payment gateway driver communication, an
Aero\Payment\Responses\PaymentResponseclass is used. This common class must be returned from the
re ...gister,
complete,
capture,
refundand
cancelmethods.
Setting the payment view
Many payment gateways...
Admin / Configuration Page
How do I extend the configuration page?
The configuration page can be extended to customise exist ...ing configuration groups, add new configurations, or register entirely new ...configuration groups.
Configuration groups and configurations are built using a pipeline, allowing you to modif...
Developer Documentation / Admin Reports
How do I create a custom report?
To create and register a custom report you need to use t ...he Aero\Admin\AdminReportfacade inside of your app service providers boot method ...ce providers setup method.
The facade requires a class that extends Aero\Admin\Reports\Report. Additionall...
Search / Listings
How do I create a custom sort order for the listings pages?
When you set the sort get parameter in a listing pages url (e.g. ?sort=name-az), a method is called on the
\Aero\Search\Elastic\Query\Builder class (for name-az the method
sortByNameAz is called).
You can find the default sort by methods in the
Aero...
Developer Documentation / Php Traits
Aero\\Admin\\Traits\\HasPermissions
This trait adds the ability to add permissions to a class easily. The trait adds the following methods:
permi ...ssions Method
This method accepts an array that will set the permissions requi ...red.
allowed Method
This method optionally accepts a user and will retu...
Storefront Developer Documentation / Themes
How do I use a custom Vue component in the storefront?
This repo (https://github.com/aerocargo/example-vue
You need to make your component .vuefile(s) and your main .jsfile that will register all of the components. An example javascript structure can be found here in the repo (htt ...ps://github.com/aerocargo/example-vue/tree/master...
Developer Documentation / Listings And Search
How do I re-index listing and search documents?
Aero automatically manages indexing changes to documents. For example, if a proa product's stock level changes the document is updated to reflect the current versi ...on. Adding and removing documents is also taken care of for you, sparing the need to schedule in dai...
Catalog Management / Tags
What is a tag?
Tags are a convenient way to group products together. Th ...ey allow you to associate products for customers conven ...ience, this includes:
Creating selected lists - E.g. edito ...rs picks or seasonal recommendations - Associating similar colours - E.g...
Developer Documentation / Response Builders
How do I pass data to a response?
The most common task performed when extending resp ...onses, is setting additional data. Typically, for HTML responses that render from a view, this involves sending data to the view to be used as a variable. If the response returns JSO ...N, it may be adding additional key/value...
Developer Documentation / Admin Reports
How do I add lenses to my custom report?
You need to create a class for your lens that extends Aero\Admin\Reports\ReportLensand implements the required publi ...c value function. The value function will return a string used to display your lens.
<?php
namespace Acme\MyModule\Reports\Lenses;...
Developer Documentation / General
How to Set the Page Title for the Admin
By default the page title for every admin page is generated from the route name. If you would like to manually set the page title you can set a title specifically for your route or you can return an
adminPageTitlevariable to your view (this includes ...
API / Attribute Groups
Create Attribute Group Endpoint
Structure
Attribute Group
Name
Type
Description
Required
id
...int
The id for the attribute group
No
name
string
The name of the attribute group (e.g., Size or Co ...lour)
Yes
display_as
string
The display as of the attribute group (e.g.: dropdown, ...
API / General
What conventions does the API use?
Attribute Conventions
Keys generally match the attribute name on their respective models.
E ...xception: Attributes ending in "_code" shou ...ld omit the suffix when passed to the API, e.g.
currency_code =>
curr ...ency
Relationship Conventions
Nested data...
Developer Documentation / General
What queues does Aero use?
Queues are used so that HTTP requests can remain snappy and more intensive code can be executed later. You can learn more about queues here
Queue
Descripti ...on
search
This queue has search jobs. The majority of these jobs will be res ...ible for reindexing listings.
email
This queue has email jobs. Wh...
Order Management / Orders
How do I change the status of an order?
We can change the status of an order at any time.
To do so there are a couple of ways we can do it. Firstly we could click ...into the order, locate the “Order Information” section and click the ellipsis (...) butt ...on to be presented with the statuses available. Next click the ...