symfony API

sfPearEnvironment Class

You are currently browsing
the website for symfony 1

Visit the Symfony2 website

« Back to API menu

1.2 API OpenSearch

Packages

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

sfPearEnvironment represents a PEAR environment.

Method Summary

  • object The getConfig()
    Returns the PEAR Config instance.
  • object The getFrontend()
    Returns the PEAR Frontend instance.
  • mixed getOption($name)
    Returns a configuration value.
  • object The getRegistry()
    Returns the PEAR Registry instance.
  • object The getRest()
    Returns the PEAR Rest instance.
  • boolean hasOption($name)
    Returns whether configuration name exists.
  • initialize($dispatcher, $options = array())
    Initializes this sfPluginManager instance.
  • initializeConfiguration($pluginDir, $cacheDir)
    Registers the PEAR Configuration instance.
  • initializeFrontend()
    Initializes the PEAR Frontend instance.
  • initializeRegistry()
    Initializes the PEAR Registry instance.
  • registerChannel($channel, (Boolean) $isDefault = false)
    Registers a PEAR channel.
  • setOption($name, $value)
    Sets a configuration value.
  • __construct($dispatcher, $options)
    Constructs a new sfPluginManager.

Method Details

  • (object The) getConfig () Browse code

    Returns the PEAR Config instance.

    returns PEAR Config instance

  • (object The) getFrontend () Browse code

    Returns the PEAR Frontend instance.

    returns PEAR Frontend instance

  • (mixed) getOption ($name) Browse code

    $name The configuration name

    Returns a configuration value.

    returns The configuration value

  • (object The) getRegistry () Browse code

    Returns the PEAR Registry instance.

    returns PEAR Registry instance

  • (object The) getRest () Browse code

    Returns the PEAR Rest instance.

    returns PEAR Rest instance

  • (boolean) hasOption ($name) Browse code

    $name The configuration name

    Returns whether configuration name exists.

    returns True if configuration name exists

  • initialize ($dispatcher, $options = array()) Browse code

    $dispatcher An event dispatcher instance
    $options An array of options

    Initializes this sfPluginManager instance.


    Available options:

    * plugin_dir: The directory where to put plugins
    * cache_dir: The local PEAR cache directory
    * rest_base_class: The base class for REST calls (default to sfPearRest) (mainly used for testing)
    * downloader_base_class: The base class for downloads (default to sfPearDownloader) (mainly used for testing)

  • initializeConfiguration ($pluginDir, $cacheDir) Browse code

    $pluginDir The plugin path
    $cacheDir The cache path

    Registers the PEAR Configuration instance.

  • initializeFrontend () Browse code

    Initializes the PEAR Frontend instance.

  • initializeRegistry () Browse code

    Initializes the PEAR Registry instance.

  • registerChannel ($channel, (Boolean) $isDefault = false) Browse code

    $channel The channel name
    $isDefault true if this is the default PEAR channel, false otherwise

    Registers a PEAR channel.

  • setOption ($name, $value) Browse code

    $name The configuration name
    $value The configuration value

    Sets a configuration value.

  • __construct ($dispatcher, $options) Browse code

    $dispatcher An event dispatcher instance
    $options An array of options

    Constructs a new sfPluginManager.