1. sfIMessageSource.class.php
  2. /**
 * sfIMessageSource interface.
 * 
 * All messages source used by MessageFormat must be of sfIMessageSource.
 * It defines a set of operations to add and retrieve messages from the
 * message source. In addition, message source can load a particular 
 * catalogue.
 *
 * @author Xiang Wei Zhuo 
 * @version v1.0, last update on Fri Dec 24 17:40:19 EST 2004
 * @package    symfony
 * @subpackage i18n
 */
  3. interface sfIMessageSource
  4. {
  5.   /**
  6.    * Loads the translation table for this particular catalogue.
  7.    * The translation should be loaded in the following order.
  8.    *  # [1] call getCatalogueList($catalogue) to get a list of variants for for the specified $catalogue.
  9.    *  # [2] for each of the variants, call getSource($variant) to get the resource, could be a file or catalogue ID.
  10.    *  # [3] verify that this resource is valid by calling isValidSource($source)
  11.    *  # [4] try to get the messages from the cache
  12.    *  # [5] if a cache miss, call load($source) to load the message array
  13.    *  # [6] store the messages to cache.
  14.    *  # [7] continue with the foreach loop, e.g. goto [2].
  15.    *
  16.    * @param string $catalogue a catalogue to load
  17.    * @return boolean true if loaded, false otherwise.
  18.    */
  19.   function load($catalogue = 'messages');
  21.   /**
  22.    * Gets the translation table. This includes all the loaded sections.
  23.    * It must return a 2 level array of translation strings.
  24.    * # "catalogue+variant" the catalogue and its variants.
  25.    * # "source string" translation keys, and its translations.
  26.    * <code>
  27.    *   array('catalogue+variant' => 
  28.    *       array('source string' => 'target string', ...)
  29.    *             ...),
  30.    *        ...);
  31.    * </code>
  32.    *
  33.    * @return array 2 level array translation table.
  34.    */
  35.   function read();
  37.   /**
  38.    * Saves the list of untranslated blocks to the translation source. 
  39.    * If the translation was not found, you should add those
  40.    * strings to the translation source via the <b>append()</b> method.
  41.    *
  42.    * @param string $catalogue the catalogue to add to
  43.    * @return boolean true if saved successfuly, false otherwise.
  44.    */
  45.   function save($catalogue = 'messages');
  47.   /**
  48.    * Adds a untranslated message to the source. Need to call save()
  49.    * to save the messages to source.
  50.    *
  51.    * @param string $message message to add
  52.    * @return void
  53.    */
  54.   function append($message);
  56.   /**
  57.    * Deletes a particular message from the specified catalogue.
  58.    *
  59.    * @param string $message   the source message to delete.
  60.    * @param string $catalogue the catalogue to delete from.
  61.    * @return boolean true if deleted, false otherwise. 
  62.    */
  63.   function delete($message, $catalogue = 'messages');
  65.   /**
  66.    * Updates the translation.
  67.    *
  68.    * @param string $text      the source string.
  69.    * @param string $target    the new translation string.
  70.    * @param string $comments  comments
  71.    * @param string $catalogue the catalogue of the translation.
  72.    * @return boolean true if translation was updated, false otherwise. 
  73.    */
  74.   function update($text, $target, $comments, $catalogue = 'messages');
  76.   /**
  77.    * Returns a list of catalogue as key and all it variants as value.
  78.    *
  79.    * @return array list of catalogues 
  80.    */
  81.   function catalogues();
  83.   /**
  84.    * Set the culture for this particular message source.
  85.    *
  86.    * @param string $culture the Culture name.
  87.    */
  88.   function setCulture($culture);
  90.   /**
  91.    * Get the culture identifier for the source.
  92.    *
  93.    * @return string culture identifier. 
  94.    */
  95.   function getCulture();
  97.   /**
  98.    * Returns a unique identifier for the current message source.
  99.    */
  100.   function getId();
  101. }
Debug toolbar