mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-10-22 14:05:37 +02:00
3ee8f505b7
The main benefit of this is so that authors who make use of
.editorconfig don't end up with whitespace changes in their PRs.
Spaces vs. tabs has been left alone, although that could do with a
tidy-up in SS4 after the switch to PSR-1/2.
The command used was this:
for match in '*.ss' '*.css' '*.scss' '*.html' '*.yml' '*.php' '*.js' '*.csv' '*.inc' '*.php5'; do
find . -path ./thirdparty -not -prune -o -path ./admin/thirdparty -not -prune -o -type f -name "$match" -exec sed -E -i '' 's/[[:space:]]+$//' {} \+
find . -path ./thirdparty -not -prune -o -path ./admin/thirdparty -not -prune -o -type f -name "$match" | xargs perl -pi -e 's/ +$//'
done
73 lines
2.2 KiB
PHP
73 lines
2.2 KiB
PHP
<?php
|
|
/**
|
|
* Dynamically provide translatable entites for the {@link i18n} logic.
|
|
* This is particularly handy for natural language strings in static variables
|
|
* of a class definition, as the _t() method can only be used in a runtime/instance
|
|
* context. The provideI18nEntities() method enables you to define your own entities
|
|
* with your custom naming, mostly involving either the variable name or the array
|
|
* key. With this in place, you can use a getter method to trigger translation
|
|
* of your values.
|
|
* For any statics containing natural language, never use the static directly -
|
|
* always wrap it in a getter.
|
|
*
|
|
* Classes must be able to be constructed without mandatory arguments, otherwise
|
|
* this interface will have no effect.
|
|
*
|
|
* @package framework
|
|
* @subpackage i18n
|
|
* @uses i18nTextCollector->collectFromEntityProviders()
|
|
*/
|
|
interface i18nEntityProvider {
|
|
|
|
/**
|
|
* Example usage:
|
|
* <code>
|
|
* class MyTestClass implements i18nEntityProvider {
|
|
* function provideI18nEntities() {
|
|
* $entities = array();
|
|
* foreach($this->stat('my_static_array) as $key => $value) {
|
|
* $entities["MyTestClass.my_static_array_{$key}"] = array(
|
|
* $value,
|
|
*
|
|
* 'My context description'
|
|
* );
|
|
* }
|
|
* return $entities;
|
|
* }
|
|
*
|
|
* public static function my_static_array() {
|
|
* $t_my_static_array = array();
|
|
* foreach(self::$my_static_array as $k => $v) {
|
|
* $t_my_static_array[$k] = _t("MyTestClass.my_static_array_{$key}", $v);
|
|
* }
|
|
* return $t_my_static_array;
|
|
* }
|
|
* }
|
|
* </code>
|
|
*
|
|
* Example usage in {@link DataObject->provideI18nEntities()}.
|
|
*
|
|
* You can ask textcollector to add the provided entity to a different module
|
|
* than the class is contained in by adding a 4th argument to the array:
|
|
* <code>
|
|
* class MyTestClass implements i18nEntityProvider {
|
|
* function provideI18nEntities() {
|
|
* $entities = array();
|
|
* $entities["MyOtherModuleClass.MYENTITY"] = array(
|
|
* $value,
|
|
*
|
|
* 'My context description',
|
|
* 'myothermodule'
|
|
* );
|
|
* }
|
|
* return $entities;
|
|
* }
|
|
* </code>
|
|
*
|
|
* @return array All entites in an associative array, with
|
|
* entity name as the key, and a numerical array of pseudo-arguments
|
|
* for _t() as a value.
|
|
*/
|
|
public function provideI18nEntities();
|
|
}
|