symfony API

sfConfigCache Class

You are currently browsing
the website for symfony 1

Visit the Symfony2 website


« Back to API menu

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.

sfConfigCache allows you to customize the format of a configuration file to

Method Summary

  • callHandler(, , )
    Loads a configuration handler.
  • string checkConfig()
    Checks to see if a configuration file has been modified and if so
  • clear()
    Clears all configuration cache files.
  • string getCacheName()
    Converts a normal filename into a cache filename.
  • sfConfigCache getInstance()
    Retrieves the singleton instance of this class.
  • import(, )
    Imports a configuration file.
  • loadConfigHandlers()
    Loads all configuration application and module level handlers.
  • writeCacheFile(, , )
    Writes a cache file.

Method Details

  • callHandler (, , )

    Loads a configuration handler.

    throws sfConfigurationException If a requested configuration file does not have an associated configuration handler

  • (string) checkConfig ()

    Checks to see if a configuration file has been modified and if so

    recompile the cache file associated with it.

    The recompilation only occurs in a non debug environment.

    If the configuration file path is relative, symfony will look in directories
    defined in the sfLoader::getConfigPaths() method.

    returns An absolute filesystem path to the cache filename associated with this specified configuration file

    throws sfConfigurationException If a requested configuration file does not exist

  • clear ()

    Clears all configuration cache files.

  • (string) getCacheName ()

    Converts a normal filename into a cache filename.

    returns An absolute filesystem path to a cache filename

  • (sfConfigCache) getInstance ()

    Retrieves the singleton instance of this class.

    returns A sfConfigCache instance

  • import (, )

    Imports a configuration file.

  • loadConfigHandlers ()

    Loads all configuration application and module level handlers.

    throws sfConfigurationException If a configuration related error occurs.

  • writeCacheFile (, , )

    Writes a cache file.

    throws sfCacheException If the cache file cannot be written