phpmyadmin/libraries/plugins/ExportPlugin.class.php

<?php
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
 * Abstract class for the export plugins
 *
 * @package PhpMyAdmin
 */
if (! defined('PHPMYADMIN')) {
    exit;
}

/* This class extends the PluginObserver class */
require_once "PluginObserver.class.php";

/**
 * Provides a common interface that will have to implemented by all of the
 * export plugins. Some of the plugins will also implement other public
 * methods, but those are not declared here, because they are not implemented
 * by all export plugins.
 *
 * @package PhpMyAdmin
 */
abstract class ExportPlugin extends PluginObserver
{
    /**
     * Array containing the specific export plugin type properties
     *
     * @var type array
     */
    protected $properties;

    /**
     * Type of the newline character
     *
     * @var type string
     */
    private $_crlf;

    /**
     * Contains configuration settings
     *
     * @var type array
     */
    private $_cfg;

    /**
     * Database name
     *
     * @var type string
     */
    private $_db;


    /**
     * Common methods, must be overwritten by all export plugins
     */


    /**
     * Outputs export header
     *
     * @return bool Whether it succeeded
     */
    abstract public function exportHeader ();

    /**
     * Outputs export footer
     *
     * @return bool Whether it succeeded
     */
    abstract public function exportFooter ();

    /**
     * Outputs database header
     *
     * @param string $db Database name
     *
     * @return bool Whether it succeeded
     */
    abstract public function exportDBHeader ($db);

    /**
     * Outputs database footer
     *
     * @param string $db Database name
     *
     * @return bool Whether it succeeded
     */
    abstract public function exportDBFooter ($db);

    /**
     * Outputs CREATE DATABASE statement
     *
     * @param string $db Database name
     *
     * @return bool Whether it succeeded
     */
    abstract public function exportDBCreate($db);

     /**
     * Outputs the content of a table
     *
     * @param string $db        database name
     * @param string $table     table name
     * @param string $crlf      the end of line sequence
     * @param string $error_url the url to go back in case of error
     * @param string $sql_query SQL query for obtaining data
     *
     * @return bool Whether it succeeded
     */
    abstract public function exportData ($db, $table, $crlf, $error_url, $sql_query);


    /**
     * The following methods are used in export.php or in db_operations.php,
     * but they are not implemented by all export plugins
     */


    /**
     * Exports routines (procedures and functions)
     *
     * @param string $db Database
     *
     * @return bool Whether it succeeded
     */
    public function exportRoutines($db)
    {
        ;
    }

    /**
     * Outputs table's structure
     *
     * @param string $db          database name
     * @param string $table       table name
     * @param string $crlf        the end of line sequence
     * @param string $error_url   the url to go back in case of error
     * @param string $export_mode 'create_table','triggers','create_view',
     *                            'stand_in'
     * @param string $export_type 'server', 'database', 'table'
     * @param bool   $relation    whether to include relation comments
     * @param bool   $comments    whether to include the pmadb-style column comments
     *                            as comments in the structure; this is deprecated
     *                            but the parameter is left here because export.php
     *                            calls exportStructure() also for other export
     *                            types which use this parameter
     * @param bool   $mime        whether to include mime comments
     * @param bool   $dates       whether to include creation/update/check dates
     *
     * @return bool Whether it succeeded
     */
    public function exportStructure(
        $db,
        $table,
        $crlf,
        $error_url,
        $export_mode,
        $export_type,
        $relation = false,
        $comments = false,
        $mime = false,
        $dates = false
    ) {
        ;
    }

    /**
     * Returns a stand-in CREATE definition to resolve view dependencies
     *
     * @param string $db   the database name
     * @param string $view the view name
     * @param string $crlf the end of line sequence
     *
     * @return string resulting definition
     */
    public function getTableDefStandIn($db, $view, $crlf)
    {
        ;
    }

    /**
     * Outputs triggers
     *
     * @param string $db    database name
     * @param string $table table name
     *
     * @return string Formatted triggers list
     */
    protected function getTriggers($db, $table)
    {
        ;
    }

    /**
     * Formats the definition for one column
     *
     * @param array $column      info about this column
     * @param array $unique_keys unique keys of the table
     *
     * @return string Formatted column definition
     */
    protected function formatOneColumnDefinition(
        $column, $unique_keys
    ) {
        ;
    }

    /**
     * Initializes the local variables with the global values.
     * These are variables that are used by all of the export plugins.
     *
     * @global String $crlf type of the newline character
     * @global array  $cfg  array with configuration settings
     * @global String $db   database name
     *
     * @return void
     */
    protected function initExportCommonVariables()
    {
        global $crlf;
        global $cfg;
        global $db;
        $this->setCrlf($crlf);
        $this->setCfg($cfg);
        $this->setDb($db);
    }


    /* ~~~~~~~~~~~~~~~~~~~~ Getters and Setters ~~~~~~~~~~~~~~~~~~~~ */


    /**
     * Gets the export specific format plugin properties
     *
     * @return array
     */
    public function getProperties()
    {
        return $this->properties;
    }

    /**
     * Sets the export plugins properties and is implemented by each export
     * plugin
     *
     * @return void
     */
    abstract protected function setProperties();

    /**
     * Gets the type of the newline character
     *
     * @return string
     */
    public function getCrlf()
    {
        return $this->_crlf;
    }

    /**
     * Sets the type of the newline character
     *
     * @param String $crlf type of the newline character
     *
     * @return void
     */
    protected function setCrlf($crlf)
    {
        $this->_crlf = $crlf;
    }

    /**
     * Gets the configuration settings
     *
     * @return array
     */
    public function getCfg()
    {
        return $this->_cfg;
    }

    /**
     * Sets the configuration settings
     *
     * @param array $cfg array with configuration settings
     *
     * @return void
     */
    protected function setCfg($cfg)
    {
        $this->_cfg = $cfg;
    }

    /**
     * Gets the database name
     *
     * @return string
     */
    public function getDb()
    {
        return $this->_db;
    }

    /**
     * Sets the database name
     *
     * @param String $db database name
     *
     * @return void
     */
    protected function setDb($db)
    {
        $this->_db = $db;
    }
}
?>