Resource Lists

What are the available resource lists?
How do I create a custom resource list?
How do I add a column to an existing resource list?
How do I add a filter to an existing resource list?
How do I add a sort by to an existing resource list?
How do I create a custom bulk action?
How do I add a bulk action to an existing resource list?

What are the available resource lists?

Class	View
`\Aero\Admin\ResourceLists\AttributeGroupsResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\BlocksResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\CategoriesResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\CollectionsResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\CombinationsResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\CountriesResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\CountryGroupsResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\CurrenciesResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\CustomerGroupsResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\CustomersResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\CustomerTaxGroupsResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\DeletedProductsResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\DiscountsResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\ExportLogsResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\FlagsResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\FulfillmentMethodsResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\FulfillmentsResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\LocationsResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\MailNotificationsResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\ManufacturersResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\MissingPagesResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\OrderReturnReasonGroupsResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\OrdersResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\OrderStatusesResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\OrderStatusGroupsResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\PagesResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\PaymentMethodsResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\PriceListsResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\ProductsResourceList`	`admin::catalog.products.index`
`\Aero\Admin\ResourceLists\ProductTaxGroupsResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\ProductTypesResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\RedirectsResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\SettingDefinitionsResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\ShippingMethodsResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\SubscriptionActionsResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\SubscriptionPlansResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\SubscriptionsResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\TagGroupsResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\TaxRatesResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\TaxRulesResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\UsersResourceList`	`admin::resource-lists.index`
`\Aero\Admin\ResourceLists\VouchersResourceList`	`admin::resource-lists.index`

How do I create a custom resource list?

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

class OrdersResourceList extends \Aero\Admin\ResourceLists\AbstractResourceList
{
   //
}

Your controller should be like this example but for your new resource list:

class OrdersController extends \Aero\Admin\Http\Controllers\Controller
{
   public function index(\Aero\Admin\ResourceLists\OrdersResourceList $list, \Illuminate\Http\Request $request)
   {
       return view('admin::resource-lists.index', [
           'list' => $list = $list(),
           'results' => $list->apply($request->all())
               ->with('status', 'customer', 'items', 'currency')
               ->paginate($request->input('per_page', 24) ?? 24),
       ]);
   }
}

Columns

To add columns to your resource list you need to implement the protected columns() method and make it return an array of your columns.

The entries in the array should use the Aero\Admin\ResourceLists\ResourceListColumn::create() helper method. This method expects a string parameter for the columns heading, a closure parameter for how to render the columns data (this can return a string), and an optional string parameter for the columns key (by default this is generated from the columns header):

class OrdersResourceList extends \Aero\Admin\ResourceLists\AbstractResourceList
{
    protected function columns(): array
    {
        return [
            \Aero\Admin\ResourceLists\ResourceListColumn::create('Order', function ($row) {
                return view('admin::resource-lists.link', [
                    'route' => route('admin.orders.view', array_merge(request()->all(), ['order' => $row])),
                    'text' => '#'.$row->reference,
                ])->render();
            }),
        ];
    }
}

Searchable Columns

You can use the setSearchAction() method to define how your column is searched:

ResourceListColumn::create('Order', function ($row) {
    return view('admin::resource-lists.link', [
        'route' => route('admin.orders.view', array_merge(request()->all(), ['order' => $row])),
        'text' => '#'.$row->reference,
    ])->render();
})
->setSearchAction(function ($query, $term) {
    $searchTerm = ltrim($search, '#');
  
    $query->whereLower('reference', 'like', "%{$searchTerm}%");
}, 'Order Reference')

Invisible Columns

You can use the invisible() method to make a column invisible. This can be useful if wanting to add a search action but not display the relevant data.

Rows

Row views are additional rows rendered after each complete row (the best example of this is how the order items are listed after each row of the order on the orders page). To add a row view you simply need to provide your view in the protected $rowViews array:

class OrdersResourceList extends \Aero\Admin\ResourceLists\AbstractResourceList
{
    protected $rowViews = [
        'admin::resource-lists.orders.items',
    ];
}

Default Search

When your resource list is searched without a specific column being selected a handleSearch() method will be called to handle searching.

The method will be passed the search term and you can use $this->query to access the query:

class OrdersResourceList extends \Aero\Admin\ResourceLists\AbstractResourceList
{
    protected function handleSearch($search)
    {
        $searchTerm = ltrim($search, '#');

        $this->query->whereLower('reference', 'like', "%{$searchTerm}%");
    }
}

Buttons

Most resource list pages will require a create button, typically a create resource button. You can easily add buttons to the top of your resource list page by defining a header slot. Once you have defined a header slot you can inject your view using the admin slots helper.

class OrdersResourceList extends \Aero\Admin\ResourceLists\AbstractResourceList
{
    protected $headerSlot = 'orders.index.header.buttons';
}

See here for how to inject into admin slots.

Filters

To add a filter to your resource list, simply add it to the $filters array:

class OrdersResourceList extends \Aero\Admin\ResourceLists\AbstractResourceList
{
    protected $filters = [
        \Aero\Admin\Filters\Order\OrderStatusAdminFilter::class,
    ];
}

