This repository has been archived on 2023-10-16. You can view files and clone it, but cannot push or open issues or pull requests.
2022-05-08 02:37:00 +08:00

90 lines
2.3 KiB
PHP

<?php
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
* Abstract class for the schema export plugins
*
* @package PhpMyAdmin
*/
namespace PhpMyAdmin\Plugins;
use PhpMyAdmin\Properties\Options\Items\BoolPropertyItem;
use PhpMyAdmin\Properties\Options\Groups\OptionsPropertyMainGroup;
use PhpMyAdmin\Properties\Plugins\SchemaPluginProperties;
/**
* 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
{
/**
* PhpMyAdmin\Properties\Plugins\SchemaPluginProperties object containing
* the specific schema export plugin type properties
*
* @var SchemaPluginProperties
*/
protected $properties;
/**
* Gets the export specific format plugin properties
*
* @return SchemaPluginProperties
*/
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 \PhpMyAdmin\Properties\Options\Groups\OptionsPropertyMainGroup $propertyGroup property group
*
* @return void
*/
protected function addCommonOptions(OptionsPropertyMainGroup $propertyGroup)
{
$leaf = new BoolPropertyItem('show_color', __('Show color'));
$propertyGroup->addProperty($leaf);
$leaf = new BoolPropertyItem('show_keys', __('Only show keys'));
$propertyGroup->addProperty($leaf);
}
/**
* Returns the array of paper sizes
*
* @return array array of paper sizes
*/
protected function getPaperSizeArray()
{
$ret = array();
foreach ($GLOBALS['cfg']['PDFPageSizes'] as $val) {
$ret[$val] = $val;
}
return $ret;
}
}