symfony API

sfMessageSource_File Class

You are currently browsing
the website for symfony 1

Visit the Symfony2 website


« Back to API menu

1.1 API OpenSearch

Packages

You are currently browsing the symfony API for the 1.1 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_File class.

Inheritence

sfMessageSource_gettext, sfMessageSource_XLIFF  <  sfMessageSource_File  <  sfMessageSource

Method Summary

  • array catalogues()
    Returns a list of catalogue and its culture ID.
  • array getCatalogueByDir($catalogue)
    Traverses through the directory structure to find the catalogues.
  • array getCatalogueList($catalogue)
    Gets all the variants of a particular catalogue.
  • array getCatalogues()
    Returns a list of catalogue and its culture ID. This takes care
  • getId()
  • int getLastModified($source)
    Gets the last modified unix-time for this particular catalogue+variant.
  • string getSource($variant)
    Gets the message file for a specific message catalogue and cultural variant.
  • boolean isValidSource($source)
    Determines if the message file source is valid.
  • __construct($source)
    Constructor.

Methods inherited from sfMessageSource

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

Method Details

  • (array) catalogues () Browse code

    Returns a list of catalogue and its culture ID.

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

    returns list of catalogues

  • (array) getCatalogueByDir ($catalogue) Browse code

    $catalogue a particular catalogue.

    Traverses through the directory structure to find the catalogues.

    This should only be called by getCatalogueList()

    returns a list of catalogues.

  • (array) getCatalogueList ($catalogue) Browse code

    $catalogue catalogue name

    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

  • getId () Browse code

  • (int) getLastModified ($source) Browse code

    $source catalogue+variant

    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 ($variant) Browse code

    $variant message catalogue

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

    returns full path to the message file.

  • (boolean) isValidSource ($source) Browse code

    $source message file

    Determines if the message file source is valid.

    returns true if valid, false otherwise.

  • __construct ($source) Browse code

    $source the directory where the messages are stored.

    Constructor.