[ Index ]
 

Code source de Symfony 1.0.0

Accédez au Source d'autres logiciels libresSoutenez Angelica Josefina !

title

Body

[fermer]

/lib/vendor/propel/ -> Propel.php (sommaire)

(pas de description)

Poids: 581 lignes (17 kb)
Inclus ou requis:0 fois
Référencé: 0 fois
Nécessite: 0 fichiers

Définit 1 class

Propel:: (21 méthodes):
  initialize()
  initAdapters()
  configure()
  init()
  isInit()
  setConfiguration()
  getConfiguration()
  configureLogging()
  setLogger()
  hasLogger()
  logger()
  log()
  getDatabaseMap()
  initDatabaseMap()
  registerMapBuilder()
  getDatabaseProperty()
  getConnection()
  getDB()
  getDefaultDB()
  import()
  close()


Classe: Propel  - X-Ref

Propel's main resource pool and initialization & configuration class.

This static class is used to handle Propel initialization and to maintain all of the
open database connections and instantiated database maps.

initialize()   X-Ref
initialize Propel

return: void

initAdapters($configuration)   X-Ref
Setup the adapters needed.  An adapter must be defined for each database connection.
Generally the adapter will be the same as the PEAR phpname; e.g. for MySQL, use the
'mysql' adapter.

param: array $configuration the Configuration representing the properties file

configure($configFile)   X-Ref
configure propel

param: string $config Path (absolute or relative to include_path) to config file.
return: void

init($c)   X-Ref
Initialization of Propel with a properties file.

param: string $c The Propel configuration file path.
return: void

isInit()   X-Ref
Determine whether Propel has already been initialized.

return: boolean True if Propel is already initialized.

setConfiguration($c)   X-Ref
Sets the configuration for Propel and all dependencies.

param: array $c the Configuration
return: void

getConfiguration()   X-Ref
Get the configuration for this component.

return: the Configuration

configureLogging()   X-Ref
Configure the logging for this subsystem.
The logging system is only configured if there is a 'log'
section in the passed-in runtime configuration.

return: void

setLogger($logger)   X-Ref
Override the configured logger.

This is primarily for things like unit tests / debugging where
you want to change the logger without altering the configuration file.

You can use any logger class that implements the propel.logger.BasicLogger
interface.  This interface is based on PEAR::Log, so you can also simply pass
a PEAR::Log object to this method.

param: object $logger The new logger to use. ([PEAR] Log or BasicLogger)
return: void

hasLogger()   X-Ref
Returns true if a logger, for example PEAR::Log, has been configured,
otherwise false.

return: boolean True if Propel uses logging

logger()   X-Ref
Get the configured logger.

return: object Configured log class ([PEAR] Log or BasicLogger).

log($message, $level = self::LOG_DEBUG)   X-Ref
Logs a message
If a logger has been configured, the logger will be used, otherwrise the
logging message will be discarded without any further action

param: string $message The message that will be logged.
param: string $level The logging level.
return: boolean True if the message was logged successfully or no logger was used.

getDatabaseMap($name = null)   X-Ref
Returns the database map information. Name relates to the name
of the connection pool to associate with the map.

The database maps are "registered" by the generated map builder classes.

param: string $name The name of the database corresponding to the DatabaseMapto retrieve.
return: DatabaseMap The named <code>DatabaseMap</code>.

initDatabaseMap($name)   X-Ref
Creates and initializes the mape for the named database.

The database maps are "registered" by the generated map builder classes
by calling this method and then adding the tables, etc. to teh DatabaseMap
object returned from this method.

param: string $name The name of the database to map.
return: DatabaseMap The desired map.

registerMapBuilder($className)   X-Ref
Register a MapBuilder

param: string $className the MapBuilder

getDatabaseProperty($db, $prop)   X-Ref
Returns the specified property of the given database, or the empty
string if no value is set for the property.

param: string $db   The name of the database whose property to get.
param: string $prop The name of the property to get.
return: mixed The property's value.

getConnection($name = null)   X-Ref

param: string $name The database name.
return: Connection A database connection

getDB($name = null)   X-Ref
Returns database adapter for a specific connection pool.

param: string $name A database name.
return: DBAdapter The corresponding database adapter.

getDefaultDB()   X-Ref
Returns the name of the default database.

return: string Name of the default DB

import($path)   X-Ref
Include once a file specified in DOT notation and reutrn unqualified clasname.

Package notation is expected to be relative to a location
on the PHP include_path.  The dot-path classes are used as a way
to represent both classname and filesystem location; there is
an inherent assumption about filenaming.  To get around these
naming requirements you can include the class yourself
and then just use the classname instead of dot-path.

param: string $class dot-path to clas (e.g. path.to.my.ClassName).
return: string unqualified classname

close()   X-Ref
Closes any associated resource handles.

This method frees any database connection handles that have been
opened by the getConnection() method.

return: void



Généré le : Fri Mar 16 22:42:14 2007 par Balluche grâce à PHPXref 0.7