Blame view

sources/lib/public/il10n.php 2.03 KB
31b7f2792   Kload   Upgrade to ownclo...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
  <?php
  /**
   * Copyright (c) 2013 Bart Visscher <bartv@thisnet.nl>
   * This file is licensed under the Affero General Public License version 3 or
   * later.
   * See the COPYING-README file.
   *
   */
  
  /**
   * Public interface of ownCloud for apps to use.
   * L10n interface
   *
   */
  
  // use OCP namespace for all classes that are considered public.
  // This means that they should be used by apps instead of the internal ownCloud classes
  namespace OCP;
  
  /**
   * TODO: Description
   */
  interface IL10N {
  	/**
  	 * Translating
  	 * @param $text String The text we need a translation for
  	 * @param array $parameters default:array() Parameters for sprintf
  	 * @return \OC_L10N_String|string Translation or the same text
  	 *
  	 * Returns the translation. If no translation is found, $text will be
  	 * returned.
  	 */
  	public function t($text, $parameters = array());
  
  	/**
  	 * Translating
  	 * @param $text_singular String the string to translate for exactly one object
  	 * @param $text_plural String the string to translate for n objects
  	 * @param $count Integer Number of objects
  	 * @param array $parameters default:array() Parameters for sprintf
  	 * @return \OC_L10N_String|string Translation or the same text
  	 *
  	 * Returns the translation. If no translation is found, $text will be
  	 * returned. %n will be replaced with the number of objects.
  	 *
  	 * The correct plural is determined by the plural_forms-function
  	 * provided by the po file.
  	 *
  	 */
  	public function n($text_singular, $text_plural, $count, $parameters = array());
  
  	/**
  	 * Localization
  	 * @param $type Type of localization
  	 * @param $params parameters for this localization
  	 * @return String or false
  	 *
  	 * Returns the localized data.
  	 *
  	 * Implemented types:
  	 *  - date
  	 *    - Creates a date
  	 *    - l10n-field: date
  	 *    - params: timestamp (int/string)
  	 *  - datetime
  	 *    - Creates date and time
  	 *    - l10n-field: datetime
  	 *    - params: timestamp (int/string)
  	 *  - time
  	 *    - Creates a time
  	 *    - l10n-field: time
  	 *    - params: timestamp (int/string)
  	 */
  	public function l($type, $data);
  }