nextcloud/lib/public/L10N/ILanguageIterator.php
Côme Chilliet 1ab09ec753
chore: Apply new coding standard to all files
The diff can be checked using: git diff --ignore-all-space --ignore-blank-lines
To see only the changes not related to blank lines.

Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>
2026-06-01 13:46:39 +02:00

60 lines
1.2 KiB
PHP

<?php
/**
* SPDX-FileCopyrightText: 2018 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\L10N;
/**
* Interface ILanguageIterator
*
* iterator across language settings (if provided) in this order:
* 1. returns the forced language or:
* 2. if applicable, the trunk of 1 (e.g. "fu" instead of "fu_BAR"
* 3. returns the user language or:
* 4. if applicable, the trunk of 3
* 5. returns the system default language or:
* 6. if applicable, the trunk of 5
* 7+∞. returns 'en'
*
* if settings are not present or truncating is not applicable, the iterator
* skips to the next valid item itself
*
* @template-extends \Iterator<int, string>
* @since 14.0.0
*/
interface ILanguageIterator extends \Iterator {
/**
* Return the current element
*
* @since 14.0.0
*/
#[\Override]
public function current(): string;
/**
* Move forward to next element
*
* @since 14.0.0
*/
#[\Override]
public function next(): void;
/**
* Return the key of the current element
*
* @since 14.0.0
*/
#[\Override]
public function key(): int;
/**
* Checks if current position is valid
*
* @since 14.0.0
*/
#[\Override]
public function valid(): bool;
}