AMNameSanitizerBundle.php

<?php

namespace MauticPlugin\AMNameSanitizerBundle;

use Doctrine\DBAL\Schema\Schema;
use Mautic\PluginBundle\Bundle\PluginBundleBase;
use Mautic\PluginBundle\Entity\Plugin;
use Mautic\CoreBundle\Factory\MauticFactory; //Is depracated and will be removed in Mautic 3.0

class AMNameSanitizerBundle extends PluginBundleBase
{
    /**
     * Called by PluginController::reloadAction when adding a new plugin that's not already installed
     *
     * @param Plugin        $plugin
     * @param MauticFactory $factory
     * @param null          $metadata
     * @param null          $installedSchema
     */
    public static function onPluginInstall(Plugin $plugin, MauticFactory $factory, $metadata = null, $installedSchema = null)
    {
        if ($metadata !== null) {
            self::installPluginSchema($metadata, $factory);
        }
    }

    /**
     * Called by PluginController::reloadAction when the plugin version does not match what's installed
     *
     * @param Plugin        $plugin
     * @param MauticFactory $factory
     * @param null          $metadata
     * @param Schema        $installedSchema
     *
     * @throws \Exception
     */
    public static function onPluginUpdate(Plugin $plugin, MauticFactory $factory, $metadata = null, Schema $installedSchema = null)
    {
        $db = $factory->getDatabase();
        $platform = $db->getDatabasePlatform()->getName();
        $queries = array();
        $fromVersion = $plugin->getVersion();

        // Simple example - Altering database structure on the plugin update. $fromVersion receives the actual version of the plugin and do the queries acording to it.
        switch ($fromVersion) {
            case '1.0':
                switch ($platform) {
                    //Commented for future changes
                    case 'mysql':
                        //$queries[] = 'ALTER TABLE ' . MAUTIC_TABLE_PREFIX . 'worlds CHANGE CHANGE description description LONGTEXT DEFAULT NULL';
                        break;

                    case 'postgresql':
                        //$queries[] = 'ALTER TABLE ' . MAUTIC_TABLE_PREFIX . 'worlds ALTER description ALTER TYPE TEXT';
                        break;
                }

                break;
        }

        if ( ! empty($queries)) {
            $db->beginTransaction();
            try {
                foreach ($queries as $q) {
                    $db->query($q);
                }

                $db->commit();
            } catch (\Exception $e) {
                $db->rollback();

                throw $e;
            }
        }
    }
}