symfony API

sfViewCacheManager 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.

Cache class to cache the HTML results for actions and templates.

Method Summary

  • addCache(, , )
    Adds a cache to the manager.
  • array generateNamespace()
    Generates namespaces for the cache manager
  • string get()
    Retrieves namespace for the current cache.
  • sfCache getCache()
    Retrieves the current cache type.
  • mixed getCacheConfig(, , )
    Gets a config option from the cache.
  • int getClientLifeTime()
    Retrieves client lifetime from the cache option list
  • sfContext getContext()
    Retrieves the current cache context.
  • int getLifeTime()
    Retrieves lifetime from the cache option list.
  • array getVary()
    Retrieves vary option from the cache option list.
  • boolean has()
    Returns true if there is a cache.
  • boolean ignore()
    Ignores the cache functionality.
  • initialize(, , )
    Initializes the cache manager.
  • boolean isActionCacheable($moduleName, $actionName)
    Returns true if the action is cacheable.
  • bool isCacheable($internalUri)
    Returns true if the current content is cacheable.
  • boolean isContextual()
    Retrieves contextual option from the cache option list.
  • string lastModified()
    Retrieves the last modified time.
  • registerConfiguration()
    Registers configuration options for the cache.
  • boolean remove()
    Removes the cache for the current namespace.
  • boolean set(, )
    Sets the cache content
  • shutdown()
    Executes the shutdown procedure.
  • boolean start(, , , )
    Starts the fragment cache.
  • boolean stop()
    Stops the fragment cache.
  • boolean withLayout()
    Retrieves the layout from the cache option list.

Method Details

  • addCache (, , ) Browse code

    Adds a cache to the manager.

  • (array) generateNamespace () Browse code

    Generates namespaces for the cache manager

    returns Path and filename for the current namespace

    throws sfException if the generation fails

  • (string) get () Browse code

    Retrieves namespace for the current cache.

    returns The data of the cache

  • (sfCache) getCache () Browse code

    Retrieves the current cache type.

    returns The current cache type

  • (mixed) getCacheConfig (, , ) Browse code

    Gets a config option from the cache.

    returns Value of the option

  • (int) getClientLifeTime () Browse code

    Retrieves client lifetime from the cache option list

    returns Client lifetime

  • (sfContext) getContext () Browse code

    Retrieves the current cache context.

    returns The sfContext instance

  • (int) getLifeTime () Browse code

    Retrieves lifetime from the cache option list.

    returns LifeTime

  • (array) getVary () Browse code

    Retrieves vary option from the cache option list.

    returns Vary options for the cache

  • (boolean) has () Browse code

    Returns true if there is a cache.

    returns true, if there is a cache otherwise false

  • (boolean) ignore () Browse code

    Ignores the cache functionality.

    returns true, if the cache is ignore otherwise false

  • initialize (, , ) Browse code

    Initializes the cache manager.

  • (boolean) isActionCacheable ($moduleName, $actionName) Browse code

    $moduleName A module name
    $actionName An action or partial template name

    Returns true if the action is cacheable.

    returns True if the action is cacheable

  • (bool) isCacheable ($internalUri) Browse code

    $internalUri Internal uniform resource identifier

    Returns true if the current content is cacheable.


    Possible break in backward compatibility: If the sf_lazy_cache_key
    setting is turned on in settings.yml, this method is not used when
    initially checking a partial's cacheability.

    returns true, if the content is cacheable otherwise false

  • (boolean) isContextual () Browse code

    Retrieves contextual option from the cache option list.

    returns true, if is contextual otherwise false

  • (string) lastModified () Browse code

    Retrieves the last modified time.

    returns Last modified datetime for the current namespace

  • registerConfiguration () Browse code

    Registers configuration options for the cache.

  • (boolean) remove () Browse code

    Removes the cache for the current namespace.

    returns true, if the remove happend otherwise false

  • (boolean) set (, ) Browse code

    Sets the cache content

    returns true, if the data get set successfully otherwise false

  • shutdown () Browse code

    Executes the shutdown procedure.

  • (boolean) start (, , , ) Browse code

    Starts the fragment cache.

    returns true, if success otherwise false

  • (boolean) stop () Browse code

    Stops the fragment cache.

    returns true, if success otherwise false

  • (boolean) withLayout () Browse code

    Retrieves the layout from the cache option list.

    returns true, if have layout otherwise false