From 5609a90c029abc4d1f07b51c588450a21e7b3ea3 Mon Sep 17 00:00:00 2001 From: Alex Marin Date: Tue, 10 Jul 2012 00:26:19 +0300 Subject: [PATCH 01/17] oop: Create properties system files --- libraries/properties/PropertyItem.class.php | 49 ++++ .../options/OptionsPropertyGroup.class.php | 100 ++++++++ .../options/OptionsPropertyItem.class.php | 98 ++++++++ .../options/OptionsPropertyOneItem.class.php | 115 ++++++++++ .../groups/OptionsPropertyMainGroup.class.php | 35 +++ .../groups/OptionsPropertyRootGroup.class.php | 35 +++ .../groups/OptionsPropertySubgroup.class.php | 35 +++ .../options/items/BoolPropertyItem.class.php | 35 +++ .../options/items/DocPropertyItem.class.php | 35 +++ .../items/HiddenPropertyItem.class.php | 35 +++ .../items/MessageOnlyPropertyItem.class.php | 35 +++ .../options/items/RadioPropertyItem.class.php | 35 +++ .../items/SelectPropertyItem.class.php | 35 +++ .../options/items/TextPropertyItem.class.php | 35 +++ .../plugins/ExportPluginProperties.class.php | 215 ++++++++++++++++++ .../plugins/ImportPluginProperties.class.php | 156 +++++++++++++ .../plugins/PluginPropertyItem.class.php | 36 +++ .../TransformationsPluginProperties.class.php | 157 +++++++++++++ 18 files changed, 1276 insertions(+) create mode 100644 libraries/properties/PropertyItem.class.php create mode 100644 libraries/properties/options/OptionsPropertyGroup.class.php create mode 100644 libraries/properties/options/OptionsPropertyItem.class.php create mode 100644 libraries/properties/options/OptionsPropertyOneItem.class.php create mode 100644 libraries/properties/options/groups/OptionsPropertyMainGroup.class.php create mode 100644 libraries/properties/options/groups/OptionsPropertyRootGroup.class.php create mode 100644 libraries/properties/options/groups/OptionsPropertySubgroup.class.php create mode 100644 libraries/properties/options/items/BoolPropertyItem.class.php create mode 100644 libraries/properties/options/items/DocPropertyItem.class.php create mode 100644 libraries/properties/options/items/HiddenPropertyItem.class.php create mode 100644 libraries/properties/options/items/MessageOnlyPropertyItem.class.php create mode 100644 libraries/properties/options/items/RadioPropertyItem.class.php create mode 100644 libraries/properties/options/items/SelectPropertyItem.class.php create mode 100644 libraries/properties/options/items/TextPropertyItem.class.php create mode 100644 libraries/properties/plugins/ExportPluginProperties.class.php create mode 100644 libraries/properties/plugins/ImportPluginProperties.class.php create mode 100644 libraries/properties/plugins/PluginPropertyItem.class.php create mode 100644 libraries/properties/plugins/TransformationsPluginProperties.class.php diff --git a/libraries/properties/PropertyItem.class.php b/libraries/properties/PropertyItem.class.php new file mode 100644 index 0000000000..21d50682c5 --- /dev/null +++ b/libraries/properties/PropertyItem.class.php @@ -0,0 +1,49 @@ + \ No newline at end of file diff --git a/libraries/properties/options/OptionsPropertyGroup.class.php b/libraries/properties/options/OptionsPropertyGroup.class.php new file mode 100644 index 0000000000..22b8ada5b7 --- /dev/null +++ b/libraries/properties/options/OptionsPropertyGroup.class.php @@ -0,0 +1,100 @@ +getProperties(), true)) { + return; + } + $this->_properties [] = $property; + } + + /** + * Removes a property from the group of properties + * + * @param OptionsPropertyItem $property the property instance to be removed + * from the group + * + * @return void + */ + public function removeProperty($property) + { + $this->_properties = array_udiff( + $this->getProperties(), + array($property), + function ($a, $b) { + return ($a === $b ) ? 0 : 1; + } + ); + } + + + /* ~~~~~~~~~~~~~~~~~~~~ Getters and Setters ~~~~~~~~~~~~~~~~~~~~ */ + + + /** + * Gets the instance of the class + * + * @return array + */ + public function getGroup() + { + return $this; + } + + /** + * Gets the group of properties + * + * @return array + */ + public function getProperties() + { + return $this->_properties; + } + + /** + * Gets the number of properties + * + * @return int + */ + public function getNrOfProperties() + { + return count($this->_properties); + } +} +?> \ No newline at end of file diff --git a/libraries/properties/options/OptionsPropertyItem.class.php b/libraries/properties/options/OptionsPropertyItem.class.php new file mode 100644 index 0000000000..b10ee63123 --- /dev/null +++ b/libraries/properties/options/OptionsPropertyItem.class.php @@ -0,0 +1,98 @@ +_name; + } + + /** + * Sets the name + * + * @param string $name name + * + * @return void + */ + public function setName($name) + { + $this->_name = $name; + } + + /** + * Gets the text + * + * @return string + */ + public function getText() + { + return $this->_text; + } + + /** + * Sets the text + * + * @param string $text text + * + * @return void + */ + public function setText($text) + { + $this->_text = $text; + } + + /** + * Returns the property type ( either "options", or "plugin" ). + * + * @return string + */ + public abstract function getPropertyType() + { + return "options"; + } +} +?> \ No newline at end of file diff --git a/libraries/properties/options/OptionsPropertyOneItem.class.php b/libraries/properties/options/OptionsPropertyOneItem.class.php new file mode 100644 index 0000000000..368f68f01f --- /dev/null +++ b/libraries/properties/options/OptionsPropertyOneItem.class.php @@ -0,0 +1,115 @@ +_force; + } + + /** + * Sets the force parameter + * + * @param bool $force force parameter + * + * @return void + */ + public function setForce($force) + { + $this->_force = $force; + } + + /** + * Gets the values + * + * @return string + */ + public function getValues() + { + return $this->_values; + } + + /** + * Sets the values + * + * @param array $values values + * + * @return void + */ + public function setValues($values) + { + $this->_values = $values; + } + + /** + * Gets the type of the newline character + * + * @return string + */ + public function getDoc() + { + return $this->_doc; + } + + /** + * Sets the doc + * + * @param string $doc doc + * + * @return void + */ + public function setDoc($doc) + { + $this->_doc = $doc; + } +} +?> \ No newline at end of file diff --git a/libraries/properties/options/groups/OptionsPropertyMainGroup.class.php b/libraries/properties/options/groups/OptionsPropertyMainGroup.class.php new file mode 100644 index 0000000000..5a85e95b0a --- /dev/null +++ b/libraries/properties/options/groups/OptionsPropertyMainGroup.class.php @@ -0,0 +1,35 @@ + \ No newline at end of file diff --git a/libraries/properties/options/groups/OptionsPropertyRootGroup.class.php b/libraries/properties/options/groups/OptionsPropertyRootGroup.class.php new file mode 100644 index 0000000000..83afa89912 --- /dev/null +++ b/libraries/properties/options/groups/OptionsPropertyRootGroup.class.php @@ -0,0 +1,35 @@ + \ No newline at end of file diff --git a/libraries/properties/options/groups/OptionsPropertySubgroup.class.php b/libraries/properties/options/groups/OptionsPropertySubgroup.class.php new file mode 100644 index 0000000000..759aa3d94f --- /dev/null +++ b/libraries/properties/options/groups/OptionsPropertySubgroup.class.php @@ -0,0 +1,35 @@ + \ No newline at end of file diff --git a/libraries/properties/options/items/BoolPropertyItem.class.php b/libraries/properties/options/items/BoolPropertyItem.class.php new file mode 100644 index 0000000000..9c3231a42d --- /dev/null +++ b/libraries/properties/options/items/BoolPropertyItem.class.php @@ -0,0 +1,35 @@ + \ No newline at end of file diff --git a/libraries/properties/options/items/DocPropertyItem.class.php b/libraries/properties/options/items/DocPropertyItem.class.php new file mode 100644 index 0000000000..0ebdaaa0ea --- /dev/null +++ b/libraries/properties/options/items/DocPropertyItem.class.php @@ -0,0 +1,35 @@ + \ No newline at end of file diff --git a/libraries/properties/options/items/HiddenPropertyItem.class.php b/libraries/properties/options/items/HiddenPropertyItem.class.php new file mode 100644 index 0000000000..08562b8dbf --- /dev/null +++ b/libraries/properties/options/items/HiddenPropertyItem.class.php @@ -0,0 +1,35 @@ + \ No newline at end of file diff --git a/libraries/properties/options/items/MessageOnlyPropertyItem.class.php b/libraries/properties/options/items/MessageOnlyPropertyItem.class.php new file mode 100644 index 0000000000..b10bbbb736 --- /dev/null +++ b/libraries/properties/options/items/MessageOnlyPropertyItem.class.php @@ -0,0 +1,35 @@ + \ No newline at end of file diff --git a/libraries/properties/options/items/RadioPropertyItem.class.php b/libraries/properties/options/items/RadioPropertyItem.class.php new file mode 100644 index 0000000000..c5ee62e0cd --- /dev/null +++ b/libraries/properties/options/items/RadioPropertyItem.class.php @@ -0,0 +1,35 @@ + \ No newline at end of file diff --git a/libraries/properties/options/items/SelectPropertyItem.class.php b/libraries/properties/options/items/SelectPropertyItem.class.php new file mode 100644 index 0000000000..e6f39c8767 --- /dev/null +++ b/libraries/properties/options/items/SelectPropertyItem.class.php @@ -0,0 +1,35 @@ + \ No newline at end of file diff --git a/libraries/properties/options/items/TextPropertyItem.class.php b/libraries/properties/options/items/TextPropertyItem.class.php new file mode 100644 index 0000000000..c4c62469bb --- /dev/null +++ b/libraries/properties/options/items/TextPropertyItem.class.php @@ -0,0 +1,35 @@ + \ No newline at end of file diff --git a/libraries/properties/plugins/ExportPluginProperties.class.php b/libraries/properties/plugins/ExportPluginProperties.class.php new file mode 100644 index 0000000000..64f58c7895 --- /dev/null +++ b/libraries/properties/plugins/ExportPluginProperties.class.php @@ -0,0 +1,215 @@ +_text; + } + + /** + * Sets the text + * + * @param string $text text + * + * @return void + */ + public function setText($text) + { + $this->_text = $text; + } + + /** + * Gets the extension + * + * @return string + */ + public function getExtension() + { + return $this->_extension; + } + + /** + * Sets the extension + * + * @param string $extension extension + * + * @return void + */ + public function setExtension($extension) + { + $this->_extension = $extension; + } + + /** + * Gets the options + * + * @return OptionsPropertyRootGroup + */ + public function getOptions() + { + return $this->_options; + } + + /** + * Sets the options + * + * @param OptionsPropertyRootGroup $options options + * + * @return void + */ + public function setOptions($options) + { + $this->_options = $options; + } + + /** + * Gets the options text + * + * @return string + */ + public function getOptionsText() + { + return $this->_optionsText; + } + + /** + * Sets the options text + * + * @param string $optionsText optionsText + * + * @return void + */ + public function setOptionsText($optionsText) + { + $this->_optionsText = $optionsText; + } + + /** + * Gets the MIME type + * + * @return string + */ + public function getMimeType() + { + return $this->_mimeType; + } + + /** + * Sets the MIME type + * + * @param string $mimeType MIME type + * + * @return void + */ + public function setMimeType($mimeType) + { + $this->_mimeType = $mimeType; + } + + /** + * Gets the force file parameter + * + * @return bool + */ + public function getForceFile() + { + return $this->_forceFile; + } + + /** + * Sets the force file parameter + * + * @param bool $forceFile the force file parameter + * + * @return void + */ + public function setForceFile($forceFile) + { + $this->_forceFile = $forceFile; + } +} +?> \ No newline at end of file diff --git a/libraries/properties/plugins/ImportPluginProperties.class.php b/libraries/properties/plugins/ImportPluginProperties.class.php new file mode 100644 index 0000000000..42150a691c --- /dev/null +++ b/libraries/properties/plugins/ImportPluginProperties.class.php @@ -0,0 +1,156 @@ +_text; + } + + /** + * Sets the text + * + * @param string $text text + * + * @return void + */ + public function setText($text) + { + $this->_text = $text; + } + + /** + * Gets the extension + * + * @return string + */ + public function getExtension() + { + return $this->_extension; + } + + /** + * Sets the extension + * + * @param string $extension extension + * + * @return void + */ + public function setExtension($extension) + { + $this->_extension = $extension; + } + + /** + * Gets the options + * + * @return OptionsPropertyRootGroup + */ + public function getOptions() + { + return $this->_options; + } + + /** + * Sets the options + * + * @param OptionsPropertyRootGroup $options options + * + * @return void + */ + public function setOptions($options) + { + $this->_options = $options; + } + + /** + * Gets the options text + * + * @return string + */ + public function getOptionsText() + { + return $this->_optionsText; + } + + /** + * Sets the options text + * + * @param string $optionsText options text + * + * @return void + */ + public function setOptionsText($optionsText) + { + $this->_optionsText = $optionsText; + } +} +?> \ No newline at end of file diff --git a/libraries/properties/plugins/PluginPropertyItem.class.php b/libraries/properties/plugins/PluginPropertyItem.class.php new file mode 100644 index 0000000000..71a0528a55 --- /dev/null +++ b/libraries/properties/plugins/PluginPropertyItem.class.php @@ -0,0 +1,36 @@ + \ No newline at end of file diff --git a/libraries/properties/plugins/TransformationsPluginProperties.class.php b/libraries/properties/plugins/TransformationsPluginProperties.class.php new file mode 100644 index 0000000000..d3b80e7f86 --- /dev/null +++ b/libraries/properties/plugins/TransformationsPluginProperties.class.php @@ -0,0 +1,157 @@ +_info; + } + + /** + * Sets information about the transformations plug-in + * + * @param string $info information about the transformations plug-in + * + * @return void + */ + public function setInfo($info) + { + $this->_info = $info; + } + + /** + * Gets the MIME type + * + * @return string + */ + public function getMimeType() + { + return $this->_mimeType; + } + + /** + * Sets the MIME type + * + * @param string $mimeType MIME type + * + * @return void + */ + public function setMimeType($mimeType) + { + $this->_mimeType = $mimeType; + } + + /** + * Gets the MIME subtype + * + * @return string + */ + public function getMimeSubtype() + { + return $this->_mimeSubype; + } + + /** + * Sets the MIME subtype + * + * @param string $mimeSubtype MIME subtype + * + * @return void + */ + public function setMimeSubtype($mimeSubtype) + { + $this->_mimeSubype = $mimeSubtype; + } + + /** + * Gets the transformation name + * + * @return string + */ + public function getTransformationName() + { + return $this->_transformationName; + } + + /** + * Sets the transformation name + * + * @param string $transformationName transformation name + * + * @return void + */ + public function setTransformationName($transformationName) + { + $this->_transformationName = $transformationName; + } +} +?> \ No newline at end of file From 44103fdbbbed4214eaee840938b16b6fda301c81 Mon Sep 17 00:00:00 2001 From: Alex Marin Date: Tue, 10 Jul 2012 21:47:20 +0300 Subject: [PATCH 02/17] oop: Fixes for properties files --- libraries/properties/options/OptionsPropertyGroup.class.php | 4 +++- libraries/properties/options/OptionsPropertyItem.class.php | 4 ++-- .../options/groups/OptionsPropertyMainGroup.class.php | 6 +++--- .../options/groups/OptionsPropertyRootGroup.class.php | 6 +++--- .../options/groups/OptionsPropertySubgroup.class.php | 6 +++--- .../properties/options/items/BoolPropertyItem.class.php | 6 +++--- .../properties/options/items/DocPropertyItem.class.php | 6 +++--- .../properties/options/items/HiddenPropertyItem.class.php | 6 +++--- .../options/items/MessageOnlyPropertyItem.class.php | 6 +++--- .../properties/options/items/RadioPropertyItem.class.php | 6 +++--- .../properties/options/items/SelectPropertyItem.class.php | 6 +++--- .../properties/options/items/TextPropertyItem.class.php | 6 +++--- .../properties/plugins/ExportPluginProperties.class.php | 2 +- .../properties/plugins/ImportPluginProperties.class.php | 2 +- libraries/properties/plugins/PluginPropertyItem.class.php | 6 +++--- .../plugins/TransformationsPluginProperties.class.php | 2 +- 16 files changed, 41 insertions(+), 39 deletions(-) diff --git a/libraries/properties/options/OptionsPropertyGroup.class.php b/libraries/properties/options/OptionsPropertyGroup.class.php index 22b8ada5b7..a8ad40f326 100644 --- a/libraries/properties/options/OptionsPropertyGroup.class.php +++ b/libraries/properties/options/OptionsPropertyGroup.class.php @@ -38,7 +38,9 @@ abstract class OptionsPropertyGroup extends OptionsPropertyItem */ public function addProperty($property) { - if (in_array($property, $this->getProperties(), true)) { + if ($this->getProperties() == null + || in_array($property, $this->getProperties(), true) + ) { return; } $this->_properties [] = $property; diff --git a/libraries/properties/options/OptionsPropertyItem.class.php b/libraries/properties/options/OptionsPropertyItem.class.php index b10ee63123..4c683e8e3e 100644 --- a/libraries/properties/options/OptionsPropertyItem.class.php +++ b/libraries/properties/options/OptionsPropertyItem.class.php @@ -11,7 +11,7 @@ if (! defined('PHPMYADMIN')) { } /* This class extends the PropertyItem class */ -require_once "../PropertyItem.class.php"; +require_once "libraries/properties/PropertyItem.class.php"; /** * Superclass for @@ -90,7 +90,7 @@ abstract class OptionsPropertyItem extends PropertyItem * * @return string */ - public abstract function getPropertyType() + public function getPropertyType() { return "options"; } diff --git a/libraries/properties/options/groups/OptionsPropertyMainGroup.class.php b/libraries/properties/options/groups/OptionsPropertyMainGroup.class.php index 5a85e95b0a..2de7eadf1c 100644 --- a/libraries/properties/options/groups/OptionsPropertyMainGroup.class.php +++ b/libraries/properties/options/groups/OptionsPropertyMainGroup.class.php @@ -10,7 +10,7 @@ if (! defined('PHPMYADMIN')) { } /* This class extends the OptionsPropertyGroup class */ -require_once "../OptionsPropertyGroup.class.php"; +require_once "libraries/properties/options/OptionsPropertyGroup.class.php"; /** * Group property item class of type main @@ -23,11 +23,11 @@ class OptionsPropertyMainGroup extends OptionsPropertyGroup * Returns the property item type of either an instance of * - OptionsPropertyOneItem ( f.e. "bool", "text", "radio", etc ) or * - OptionsPropertyGroup ( "root", "main" or "subgroup" ) - * - PluginPropertyItem ( "export", "import", "transformations" ) + * - PluginPropertyItem ( "export", "import", "transformations" ) * * @return string */ - public abstract function getItemType() + public function getItemType() { return "main"; } diff --git a/libraries/properties/options/groups/OptionsPropertyRootGroup.class.php b/libraries/properties/options/groups/OptionsPropertyRootGroup.class.php index 83afa89912..f1ded7fdb6 100644 --- a/libraries/properties/options/groups/OptionsPropertyRootGroup.class.php +++ b/libraries/properties/options/groups/OptionsPropertyRootGroup.class.php @@ -10,7 +10,7 @@ if (! defined('PHPMYADMIN')) { } /* This class extends the OptionsPropertyGroup class */ -require_once "../OptionsPropertyGroup.class.php"; +require_once "libraries/properties/options/OptionsPropertyGroup.class.php"; /** * Group property item class of type root @@ -23,11 +23,11 @@ class OptionsPropertyRootGroup extends OptionsPropertyGroup * Returns the property item type of either an instance of * - OptionsPropertyOneItem ( f.e. "bool", "text", "radio", etc ) or * - OptionsPropertyGroup ( "root", "main" or "subgroup" ) - * - PluginPropertyItem ( "export", "import", "transformations" ) + * - PluginPropertyItem ( "export", "import", "transformations" ) * * @return string */ - public abstract function getItemType() + public function getItemType() { return "root"; } diff --git a/libraries/properties/options/groups/OptionsPropertySubgroup.class.php b/libraries/properties/options/groups/OptionsPropertySubgroup.class.php index 759aa3d94f..ae07d0e92e 100644 --- a/libraries/properties/options/groups/OptionsPropertySubgroup.class.php +++ b/libraries/properties/options/groups/OptionsPropertySubgroup.class.php @@ -10,7 +10,7 @@ if (! defined('PHPMYADMIN')) { } /* This class extends the OptionsPropertyGroup class */ -require_once "../OptionsPropertyGroup.class.php"; +require_once "libraries/properties/options/OptionsPropertyGroup.class.php"; /** * Group property item class of type subgroup @@ -23,11 +23,11 @@ class OptionsPropertySubgroup extends OptionsPropertyGroup * Returns the property item type of either an instance of * - OptionsPropertyOneItem ( f.e. "bool", "text", "radio", etc ) or * - OptionsPropertyGroup ( "root", "main" or "subgroup" ) - * - PluginPropertyItem ( "export", "import", "transformations" ) + * - PluginPropertyItem ( "export", "import", "transformations" ) * * @return string */ - public abstract function getItemType() + public function getItemType() { return "subgroup"; } diff --git a/libraries/properties/options/items/BoolPropertyItem.class.php b/libraries/properties/options/items/BoolPropertyItem.class.php index 9c3231a42d..480921d353 100644 --- a/libraries/properties/options/items/BoolPropertyItem.class.php +++ b/libraries/properties/options/items/BoolPropertyItem.class.php @@ -10,7 +10,7 @@ if (! defined('PHPMYADMIN')) { } /* This class extends the OptionsPropertyOneItem class */ -require_once "../OptionsPropertyOneItem.class.php"; +require_once "libraries/properties/options/OptionsPropertyOneItem.class.php"; /** * Single property item class of type bool @@ -23,11 +23,11 @@ class BoolPropertyItem extends OptionsPropertyOneItem * Returns the property item type of either an instance of * - OptionsPropertyOneItem ( f.e. "bool", "text", "radio", etc ) or * - OptionsPropertyGroup ( "root", "main" or "subgroup" ) - * - PluginPropertyItem ( "export", "import", "transformations" ) + * - PluginPropertyItem ( "export", "import", "transformations" ) * * @return string */ - public abstract function getItemType() + public function getItemType() { return "bool"; } diff --git a/libraries/properties/options/items/DocPropertyItem.class.php b/libraries/properties/options/items/DocPropertyItem.class.php index 0ebdaaa0ea..bc69e7edbd 100644 --- a/libraries/properties/options/items/DocPropertyItem.class.php +++ b/libraries/properties/options/items/DocPropertyItem.class.php @@ -10,7 +10,7 @@ if (! defined('PHPMYADMIN')) { } /* This class extends the OptionsPropertyOneItem class */ -require_once "../OptionsPropertyOneItem.class.php"; +require_once "libraries/properties/options/OptionsPropertyOneItem.class.php"; /** * Single property item class of type doc @@ -23,11 +23,11 @@ class DocPropertyItem extends OptionsPropertyOneItem * Returns the property item type of either an instance of * - OptionsPropertyOneItem ( f.e. "bool", "text", "radio", etc ) or * - OptionsPropertyGroup ( "root", "main" or "subgroup" ) - * - PluginPropertyItem ( "export", "import", "transformations" ) + * - PluginPropertyItem ( "export", "import", "transformations" ) * * @return string */ - public abstract function getItemType() + public function getItemType() { return "doc"; } diff --git a/libraries/properties/options/items/HiddenPropertyItem.class.php b/libraries/properties/options/items/HiddenPropertyItem.class.php index 08562b8dbf..f91c5d6e73 100644 --- a/libraries/properties/options/items/HiddenPropertyItem.class.php +++ b/libraries/properties/options/items/HiddenPropertyItem.class.php @@ -10,7 +10,7 @@ if (! defined('PHPMYADMIN')) { } /* This class extends the OptionsPropertyOneItem class */ -require_once "../OptionsPropertyOneItem.class.php"; +require_once "libraries/properties/options/OptionsPropertyOneItem.class.php"; /** * Single property item class of type hidden @@ -23,11 +23,11 @@ class HiddenPropertyItem extends OptionsPropertyOneItem * Returns the property item type of either an instance of * - OptionsPropertyOneItem ( f.e. "bool", "text", "radio", etc ) or * - OptionsPropertyGroup ( "root", "main" or "subgroup" ) - * - PluginPropertyItem ( "export", "import", "transformations" ) + * - PluginPropertyItem ( "export", "import", "transformations" ) * * @return string */ - public abstract function getItemType() + public function getItemType() { return "hidden"; } diff --git a/libraries/properties/options/items/MessageOnlyPropertyItem.class.php b/libraries/properties/options/items/MessageOnlyPropertyItem.class.php index b10bbbb736..f80dbc8ad0 100644 --- a/libraries/properties/options/items/MessageOnlyPropertyItem.class.php +++ b/libraries/properties/options/items/MessageOnlyPropertyItem.class.php @@ -10,7 +10,7 @@ if (! defined('PHPMYADMIN')) { } /* This class extends the OptionsPropertyOneItem class */ -require_once "../OptionsPropertyOneItem.class.php"; +require_once "libraries/properties/options/OptionsPropertyOneItem.class.php"; /** * Single property item class of type messageOnly @@ -23,11 +23,11 @@ class MessageOnlyPropertyItem extends OptionsPropertyOneItem * Returns the property item type of either an instance of * - OptionsPropertyOneItem ( f.e. "bool", "text", "radio", etc ) or * - OptionsPropertyGroup ( "root", "main" or "subgroup" ) - * - PluginPropertyItem ( "export", "import", "transformations" ) + * - PluginPropertyItem ( "export", "import", "transformations" ) * * @return string */ - public abstract function getItemType() + public function getItemType() { return "messageOnly"; } diff --git a/libraries/properties/options/items/RadioPropertyItem.class.php b/libraries/properties/options/items/RadioPropertyItem.class.php index c5ee62e0cd..4f7eef3973 100644 --- a/libraries/properties/options/items/RadioPropertyItem.class.php +++ b/libraries/properties/options/items/RadioPropertyItem.class.php @@ -10,7 +10,7 @@ if (! defined('PHPMYADMIN')) { } /* This class extends the OptionsPropertyOneItem class */ -require_once "../OptionsPropertyOneItem.class.php"; +require_once "libraries/properties/options/OptionsPropertyOneItem.class.php"; /** * Single property item class of type radio @@ -23,11 +23,11 @@ class RadioPropertyItem extends OptionsPropertyOneItem * Returns the property item type of either an instance of * - OptionsPropertyOneItem ( f.e. "bool", "text", "radio", etc ) or * - OptionsPropertyGroup ( "root", "main" or "subgroup" ) - * - PluginPropertyItem ( "export", "import", "transformations" ) + * - PluginPropertyItem ( "export", "import", "transformations" ) * * @return string */ - public abstract function getItemType() + public function getItemType() { return "radio"; } diff --git a/libraries/properties/options/items/SelectPropertyItem.class.php b/libraries/properties/options/items/SelectPropertyItem.class.php index e6f39c8767..51d294d290 100644 --- a/libraries/properties/options/items/SelectPropertyItem.class.php +++ b/libraries/properties/options/items/SelectPropertyItem.class.php @@ -10,7 +10,7 @@ if (! defined('PHPMYADMIN')) { } /* This class extends the OptionsPropertyOneItem class */ -require_once "../OptionsPropertyOneItem.class.php"; +require_once "libraries/properties/options/OptionsPropertyOneItem.class.php"; /** * Single property item class of type select @@ -23,11 +23,11 @@ class SelectPropertyItem extends OptionsPropertyOneItem * Returns the property item type of either an instance of * - OptionsPropertyOneItem ( f.e. "bool", "text", "radio", etc ) or * - OptionsPropertyGroup ( "root", "main" or "subgroup" ) - * - PluginPropertyItem ( "export", "import", "transformations" ) + * - PluginPropertyItem ( "export", "import", "transformations" ) * * @return string */ - public abstract function getItemType() + public function getItemType() { return "select"; } diff --git a/libraries/properties/options/items/TextPropertyItem.class.php b/libraries/properties/options/items/TextPropertyItem.class.php index c4c62469bb..0e0f0915fd 100644 --- a/libraries/properties/options/items/TextPropertyItem.class.php +++ b/libraries/properties/options/items/TextPropertyItem.class.php @@ -10,7 +10,7 @@ if (! defined('PHPMYADMIN')) { } /* This class extends the OptionsPropertyOneItem class */ -require_once "../OptionsPropertyOneItem.class.php"; +require_once "libraries/properties/options/OptionsPropertyOneItem.class.php"; /** * Single property item class of type text @@ -23,11 +23,11 @@ class TextPropertyItem extends OptionsPropertyOneItem * Returns the property item type of either an instance of * - OptionsPropertyOneItem ( f.e. "bool", "text", "radio", etc ) or * - OptionsPropertyGroup ( "root", "main" or "subgroup" ) - * - PluginPropertyItem ( "export", "import", "transformations" ) + * - PluginPropertyItem ( "export", "import", "transformations" ) * * @return string */ - public abstract function getItemType() + public function getItemType() { return "text"; } diff --git a/libraries/properties/plugins/ExportPluginProperties.class.php b/libraries/properties/plugins/ExportPluginProperties.class.php index 64f58c7895..b8f8465da8 100644 --- a/libraries/properties/plugins/ExportPluginProperties.class.php +++ b/libraries/properties/plugins/ExportPluginProperties.class.php @@ -75,7 +75,7 @@ class ExportPluginProperties extends PluginPropertyItem * * @return string */ - public abstract function getItemType() + public function getItemType() { return "export"; } diff --git a/libraries/properties/plugins/ImportPluginProperties.class.php b/libraries/properties/plugins/ImportPluginProperties.class.php index 42150a691c..24ff567d61 100644 --- a/libraries/properties/plugins/ImportPluginProperties.class.php +++ b/libraries/properties/plugins/ImportPluginProperties.class.php @@ -60,7 +60,7 @@ class ImportPluginProperties extends PluginPropertyItem * * @return string */ - public abstract function getItemType() +public function getItemType() { return "import"; } diff --git a/libraries/properties/plugins/PluginPropertyItem.class.php b/libraries/properties/plugins/PluginPropertyItem.class.php index 71a0528a55..f017e9055d 100644 --- a/libraries/properties/plugins/PluginPropertyItem.class.php +++ b/libraries/properties/plugins/PluginPropertyItem.class.php @@ -11,7 +11,7 @@ if (! defined('PHPMYADMIN')) { } /* This class extends the PropertyItem class */ -require_once "../PropertyItem.class.php"; +require_once "libraries/properties/PropertyItem.class.php"; /** * Superclass for @@ -21,14 +21,14 @@ require_once "../PropertyItem.class.php"; * * @package PhpMyAdmin */ -abstract class OptionsPropertyItem extends PropertyItem +abstract class PluginPropertyItem extends PropertyItem { /** * Returns the property type ( either "options", or "plugin" ). * * @return string */ - public abstract function getPropertyType() + public function getPropertyType() { return "plugin"; } diff --git a/libraries/properties/plugins/TransformationsPluginProperties.class.php b/libraries/properties/plugins/TransformationsPluginProperties.class.php index d3b80e7f86..abdc8e1203 100644 --- a/libraries/properties/plugins/TransformationsPluginProperties.class.php +++ b/libraries/properties/plugins/TransformationsPluginProperties.class.php @@ -61,7 +61,7 @@ class TransformationsPluginProperties extends PluginPropertyItem * * @return string */ - public abstract function getItemType() + public function getItemType() { return "transformations"; } From 9458f9d06263822558d39e2a52fabafe40259bf1 Mon Sep 17 00:00:00 2001 From: Alex Marin Date: Tue, 17 Jul 2012 13:32:13 +0300 Subject: [PATCH 03/17] oop: integrate the properties system for ExportXml --- export.php | 17 +- libraries/CommonFunctions.class.php | 3 +- libraries/plugin_interface.lib.php | 315 +++++++++++------- libraries/plugins/export/ExportXml.class.php | 139 ++++---- .../ExportCodegen.class.php | 0 .../ExportCsv.class.php | 0 .../ExportExcel.class.php | 0 .../ExportHtmlword.class.php | 0 .../ExportJson.class.php | 0 .../ExportLatex.class.php | 0 .../ExportMediawiki.class.php | 0 .../ExportOds.class.php | 0 .../ExportOdt.class.php | 0 .../ExportPdf.class.php | 0 .../ExportPhparray.class.php | 0 .../ExportSql.class.php | 0 .../ExportTexytext.class.php | 0 .../ExportYaml.class.php | 0 .../options/OptionsPropertyGroup.class.php | 4 +- .../options/OptionsPropertyOneItem.class.php | 59 +++- .../groups/OptionsPropertySubgroup.class.php | 33 ++ 21 files changed, 377 insertions(+), 193 deletions(-) rename libraries/plugins/export/{ => todo_change_properties}/ExportCodegen.class.php (100%) rename libraries/plugins/export/{ => todo_change_properties}/ExportCsv.class.php (100%) rename libraries/plugins/export/{ => todo_change_properties}/ExportExcel.class.php (100%) rename libraries/plugins/export/{ => todo_change_properties}/ExportHtmlword.class.php (100%) rename libraries/plugins/export/{ => todo_change_properties}/ExportJson.class.php (100%) rename libraries/plugins/export/{ => todo_change_properties}/ExportLatex.class.php (100%) rename libraries/plugins/export/{ => todo_change_properties}/ExportMediawiki.class.php (100%) rename libraries/plugins/export/{ => todo_change_properties}/ExportOds.class.php (100%) rename libraries/plugins/export/{ => todo_change_properties}/ExportOdt.class.php (100%) rename libraries/plugins/export/{ => todo_change_properties}/ExportPdf.class.php (100%) rename libraries/plugins/export/{ => todo_change_properties}/ExportPhparray.class.php (100%) rename libraries/plugins/export/{ => todo_change_properties}/ExportSql.class.php (100%) rename libraries/plugins/export/{ => todo_change_properties}/ExportTexytext.class.php (100%) rename libraries/plugins/export/{ => todo_change_properties}/ExportYaml.class.php (100%) diff --git a/export.php b/export.php index d638f218d6..abe366d99f 100644 --- a/export.php +++ b/export.php @@ -42,8 +42,6 @@ $type = $what; // Check export type if (! isset($export_plugin)) { PMA_fatalError(__('Bad type!')); -} else { - $export_plugin_properties = $export_plugin->getProperties(); } /** @@ -92,9 +90,10 @@ if ($_REQUEST['output_format'] == 'astext') { } // Does export require to be into file? -if (isset($export_plugin_properties['force_file']) && ! $asfile) { - - $message = PMA_Message::error(__('Selected export type has to be saved in file!')); +if ($export_plugin->getProperties()->getForceFile() != null && ! $asfile) { + $message = PMA_Message::error( + __('Selected export type has to be saved in file!') + ); if ($export_type == 'server') { $active_page = 'server_export.php'; include 'server_export.php'; @@ -326,13 +325,15 @@ if ($asfile) { // Grab basic dump extension and mime type // Check if the user already added extension; get the substring where the extension would be if it was included - $extension_start_pos = strlen($filename) - strlen($export_plugin_properties['extension']) - 1; + $extension_start_pos = strlen($filename) - strlen( + $export_plugin->getProperties()->getExtension() + ) - 1; $user_extension = substr($filename, $extension_start_pos, strlen($filename)); - $required_extension = "." . $export_plugin_properties['extension']; + $required_extension = "." . $export_plugin->getProperties()->getExtension(); if (strtolower($user_extension) != $required_extension) { $filename .= $required_extension; } - $mime_type = $export_plugin_properties['mime_type']; + $mime_type = $export_plugin->getProperties()->getMimeType(); // If dump is going to be compressed, set correct mime_type and add // compression to extension diff --git a/libraries/CommonFunctions.class.php b/libraries/CommonFunctions.class.php index 439a49710e..896f3429ee 100644 --- a/libraries/CommonFunctions.class.php +++ b/libraries/CommonFunctions.class.php @@ -3537,8 +3537,7 @@ class PMA_CommonFunctions if (! empty($extensions)) { $extensions .= '|'; } - $properties = $import_plugin->getProperties(); - $extensions .= $properties['extension']; + $extensions .= $import_plugin->getProperties()->getExtension(); } $matcher = '@\.(' . $extensions . ')(\.(' diff --git a/libraries/plugin_interface.lib.php b/libraries/plugin_interface.lib.php index 03d11e22f0..208a5c0fad 100644 --- a/libraries/plugin_interface.lib.php +++ b/libraries/plugin_interface.lib.php @@ -129,14 +129,21 @@ function PMA_pluginCheckboxCheck($section, $opt) */ function PMA_pluginGetDefault($section, $opt) { - if (isset($_GET[$opt])) { // If the form is being repopulated using $_GET data, that is priority + if (isset($_GET[$opt])) { + // If the form is being repopulated using $_GET data, that is priority return htmlspecialchars($_GET[$opt]); - } elseif (isset($GLOBALS['timeout_passed']) && $GLOBALS['timeout_passed'] && isset($_REQUEST[$opt])) { + } elseif (isset($GLOBALS['timeout_passed']) + && $GLOBALS['timeout_passed'] + && isset($_REQUEST[$opt])) { return htmlspecialchars($_REQUEST[$opt]); } elseif (isset($GLOBALS['cfg'][$section][$opt])) { $matches = array(); /* Possibly replace localised texts */ - if (preg_match_all('/(str[A-Z][A-Za-z0-9]*)/', $GLOBALS['cfg'][$section][$opt], $matches)) { + if (preg_match_all( + '/(str[A-Z][A-Za-z0-9]*)/', + $GLOBALS['cfg'][$section][$opt], + $matches + )) { $val = $GLOBALS['cfg'][$section][$opt]; foreach ($matches[0] as $match) { if (isset($GLOBALS[$match])) { @@ -172,7 +179,6 @@ function PMA_pluginGetChoice($section, $name, &$list, $cfgname = null) $default = PMA_pluginGetDefault($section, $cfgname); foreach ($list as $plugin) { $plugin_name = strtolower(substr(get_class($plugin), strlen($section))); - $properties = $plugin->getProperties(); $ret .= '' - . PMA_getString($properties['text']) + . PMA_getString($plugin->getProperties()->getText()) . '' . "\n"; } $ret .= '' . "\n"; @@ -191,9 +197,9 @@ function PMA_pluginGetChoice($section, $name, &$list, $cfgname = null) // Whether each plugin has to be saved as a file foreach ($list as $plugin) { $plugin_name = strtolower(substr(get_class($plugin), strlen($section))); - $properties = $plugin->getProperties(); - $ret .= '' - . PMA_getString($opt['text']) . ''; - } elseif ($opt['type'] == 'text') { - $ret .= '
  • ' . "\n"; - $ret .= ''; - $ret .= ''; - } elseif ($opt['type'] == 'message_only') { - $ret .= '
  • ' . "\n"; - $ret .= '

    ' . PMA_getString($opt['text']) . '

    '; - } elseif ($opt['type'] == 'select') { - $ret .= '
  • ' . "\n"; - $ret .= ''; - $ret .= ''; - } elseif ($opt['type'] == 'radio') { - $default = PMA_pluginGetDefault($section, $plugin_name . '_' . $opt['name']); - foreach ($opt['values'] as $key => $val) { - $ret .= '
  • ' - . PMA_getString($val) . '
  • '; - } - } elseif ($opt['type'] == 'hidden') { - $ret .= '
  • '; - } elseif ($opt['type'] == 'begin_group') { - $ret .= '
    '; - if (isset($opt['text'])) { - $ret .= '

    ' . PMA_getString($opt['text']) . '

    '; + + if (! $is_subgroup) { + // for main groups + $ret .= '
    '; + if ($propertyGroup->getText() != null) { + $ret .= '

    ' . PMA_getString($propertyGroup->getText()) . '

    '; } $ret .= '
      '; - } elseif ($opt['type'] == 'end_group') { - $ret .= '
    '; - } elseif ($opt['type'] == 'begin_subgroup') { - /* each subgroup can have a header, which may also be a form element */ - $ret .= PMA_pluginGetOneOption($section, $plugin_name, $id, $opt['subgroup_header']) . '
  • '; - } else { - $ret .= '>'; - } - } elseif ($opt['type'] == 'end_subgroup') { - $ret .= '
  • '; - } else { - /* This should be seen only by plugin writers, so I do not thing this - * needs translation. */ - $ret .= 'UNKNOWN OPTION ' . $opt['type'] . ' IN IMPORT PLUGIN ' . $plugin_name . '!'; } - if (isset($opt['doc'])) { - if (count($opt['doc']) == 3) { - $ret .= PMA_CommonFunctions::getInstance()->showMySQLDocu($opt['doc'][0], $opt['doc'][1], false, $opt['doc'][2]); - } elseif (count($opt['doc']) == 1) { - $ret .= PMA_CommonFunctions::getInstance()->showDocu($opt['doc'][0]); + + foreach ($propertyGroup->getProperties() as $propertyItem) { + $property_class = get_class($propertyItem); + // if the property is a subgroup, we deal with it recursively + if (strpos("group", $property_class)) { + // for subgroups + // each subgroup can have a header, which may also be a form element + $subgroup_header = $propertyItem->getSubgroupHeader(); + $ret .= PMA_pluginGetOneOption( + $section, + $plugin_name, + $propertyItem, + true + ) . '
  • '; + } else { + $ret .= '>'; + } } else { - $ret .= PMA_CommonFunctions::getInstance()->showMySQLDocu($opt['doc'][0], $opt['doc'][1]); + // single property item + switch ($property_class) { + case "BoolPropertyItem": + $ret .= '
  • ' . "\n"; + $ret .= 'getName()); + + if ($propertyItem->getForce() != null) { + // Same code is also few lines lower, update both if needed + $ret .= ' onclick="if (!this.checked && ' + . '(!document.getElementById(\'checkbox_' . $plugin_name + . '_' . $propertyItem->getForce() . '\') ' + . '|| !document.getElementById(\'checkbox_' + . $plugin_name . '_' . $propertyItem->getForce() + . '\').checked)) ' + . 'return false; else return true;"'; + } + $ret .= ' />'; + $ret .= ''; + break; + case "DocPropertyItem": + echo "DocPropertyItem"; + break; + case "HiddenPropertyItem": + $ret .= '
  • '; + break; + case "MessageOnlyPropertyItem": + $ret .= '
  • ' . "\n"; + $ret .= '

    ' . PMA_getString($propertyItem->getText()) . '

    '; + break; + case "RadioPropertyItem": + $default = PMA_pluginGetDefault($section, $plugin_name . '_' + . $propertyItem->getName()); + foreach ($propertyItem->getValues() as $key => $val) { + $ret .= '
  • ' + . PMA_getString($val) . '
  • '; + } + break; + case "SelectPropertyItem": + $ret .= '
  • ' . "\n"; + $ret .= ''; + $ret .= ''; + break; + case "TextPropertyItem": + $ret .= '
  • ' . "\n"; + $ret .= ''; + $ret .= 'getSize() != null + ? ' size="' . $propertyItem->getSize() . '"' + : '') + . ($propertyItem->getLen() != null + ? ' maxlength="' . $propertyItem->getLen() . '"' + : '') + . ' />'; + break; + default:; + } } } - // Close the list element after $opt['doc'] link is displayed - if ($opt['type'] == 'bool' || $opt['type'] == 'text' || $opt['type'] == 'message_only' || $opt['type'] == 'select') { + if ($is_subgroup) { + // end subgroup + $ret .= '
  • '; + } else { + // end main group + $ret .= '
    '; + } + + $doc = $propertyItem->getDoc(); + if (isset($doc)) { + if (count($doc) == 3) { + $ret .= PMA_CommonFunctions::getInstance()->showMySQLDocu( + $doc[0], + $doc[1], + false, + $doc[2] + ); + } elseif (count($doc) == 1) { + $ret .= PMA_CommonFunctions::getInstance()->showDocu($doc[0]); + } else { + $ret .= PMA_CommonFunctions::getInstance()->showMySQLDocu( + $doc[0], + $doc[1] + ); + } + } + + // Close the list element after $doc link is displayed + if ($property_class == 'BoolPropertyItem' + || $property_class == 'MessageOnlyPropertyItem' + || $property_class == 'SelectPropertyItem' + || $property_class == 'TextPropertyItem' + ) { $ret .= ''; } $ret .= "\n"; @@ -329,27 +411,32 @@ function PMA_pluginGetOptions($section, &$list) // Options for plugins that support them foreach ($list as $plugin) { $plugin_name = strtolower(substr(get_class($plugin), strlen($section))); - $properties = $plugin->getProperties(); - $ret .= '
    '; + $ret .= '
    '; $count = 0; - $ret .= '

    ' . PMA_getString($properties['text']) . '

    '; - if (isset($properties['options']) && count($properties['options']) > 0) { - foreach ($properties['options'] as $id => $opt) { - if ($opt['type'] != 'hidden' - && $opt['type'] != 'begin_group' - && $opt['type'] != 'end_group' - && $opt['type'] != 'begin_subgroup' - && $opt['type'] != 'end_subgroup' - ) { - $count++; - } - $ret .= PMA_pluginGetOneOption($section, $plugin_name, $id, $opt); + $ret .= '

    ' . PMA_getString($plugin->getProperties()->getText()) + . '

    '; + + if ($plugin->getProperties()->getOptions() != null + && count($plugin->getProperties()->getOptions()) > 0 + ) { + foreach ($plugin->getProperties()->getOptions()->getProperties() + as $propertyMainGroup + ) { + // todo: check for hidden properties + $count++; + $ret .= PMA_pluginGetOneOption( + $section, + $plugin_name, + $propertyMainGroup + ); } } + if ($count == 0) { $ret .= '

    ' . __('This format has no options') . '

    '; } $ret .= '
    '; } return $ret; -} +} \ No newline at end of file diff --git a/libraries/plugins/export/ExportXml.class.php b/libraries/plugins/export/ExportXml.class.php index 36d15658a2..8e5718a8d6 100644 --- a/libraries/plugins/export/ExportXml.class.php +++ b/libraries/plugins/export/ExportXml.class.php @@ -64,81 +64,88 @@ class ExportXml extends ExportPlugin */ protected function setProperties() { - $this->properties = array( - 'text' => __('XML'), - 'extension' => 'xml', - 'mime_type' => 'text/xml', - 'options' => array(), - 'options_text' => __('Options') - ); + require_once "libraries/properties/plugins/ExportPluginProperties.class.php"; + require_once "libraries/properties/options/groups/OptionsPropertyRootGroup.class.php"; + require_once "libraries/properties/options/groups/OptionsPropertyMainGroup.class.php"; + require_once "libraries/properties/options/items/BoolPropertyItem.class.php"; + require_once "libraries/properties/options/items/HiddenPropertyItem.class.php"; - $this->properties['options'] = array( - array( - 'type' => 'begin_group', - 'name' => 'general_opts' - ), - array( - 'type' => 'hidden', - 'name' => 'structure_or_data' - ), - array( - 'type' => 'end_group' - ) - ); + // create the export plugin property item + $exportPluginProperties = new ExportPluginProperties(); + $exportPluginProperties->setText('XML'); + $exportPluginProperties->setExtension('xml'); + $exportPluginProperties->setMimeType('text/xml'); + $exportPluginProperties->setOptionsText(__('Options')); + + // create the root group that will be the options field for + // $exportPluginProperties + // this will be shown as "Format specific options" + $exportSpecificOptions = new OptionsPropertyRootGroup(); + $exportSpecificOptions->setName("Format Specific Options"); + + // add the actual properties to the group + $generalOptions = new OptionsPropertyMainGroup(); + $generalOptions->setName("general_opts"); + + // create primary item and add it to the group + $hiddenProperty = new HiddenPropertyItem(); + $hiddenProperty->setName("structure_or_data"); + $generalOptions->addProperty($hiddenProperty); + // add the main group to the root group + $exportSpecificOptions->addProperty($generalOptions); /* Export structure */ - $this->properties['options'][] = array( - 'type' => 'begin_group', - 'name' => 'structure', - 'text' => __('Object creation options (all are recommended)') - ); + $structure = new OptionsPropertyMainGroup(); + $structure->setName("structure"); + $structure->setText(__('Object creation options (all are recommended)')); + if (! PMA_DRIZZLE) { - $this->properties['options'][] = array( - 'type' => 'bool', - 'name' => 'export_functions', - 'text' => __('Functions') - ); - $this->properties['options'][] = array( - 'type' => 'bool', - 'name' => 'export_procedures', - 'text' => __('Procedures') - ); + $exportFunctions = new BoolPropertyItem(); + $exportFunctions->setName("export_functions"); + $exportFunctions->setText(__('Functions')); + $structure->addProperty($exportFunctions); + + $exportProcedures = new BoolPropertyItem(); + $exportProcedures->setName("export_procedures"); + $exportProcedures->setText(__('Procedures')); + $structure->addProperty($exportProcedures); } - $this->properties['options'][] = array( - 'type' => 'bool', - 'name' => 'export_tables', - 'text' => __('Tables') - ); + + $exportTables = new BoolPropertyItem(); + $exportTables->setName("export_tables"); + $exportTables->setText(__('Tables')); + $structure->addProperty($exportTables); + if (! PMA_DRIZZLE) { - $this->properties['options'][] = array( - 'type' => 'bool', - 'name' => 'export_triggers', - 'text' => __('Triggers') - ); - $this->properties['options'][] = array( - 'type' => 'bool', - 'name' => 'export_views', - 'text' => __('Views') - ); + $exportTriggers = new BoolPropertyItem(); + $exportTriggers->setName("export_triggers"); + $exportTriggers->setText(__('Triggers')); + $structure->addProperty($exportTriggers); + + $exportViews = new BoolPropertyItem(); + $exportViews->setName("export_views"); + $exportViews->setText(__('Views')); + $structure->addProperty($exportViews); } - $this->properties['options'][] = array( - 'type' => 'end_group' - ); + + $exportSpecificOptions->addProperty($structure); /* Data */ - $this->properties['options'][] = array( - 'type' => 'begin_group', - 'name' => 'data', - 'text' => __('Data dump options') - ); - $this->properties['options'][] = array( - 'type' => 'bool', - 'name' => 'export_contents', - 'text' => __('Export contents') - ); - $this->properties['options'][] = array( - 'type' => 'end_group' - ); + $data = new OptionsPropertyMainGroup(); + $data->setName("data"); + $data->setText(__('Data dump options')); + + $exportContents = new BoolPropertyItem(); + $exportContents->setName("export_contents"); + $exportContents->setText(__('Export contents')); + $data->addProperty($exportContents); + + $exportSpecificOptions->addProperty($data); + + // set the options for the export plugin property item + $exportPluginProperties->setOptions($exportSpecificOptions); + + $this->properties = $exportPluginProperties; } /** diff --git a/libraries/plugins/export/ExportCodegen.class.php b/libraries/plugins/export/todo_change_properties/ExportCodegen.class.php similarity index 100% rename from libraries/plugins/export/ExportCodegen.class.php rename to libraries/plugins/export/todo_change_properties/ExportCodegen.class.php diff --git a/libraries/plugins/export/ExportCsv.class.php b/libraries/plugins/export/todo_change_properties/ExportCsv.class.php similarity index 100% rename from libraries/plugins/export/ExportCsv.class.php rename to libraries/plugins/export/todo_change_properties/ExportCsv.class.php diff --git a/libraries/plugins/export/ExportExcel.class.php b/libraries/plugins/export/todo_change_properties/ExportExcel.class.php similarity index 100% rename from libraries/plugins/export/ExportExcel.class.php rename to libraries/plugins/export/todo_change_properties/ExportExcel.class.php diff --git a/libraries/plugins/export/ExportHtmlword.class.php b/libraries/plugins/export/todo_change_properties/ExportHtmlword.class.php similarity index 100% rename from libraries/plugins/export/ExportHtmlword.class.php rename to libraries/plugins/export/todo_change_properties/ExportHtmlword.class.php diff --git a/libraries/plugins/export/ExportJson.class.php b/libraries/plugins/export/todo_change_properties/ExportJson.class.php similarity index 100% rename from libraries/plugins/export/ExportJson.class.php rename to libraries/plugins/export/todo_change_properties/ExportJson.class.php diff --git a/libraries/plugins/export/ExportLatex.class.php b/libraries/plugins/export/todo_change_properties/ExportLatex.class.php similarity index 100% rename from libraries/plugins/export/ExportLatex.class.php rename to libraries/plugins/export/todo_change_properties/ExportLatex.class.php diff --git a/libraries/plugins/export/ExportMediawiki.class.php b/libraries/plugins/export/todo_change_properties/ExportMediawiki.class.php similarity index 100% rename from libraries/plugins/export/ExportMediawiki.class.php rename to libraries/plugins/export/todo_change_properties/ExportMediawiki.class.php diff --git a/libraries/plugins/export/ExportOds.class.php b/libraries/plugins/export/todo_change_properties/ExportOds.class.php similarity index 100% rename from libraries/plugins/export/ExportOds.class.php rename to libraries/plugins/export/todo_change_properties/ExportOds.class.php diff --git a/libraries/plugins/export/ExportOdt.class.php b/libraries/plugins/export/todo_change_properties/ExportOdt.class.php similarity index 100% rename from libraries/plugins/export/ExportOdt.class.php rename to libraries/plugins/export/todo_change_properties/ExportOdt.class.php diff --git a/libraries/plugins/export/ExportPdf.class.php b/libraries/plugins/export/todo_change_properties/ExportPdf.class.php similarity index 100% rename from libraries/plugins/export/ExportPdf.class.php rename to libraries/plugins/export/todo_change_properties/ExportPdf.class.php diff --git a/libraries/plugins/export/ExportPhparray.class.php b/libraries/plugins/export/todo_change_properties/ExportPhparray.class.php similarity index 100% rename from libraries/plugins/export/ExportPhparray.class.php rename to libraries/plugins/export/todo_change_properties/ExportPhparray.class.php diff --git a/libraries/plugins/export/ExportSql.class.php b/libraries/plugins/export/todo_change_properties/ExportSql.class.php similarity index 100% rename from libraries/plugins/export/ExportSql.class.php rename to libraries/plugins/export/todo_change_properties/ExportSql.class.php diff --git a/libraries/plugins/export/ExportTexytext.class.php b/libraries/plugins/export/todo_change_properties/ExportTexytext.class.php similarity index 100% rename from libraries/plugins/export/ExportTexytext.class.php rename to libraries/plugins/export/todo_change_properties/ExportTexytext.class.php diff --git a/libraries/plugins/export/ExportYaml.class.php b/libraries/plugins/export/todo_change_properties/ExportYaml.class.php similarity index 100% rename from libraries/plugins/export/ExportYaml.class.php rename to libraries/plugins/export/todo_change_properties/ExportYaml.class.php diff --git a/libraries/properties/options/OptionsPropertyGroup.class.php b/libraries/properties/options/OptionsPropertyGroup.class.php index a8ad40f326..05b96222aa 100644 --- a/libraries/properties/options/OptionsPropertyGroup.class.php +++ b/libraries/properties/options/OptionsPropertyGroup.class.php @@ -38,8 +38,8 @@ abstract class OptionsPropertyGroup extends OptionsPropertyItem */ public function addProperty($property) { - if ($this->getProperties() == null - || in_array($property, $this->getProperties(), true) + if (! $this->getProperties() == null + && in_array($property, $this->getProperties(), true) ) { return; } diff --git a/libraries/properties/options/OptionsPropertyOneItem.class.php b/libraries/properties/options/OptionsPropertyOneItem.class.php index 368f68f01f..84b27d37e8 100644 --- a/libraries/properties/options/OptionsPropertyOneItem.class.php +++ b/libraries/properties/options/OptionsPropertyOneItem.class.php @@ -16,7 +16,6 @@ require_once "OptionsPropertyItem.class.php"; * Parents only single property items (not groups). * Defines possible options and getters and setters for them. * - * @todo modify descriptions if needed, when the options are integrated * @package PhpMyAdmin */ abstract class OptionsPropertyOneItem extends OptionsPropertyItem @@ -42,6 +41,20 @@ abstract class OptionsPropertyOneItem extends OptionsPropertyItem */ private $_doc; + /** + * Length + * + * @var int + */ + private $_len; + + /** + * Size + * + * @var int + */ + private $_size; + /* ~~~~~~~~~~~~~~~~~~~~ Getters and Setters ~~~~~~~~~~~~~~~~~~~~ */ @@ -111,5 +124,49 @@ abstract class OptionsPropertyOneItem extends OptionsPropertyItem { $this->_doc = $doc; } + + /** + * Gets the length + * + * @return int + */ + public function getLen() + { + return $this->_len; + } + + /** + * Sets the length + * + * @param int $len length + * + * @return void + */ + public function setLen($len) + { + $this->_len = $len; + } + + /** + * Gets the size + * + * @return int + */ + public function getSize() + { + return $this->_size; + } + + /** + * Sets the size + * + * @param int $size size + * + * @return void + */ + public function setSize($size) + { + $this->_size = $size; + } } ?> \ No newline at end of file diff --git a/libraries/properties/options/groups/OptionsPropertySubgroup.class.php b/libraries/properties/options/groups/OptionsPropertySubgroup.class.php index ae07d0e92e..7a6a5e5a06 100644 --- a/libraries/properties/options/groups/OptionsPropertySubgroup.class.php +++ b/libraries/properties/options/groups/OptionsPropertySubgroup.class.php @@ -19,6 +19,17 @@ require_once "libraries/properties/options/OptionsPropertyGroup.class.php"; */ class OptionsPropertySubgroup extends OptionsPropertyGroup { + /** + * Subgroup Header + * + * @var string + */ + private $_subgroupHeader; + + + /* ~~~~~~~~~~~~~~~~~~~~ Getters and Setters ~~~~~~~~~~~~~~~~~~~~ */ + + /** * Returns the property item type of either an instance of * - OptionsPropertyOneItem ( f.e. "bool", "text", "radio", etc ) or @@ -31,5 +42,27 @@ class OptionsPropertySubgroup extends OptionsPropertyGroup { return "subgroup"; } + + /** + * Gets the subgroup header + * + * @return string + */ + public function getSubgroupHeader() + { + return $this->_subgroupHeader; + } + + /** + * Sets the subgroup header + * + * @param string $subgroupHeader subgroup header + * + * @return void + */ + public function setSubgroupHeader($subgroupHeader) + { + $this->_subgroupHeader = $subgroupHeader; + } } ?> \ No newline at end of file From 36afdd0b415a5deac11909702bf0316fe176bc1d Mon Sep 17 00:00:00 2001 From: Alex Marin Date: Tue, 17 Jul 2012 17:04:31 +0300 Subject: [PATCH 04/17] oop: use properties for ExportCodegen --- .../ExportCodegen.class.php | 67 ++++++++++++------- libraries/plugins/export/ExportXml.class.php | 11 +-- 2 files changed, 47 insertions(+), 31 deletions(-) rename libraries/plugins/export/{todo_change_properties => }/ExportCodegen.class.php (84%) diff --git a/libraries/plugins/export/todo_change_properties/ExportCodegen.class.php b/libraries/plugins/export/ExportCodegen.class.php similarity index 84% rename from libraries/plugins/export/todo_change_properties/ExportCodegen.class.php rename to libraries/plugins/export/ExportCodegen.class.php index 11e9df24c0..0b5df38e26 100644 --- a/libraries/plugins/export/todo_change_properties/ExportCodegen.class.php +++ b/libraries/plugins/export/ExportCodegen.class.php @@ -75,33 +75,48 @@ class ExportCodegen extends ExportPlugin */ protected function setProperties() { - $this->properties = array( - 'text' => 'CodeGen', - 'extension' => 'cs', - 'mime_type' => 'text/cs', - 'options' => array(), - 'options_text' => __('Options') - ); + $props = 'libraries/properties/'; + require_once "$props/plugins/ExportPluginProperties.class.php"; + require_once "$props/options/groups/OptionsPropertyRootGroup.class.php"; + require_once "$props/options/groups/OptionsPropertyMainGroup.class.php"; + require_once "$props/options/items/HiddenPropertyItem.class.php"; + require_once "$props/options/items/SelectPropertyItem.class.php"; - $this->properties['options'] = array( - array( - 'type' => 'begin_group', - 'name' => 'general_opts' - ), - array( - 'type' => 'hidden', - 'name' => 'structure_or_data' - ), - array( - 'type' => 'select', - 'name' => 'format', - 'text' => __('Format:'), - 'values' => $this->_getCgFormats() - ), - array( - 'type' => 'end_group' - ) - ); + $exportPluginProperties = new ExportPluginProperties(); + $exportPluginProperties->setText('CodeGen'); + $exportPluginProperties->setExtension('cs'); + $exportPluginProperties->setMimeType('text/cs'); + $exportPluginProperties->setOptionsText(__('Options')); + + // create the root group that will be the options field for + // $exportPluginProperties + // this will be shown as "Format specific options" + $exportSpecificOptions = new OptionsPropertyRootGroup(); + $exportSpecificOptions->setName("Format Specific Options"); + + // add the actual properties to the group + $generalOptions = new OptionsPropertyMainGroup(); + $generalOptions->setName("general_opts"); + + // create primary item and add it to the group + $hiddenProperty = new HiddenPropertyItem(); + $hiddenProperty->setName("structure_or_data"); + $generalOptions->addProperty($hiddenProperty); + + // create primary item and add it to the group + $selectProperty = new SelectPropertyItem(); + $selectProperty->setName("format"); + $selectProperty->setText(__('Format:')); + $selectProperty->setValues($this->_getCgFormats()); + $generalOptions->addProperty($selectProperty); + + // add the main group to the root group + $exportSpecificOptions->addProperty($generalOptions); + + // set the options for the export plugin property item + $exportPluginProperties->setOptions($exportSpecificOptions); + + $this->properties = $exportPluginProperties; } /** diff --git a/libraries/plugins/export/ExportXml.class.php b/libraries/plugins/export/ExportXml.class.php index 8e5718a8d6..da11fcb5c8 100644 --- a/libraries/plugins/export/ExportXml.class.php +++ b/libraries/plugins/export/ExportXml.class.php @@ -64,11 +64,12 @@ class ExportXml extends ExportPlugin */ protected function setProperties() { - require_once "libraries/properties/plugins/ExportPluginProperties.class.php"; - require_once "libraries/properties/options/groups/OptionsPropertyRootGroup.class.php"; - require_once "libraries/properties/options/groups/OptionsPropertyMainGroup.class.php"; - require_once "libraries/properties/options/items/BoolPropertyItem.class.php"; - require_once "libraries/properties/options/items/HiddenPropertyItem.class.php"; + $props = 'libraries/properties/'; + require_once "$props/plugins/ExportPluginProperties.class.php"; + require_once "$props/options/groups/OptionsPropertyRootGroup.class.php"; + require_once "$props/options/groups/OptionsPropertyMainGroup.class.php"; + require_once "$props/options/items/HiddenPropertyItem.class.php"; + require_once "$props/options/items/BoolPropertyItem.class.php"; // create the export plugin property item $exportPluginProperties = new ExportPluginProperties(); From 9823d9532ca457f8c950652f2c15c6c09a3af457 Mon Sep 17 00:00:00 2001 From: Alex Marin Date: Tue, 17 Jul 2012 17:09:26 +0300 Subject: [PATCH 05/17] oop: use properties for ExportJson --- .../ExportJson.class.php | 53 ++++++++++++------- 1 file changed, 33 insertions(+), 20 deletions(-) rename libraries/plugins/export/{todo_change_properties => }/ExportJson.class.php (74%) diff --git a/libraries/plugins/export/todo_change_properties/ExportJson.class.php b/libraries/plugins/export/ExportJson.class.php similarity index 74% rename from libraries/plugins/export/todo_change_properties/ExportJson.class.php rename to libraries/plugins/export/ExportJson.class.php index 21d57f4c12..b8e7c75c65 100644 --- a/libraries/plugins/export/todo_change_properties/ExportJson.class.php +++ b/libraries/plugins/export/ExportJson.class.php @@ -35,27 +35,40 @@ class ExportJson extends ExportPlugin */ protected function setProperties() { - $this->properties = array( - 'text' => 'JSON', - 'extension' => 'json', - 'mime_type' => 'text/plain', - 'options' => array(), - 'options_text' => __('Options') - ); + $props = 'libraries/properties/'; + require_once "$props/plugins/ExportPluginProperties.class.php"; + require_once "$props/options/groups/OptionsPropertyRootGroup.class.php"; + require_once "$props/options/groups/OptionsPropertyMainGroup.class.php"; + require_once "$props/options/items/HiddenPropertyItem.class.php"; - $this->properties['options'] = array( - array( - 'type' => 'begin_group', - 'name' => 'general_opts' - ), - array( - 'type' => 'hidden', - 'name' => 'structure_or_data', - ), - array( - 'type' => 'end_group' - ) - ); + $exportPluginProperties = new ExportPluginProperties(); + $exportPluginProperties->setText('JSON'); + $exportPluginProperties->setExtension('json'); + $exportPluginProperties->setMimeType('text/plain'); + $exportPluginProperties->setOptionsText(__('Options')); + + // create the root group that will be the options field for + // $exportPluginProperties + // this will be shown as "Format specific options" + $exportSpecificOptions = new OptionsPropertyRootGroup(); + $exportSpecificOptions->setName("Format Specific Options"); + + // add the actual properties to the group + $generalOptions = new OptionsPropertyMainGroup(); + $generalOptions->setName("general_opts"); + + // create primary item and add it to the group + $hiddenProperty = new HiddenPropertyItem(); + $hiddenProperty->setName("structure_or_data"); + $generalOptions->addProperty($hiddenProperty); + + // add the main group to the root group + $exportSpecificOptions->addProperty($generalOptions); + + // set the options for the export plugin property item + $exportPluginProperties->setOptions($exportSpecificOptions); + + $this->properties = $exportPluginProperties; } /** From 616228570b64f343c2ce86a7d9301658827aa8a1 Mon Sep 17 00:00:00 2001 From: Alex Marin Date: Tue, 17 Jul 2012 17:18:43 +0300 Subject: [PATCH 06/17] oop: check for hidden properties --- libraries/plugin_interface.lib.php | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/libraries/plugin_interface.lib.php b/libraries/plugin_interface.lib.php index 208a5c0fad..873945ef68 100644 --- a/libraries/plugin_interface.lib.php +++ b/libraries/plugin_interface.lib.php @@ -413,7 +413,6 @@ function PMA_pluginGetOptions($section, &$list) $plugin_name = strtolower(substr(get_class($plugin), strlen($section))); $ret .= '
    '; - $count = 0; $ret .= '

    ' . PMA_getString($plugin->getProperties()->getText()) . '

    '; @@ -423,8 +422,15 @@ function PMA_pluginGetOptions($section, &$list) foreach ($plugin->getProperties()->getOptions()->getProperties() as $propertyMainGroup ) { - // todo: check for hidden properties - $count++; + // check for hidden properties + $no_options = true; + foreach ($propertyMainGroup->getProperties() as $propertyItem) { + if (strcmp("HiddenPropertyItem", get_class($propertyItem))) { + $no_options = false; + break; + } + } + $ret .= PMA_pluginGetOneOption( $section, $plugin_name, @@ -433,7 +439,7 @@ function PMA_pluginGetOptions($section, &$list) } } - if ($count == 0) { + if ($no_options) { $ret .= '

    ' . __('This format has no options') . '

    '; } $ret .= '
    '; From 12e5c6f5c996757d4ba8b3cf4de84489793a0882 Mon Sep 17 00:00:00 2001 From: Alex Marin Date: Wed, 18 Jul 2012 10:12:45 +0300 Subject: [PATCH 07/17] oop: use properties for ExportCsv --- .../ExportCsv.class.php | 118 +++++++++--------- 1 file changed, 61 insertions(+), 57 deletions(-) rename libraries/plugins/export/{todo_change_properties => }/ExportCsv.class.php (79%) diff --git a/libraries/plugins/export/todo_change_properties/ExportCsv.class.php b/libraries/plugins/export/ExportCsv.class.php similarity index 79% rename from libraries/plugins/export/todo_change_properties/ExportCsv.class.php rename to libraries/plugins/export/ExportCsv.class.php index 24af87d603..0ffc3ea4a8 100644 --- a/libraries/plugins/export/todo_change_properties/ExportCsv.class.php +++ b/libraries/plugins/export/ExportCsv.class.php @@ -83,64 +83,68 @@ class ExportCsv extends ExportPlugin */ protected function setProperties() { - $this->properties = array( - 'text' => __('CSV'), - 'extension' => 'csv', - 'mime_type' => 'text/comma-separated-values', - 'options' => array(), - 'options_text' => __('Options') - ); + $props = 'libraries/properties/'; + require_once "$props/plugins/ExportPluginProperties.class.php"; + require_once "$props/options/groups/OptionsPropertyRootGroup.class.php"; + require_once "$props/options/groups/OptionsPropertyMainGroup.class.php"; + require_once "$props/options/items/TextPropertyItem.class.php"; + require_once "$props/options/items/BoolPropertyItem.class.php"; + require_once "$props/options/items/HiddenPropertyItem.class.php"; - $this->properties['options'] = array( - array( - 'type' => 'begin_group', - 'name' => 'general_opts' - ), - array( - 'type' => 'text', - 'name' => 'separator', - 'text' => __('Columns separated with:') - ), - array( - 'type' => 'text', - 'name' => 'enclosed', - 'text' => __('Columns enclosed with:') - ), - array( - 'type' => 'text', - 'name' => 'escaped', - 'text' => __('Columns escaped with:') - ), - array( - 'type' => 'text', - 'name' => 'terminated', - 'text' => __('Lines terminated with:') - ), - array( - 'type' => 'text', - 'name' => 'null', - 'text' => __('Replace NULL with:') - ), - array( - 'type' => 'bool', - 'name' => 'removeCRLF', - 'text' => __( - 'Remove carriage return/line feed characters within columns' - ) - ), - array( - 'type' => 'bool', - 'name' => 'columns', - 'text' => __('Put columns names in the first row') - ), - array( - 'type' => 'hidden', - 'name' => 'structure_or_data' - ), - array( - 'type' => 'end_group' - ) - ); + $exportPluginProperties = new ExportPluginProperties(); + $exportPluginProperties->setText('CSV'); + $exportPluginProperties->setExtension('csv'); + $exportPluginProperties->setMimeType('text/comma-separated-values'); + $exportPluginProperties->setOptionsText(__('Options')); + + // create the root group that will be the options field for + // $exportPluginProperties + // this will be shown as "Format specific options" + $exportSpecificOptions = new OptionsPropertyRootGroup(); + $exportSpecificOptions->setName("Format Specific Options"); + + // general options main group + $generalOptions = new OptionsPropertyMainGroup(); + $generalOptions->setName("general_opts"); + // create leaf items and add them to the group + $leaf = new TextPropertyItem(); + $leaf->setName("separator"); + $leaf->setText(__('Columns separated with:')); + $generalOptions->addProperty($leaf); + $leaf = new TextPropertyItem(); + $leaf->setName("enclosed"); + $leaf->setText(__('Columns enclosed with:')); + $generalOptions->addProperty($leaf); + $leaf = new TextPropertyItem(); + $leaf->setName("escaped"); + $leaf->setText(__('Columns escaped with:')); + $generalOptions->addProperty($leaf); + $leaf = new TextPropertyItem(); + $leaf->setName("terminated"); + $leaf->setText(__('Lines terminated with:')); + $generalOptions->addProperty($leaf); + $leaf = new TextPropertyItem(); + $leaf->setName('null'); + $leaf->setText(__('Replace NULL with:')); + $generalOptions->addProperty($leaf); + $leaf = new BoolPropertyItem(); + $leaf->setName('removeCRLF'); + $leaf->setText(__( + 'Remove carriage return/line feed characters within columns' + )); + $leaf = new BoolPropertyItem(); + $leaf->setName('columns'); + $leaf->setText(__('Put columns names in the first row')); + $generalOptions->addProperty($leaf); + $leaf = new HiddenPropertyItem(); + $leaf->setName('structure_or_data'); + $generalOptions->addProperty($leaf); + // add the main group to the root group + $exportSpecificOptions->addProperty($generalOptions); + + // set the options for the export plugin property item + $exportPluginProperties->setOptions($exportSpecificOptions); + $this->properties = $exportPluginProperties; } /** From 9288f0eaecea3018b279c2d4902b4e1fc5db9cba Mon Sep 17 00:00:00 2001 From: Alex Marin Date: Wed, 18 Jul 2012 10:15:48 +0300 Subject: [PATCH 08/17] oop: reorganise usage of properties in plug-ins --- .../plugins/export/ExportCodegen.class.php | 25 +++---- libraries/plugins/export/ExportJson.class.php | 13 ++-- libraries/plugins/export/ExportXml.class.php | 74 +++++++++---------- 3 files changed, 48 insertions(+), 64 deletions(-) diff --git a/libraries/plugins/export/ExportCodegen.class.php b/libraries/plugins/export/ExportCodegen.class.php index 0b5df38e26..13f9d0004e 100644 --- a/libraries/plugins/export/ExportCodegen.class.php +++ b/libraries/plugins/export/ExportCodegen.class.php @@ -94,28 +94,23 @@ class ExportCodegen extends ExportPlugin $exportSpecificOptions = new OptionsPropertyRootGroup(); $exportSpecificOptions->setName("Format Specific Options"); - // add the actual properties to the group + // general options main group $generalOptions = new OptionsPropertyMainGroup(); $generalOptions->setName("general_opts"); - - // create primary item and add it to the group - $hiddenProperty = new HiddenPropertyItem(); - $hiddenProperty->setName("structure_or_data"); - $generalOptions->addProperty($hiddenProperty); - - // create primary item and add it to the group - $selectProperty = new SelectPropertyItem(); - $selectProperty->setName("format"); - $selectProperty->setText(__('Format:')); - $selectProperty->setValues($this->_getCgFormats()); - $generalOptions->addProperty($selectProperty); - + // create primary items and add them to the group + $leaf = new HiddenPropertyItem(); + $leaf->setName("structure_or_data"); + $generalOptions->addProperty($leaf); + $leaf = new SelectPropertyItem(); + $leaf->setName("format"); + $leaf->setText(__('Format:')); + $leaf->setValues($this->_getCgFormats()); + $generalOptions->addProperty($leaf); // add the main group to the root group $exportSpecificOptions->addProperty($generalOptions); // set the options for the export plugin property item $exportPluginProperties->setOptions($exportSpecificOptions); - $this->properties = $exportPluginProperties; } diff --git a/libraries/plugins/export/ExportJson.class.php b/libraries/plugins/export/ExportJson.class.php index b8e7c75c65..a75e184afa 100644 --- a/libraries/plugins/export/ExportJson.class.php +++ b/libraries/plugins/export/ExportJson.class.php @@ -53,21 +53,18 @@ class ExportJson extends ExportPlugin $exportSpecificOptions = new OptionsPropertyRootGroup(); $exportSpecificOptions->setName("Format Specific Options"); - // add the actual properties to the group + // general options main group $generalOptions = new OptionsPropertyMainGroup(); $generalOptions->setName("general_opts"); - - // create primary item and add it to the group - $hiddenProperty = new HiddenPropertyItem(); - $hiddenProperty->setName("structure_or_data"); - $generalOptions->addProperty($hiddenProperty); - + // create primary items and add them to the group + $leaf = new HiddenPropertyItem(); + $leaf->setName("structure_or_data"); + $generalOptions->addProperty($leaf); // add the main group to the root group $exportSpecificOptions->addProperty($generalOptions); // set the options for the export plugin property item $exportPluginProperties->setOptions($exportSpecificOptions); - $this->properties = $exportPluginProperties; } diff --git a/libraries/plugins/export/ExportXml.class.php b/libraries/plugins/export/ExportXml.class.php index da11fcb5c8..3fb8452afd 100644 --- a/libraries/plugins/export/ExportXml.class.php +++ b/libraries/plugins/export/ExportXml.class.php @@ -84,68 +84,60 @@ class ExportXml extends ExportPlugin $exportSpecificOptions = new OptionsPropertyRootGroup(); $exportSpecificOptions->setName("Format Specific Options"); - // add the actual properties to the group + // general options main group $generalOptions = new OptionsPropertyMainGroup(); $generalOptions->setName("general_opts"); - - // create primary item and add it to the group - $hiddenProperty = new HiddenPropertyItem(); - $hiddenProperty->setName("structure_or_data"); - $generalOptions->addProperty($hiddenProperty); + // create primary items and add them to the group + $leaf = new HiddenPropertyItem(); + $leaf->setName("structure_or_data"); + $generalOptions->addProperty($leaf); // add the main group to the root group $exportSpecificOptions->addProperty($generalOptions); - /* Export structure */ + // export structure main group $structure = new OptionsPropertyMainGroup(); $structure->setName("structure"); $structure->setText(__('Object creation options (all are recommended)')); - + // create primary items and add them to the group if (! PMA_DRIZZLE) { - $exportFunctions = new BoolPropertyItem(); - $exportFunctions->setName("export_functions"); - $exportFunctions->setText(__('Functions')); - $structure->addProperty($exportFunctions); - - $exportProcedures = new BoolPropertyItem(); - $exportProcedures->setName("export_procedures"); - $exportProcedures->setText(__('Procedures')); - $structure->addProperty($exportProcedures); + $leaf = new BoolPropertyItem(); + $leaf->setName("export_functions"); + $leaf->setText(__('Functions')); + $structure->addProperty($leaf); + $leaf = new BoolPropertyItem(); + $leaf->setName("export_procedures"); + $leaf->setText(__('Procedures')); + $structure->addProperty($leaf); } - - $exportTables = new BoolPropertyItem(); - $exportTables->setName("export_tables"); - $exportTables->setText(__('Tables')); - $structure->addProperty($exportTables); - + $leaf = new BoolPropertyItem(); + $leaf->setName("export_tables"); + $leaf->setText(__('Tables')); + $structure->addProperty($leaf); if (! PMA_DRIZZLE) { - $exportTriggers = new BoolPropertyItem(); - $exportTriggers->setName("export_triggers"); - $exportTriggers->setText(__('Triggers')); - $structure->addProperty($exportTriggers); - - $exportViews = new BoolPropertyItem(); - $exportViews->setName("export_views"); - $exportViews->setText(__('Views')); - $structure->addProperty($exportViews); + $leaf = new BoolPropertyItem(); + $leaf->setName("export_triggers"); + $leaf->setText(__('Triggers')); + $structure->addProperty($leaf); + $leaf = new BoolPropertyItem(); + $leaf->setName("export_views"); + $leaf->setText(__('Views')); + $structure->addProperty($leaf); } - $exportSpecificOptions->addProperty($structure); - /* Data */ + // data main group $data = new OptionsPropertyMainGroup(); $data->setName("data"); $data->setText(__('Data dump options')); - - $exportContents = new BoolPropertyItem(); - $exportContents->setName("export_contents"); - $exportContents->setText(__('Export contents')); - $data->addProperty($exportContents); - + // create primary items and add them to the group + $leaf = new BoolPropertyItem(); + $leaf->setName("export_contents"); + $leaf->setText(__('Export contents')); + $data->addProperty($leaf); $exportSpecificOptions->addProperty($data); // set the options for the export plugin property item $exportPluginProperties->setOptions($exportSpecificOptions); - $this->properties = $exportPluginProperties; } From 94ea719b4de8dd696e93d13220b3a1d1ea7c807b Mon Sep 17 00:00:00 2001 From: Alex Marin Date: Wed, 18 Jul 2012 10:35:17 +0300 Subject: [PATCH 09/17] oop: use properties for ExportExcel --- .../plugins/export/ExportExcel.class.php | 101 ++++++++++++++++++ .../ExportExcel.class.php | 92 ---------------- 2 files changed, 101 insertions(+), 92 deletions(-) create mode 100644 libraries/plugins/export/ExportExcel.class.php delete mode 100644 libraries/plugins/export/todo_change_properties/ExportExcel.class.php diff --git a/libraries/plugins/export/ExportExcel.class.php b/libraries/plugins/export/ExportExcel.class.php new file mode 100644 index 0000000000..c77029dc2e --- /dev/null +++ b/libraries/plugins/export/ExportExcel.class.php @@ -0,0 +1,101 @@ +setText('CSV for MS Excel'); + $exportPluginProperties->setExtension('csv'); + $exportPluginProperties->setMimeType('text/comma-separated-values'); + $exportPluginProperties->setOptionsText(__('Options')); + + // create the root group that will be the options field for + // $exportPluginProperties + // this will be shown as "Format specific options" + $exportSpecificOptions = new OptionsPropertyRootGroup(); + $exportSpecificOptions->setName("Format Specific Options"); + + // general options main group + $generalOptions = new OptionsPropertyMainGroup(); + $generalOptions->setName("general_opts"); + // create primary items and add them to the group + $leaf = new TextPropertyItem(); + $leaf->setName('null'); + $leaf->setText(__('Replace NULL with:')); + $generalOptions->addProperty($leaf); + $leaf = new BoolPropertyItem(); + $leaf->setName('removeCRLF'); + $leaf->setText(__( + 'Remove carriage return/line feed characters within columns' + )); + $leaf = new BoolPropertyItem(); + $leaf->setName('columns'); + $leaf->setText(__('Put columns names in the first row')); + $generalOptions->addProperty($leaf); + $leaf = new SelectPropertyItem(); + $leaf->setName('edition'); + $leaf->setValues(array( + 'win' => 'Windows', + 'mac_excel2003' => 'Excel 2003 / Macintosh', + 'mac_excel2008' => 'Excel 2008 / Macintosh' + )); + $leaf->setText(__('Excel edition:')); + $generalOptions->addProperty($leaf); + $leaf = new HiddenPropertyItem(); + $leaf->setName('structure_or_data'); + $generalOptions->addProperty($leaf); + // add the main group to the root group + $exportSpecificOptions->addProperty($generalOptions); + + // set the options for the export plugin property item + $exportPluginProperties->setOptions($exportSpecificOptions); + $this->properties = $exportPluginProperties; + } + + /** + * This method is called when any PluginManager to which the observer + * is attached calls PluginManager::notify() + * + * @param SplSubject $subject The PluginManager notifying the observer + * of an update. + * + * @return void + */ + public function update (SplSubject $subject) + { + } +} +?> \ No newline at end of file diff --git a/libraries/plugins/export/todo_change_properties/ExportExcel.class.php b/libraries/plugins/export/todo_change_properties/ExportExcel.class.php deleted file mode 100644 index 96bf0ba3cb..0000000000 --- a/libraries/plugins/export/todo_change_properties/ExportExcel.class.php +++ /dev/null @@ -1,92 +0,0 @@ -properties = array( - 'text' => __('CSV for MS Excel'), - 'extension' => 'csv', - 'mime_type' => 'text/comma-separated-values', - 'options' => array(), - 'options_text' => __('Options') - ); - - $this->properties['options'] = array( - array( - 'type' => 'begin_group', - 'name' => 'general_opts' - ), - array( - 'type' => 'text', - 'name' => 'null', - 'text' => __('Replace NULL with:') - ), - array( - 'type' => 'bool', - 'name' => 'removeCRLF', - 'text' => __( - 'Remove carriage return/line feed characters within columns' - ) - ), - array( - 'type' => 'bool', - 'name' => 'columns', - 'text' => __('Put columns names in the first row') - ), - array( - 'type' => 'select', - 'name' => 'edition', - 'values' => array( - 'win' => 'Windows', - 'mac_excel2003' => 'Excel 2003 / Macintosh', - 'mac_excel2008' => 'Excel 2008 / Macintosh'), - 'text' => __('Excel edition:') - ), - array( - 'type' => 'hidden', - 'name' => 'structure_or_data' - ), - array( - 'type' => 'end_group' - ) - ); - } - - /** - * This method is called when any PluginManager to which the observer - * is attached calls PluginManager::notify() - * - * @param SplSubject $subject The PluginManager notifying the observer - * of an update. - * - * @return void - */ - public function update (SplSubject $subject) - { - } -} -?> \ No newline at end of file From 857d56277c3fe4ebf762e7b31d76f053501143f1 Mon Sep 17 00:00:00 2001 From: Alex Marin Date: Wed, 18 Jul 2012 10:50:04 +0300 Subject: [PATCH 10/17] oop: use properties for ExportHtmlword --- .../ExportHtmlword.class.php | 107 ++++++++++-------- .../options/OptionsPropertyItem.class.php | 29 +++++ 2 files changed, 86 insertions(+), 50 deletions(-) rename libraries/plugins/export/{todo_change_properties => }/ExportHtmlword.class.php (87%) diff --git a/libraries/plugins/export/todo_change_properties/ExportHtmlword.class.php b/libraries/plugins/export/ExportHtmlword.class.php similarity index 87% rename from libraries/plugins/export/todo_change_properties/ExportHtmlword.class.php rename to libraries/plugins/export/ExportHtmlword.class.php index 14bc6f0941..3f43dceebf 100644 --- a/libraries/plugins/export/todo_change_properties/ExportHtmlword.class.php +++ b/libraries/plugins/export/ExportHtmlword.class.php @@ -35,56 +35,63 @@ class ExportHtmlword extends ExportPlugin */ protected function setProperties() { - $this->properties = array( - 'text' => __('Microsoft Word 2000'), - 'extension' => 'doc', - 'mime_type' => 'application/vnd.ms-word', - 'force_file' => true, - 'options' => array(), - 'options_text' => __('Options') - ); + $props = 'libraries/properties/'; + require_once "$props/plugins/ExportPluginProperties.class.php"; + require_once "$props/options/groups/OptionsPropertyRootGroup.class.php"; + require_once "$props/options/groups/OptionsPropertyMainGroup.class.php"; + require_once "$props/options/items/RadioPropertyItem.class.php"; + require_once "$props/options/items/TextPropertyItem.class.php"; + require_once "$props/options/items/BoolPropertyItem.class.php"; - $this->properties['options'] = array( - /* what to dump (structure/data/both) */ - array( - 'type' => 'begin_group', - 'name' => 'dump_what', - 'text' => __('Dump table') - ), - array( - 'type' => 'radio', - 'name' => 'structure_or_data', - 'values' => array( - 'structure' => __('structure'), - 'data' => __('data'), - 'structure_and_data' => __('structure and data') - ) - ), - array( - 'type' => 'end_group' - ), + $exportPluginProperties = new ExportPluginProperties(); + $exportPluginProperties->setText('Microsoft Word 2000'); + $exportPluginProperties->setExtension('doc'); + $exportPluginProperties->setMimeType('application/vnd.ms-word'); + $exportPluginProperties->setForceFile(true); + $exportPluginProperties->setOptionsText(__('Options')); - /* data options */ - array( - 'type' => 'begin_group', - 'name' => 'data', - 'text' => __('Data dump options'), - 'force' => 'structure' - ), - array( - 'type' => 'text', - 'name' => 'null', - 'text' => __('Replace NULL with:') - ), - array( - 'type' => 'bool', - 'name' => 'columns', - 'text' => __('Put columns names in the first row') - ), - array( - 'type' => 'end_group' - ) - ); + // create the root group that will be the options field for + // $exportPluginProperties + // this will be shown as "Format specific options" + $exportSpecificOptions = new OptionsPropertyRootGroup(); + $exportSpecificOptions->setName("Format Specific Options"); + + // what to dump (structure/data/both) + $generalOptions = new OptionsPropertyMainGroup(); + $generalOptions->setName("dump_what"); + $generalOptions->setText(__('Dump table')); + // create primary items and add them to the group + $leaf = new RadioPropertyItem(); + $leaf->setName("structure_or_data"); + $leaf->setValues(array( + 'structure' => __('structure'), + 'data' => __('data'), + 'structure_and_data' => __('structure and data') + )); + $generalOptions->addProperty($leaf); + // add the main group to the root group + $exportSpecificOptions->addProperty($generalOptions); + + // data options + $dataOptions = new OptionsPropertyMainGroup(); + $dataOptions->setName("dump_what"); + $dataOptions->setText(__('Data dump options')); + $dataOptions->setForce('structure'); + // create primary items and add them to the group + $leaf = new TextPropertyItem(); + $leaf->setName("null"); + $leaf->setText(__('Replace NULL with:')); + $dataOptions->addProperty($leaf); + $leaf = new BoolPropertyItem(); + $leaf->setName("columns"); + $leaf->setText(__('Put columns names in the first row')); + $dataOptions->addProperty($leaf); + // add the main group to the root group + $exportSpecificOptions->addProperty($dataOptions); + + // set the options for the export plugin property item + $exportPluginProperties->setOptions($exportSpecificOptions); + $this->properties = $exportPluginProperties; } /** @@ -590,10 +597,10 @@ class ExportHtmlword extends ExportPlugin $column, $unique_keys ) { $definition = ''; - + $extracted_columnspec = PMA_CommonFunctions::getInstance()->extractColumnSpec($column['Type']); - + $type = htmlspecialchars($extracted_columnspec['print_type']); if (empty($type)) { $type = ' '; diff --git a/libraries/properties/options/OptionsPropertyItem.class.php b/libraries/properties/options/OptionsPropertyItem.class.php index 4c683e8e3e..4a2418d34b 100644 --- a/libraries/properties/options/OptionsPropertyItem.class.php +++ b/libraries/properties/options/OptionsPropertyItem.class.php @@ -36,6 +36,13 @@ abstract class OptionsPropertyItem extends PropertyItem */ private $_text; + /** + * What to force + * + * @var string + */ + private $_force; + /* ~~~~~~~~~~~~~~~~~~~~ Getters and Setters ~~~~~~~~~~~~~~~~~~~~ */ @@ -85,6 +92,28 @@ abstract class OptionsPropertyItem extends PropertyItem $this->_text = $text; } + /** + * Gets the force parameter + * + * @return string + */ + public function getForce() + { + return $this->_force; + } + + /** + * Sets the force paramter + * + * @param string $force force parameter + * + * @return void + */ + public function setForce($force) + { + $this->_force = $force; + } + /** * Returns the property type ( either "options", or "plugin" ). * From 63fa3fa4c07fcb54e3f672384f314fe9c16d34c9 Mon Sep 17 00:00:00 2001 From: Alex Marin Date: Wed, 18 Jul 2012 11:44:19 +0300 Subject: [PATCH 11/17] oop: use properties for ExportLatex --- .../plugins/export/ExportHtmlword.class.php | 12 +- .../ExportLatex.class.php | 236 +++++++++--------- 2 files changed, 121 insertions(+), 127 deletions(-) rename libraries/plugins/export/{todo_change_properties => }/ExportLatex.class.php (75%) diff --git a/libraries/plugins/export/ExportHtmlword.class.php b/libraries/plugins/export/ExportHtmlword.class.php index 3f43dceebf..69268b5f03 100644 --- a/libraries/plugins/export/ExportHtmlword.class.php +++ b/libraries/plugins/export/ExportHtmlword.class.php @@ -57,9 +57,9 @@ class ExportHtmlword extends ExportPlugin $exportSpecificOptions->setName("Format Specific Options"); // what to dump (structure/data/both) - $generalOptions = new OptionsPropertyMainGroup(); - $generalOptions->setName("dump_what"); - $generalOptions->setText(__('Dump table')); + $dumpWhat = new OptionsPropertyMainGroup(); + $dumpWhat->setName("dump_what"); + $dumpWhat->setText(__('Dump table')); // create primary items and add them to the group $leaf = new RadioPropertyItem(); $leaf->setName("structure_or_data"); @@ -68,11 +68,11 @@ class ExportHtmlword extends ExportPlugin 'data' => __('data'), 'structure_and_data' => __('structure and data') )); - $generalOptions->addProperty($leaf); + $dumpWhat->addProperty($leaf); // add the main group to the root group - $exportSpecificOptions->addProperty($generalOptions); + $exportSpecificOptions->addProperty($dumpWhat); - // data options + // data options main group $dataOptions = new OptionsPropertyMainGroup(); $dataOptions->setName("dump_what"); $dataOptions->setText(__('Data dump options')); diff --git a/libraries/plugins/export/todo_change_properties/ExportLatex.class.php b/libraries/plugins/export/ExportLatex.class.php similarity index 75% rename from libraries/plugins/export/todo_change_properties/ExportLatex.class.php rename to libraries/plugins/export/ExportLatex.class.php index b95f8134df..77f9746900 100644 --- a/libraries/plugins/export/todo_change_properties/ExportLatex.class.php +++ b/libraries/plugins/export/ExportLatex.class.php @@ -59,136 +59,130 @@ class ExportLatex extends ExportPlugin $hide_structure = true; } - $this->properties = array( - 'text' => __('LaTeX'), - 'extension' => 'tex', - 'mime_type' => 'application/x-tex', - 'options' => array(), - 'options_text' => __('Options') - ); + $props = 'libraries/properties/'; + require_once "$props/plugins/ExportPluginProperties.class.php"; + require_once "$props/options/groups/OptionsPropertyRootGroup.class.php"; + require_once "$props/options/groups/OptionsPropertyMainGroup.class.php"; + require_once "$props/options/items/BoolPropertyItem.class.php"; + require_once "$props/options/items/RadioPropertyItem.class.php"; + require_once "$props/options/items/TextPropertyItem.class.php"; - $this->properties['options'] = array( - array( - 'type' => 'begin_group', - 'name' => 'general_opts' - ), - array( - 'type' => 'bool', - 'name' => 'caption', - 'text' => __('Include table caption') - ), - array( - 'type' => 'end_group' - ) - ); + $exportPluginProperties = new ExportPluginProperties(); + $exportPluginProperties->setText('LaTeX'); + $exportPluginProperties->setExtension('tex'); + $exportPluginProperties->setMimeType('application/x-tex'); + $exportPluginProperties->setOptionsText(__('Options')); - /* what to dump (structure/data/both) */ - $this->properties['options'][] = array( - 'type' => 'begin_group', - 'name' => 'dump_what', - 'text' => __('Dump table') - ); - $this->properties['options'][] = array( - 'type' => 'radio', - 'name' => 'structure_or_data', - 'values' => array( - 'structure' => __('structure'), - 'data' => __('data'), - 'structure_and_data' => __('structure and data') - ) - ); - $this->properties['options'][] = array( - 'type' => 'end_group' - ); + // create the root group that will be the options field for + // $exportPluginProperties + // this will be shown as "Format specific options" + $exportSpecificOptions = new OptionsPropertyRootGroup(); + $exportSpecificOptions->setName("Format Specific Options"); - /* Structure options */ + // general options main group + $generalOptions = new OptionsPropertyMainGroup(); + $generalOptions->setName("general_opts"); + // create primary items and add them to the group + $leaf = new BoolPropertyItem(); + $leaf->setName("caption"); + $leaf->setText(__('Include table caption')); + $generalOptions->addProperty($leaf); + // add the main group to the root group + $exportSpecificOptions->addProperty($generalOptions); + + // what to dump (structure/data/both) main group + $dumpWhat = new OptionsPropertyMainGroup(); + $dumpWhat->setName("dump_what"); + $dumpWhat->setText(__('Dump table')); + // create primary items and add them to the group + $leaf = new RadioPropertyItem(); + $leaf->setName("structure_or_data"); + $leaf->setValues(array( + 'structure' => __('structure'), + 'data' => __('data'), + 'structure_and_data' => __('structure and data') + )); + $dumpWhat->addProperty($leaf); + // add the main group to the root group + $exportSpecificOptions->addProperty($dumpWhat); + + // structure options main group if (! $hide_structure) { - $this->properties['options'][] = array( - 'type' => 'begin_group', - 'name' => 'structure', - 'text' => __('Object creation options'), - 'force' => 'data' - ); - $this->properties['options'][] = array( - 'type' => 'text', - 'name' => 'structure_caption', - 'text' => __('Table caption'), - 'doc' => 'faq6_27' - ); - $this->properties['options'][] = array( - 'type' => 'text', - 'name' => 'structure_continued_caption', - 'text' => __('Table caption (continued)'), - 'doc' => 'faq6_27' - ); - $this->properties['options'][] = array( - 'type' => 'text', - 'name' => 'structure_label', - 'text' => __('Label key'), - 'doc' => 'faq6_27' - ); + $structureOptions = new OptionsPropertyMainGroup(); + $structureOptions->setName("structure"); + $structureOptions->setText(__('Object creation options')); + $structureOptions->setForce('data'); + // create primary items and add them to the group + $leaf = new TextPropertyItem(); + $leaf->setName("structure_caption"); + $leaf->setText(__('Table caption')); + $leaf->setDoc('faq6_27'); + $structureOptions->addProperty($leaf); + $leaf = new TextPropertyItem(); + $leaf->setName("structure_continued_caption"); + $leaf->setText(__('Table caption (continued)')); + $leaf->setDoc('faq6_27'); + $structureOptions->addProperty($leaf); + $leaf = new TextPropertyItem(); + $leaf->setName("structure_label"); + $leaf->setText(__('Label key')); + $leaf->setDoc('faq6_27'); + $structureOptions->addProperty($leaf); if (! empty($GLOBALS['cfgRelation']['relation'])) { - $this->properties['options'][] = array( - 'type' => 'bool', - 'name' => 'relation', - 'text' => __('Display foreign key relationships') - ); + $leaf = new BoolPropertyItem(); + $leaf->setName("relation"); + $leaf->setText(__('Display foreign key relationships')); + $structureOptions->addProperty($leaf); } - $this->properties['options'][] = array( - 'type' => 'bool', - 'name' => 'comments', - 'text' => __('Display comments') - ); + $leaf = new BoolPropertyItem(); + $leaf->setName("comments"); + $leaf->setText(__('Display comments')); + $structureOptions->addProperty($leaf); if (! empty($GLOBALS['cfgRelation']['mimework'])) { - $this->properties['options'][] = array( - 'type' => 'bool', - 'name' => 'mime', - 'text' => __('Display MIME types') - ); + $leaf = new BoolPropertyItem(); + $leaf->setName("mime"); + $leaf->setText(__('Display MIME types')); + $structureOptions->addProperty($leaf); } - $this->properties['options'][] = array( - 'type' => 'end_group' - ); + // add the main group to the root group + $exportSpecificOptions->addProperty($structureOptions); } - /* Data */ - $this->properties['options'][] = array( - 'type' => 'begin_group', - 'name' => 'data', - 'text' => __('Data dump options'), - 'force' => 'structure' - ); - $this->properties['options'][] = array( - 'type' => 'bool', - 'name' => 'columns', - 'text' => __('Put columns names in the first row') - ); - $this->properties['options'][] = array( - 'type' => 'text', - 'name' => 'data_caption', - 'text' => __('Table caption'), - 'doc' => 'faq6_27' - ); - $this->properties['options'][] = array( - 'type' => 'text', - 'name' => 'data_continued_caption', - 'text' => __('Table caption (continued)'), - 'doc' => 'faq6_27' - ); - $this->properties['options'][] = array( - 'type' => 'text', - 'name' => 'data_label', - 'text' => __('Label key'), - 'doc' => 'faq6_27' - ); - $this->properties['options'][] = array( - 'type' => 'text', - 'name' => 'null', - 'text' => __('Replace NULL with:') - ); - $this->properties['options'][] = array( - 'type' => 'end_group' - ); + // data options main group + $dataOptions = new OptionsPropertyMainGroup(); + $dataOptions->setName("data"); + $dataOptions->setText(__('Data dump options')); + $dataOptions->setForce(structure); + // create primary items and add them to the group + $leaf = new BoolPropertyItem(); + $leaf->setName("columns"); + $leaf->setText(__('Put columns names in the first row')); + $dataOptions->addProperty($leaf); + $leaf = new TextPropertyItem(); + $leaf->setName("data_caption"); + $leaf->setText(__('Table caption')); + $leaf->setDoc('faq6_27'); + $dataOptions->addProperty($leaf); + $leaf = new TextPropertyItem(); + $leaf->setName("data_continued_caption"); + $leaf->setText(__('Table caption (continued)')); + $leaf->setDoc('faq6_27'); + $dataOptions->addProperty($leaf); + $leaf = new TextPropertyItem(); + $leaf->setName("data_label"); + $leaf->setText(__('Label key')); + $leaf->setDoc('faq6_27'); + $dataOptions->addProperty($leaf); + $leaf = new TextPropertyItem(); + $leaf->setName('null'); + $leaf->setText(__('Replace NULL with:')); + $dataOptions->addProperty($leaf); + // add the main group to the root group + $exportSpecificOptions->addProperty($dataOptions); + + // set the options for the export plugin property item + $exportPluginProperties->setOptions($exportSpecificOptions); + $this->properties = $exportPluginProperties; } /** @@ -442,7 +436,7 @@ class ExportLatex extends ExportPlugin $dates = false ) { global $cfgRelation; - + $common_functions = PMA_CommonFunctions::getInstance(); $this->setCfgRelation($cfgRelation); From 1f23a10f538a1e8198e3bcea3007ecfdde2d889e Mon Sep 17 00:00:00 2001 From: Alex Marin Date: Wed, 18 Jul 2012 11:55:13 +0300 Subject: [PATCH 12/17] oop: use properties for ExportOds --- .../ExportOds.class.php | 72 +++++++++++-------- 1 file changed, 41 insertions(+), 31 deletions(-) rename libraries/plugins/export/{todo_change_properties => }/ExportOds.class.php (82%) diff --git a/libraries/plugins/export/todo_change_properties/ExportOds.class.php b/libraries/plugins/export/ExportOds.class.php similarity index 82% rename from libraries/plugins/export/todo_change_properties/ExportOds.class.php rename to libraries/plugins/export/ExportOds.class.php index ae320cc926..f599d86431 100644 --- a/libraries/plugins/export/todo_change_properties/ExportOds.class.php +++ b/libraries/plugins/export/ExportOds.class.php @@ -38,38 +38,48 @@ class ExportOds extends ExportPlugin */ protected function setProperties() { - $this->properties = array( - 'text' => __('Open Document Spreadsheet'), - 'extension' => 'ods', - 'mime_type' => 'application/vnd.oasis.opendocument.spreadsheet', - 'force_file' => true, - 'options' => array(), - 'options_text' => __('Options') - ); + $props = 'libraries/properties/'; + require_once "$props/plugins/ExportPluginProperties.class.php"; + require_once "$props/options/groups/OptionsPropertyRootGroup.class.php"; + require_once "$props/options/groups/OptionsPropertyMainGroup.class.php"; + require_once "$props/options/items/TextPropertyItem.class.php"; + require_once "$props/options/items/BoolPropertyItem.class.php"; + require_once "$props/options/items/HiddenPropertyItem.class.php"; - $this->properties['options'] = array( - array( - 'type' => 'begin_group', - 'name' => 'general_opts' - ), - array( - 'type' => 'text', - 'name' => 'null', - 'text' => __('Replace NULL with:') - ), - array( - 'type' => 'bool', - 'name' => 'columns', - 'text' => __('Put columns names in the first row') - ), - array( - 'type' => 'hidden', - 'name' => 'structure_or_data' - ), - array( - 'type' => 'end_group' - ) - ); + $exportPluginProperties = new ExportPluginProperties(); + $exportPluginProperties->setText('Open Document Spreadsheet'); + $exportPluginProperties->setExtension('ods'); + $exportPluginProperties->setMimeType('application/vnd.oasis.opendocument.spreadsheet'); + $exportPluginProperties->setForceFile(true); + $exportPluginProperties->setOptionsText(__('Options')); + + // create the root group that will be the options field for + // $exportPluginProperties + // this will be shown as "Format specific options" + $exportSpecificOptions = new OptionsPropertyRootGroup(); + $exportSpecificOptions->setName("Format Specific Options"); + + // general options main group + $generalOptions = new OptionsPropertyMainGroup(); + $generalOptions->setName("general_opts"); + // create primary items and add them to the group + $leaf = new TextPropertyItem(); + $leaf->setName("null"); + $leaf->setText(__('Replace NULL with:')); + $generalOptions->addProperty($leaf); + $leaf = new BoolPropertyItem(); + $leaf->setName("columns"); + $leaf->setText(__('Put columns names in the first row')); + $generalOptions->addProperty($leaf); + $leaf = new HiddenPropertyItem(); + $leaf->setName("structure_or_data"); + $generalOptions->addProperty($leaf); + // add the main group to the root group + $exportSpecificOptions->addProperty($generalOptions); + + // set the options for the export plugin property item + $exportPluginProperties->setOptions($exportSpecificOptions); + $this->properties = $exportPluginProperties; } /** From 05e0bd9756f00283654542aed16b2d0c97913d96 Mon Sep 17 00:00:00 2001 From: Alex Marin Date: Wed, 18 Jul 2012 12:13:12 +0300 Subject: [PATCH 13/17] oop: use properties for ExportOdt --- .../plugins/export/ExportLatex.class.php | 2 +- .../ExportOdt.class.php | 149 +++++++++--------- 2 files changed, 78 insertions(+), 73 deletions(-) rename libraries/plugins/export/{todo_change_properties => }/ExportOdt.class.php (85%) diff --git a/libraries/plugins/export/ExportLatex.class.php b/libraries/plugins/export/ExportLatex.class.php index 77f9746900..43c9677d4f 100644 --- a/libraries/plugins/export/ExportLatex.class.php +++ b/libraries/plugins/export/ExportLatex.class.php @@ -152,7 +152,7 @@ class ExportLatex extends ExportPlugin $dataOptions = new OptionsPropertyMainGroup(); $dataOptions->setName("data"); $dataOptions->setText(__('Data dump options')); - $dataOptions->setForce(structure); + $dataOptions->setForce('structure'); // create primary items and add them to the group $leaf = new BoolPropertyItem(); $leaf->setName("columns"); diff --git a/libraries/plugins/export/todo_change_properties/ExportOdt.class.php b/libraries/plugins/export/ExportOdt.class.php similarity index 85% rename from libraries/plugins/export/todo_change_properties/ExportOdt.class.php rename to libraries/plugins/export/ExportOdt.class.php index eca4ae1481..2667c0b38c 100644 --- a/libraries/plugins/export/todo_change_properties/ExportOdt.class.php +++ b/libraries/plugins/export/ExportOdt.class.php @@ -46,86 +46,91 @@ class ExportOdt extends ExportPlugin $hide_structure = true; } - $this->properties = array( - 'text' => __('Open Document Text'), - 'extension' => 'odt', - 'mime_type' => 'application/vnd.oasis.opendocument.text', - 'force_file' => true, - 'options' => array(), - 'options_text' => __('Options') - ); + $props = 'libraries/properties/'; + require_once "$props/plugins/ExportPluginProperties.class.php"; + require_once "$props/options/groups/OptionsPropertyRootGroup.class.php"; + require_once "$props/options/groups/OptionsPropertyMainGroup.class.php"; + require_once "$props/options/items/TextPropertyItem.class.php"; + require_once "$props/options/items/BoolPropertyItem.class.php"; + require_once "$props/options/items/HiddenPropertyItem.class.php"; - /* what to dump (structure/data/both) */ - $this->properties['options'][] = array( - 'type' => 'begin_group', - 'text' => __('Dump table'), - 'name' => 'general_opts' - ); - $this->properties['options'][] = array( - 'type' => 'radio', - 'name' => 'structure_or_data', - 'values' => array( - 'structure' => __('structure'), - 'data' => __('data'), - 'structure_and_data' => __('structure and data') - ) - ); - $this->properties['options'][] = array( - 'type' => 'end_group' - ); + $exportPluginProperties = new ExportPluginProperties(); + $exportPluginProperties->setText('Open Document Text'); + $exportPluginProperties->setExtension('odt'); + $exportPluginProperties->setMimeType('application/vnd.oasis.opendocument.text'); + $exportPluginProperties->setForceFile(true); + $exportPluginProperties->setOptionsText(__('Options')); - /* Structure options */ + // create the root group that will be the options field for + // $exportPluginProperties + // this will be shown as "Format specific options" + $exportSpecificOptions = new OptionsPropertyRootGroup(); + $exportSpecificOptions->setName("Format Specific Options"); + + // what to dump (structure/data/both) main group + $dumpWhat = new OptionsPropertyMainGroup(); + $dumpWhat->setName("general_opts"); + $dumpWhat->setText(__('Dump table')); + // create primary items and add them to the group + $leaf = new RadioPropertyItem(); + $leaf->setName("structure_or_data"); + $leaf->setValues(array( + 'structure' => __('structure'), + 'data' => __('data'), + 'structure_and_data' => __('structure and data') + )); + $dumpWhat->addProperty($leaf); + // add the main group to the root group + $exportSpecificOptions->addProperty($dumpWhat); + + + // structure options main group if (! $hide_structure) { - $this->properties['options'][] = array( - 'type' => 'begin_group', - 'name' => 'structure', - 'text' => __('Object creation options'), - 'force' => 'data' - ); + $structureOptions = new OptionsPropertyMainGroup(); + $structureOptions->setName("structure"); + $structureOptions->setText(__('Object creation options')); + $structureOptions->setForce('data'); + // create primary items and add them to the group if (! empty($GLOBALS['cfgRelation']['relation'])) { - $this->properties['options'][] = array( - 'type' => 'bool', - 'name' => 'relation', - 'text' => __('Display foreign key relationships') - ); + $leaf = new BoolPropertyItem(); + $leaf->setName("relation"); + $leaf->setText(__('Display foreign key relationships')); + $structureOptions->addProperty($leaf); } - $this->properties['options'][] = array( - 'type' => 'bool', - 'name' => 'comments', - 'text' => __('Display comments') - ); + $leaf = new BoolPropertyItem(); + $leaf->setName("comments"); + $leaf->setText(__('Display comments')); + $structureOptions->addProperty($leaf); if (! empty($GLOBALS['cfgRelation']['mimework'])) { - $this->properties['options'][] = array( - 'type' => 'bool', - 'name' => 'mime', - 'text' => __('Display MIME types') - ); + $leaf = new BoolPropertyItem(); + $leaf->setName("mime"); + $leaf->setText(__('Display MIME types')); + $structureOptions->addProperty($leaf); } - $this->properties['options'][] = array( - 'type' => 'end_group' - ); + // add the main group to the root group + $exportSpecificOptions->addProperty($structureOptions); } - /* Data */ - $this->properties['options'][] = array( - 'type' => 'begin_group', - 'name' => 'data', - 'text' => __('Data dump options'), - 'force' => 'structure' - ); - $this->properties['options'][] = array( - 'type' => 'bool', - 'name' => 'columns', - 'text' => __('Put columns names in the first row') - ); - $this->properties['options'][] = array( - 'type' => 'text', - 'name' => 'null', - 'text' => __('Replace NULL with:') - ); - $this->properties['options'][] = array( - 'type' => 'end_group' - ); + // data options main group + $dataOptions = new OptionsPropertyMainGroup(); + $dataOptions->setName("data"); + $dataOptions->setText(__('Data dump options')); + $dataOptions->setForce('structure'); + // create primary items and add them to the group + $leaf = new BoolPropertyItem(); + $leaf->setName("columns"); + $leaf->setText(__('Put columns names in the first row')); + $dataOptions->addProperty($leaf); + $leaf = new TextPropertyItem(); + $leaf->setName('null'); + $leaf->setText(__('Replace NULL with:')); + $dataOptions->addProperty($leaf); + // add the main group to the root group + $exportSpecificOptions->addProperty($dataOptions); + + // set the options for the export plugin property item + $exportPluginProperties->setOptions($exportSpecificOptions); + $this->properties = $exportPluginProperties; } /** @@ -386,7 +391,7 @@ class ExportOdt extends ExportPlugin * @param bool $add_semicolon whether to add semicolon and end-of-line at * the end * @param bool $view whether we're handling a view - * + * * @return bool true */ public function getTableDef( From 9f53828dca0c356aa3a20434323a82f4bb4277b6 Mon Sep 17 00:00:00 2001 From: Alex Marin Date: Wed, 18 Jul 2012 12:18:37 +0300 Subject: [PATCH 14/17] oop: use properties for ExportPdf --- .../ExportPdf.class.php | 76 +++++++++++-------- 1 file changed, 43 insertions(+), 33 deletions(-) rename libraries/plugins/export/{todo_change_properties => }/ExportPdf.class.php (68%) diff --git a/libraries/plugins/export/todo_change_properties/ExportPdf.class.php b/libraries/plugins/export/ExportPdf.class.php similarity index 68% rename from libraries/plugins/export/todo_change_properties/ExportPdf.class.php rename to libraries/plugins/export/ExportPdf.class.php index 9aa41553f8..df3867f518 100644 --- a/libraries/plugins/export/todo_change_properties/ExportPdf.class.php +++ b/libraries/plugins/export/ExportPdf.class.php @@ -65,40 +65,50 @@ class ExportPdf extends ExportPlugin */ protected function setProperties() { - $this->properties = array( - 'text' => __('PDF'), - 'extension' => 'pdf', - 'mime_type' => 'application/pdf', - 'force_file' => true, - 'options' => array(), - 'options_text' => __('Options') - ); + $props = 'libraries/properties/'; + require_once "$props/plugins/ExportPluginProperties.class.php"; + require_once "$props/options/groups/OptionsPropertyRootGroup.class.php"; + require_once "$props/options/groups/OptionsPropertyMainGroup.class.php"; + require_once "$props/options/items/MessageOnlyPropertyItem.class.php"; + require_once "$props/options/items/TextPropertyItem.class.php"; + require_once "$props/options/items/HiddenPropertyItem.class.php"; - $this->properties['options'] = array( - array( - 'type' => 'begin_group', - 'name' => 'general_opts' - ), - array( - 'type' => 'message_only', - 'name' => 'explanation', - 'text' => __( - '(Generates a report containing the data of a single table)' - ) - ), - array( - 'type' => 'text', - 'name' => 'report_title', - 'text' => __('Report title:') - ), - array( - 'type' => 'hidden', - 'name' => 'structure_or_data' - ), - array( - 'type' => 'end_group' - ) - ); + $exportPluginProperties = new ExportPluginProperties(); + $exportPluginProperties->setText('PDF'); + $exportPluginProperties->setExtension('pdf'); + $exportPluginProperties->setMimeType('application/pdf'); + $exportPluginProperties->setForceFile(true); + $exportPluginProperties->setOptionsText(__('Options')); + + // create the root group that will be the options field for + // $exportPluginProperties + // this will be shown as "Format specific options" + $exportSpecificOptions = new OptionsPropertyRootGroup(); + $exportSpecificOptions->setName("Format Specific Options"); + + // general options main group + $generalOptions = new OptionsPropertyMainGroup(); + $generalOptions->setName("general_opts"); + // create primary items and add them to the group + $leaf = new MessageOnlyPropertyItem(); + $leaf->setName("explanation"); + $leaf->setText(__( + '(Generates a report containing the data of a single table)' + )); + $generalOptions->addProperty($leaf); + $leaf = new TextPropertyItem(); + $leaf->setName("report_title"); + $leaf->setText(__('Report title:')); + $generalOptions->addProperty($leaf); + $leaf = new HiddenPropertyItem(); + $leaf->setName("structure_or_data"); + $generalOptions->addProperty($leaf); + // add the main group to the root group + $exportSpecificOptions->addProperty($generalOptions); + + // set the options for the export plugin property item + $exportPluginProperties->setOptions($exportSpecificOptions); + $this->properties = $exportPluginProperties; } /** From b672d605e21f2dd4efe0f8bde7de131ea42a3050 Mon Sep 17 00:00:00 2001 From: Alex Marin Date: Wed, 18 Jul 2012 17:29:23 +0300 Subject: [PATCH 15/17] oop: use properties for ExportPhparray --- .../ExportPhparray.class.php | 50 +++++++++++-------- 1 file changed, 30 insertions(+), 20 deletions(-) rename libraries/plugins/export/{todo_change_properties => }/ExportPhparray.class.php (76%) diff --git a/libraries/plugins/export/todo_change_properties/ExportPhparray.class.php b/libraries/plugins/export/ExportPhparray.class.php similarity index 76% rename from libraries/plugins/export/todo_change_properties/ExportPhparray.class.php rename to libraries/plugins/export/ExportPhparray.class.php index f739fd21a4..c1116d3906 100644 --- a/libraries/plugins/export/todo_change_properties/ExportPhparray.class.php +++ b/libraries/plugins/export/ExportPhparray.class.php @@ -35,27 +35,37 @@ class ExportPhparray extends ExportPlugin */ protected function setProperties() { - $this->properties = array( - 'text' => __('PHP array'), - 'extension' => 'php', - 'mime_type' => 'text/plain', - 'options' => array(), - 'options_text' => __('Options') - ); + $props = 'libraries/properties/'; + require_once "$props/plugins/ExportPluginProperties.class.php"; + require_once "$props/options/groups/OptionsPropertyRootGroup.class.php"; + require_once "$props/options/groups/OptionsPropertyMainGroup.class.php"; + require_once "$props/options/items/HiddenPropertyItem.class.php"; - $this->properties['options'] = array( - array( - 'type' => 'begin_group', - 'name' => 'general_opts' - ), - array( - 'type' => 'hidden', - 'name' => 'structure_or_data', - ), - array( - 'type' => 'end_group' - ) - ); + $exportPluginProperties = new ExportPluginProperties(); + $exportPluginProperties->setText('PHP array'); + $exportPluginProperties->setExtension('php'); + $exportPluginProperties->setMimeType('text/plain'); + $exportPluginProperties->setOptionsText(__('Options')); + + // create the root group that will be the options field for + // $exportPluginProperties + // this will be shown as "Format specific options" + $exportSpecificOptions = new OptionsPropertyRootGroup(); + $exportSpecificOptions->setName("Format Specific Options"); + + // general options main group + $generalOptions = new OptionsPropertyMainGroup(); + $generalOptions->setName("general_opts"); + // create primary items and add them to the group + $leaf = new HiddenPropertyItem(); + $leaf->setName("structure_or_data"); + $generalOptions->addProperty($leaf); + // add the main group to the root group + $exportSpecificOptions->addProperty($generalOptions); + + // set the options for the export plugin property item + $exportPluginProperties->setOptions($exportSpecificOptions); + $this->properties = $exportPluginProperties; } /** From bbee588f956c991e266ef7ae9687601ffa7fb266 Mon Sep 17 00:00:00 2001 From: Alex Marin Date: Wed, 18 Jul 2012 17:32:10 +0300 Subject: [PATCH 16/17] oop: use properties for ExportYaml --- .../ExportYaml.class.php | 52 +++++++++++-------- 1 file changed, 31 insertions(+), 21 deletions(-) rename libraries/plugins/export/{todo_change_properties => }/ExportYaml.class.php (72%) diff --git a/libraries/plugins/export/todo_change_properties/ExportYaml.class.php b/libraries/plugins/export/ExportYaml.class.php similarity index 72% rename from libraries/plugins/export/todo_change_properties/ExportYaml.class.php rename to libraries/plugins/export/ExportYaml.class.php index 2ac51c6b05..9c084e6b92 100644 --- a/libraries/plugins/export/todo_change_properties/ExportYaml.class.php +++ b/libraries/plugins/export/ExportYaml.class.php @@ -35,28 +35,38 @@ class ExportYaml extends ExportPlugin */ protected function setProperties() { - $this->properties = array( - 'text' => 'YAML', - 'extension' => 'yml', - 'mime_type' => 'text/yaml', - 'force_file' => true, - 'options' => array(), - 'options_text' => __('Options') - ); + $props = 'libraries/properties/'; + require_once "$props/plugins/ExportPluginProperties.class.php"; + require_once "$props/options/groups/OptionsPropertyRootGroup.class.php"; + require_once "$props/options/groups/OptionsPropertyMainGroup.class.php"; + require_once "$props/options/items/HiddenPropertyItem.class.php"; - $this->properties['options'] = array( - array( - 'type' => 'begin_group', - 'name' => 'general_opts' - ), - array( - 'type' => 'hidden', - 'name' => 'structure_or_data', - ), - array( - 'type' => 'end_group' - ) - ); + $exportPluginProperties = new ExportPluginProperties(); + $exportPluginProperties->setText('YAML'); + $exportPluginProperties->setExtension('yml'); + $exportPluginProperties->setMimeType('text/yaml'); + $exportPluginProperties->setForceFile(true); + $exportPluginProperties->setOptionsText(__('Options')); + + // create the root group that will be the options field for + // $exportPluginProperties + // this will be shown as "Format specific options" + $exportSpecificOptions = new OptionsPropertyRootGroup(); + $exportSpecificOptions->setName("Format Specific Options"); + + // general options main group + $generalOptions = new OptionsPropertyMainGroup(); + $generalOptions->setName("general_opts"); + // create primary items and add them to the group + $leaf = new HiddenPropertyItem(); + $leaf->setName("structure_or_data"); + $generalOptions->addProperty($leaf); + // add the main group to the root group + $exportSpecificOptions->addProperty($generalOptions); + + // set the options for the export plugin property item + $exportPluginProperties->setOptions($exportSpecificOptions); + $this->properties = $exportPluginProperties; } /** From afebe60cdbb575151783428c6a2f73e24bf062a3 Mon Sep 17 00:00:00 2001 From: Alex Marin Date: Wed, 18 Jul 2012 17:37:41 +0300 Subject: [PATCH 17/17] oop: use properties for ExportTexytext --- .../ExportTexytext.class.php | 101 ++++++++++-------- 1 file changed, 55 insertions(+), 46 deletions(-) rename libraries/plugins/export/{todo_change_properties => }/ExportTexytext.class.php (85%) diff --git a/libraries/plugins/export/todo_change_properties/ExportTexytext.class.php b/libraries/plugins/export/ExportTexytext.class.php similarity index 85% rename from libraries/plugins/export/todo_change_properties/ExportTexytext.class.php rename to libraries/plugins/export/ExportTexytext.class.php index 7fcbc7117f..be87426a02 100644 --- a/libraries/plugins/export/todo_change_properties/ExportTexytext.class.php +++ b/libraries/plugins/export/ExportTexytext.class.php @@ -35,53 +35,62 @@ class ExportTexytext extends ExportPlugin */ protected function setProperties() { - $this->properties = array( - 'text' => __('Texy! text'), - 'extension' => 'txt', - 'mime_type' => 'text/plain', - 'options' => array(), - 'options_text' => __('Options') - ); + $props = 'libraries/properties/'; + require_once "$props/plugins/ExportPluginProperties.class.php"; + require_once "$props/options/groups/OptionsPropertyRootGroup.class.php"; + require_once "$props/options/groups/OptionsPropertyMainGroup.class.php"; + require_once "$props/options/items/RadioPropertyItem.class.php"; + require_once "$props/options/items/BoolPropertyItem.class.php"; + require_once "$props/options/items/TextPropertyItem.class.php"; - $this->properties['options'] = array( - /* what to dump (structure/data/both) */ - array( - 'type' => 'begin_group', - 'text' => __('Dump table'), - 'name' => 'general_opts' - ), - array( - 'type' => 'radio', - 'name' => 'structure_or_data', - 'values' => array( - 'structure' => __('structure'), - 'data' => __('data'), - 'structure_and_data' => __('structure and data') - ) - ), - array( - 'type' => 'end_group' - ), - array( - 'type' => 'begin_group', - 'name' => 'data', - 'text' => __('Data dump options'), - 'force' => 'structure' - ), - array( - 'type' => 'text', - 'name' => 'null', - 'text' => __('Replace NULL by') - ), - array( - 'type' => 'bool', - 'name' => 'columns', - 'text' => __('Put columns names in the first row') - ), - array( - 'type' => 'end_group' - ) - ); + $exportPluginProperties = new ExportPluginProperties(); + $exportPluginProperties->setText('Texy! text'); + $exportPluginProperties->setExtension('txt'); + $exportPluginProperties->setMimeType('text/plain'); + $exportPluginProperties->setOptionsText(__('Options')); + + // create the root group that will be the options field for + // $exportPluginProperties + // this will be shown as "Format specific options" + $exportSpecificOptions = new OptionsPropertyRootGroup(); + $exportSpecificOptions->setName("Format Specific Options"); + + // what to dump (structure/data/both) main group + $dumpWhat = new OptionsPropertyMainGroup(); + $dumpWhat->setName("general_opts"); + $dumpWhat->setText(__('Dump table')); + // create primary items and add them to the group + $leaf = new RadioPropertyItem(); + $leaf->setName("structure_or_data"); + $leaf->setValues(array( + 'structure' => __('structure'), + 'data' => __('data'), + 'structure_and_data' => __('structure and data') + )); + $dumpWhat->addProperty($leaf); + // add the main group to the root group + $exportSpecificOptions->addProperty($dumpWhat); + + // set the options for the export plugin property item + $exportPluginProperties->setOptions($exportSpecificOptions); + $this->properties = $exportPluginProperties; + + // data options main group + $dataOptions = new OptionsPropertyMainGroup(); + $dataOptions->setName("data"); + $dataOptions->setText(__('Data dump options')); + $dataOptions->setForce('structure'); + // create primary items and add them to the group + $leaf = new BoolPropertyItem(); + $leaf->setName("columns"); + $leaf->setText(__('Put columns names in the first row')); + $dataOptions->addProperty($leaf); + $leaf = new TextPropertyItem(); + $leaf->setName('null'); + $leaf->setText(__('Replace NULL with:')); + $dataOptions->addProperty($leaf); + // add the main group to the root group + $exportSpecificOptions->addProperty($dataOptions); } /**