<?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 string $text The text we need a translation for

  	 * @param array $parameters default:array() Parameters for sprintf

  	 * @return \OC_L10N_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 string $text_singular the string to translate for exactly one object
  	 * @param string $text_plural the string to translate for n objects
  	 * @param integer $count Number of objects

  	 * @param array $parameters default:array() Parameters for sprintf

  	 * @return \OC_L10N_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 string $type Type of localization
  	 * @param array $data parameters for this localization
  	 * @return string|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);

  
  
  	/**
  	 * find the best language
  	 * @param array|string $app details below
  	 * @return string language
  	 *
  	 * If $app is an array, ownCloud assumes that these are the available
  	 * languages. Otherwise ownCloud tries to find the files in the l10n
  	 * folder.
  	 *
  	 * If nothing works it returns 'en'
  	 */
  	public function getLanguageCode($app=null);

  }