Laravel/Execute commands

From Aimeos documentation

Laravel
Other languages:
English 100%


The Aimeos Laravel package provides some commands that can be executed from the command line shell. These commands are available:

Technically, they are implemented as Artisan commands which can be executed from the base directory for your Laravel application via:

  1. php artisan aimeos:<name> ...

Clear the content cache

For best performance, Aimeos caches the generated HTML of the components as long as the cache manager configuration option isn't set to "None". The cached HTML snippets are invalidated if their content is changed but sometimes you might want to clear the complete cache at once:

  1. php artisan aimeos:cache [<site>]

The aimeos:cache command accepts an optional site code or list of site codes separated by white spaces. If no site code in given, the content caches of all sites are cleared.

Execute a job task

Running a shop requires several tasks that need to be executed regularly such as sending notification e-mails, updating the catalog index, and exporting orders to the ERP system. The "aimeos:jobs" command is able to perform these tasks by calling the appropriate core job controllers. More details about the required jobs and their setup is available in the article about configuring the cronjobs.

  1. php artisan aimeos:jobs <jobs> [<site>]

At least one job name is required but you can hand over several job names at once if you separate them via white spaces. By executing php artisan help aimeos:jobs more details about the options is displayed.

The aimeos:jobs command accepts an optional site code or list of site codes separated by white spaces. If no site code in given, the jobs are executed for all sites.

Setup the database

Creating the required database structure for Aimeos is normally done automatically as soon as you execute "composer install" or "composer update" if you've added the lines to the post-install-cmd and post-update-cmd sections in your composer.json file. To execute the setup tasks manually, use:

  1. php artisan aimeos:setup [--option="..."] [<site>] default

You can pass additional options to the setup tasks using the "--option=..." command line switch. If options require a value, the option name and value is separated by an colon (":"). Currently available is the following setup option:

  • setup/default/demo:1 (add demo data to the site to get a fully working shop)

The aimeos:setup command accepts an optional site code or list of site codes separated by white spaces. If no site code in given, the "default" site is assumed.


<< Previous: Configure cronjobs | Next: Work with your shop >>