symfony API

sfMessageSource_XLIFF Class

You are currently browsing
the website for symfony 1

Visit the Symfony2 website

« Back to API menu

1.0 API OpenSearch

Packages

You are currently browsing the symfony API for the 1.0 version. Switch to:
This version of symfony is not maintained anymore.
If some of your projects still use this version, consider upgrading as soon as possible.

sfMessageSource_XLIFF class.

Inheritence

sfMessageSource_XLIFF  <  sfMessageSource

Method Summary

  • array &()
    Loads the messages from a XLIFF file.
  • array catalogues()
    Returns a list of catalogue and its culture ID.
  • boolean delete(, )
    Deletes a particular message from the specified catalogue.
  • array getCatalogueByDir()
    Traverses through the directory structure to find the catalogues.
  • array getCatalogueList()
    Gets all the variants of a particular catalogue.
  • array getCatalogues()
    Returns a list of catalogue and its culture ID. This takes care
  • int getLastModified()
    Gets the last modified unix-time for this particular catalogue+variant.
  • string getSource()
    Gets the XLIFF file for a specific message catalogue and cultural variant.
  • string getVariants()
    Gets the variant for a catalogue depending on the current culture.
  • boolean isValidSource()
    Determines if the XLIFF file source is valid.
  • boolean save()
    Saves the list of untranslated blocks to the translation source.
  • boolean update(, , , )
    Updates the translation.
  • __construct()
    Constructor.

Methods inherited from sfMessageSource

& , append , factory , getCache , getCatalogueList , getCulture , getLastModified , getSource , isValidSource , load , read , setCache , setCulture , __construct

Method Details

  • (array) & () Browse code

    Loads the messages from a XLIFF file.

    returns of messages.

  • (array) catalogues () Browse code

    Returns a list of catalogue and its culture ID.

    E.g. array('messages', 'en_AU')

    returns list of catalogues

  • (boolean) delete (, ) Browse code

    Deletes a particular message from the specified catalogue.

    returns true if deleted, false otherwise.

  • (array) getCatalogueByDir () Browse code

    Traverses through the directory structure to find the catalogues.

    This should only be called by getCatalogueList()

    returns a list of catalogues.

  • (array) getCatalogueList () Browse code

    Gets all the variants of a particular catalogue.

    returns list of all variants for this catalogue.

  • (array) getCatalogues () Browse code

    Returns a list of catalogue and its culture ID. This takes care

    of directory structures.
    E.g. array('messages', 'en_AU')

    returns list of catalogues

  • (int) getLastModified () Browse code

    Gets the last modified unix-time for this particular catalogue+variant.

    Just use the file modified time.

    returns last modified in unix-time format.

  • (string) getSource () Browse code

    Gets the XLIFF file for a specific message catalogue and cultural variant.

    returns full path to the XLIFF file.

  • (string) getVariants () Browse code

    Gets the variant for a catalogue depending on the current culture.

    returns the variant.

  • (boolean) isValidSource () Browse code

    Determines if the XLIFF file source is valid.

    returns true if valid, false otherwise.

  • (boolean) save () Browse code

    Saves the list of untranslated blocks to the translation source.

    If the translation was not found, you should add those
    strings to the translation source via the append() method.

    returns true if saved successfuly, false otherwise.

  • (boolean) update (, , , ) Browse code

    Updates the translation.

    returns true if translation was updated, false otherwise.

  • __construct () Browse code

    Constructor.