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

/**
 * Provides a common interface that will have to be implemented by all of the
 * schema 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 SchemaPlugin
{
	/**
	 * SchemaPluginProperties object containing
	 * the specific schema export plugin type properties
	 *
	 * @var SchemaPluginProperties
	 */
	protected $properties;

	/**
	 * 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 schema export plugin
	 *
	 * @return void
	 */
	protected abstract function setProperties();

	/**
	 * Exports the schema into the specified format.
	 *
	 * @param string $db database name
	 *
	 * @return bool Whether it succeeded
	 */
	public abstract function exportSchema($db);

	/**
	 * Adds export options common to all plugins.
	 *
	 * @param OptionsPropertyMainGroup $propertyGroup property group
	 *
	 * @return void
	 */
	protected function addCommonOptions(OptionsPropertyMainGroup $propertyGroup)
	{
		$leaf = new BoolPropertyItem();
		$leaf->setName('show_color');
		$leaf->setText(__('Show color'));
		$propertyGroup->addProperty($leaf);
		$leaf = new BoolPropertyItem();
		$leaf->setName('show_keys');
		$leaf->setText(__('Only show keys'));
		$propertyGroup->addProperty($leaf);
	}
}
?>