Wallogit.com
2017 © Pedro Peláez
OXID PS Console is a Symfony console application for OXID eShop. It is community and project driven with write and read access like in a public wiki (like Wikipedia)., (*1)
The following commands are available:, (*2)
cache:clear - Clear OXID cacheviews:update - Regenerate database viewsmodule:activate - Activate module in shopmodule:generate - Generate new module scaffoldmodule:fix - Fix the module chain based on the metadata contentsmigration:generate - Generate new migration filemigration:run - Run migration scriptsFor backwards compatibility the following commands are still available (but are deprecated):
* db:update - Updates database views
* g:migration - Generate new migration file
* g:module - Generate new module scaffold
* list - (default) List of all available commands
* migrate - Run migration scripts, (*3)
| OXID Version | OXID Console version | Source Code link | Download link |
|---|---|---|---|
| <4.9.0, <5.2.0 | 1.1.5 | Source Code | Download ZIP |
| >=4.9.0, >=5.2.0 | 1.2.6 | Source Code | Download ZIP |
| =6.1.x | 6.0 | Source Code | please use composer to install see next section |
| =6.2.x | - | use with care oxid console is not designed to be used with oxid 6.2 for now | |
Use Composer to add the console to your project, (*4)
composer require oxid-professional-services/oxid-console
vendor/bin/oxid list
Symfony\Component\Console\Command\Command class services:
oxid_community.moduleinternals.module.fix.command:
class: OxidCommunity\ModuleInternals\Command\ModuleFixCommand
tags:
- { name: 'console.command' }
<?php
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Input\InputInterface;
/**
* My own command
*
* Demo command for learning
*/
class MyOwnCommand extends Command
{
/**
* {@inheritdoc}
*/
public function configure()
{
$this->setName('my:own');
$this->setDescription('Demo command for learning');
$this->addOption('demo', 'd', InputOption::VALUE_NONE, 'run demo');
}
/**
* {@inheritdoc}
*/
public function execute(InputInterface $input, OutputInterface $output)
{
if ($input->getOption('demo')) {
$output->writeln('You typed in --demo or -d also');
}
$output->writeln('My demo command finished');
}
}
For more examples please see https://symfony.com/doc/current/components/console.html, (*5)
Warning current implementation does not trigger the oxid core migration "oe-eshop-doctrine_migration", (*6)
OXID Console project includes migration handling. Lets generate sample migration by running vendor/bin/oxid migration:generate "add amount field to demo module"., (*7)
Console application generated migration/20140312161434_addamountfieldtodemomodule.php file with its contents:, (*8)
<?php
class AddAmountFieldToDemoModuleMigration extends oxMigrationQuery
{
/**
* {@inheritdoc}
*/
public function up()
{
// TODO: Implement up() method.
}
/**
* {@inheritdoc}
*/
public function down()
{
// TODO: Implement down() method.
}
}
Migration handler can run migrations with your given timestamp (if no timestamp provided than it assumes timestamp as current timestamp). Inside it saves which migration queries were executed and knows which migration queries go up or go down., (*9)
Once we generated this file we run vendor/bin/oxid migration:run, (*10)
Running migration scripts [DEBUG] Migrating up 20140312161434 addamountfieldtodemomodulemigration Migration finished successfully
Now lets run the same command a second time, (*11)
Running migration scripts Migration finished successfully
Note: No migration scripts were ran, (*12)
Ok, now lets run migrations with given timestamp of the past with vendor/bin/oxid migration:run 2013-01-01 command, (*13)
Running migration scripts [DEBUG] Migrating down 20140312161434 addamountfieldtodemomodulemigration Migration finished successfully
It ran our migration query down because on given timestamp we should not have had executed that migration query., (*14)
Here is a quick example of migration query which adds a column to oxuser table, (*15)
<?php
// FILE: 20140414085723_adddemoculumntooxuser.php
class AddDemoCulumnToOxUserMigration extends oxMigrationQuery
{
/**
* {@inheritdoc}
*/
public function up()
{
if ($this->_columnExists('oxuser', 'OXDEMO')) {
return;
}
$sSql = "ALTER TABLE `oxuser`
ADD `OXDEMO`
CHAR( 32 )
CHARACTER SET utf8
COLLATE utf8_general_ci
NULL
DEFAULT NULL
COMMENT 'Demo field for migration'";
oxDb::getDb()->execute($sSql);
}
/**
* {@inheritdoc}
*/
public function down()
{
if (!$this->_columnExists('oxuser', 'OXDEMO')) {
return;
}
oxDb::getDb()->execute('ALTER TABLE `oxuser` DROP `OXDEMO`');
}
}
YYYYMMDDHHiiss_description.php formatoxMigrationQuery abstract classNote: It is better to use generator for migration queries creation, (*16)
OXID Console
GPL-3.0
console modules eshop oxid
OXID Console
GPL-3.0
console modules eshop oxid