See here for how to create an existing admin filter, or here for how to create a custom filter.

Sort Bys

To add sort bys to your resource list you need to implement the protected sortBys() method and make it return an array of your sort bys.

The entries in the array should use the Aero\Admin\ResourceLists\ResourceListSortBy::create() helper method. This method expects an array parameter holding the dropdown options that will be shown in the frontend dropdown, and a closure that will be executed when the sort option is active:

class OrdersResourceList extends \Aero\Admin\ResourceLists\AbstractResourceList
{
    protected function sortBys(): array
    {
        return [
            // Default sort by
            \Aero\Admin\ResourceLists\ResourceListSortBy::create(null, function ($sortBy, $query) {
                return $query->orderByRaw('coalesce(`orders`.`ordered_at`, `orders`.`created_at`) desc');
            }),

            \Aero\Admin\ResourceLists\ResourceListSortBy::create([
                'order-az' => 'Order A to Z',
                'order-za' => 'Order Z to A',
            ], function ($sortBy, $query) {
                return $sortBy === 'order-az' ? $query->orderBy('reference') : $query->orderByDesc('reference');
            }),
        ];
    }
}

How do I add a column to an existing resource list?

You can use the addColumn() method(s) to add a column to an existing resource list:

\Aero\Admin\ResourceLists\OrdersResourceList::extend(function (\Aero\Admin\ResourceLists\OrdersResourceList $list, \Closure $next) {
    // Add it as the first column
    $list->addColumn('Header', function($row) {
        return 'Content';
    });

    // Add it after a specific column
    $list->addColumnAfter('Header', function($row) {
        return $row->reference;
    }, 'customer');

    // Add it before a specific column
    $list->addColumnBefore('Header', function($row) {
        return $row->reference;
    }, 'customer');

    return $next($list);
});

If you need to see the keys of the existing columns in order to position your new column appropriately, you can dump them out:

\Aero\Admin\ResourceLists\OrdersResourceList::extend(function (\Aero\Admin\ResourceLists\OrdersResourceList $list, \Closure $next) {
    dd($list->getColumns()->map->key());

    return $next($list);
});

How do I add a filter to an existing resource list?

You can use the addFilter() method to add a filter to an existing resource list:

\Aero\Admin\ResourceLists\OrdersResourceList::extend(function (\Aero\Admin\ResourceLists\OrdersResourceList $list, \Closure $next) {
    $list->addFilter(\Aero\Admin\Filters\Order\OrderStatusAdminFilter::class);

    return $next($list);
});

How do I add a sort by to an existing resource list?

You can use the addSortBy() method to add a filter to an existing resource list:

\Aero\Admin\ResourceLists\OrdersResourceList::extend(function (\Aero\Admin\ResourceLists\OrdersResourceList $list, \Closure $next) {
    $list->addSortBy(\Aero\Admin\ResourceLists\ResourceListSortBy::create([
        'latest' => 'Latest',
        'oldest' => 'Oldest',
    ], function ($sortBy, $query) {
        return $sortBy === 'oldest' ? $query->orderBy('created_at') : $query->orderByDesc('created_at');
    }));

    return $next($list);
});

How do I create a custom bulk action?

You can create a class that extends \Aero\Admin\BulkActions\BulkActionJob and implement a handle method:

class DeleteProductsBulkAction extends \Aero\Admin\BulkActions\BulkActionJob
    implements \Illuminate\Contracts\Queue\ShouldQueue
{
    protected $list;

    public function __construct(\Aero\Admin\ResourceLists\ProductsResourceList $list)
    {
        $this->list = $list;
    }

    public function handle(): void
    {
        $this->list->items()->each(static function (\Aero\Catalog\Models\Product $product) {
            $product->delete();
            event(new \Aero\Catalog\Events\ProductDeleted($product));
        });
    }
}

You should implement \Illuminate\Contracts\Queue\ShouldQueue if you want the bulk action to be queued.

How do I add a bulk action to an existing resource list?

\Aero\Admin\BulkAction::create(
  \Aero\Admin\BulkActions\DeleteProductsBulkAction::class, 
  \Aero\Admin\ResourceLists\ProductsResourceList::class
)
->title('Delete products')
->permissions('products.delete')
->confirm();

See here for how to create a custom bulk action.

Methods

Method	Description
`notRunnable()`	Removes the `run` button from the bulk action, intention being you replace this with a custom button.
`wideContent()`	Displays bulk action view in a wider container.
`confirm()`	Prompts the user to confirm running the bulk action.
`confirmTitle(string $title)`	Sets the title of the confirmation popup. Default is "Are you sure?
`confirmText(string $text)`	Sets text in the confirmation popup. Default is no text.
`confirmButtonText(string $text)`	Sets the confirmation popup confirm button text. Default is "Yes".
`title(string $title)`	Sets the title of the bulk action.
`processingText(string $text)`	Sets the processing text (shown when a bulk action is queued). Default is `__('Bulk action is being processed')`.
`successText(string $text)`	Sets the success text (shown when a bulk action is ran). Default is `__('Bulk action has been processed')`.
`view(string $view)`	Sets a view for the bulk action to redirect to when ran. Allows options to be provided that are required for the bulk action to run.
`group(string $group)`	Sets the group of the bulk action, used when they're displayed to order them.