ILanguageIterator.php 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2018 Arthur Schiwon <blizzz@arthur-schiwon.de>
  4. *
  5. * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
  6. *
  7. * @license GNU AGPL version 3 or any later version
  8. *
  9. * This program is free software: you can redistribute it and/or modify
  10. * it under the terms of the GNU Affero General Public License as
  11. * published by the Free Software Foundation, either version 3 of the
  12. * License, or (at your option) any later version.
  13. *
  14. * This program is distributed in the hope that it will be useful,
  15. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17. * GNU Affero General Public License for more details.
  18. *
  19. * You should have received a copy of the GNU Affero General Public License
  20. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  21. *
  22. */
  23. namespace OCP\L10N;
  24. /**
  25. * Interface ILanguageIterator
  26. *
  27. * iterator across language settings (if provided) in this order:
  28. * 1. returns the forced language or:
  29. * 2. if applicable, the trunk of 1 (e.g. "fu" instead of "fu_BAR"
  30. * 3. returns the user language or:
  31. * 4. if applicable, the trunk of 3
  32. * 5. returns the system default language or:
  33. * 6. if applicable, the trunk of 5
  34. * 7+∞. returns 'en'
  35. *
  36. * if settings are not present or truncating is not applicable, the iterator
  37. * skips to the next valid item itself
  38. *
  39. *
  40. * @since 14.0.0
  41. */
  42. interface ILanguageIterator extends \Iterator {
  43. /**
  44. * Return the current element
  45. *
  46. * @since 14.0.0
  47. */
  48. public function current(): string;
  49. /**
  50. * Move forward to next element
  51. *
  52. * @since 14.0.0
  53. * @return void
  54. */
  55. #[\ReturnTypeWillChange]
  56. public function next();
  57. /**
  58. * Return the key of the current element
  59. *
  60. * @since 14.0.0
  61. */
  62. public function key():int;
  63. /**
  64. * Checks if current position is valid
  65. *
  66. * @since 14.0.0
  67. */
  68. public function valid():bool;
  69. }