IIndexOptions.php 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright 2018
  5. *
  6. * @author Maxence Lange <maxence@artificial-owl.com>
  7. *
  8. * @license GNU AGPL version 3 or any later version
  9. *
  10. * This program is free software: you can redistribute it and/or modify
  11. * it under the terms of the GNU Affero General Public License as
  12. * published by the Free Software Foundation, either version 3 of the
  13. * License, or (at your option) any later version.
  14. *
  15. * This program is distributed in the hope that it will be useful,
  16. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18. * GNU Affero General Public License for more details.
  19. *
  20. * You should have received a copy of the GNU Affero General Public License
  21. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  22. *
  23. */
  24. namespace OCP\FullTextSearch\Model;
  25. /**
  26. * Interface IIndexOptions
  27. *
  28. * IndexOptions are created in FullTextSearch when an admin initiate an index
  29. * from the command line:
  30. *
  31. * ./occ fulltextsearch:index "{\"option1\": \"value\", \"option2\": true}"
  32. *
  33. * @since 15.0.0
  34. *
  35. */
  36. interface IIndexOptions {
  37. /**
  38. * Get the value (as a string) for an option.
  39. *
  40. * @since 15.0.0
  41. *
  42. * @param string $option
  43. * @param string $default
  44. *
  45. * @return string
  46. */
  47. public function getOption(string $option, string $default = ''): string;
  48. /**
  49. * Get the value (as an array) for an option.
  50. *
  51. * @since 15.0.0
  52. *
  53. * @param string $option
  54. * @param array $default
  55. *
  56. * @return array
  57. */
  58. public function getOptionArray(string $option, array $default = []): array;
  59. /**
  60. * Get the value (as an boolean) for an option.
  61. *
  62. * @since 15.0.0
  63. *
  64. * @param string $option
  65. * @param bool $default
  66. *
  67. * @return bool
  68. */
  69. public function getOptionBool(string $option, bool $default): bool;
  70. }