Changeset 1569

Show
Ignore:
Timestamp:
01/24/07 15:55:29 (2 years ago)
Author:
david
Message:

threw out all documentation in config files, closes #379

Location:
branches/0.11
Files:
51 modified

Legend:

Unmodified
Added
Removed
  • branches/0.11/etc/olson/agavi/app/config/factories.xml

    r1568 r1569  
    11<?xml version="1.0" encoding="UTF-8" standalone="no"?> 
    2 <!-- 
    3 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~+ 
    4 | This file is part of the Agavi package.                                    | 
    5 | Copyright (c) 2006 the Agavi Project                                       | 
    6 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 
    7 | AGAVI FACTORIES CONFIGURATION                                              | 
    8 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 
    9 | The default configuration must at least define:                            | 
    10 |                                                                            | 
    11 |  controller            - The Controller class implementation.              | 
    12 |  dispatch_filter       - The DispatchFilter class implementation.          | 
    13 |  execution_container   - The ExecutionContainer class implementation.      | 
    14 |  execution_filter      - The ExecutionFilter class implementation.         | 
    15 |  filter_chain          - The FilterChain class implementation.             | 
    16 |  request               - The Request class implementation.                 | 
    17 |  storage               - The Storage class implementation.                 | 
    18 |  * database_manager    - The DatabaseManager class implementation.         | 
    19 |  ** security_filter    - The SecurityFilter class implementation.          | 
    20 |  ** user               - The User class implementation.                    | 
    21 |                                                                            | 
    22 | * if "core.use_database" is turned on in the parameters.xml config         | 
    23 | ** if "core.use_security" is turned on in the parameters.xml config        | 
    24 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~+ 
    25 --> 
    262<configurations> 
    273   
  • branches/0.11/etc/olson/agavi/app/config/output_types.xml

    r1223 r1569  
    11<?xml version="1.0" encoding="UTF-8" standalone="no"?> 
    2 <!-- 
    3 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~+ 
    4 | This file is part of the Agavi package.                                    | 
    5 | Copyright (c) 2006 the Agavi Project.                                      | 
    6 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 
    7 | OUTPUT TYPE CONFIGURATION                                                  | 
    8 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 
    9 | KEYWORDS:                                                                  | 
    10 | You may reference any configuration directive by enclosing the name in     | 
    11 | "%" signs. Example: %core.agavi_dir%                                         | 
    12 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~+ 
    13 --> 
    142<configurations> 
    153   
  • branches/0.11/etc/olson/agavi/app/config/settings.xml

    r1223 r1569  
    11<?xml version="1.0" encoding="UTF-8" standalone="no"?> 
    2 <!-- 
    3 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~+ 
    4 | This file is part of the Agavi package.                                    | 
    5 | Copyright (c) 2006 the Agavi Project.                                      | 
    6 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 
    7 | CORE AGAVI SETTINGS                                                        | 
    8 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 
    9 | KEYWORDS:                                                                  | 
    10 | You may reference any configuration directive by enclosing the name in     | 
    11 | "%" signs. Example: %core.agavi_dir%                                         | 
    12 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~+ 
    13 --> 
    142<configurations> 
    153  <configuration> 
  • branches/0.11/etc/olson/agavi/app/config/translation.xml

    r1223 r1569  
    11<?xml version="1.0" encoding="UTF-8" standalone="no"?> 
    2 <!-- 
    3 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~+ 
    4 | This file is part of the Agavi package.                                    | 
    5 | Copyright (c) 2006 the Agavi Project.                                      | 
    6 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~+ 
    7 --> 
    82<configurations> 
    93  <configuration> 
  • branches/0.11/samples/app/config/action_filters.xml

    r1251 r1569  
    11<?xml version="1.0" encoding="UTF-8" standalone="no"?> 
    2 <!-- 
    3 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~+ 
    4 | This file is part of the Agavi package.                                    | 
    5 | Copyright (c) 2006 the Agavi Project                                       | 
    6 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 
    7 | AGAVI ACTION FILTER CONFIGURATION                                          | 
    8 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 
    9 | A category must exist for each filter you wish to load. The category name  | 
    10 | itself is meaningless, but should be named after the filter it             | 
    11 | instantiates. The order in which you specify the filters is the order they | 
    12 | are loaded.                                                                | 
    13 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 
    14 | REQUIRED KEYS:                                                             | 
    15 |                                                                            | 
    16 | 1. class - The class name providing the custom implementation.             | 
    17 |                                                                            | 
    18 | OPTIONAL KEYS:                                                             | 
    19 |                                                                            | 
    20 | 1. file  - The filesystem path to the class file. If the path is relative, | 
    21 |            it will be relative to the "core.app_dir" Agavi application     | 
    22 |            setting.                                                        | 
    23 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 
    24 | PARAMETERS:                                                                | 
    25 |                                                                            | 
    26 | <parameters> element specifies a group of parameters to be passed to the   | 
    27 | initialization method of the class instance. Parameters can either be      | 
    28 | simple name and value pairs but also nested groups of parameters. Nested   | 
    29 | parameters can also be named and they can be nested infinitely.            | 
    30 |                                                                            | 
    31 | Any number of parameters can be passed but it's of course up to the        | 
    32 | receiving end what parameters are expected.                                | 
    33 |                                                                            | 
    34 | Example:                                                                   | 
    35 |                                                                            | 
    36 | <parameters>                                                               | 
    37 |   <parameter name="param1">value1</parameter>                              | 
    38 |   <parameter name="param2">                                                | 
    39 |     <parameters>                                                           | 
    40 |       <parameter name="subfoo1">value2</parameter>                         | 
    41 |       <parameter name="subfoo2">                                           | 
    42 |         <parameters>                                                       | 
    43 |           <parameter>first</parameter>                                     | 
    44 |           <parameter>second</parameter>                                    | 
    45 |         </parameters>                                                      | 
    46 |       </parameter>                                                         | 
    47 |     </parameters>                                                          | 
    48 |   </parameter>                                                             | 
    49 | </parameters>                                                              | 
    50 |                                                                            | 
    51 | For a list of available parameters for a class, browse the class source    | 
    52 | or documentation.                                                          | 
    53 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 
    54 | KEYWORDS:                                                                  | 
    55 | You may reference any configuration directive by enclosing the name in     | 
    56 | "%" signs. Example: %core.agavi_dir%                                       | 
    57 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~+ 
    58 --> 
    592<configurations> 
    603 
  • branches/0.11/samples/app/config/autoload.xml

    r1133 r1569  
    11<?xml version="1.0" encoding="UTF-8" standalone="no"?> 
    2 <!-- 
    3 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~+ 
    4 | This file is part of the Agavi package.                                    | 
    5 | Copyright (c) 2006 the Agavi Project.                                      | 
    6 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 
    7 | AGAVI AUTO LOAD CONFIGURATION                                              | 
    8 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 
    9 | Any file listed here will automatically be loaded by PHP when the class is | 
    10 | first accessed. This means you do not manually have to include it in your  | 
    11 | files.                                                                     | 
    12 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 
    13 | KEYWORDS:                                                                  | 
    14 | You may reference any configuration directive by enclosing the name in     | 
    15 | "%" signs. Example: %core.agavi_dir%                                         | 
    16 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~+ 
    17 --> 
    182<configurations parent="%core.system_config_dir%/autoload.xml"> 
    19   <!-- 
    20     +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~+ 
    21     | Custom Classes                                                         | 
    22     | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 
    23     | Any classes you see fit that might be of use, such as classes that     | 
    24     | used in a session that must exist when the session unserializes its    | 
    25     | data. Another good example is a custom factory implementation such as  | 
    26     | a controller or user.                                                  | 
    27     +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~+ 
    28   --> 
    293  <configuration> 
    304    <autoloads> 
  • branches/0.11/samples/app/config/compile.xml

    r908 r1569  
    11<?xml version="1.0" encoding="UTF-8" standalone="no"?> 
    2 <!-- 
    3 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~+ 
    4 | This file is part of the Agavi package.                                    | 
    5 | Copyright (c) 2006 the Agavi Project                                       | 
    6 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 
    7 | AGAVI COMPILE CONFIGURATION                                                | 
    8 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 
    9 | Any file in here will be stripped of comments and blank lines and will be  | 
    10 | loaded into a single cache file.                                           | 
    11 |                                                                            | 
    12 | NOTE: When you change one of your classes it will not be reflected in the  | 
    13 |       cache file until you remove the cache file or you change the         | 
    14 |       modified time of this file.                                          | 
    15 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 
    16 | KEYWORDS:                                                                  | 
    17 | You may reference any configuration directive by enclosing the name in     | 
    18 | "%" signs. Example: %core.agavi_dir%                                         | 
    19 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~+ 
    20  
    21 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~+ 
    22 | Core Agavi classes.                                                        | 
    23 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~+ 
    24 --> 
    252<configurations parent="%core.system_config_dir%/compile.xml"> 
    26   <!-- 
    27     +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~+ 
    28     | You shouldn't add any custom files to this file. Do so at your own risk.   | 
    29     +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~+ 
    30   --> 
    313</configurations> 
  • branches/0.11/samples/app/config/config_handlers.xml

    r1251 r1569  
    11<?xml version="1.0" encoding="UTF-8" standalone="no"?> 
    2 <!-- 
    3 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~+ 
    4 | This file is part of the Agavi package.                                    | 
    5 | Copyright (c) 2006 the Agavi Project.                                      | 
    6 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~+ 
    7 | AGAVI CONFIGURATION HANDLER CONFIGURATION                                  | 
    8 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 
    9 | CATEGORIES:                                                                | 
    10 |                                                                            | 
    11 | A category name must exist in the form of the configuration file base      | 
    12 | name, which is the name of the file without the path, or must exist with a | 
    13 | relative path to the configuration file. If a category exists with a       | 
    14 | relative path, the path itself is relative to the "core.app_dir" Agavi     | 
    15 | application setting.                                                       | 
    16 |                                                                            | 
    17 | In theory, you can have the two following categories: config.ini and       | 
    18 | modules/MyModule/config/config.ini. However, a category with a path that   | 
    19 | matches the requested configuration file exactly takes precedence over a   | 
    20 | category with just the base name.                                          | 
    21 |                                                                            | 
    22 | NOTES:                                                                     | 
    23 |                                                                            | 
    24 | 1. A category with an absolute filesystem path should never exist unless a | 
    25 |    configuration file that is used within the application exists outside   | 
    26 |    of both "core.agavi_dir" and "core.app_dir" Agavi application settings. | 
    27 |                                                                            | 
    28 | 2. Registered handlers with a parameter list should be registered with a   | 
    29 |    relative path so the parameters do not get carried over to another      | 
    30 |    configuration file with the same base name.                             | 
    31 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 
    32 | REQUIRED KEYS:                                                             | 
    33 |                                                                            | 
    34 | 1. class - The class name providing the custom implementation.             | 
    35 |                                                                            | 
    36 | OPTIONAL KEYS:                                                             | 
    37 |                                                                            | 
    38 | 1. file  - The filesystem path to the class file. If the path is relative, | 
    39 |            it will be relative to the "core.app_dir" Agavi application     | 
    40 |            setting.                                                        | 
    41 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 
    42 | PARAMETERS:                                                                | 
    43 |                                                                            | 
    44 | <parameters> element specifies a group of parameters to be passed to the   | 
    45 | initialization method of the class instance. Parameters can either be      | 
    46 | simple name and value pairs but also nested groups of parameters. Nested   | 
    47 | parameters can also be named and they can be nested infinitely.            | 
    48 |                                                                            | 
    49 | Any number of parameters can be passed but it's of course up to the        | 
    50 | receiving end what parameters are expected.                                | 
    51 |                                                                            | 
    52 | Example:                                                                   | 
    53 |                                                                            | 
    54 | <parameters>                                                               | 
    55 |   <parameter name="param1">value1</parameter>                              | 
    56 |   <parameter name="param2">                                                | 
    57 |     <parameters>                                                           | 
    58 |       <parameter name="subfoo1">value2</parameter>                         | 
    59 |       <parameter name="subfoo2">                                           | 
    60 |         <parameters>                                                       | 
    61 |           <parameter>first</parameter>                                     | 
    62 |           <parameter>second</parameter>                                    | 
    63 |         </parameters>                                                      | 
    64 |       </parameter>                                                         | 
    65 |     </parameters>                                                          | 
    66 |   </parameter>                                                             | 
    67 | </parameters>                                                              | 
    68 |                                                                            | 
    69 | For a list of available parameters for a class, browse the class source    | 
    70 | or documentation.                                                          | 
    71 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 
    72 | KEYWORDS:                                                                  | 
    73 | You may reference any configuration directive by enclosing the name in     | 
    74 | "%" signs. Example: %core.agavi_dir%                                       | 
    75 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~+ 
    76 --> 
    772<configurations parent="%core.system_config_dir%/config_handlers.xml"> 
    78 <!-- 
    79   +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~+ 
    80   | Register your custom configuration handlers here. Or register an existing  | 
    81   | handler with a new filename! Registering handlers does not slow down the   | 
    82   | application because they are only loaded when a configuration file needs   | 
    83   | to be recompiled into a cache file. To be safe, you should register them   | 
    84   | with a relative path associated so they don't get confused with somebody   | 
    85   | elses module configuration files with the same base name.                  | 
    86   +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~+ 
    87   <configuration environment="development"> 
    88     <handlers> 
    89       <handler pattern="%core.module_dir%/CoolModule/config/cool.xml" validate="optional/path/to/schema.xsd" class="CoolConfigHandler" /> 
    90     </handlers> 
    91   </configuration> 
    92 --> 
    933</configurations> 
  • branches/0.11/samples/app/config/databases.xml

    r1251 r1569  
    11<?xml version="1.0" encoding="UTF-8" standalone="no"?> 
    2 <!-- 
    3 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~+ 
    4 | This file is part of the Agavi package.                                    | 
    5 | Copyright (c) 2006 the Agavi Project                                       | 
    6 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 
    7 | AGAVI DATABASE CONNECTIVITY CONFIGURATION                                  | 
    8 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 
    9 | CATEGORIES:                                                                | 
    10 |                                                                            | 
    11 | The main category [databases] is required. This specifies connection names | 
    12 | used to retrieve a database connection from this configuration. Each name  | 
    13 | should match up with a value that is the name of another existing category | 
    14 | that specifies the exact configuration for that particular database        | 
    15 | connection. The only requirement is that a default database be setup with  | 
    16 | the name of 'default'. This way a connection can be retrieved without      | 
    17 | specifying a connection name. This always retrieves the default database   | 
    18 | connection.                                                                | 
    19 |                                                                            | 
    20 | NOTES:                                                                     | 
    21 |                                                                            | 
    22 | 1. Each database implementation has its own set of parameters. View the    | 
    23 |    class source code or the API to get a list.                             | 
    24 | 2. All database implementations provide three methods of specifying        | 
    25 |    connectivity data: normal, server, and env. With normal, you specify    | 
    26 |    the information in this file, which means all of it is plain-text       | 
    27 |    and may pose a security risk. Using the server or env methods, you      | 
    28 |    specify your connectivity information in the $_SERVER or $_ENV arrays   | 
    29 |    where the information is not directly viewable. When using the server   | 
    30 |    or env methods, the information you enter as the parameter value is     | 
    31 |    the array key the database implementation will use to retrieve the      | 
    32 |    actual value from the array. Here's a short example:                    | 
    33 |                                                                            | 
    34 |    param.user     = "DB_USER"                                              | 
    35 |    param.password = "DB_PASS"                                              | 
    36 |    param.database = "DB_DBNAME"                                            | 
    37 |    param.method   = "server"                                               | 
    38 |                                                                            | 
    39 |    When doing the above, the database class will retrieve the information  | 
    40 |    from $_SERVER, where $_SERVER['DB_USER'] is your username,              | 
    41 |    $_SERVER['DB_PASS'] is your password, and $_SERVER['DB_DBNAME'] is your | 
    42 |    database name.                                                          | 
    43 |                                                                            | 
    44 |    Using the server method for storing information allows you to hide      | 
    45 |    otherwise viewable connection information. The most notable way of      | 
    46 |    using the server method is to set the information via an Apache         | 
    47 |    <VirtualHost> directive using SetEnv NAME "VALUE". When doing so, your  | 
    48 |    $_SERVER array is populated with the data. Here's a short example:      | 
    49 |                                                                            | 
    50 |    <VirtualHost 192.168.0.1>                                               | 
    51 |        ServerName secret.domain.tld                                        | 
    52 |        DocumentRoot /www/secret.domain.told                                | 
    53 |        SetEnv DB_USER "MyUser"                                             | 
    54 |        SetEnv DB_PASS "SecretPassword"                                     | 
    55 |        SetEnv DB_DBNAME "MyDatabase"                                       | 
    56 |    </VirtualHost>                                                          | 
    57 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 
    58 | REQUIRED KEYS:                                                             | 
    59 |                                                                            | 
    60 | 1. class - The class name providing the custom implementation.             | 
    61 |                                                                            | 
    62 | OPTIONAL KEYS:                                                             | 
    63 |                                                                            | 
    64 | 1. file  - The filesystem path to the class file. If the path is relative, | 
    65 |            it will be relative to the %core.agavi_dir% Agavi application   | 
    66 |            setting.                                                        | 
    67 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 
    68 | EXAMPLES:                                                                  | 
    69 |                                                                            | 
    70 | [databases] example:                                                       | 
    71 |                                                                            | 
    72 |     [databases]                                                            | 
    73 |                                                                            | 
    74 |         default = "Default"                                                | 
    75 |         creole  = "Creole"                                                 | 
    76 |                                                                            | 
    77 | Standard PostgreSQL setup:                                                 | 
    78 |                                                                            | 
    79 |     [DBName]                                                               | 
    80 |                                                                            | 
    81 |         class = "PostgreSQLDatabase"                                       | 
    82 |                                                                            | 
    83