silverstripe-framework/i18n/i18nTranslateAdapterInterface.php
Damian Mooyman 8dd644d25d
API Namespace all classes
Namespace all templates
Move difflib and BBCodeParser2 to thirdparty
Remove deprecated API marked for removal in 4.0
2016-09-08 10:23:17 +12:00

22 lines
861 B
PHP

<?php
namespace SilverStripe\i18n;
/**
* Makes the {@link Zend_Translate_Adapter} base class aware of file naming conventions within SilverStripe.
* Needs to be implemented by all translators used through {@link i18n::register_translator()}.
*
* A bit of context: Zend is file extension agnostic by default, and simply uses the filenames to detect locales
* with the 'scan' option, passing all files to the used adapter. We support multiple formats in the same /lang/
* folder, so need to be more selective about including files to avoid e.g. a YAML adapter trying to parse a PHP file.
*
* @see http://framework.zend.com/manual/en/zend.translate.additional.html#zend.translate.additional.combination
*/
interface i18nTranslateAdapterInterface {
/**
* @param string $locale
* @return string
*/
public function getFilenameForLocale($locale);
}