ExportPluginProperties.php 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. <?php
  2. /**
  3. * Properties class for the export plug-in
  4. */
  5. declare(strict_types=1);
  6. namespace PhpMyAdmin\Properties\Plugins;
  7. /**
  8. * Defines possible options and getters and setters for them.
  9. *
  10. * @todo modify descriptions if needed, when the plug-in properties are integrated
  11. */
  12. class ExportPluginProperties extends PluginPropertyItem
  13. {
  14. /**
  15. * Whether to force or not
  16. *
  17. * @var bool
  18. */
  19. private $forceFile;
  20. /* ~~~~~~~~~~~~~~~~~~~~ Getters and Setters ~~~~~~~~~~~~~~~~~~~~ */
  21. /**
  22. * Returns the property item type of either an instance of
  23. * - PhpMyAdmin\Properties\Options\OptionsPropertyOneItem ( f.e. "bool",
  24. * "text", "radio", etc ) or
  25. * - PhpMyAdmin\Properties\Options\OptionsPropertyGroup ( "root", "main"
  26. * or "subgroup" )
  27. * - PhpMyAdmin\Properties\Plugins\PluginPropertyItem ( "export", "import", "transformations" )
  28. *
  29. * @return string
  30. */
  31. public function getItemType()
  32. {
  33. return 'export';
  34. }
  35. /**
  36. * Gets the force file parameter
  37. *
  38. * @return bool
  39. */
  40. public function getForceFile()
  41. {
  42. return $this->forceFile;
  43. }
  44. /**
  45. * Sets the force file parameter
  46. *
  47. * @param bool $forceFile the force file parameter
  48. *
  49. * @return void
  50. */
  51. public function setForceFile($forceFile)
  52. {
  53. $this->forceFile = $forceFile;
  54. }
  55. }