[Sommaire] [Imprimer]

   1   <refsect1  id="{@id reference}">
   2    <title>Reference</title>
   3    <refsect2 id="{@id ref_defines}">
   4     <title>Defines</title>
   5     All the definitions below are set in file
   6    {@link environment.php config/environment.php}
   7     <itemizedlist>
   8  
   9      <listitem><command>DEBUG</command>
  10       <cmdsynopsis>boolean set to true if TRAX_MODE is 'development',
  11       false otherwise.  Determines whether PHP error messages should be
  12       sent to the browser; true means show error messages on the
  13       browser as well as the error log, false means send error messages
  14       to only the error log.  Implemented by calling
  15       {@link http://www.php.net/ini_set ini_set()}
  16       at the time DEBUG is defined.
  17       </cmdsynopsis>
  18      </listitem>
  19  
  20      <listitem><command>PHP_LIB_ROOT</command>
  21       <cmdsynopsis>Directory containing PHP libraries.  This directory
  22       will be added to the PHP
  23       {@link http://www.php.net/manual/en/ini.core.php#ini.include-path include path}.
  24       </cmdsynopsis>
  25      </listitem>
  26  
  27      <listitem><command>TRAX_LIB_ROOT</command>
  28       <cmdsynopsis>Directory containing Trax libraries.  Set to a
  29       subdirectory of TRAX_ROOT or PHP_LIB_ROOT and added to the PHP
  30       {@link http://www.php.net/manual/en/ini.core.php#ini.include-path include path}.
  31       </cmdsynopsis>
  32      </listitem>
  33  
  34      <listitem><command>TRAX_MODE</command>
  35       <cmdsynopsis>Contains one of 'test', 'development' or 'production'.
  36        Determines which  database to use.
  37        Get it from $_SERVER['TRAX_MODE'] if that exists</cmdsynopsis>
  38      </listitem>
  39  
  40      <listitem><command>TRAX_PUBLIC</command>
  41       <cmdsynopsis>Subdirectory of the user's home directory referenced
  42       by the Apache configuration variable <literal>UserDir</literal>.
  43       </cmdsynopsis>
  44      </listitem>
  45  
  46      <listitem><command>TRAX_ROOT</command>
  47       <cmdsynopsis>Filesystem path to the top of the Trax file tree.
  48       </cmdsynopsis>
  49      </listitem>
  50  
  51      <listitem><command>TRAX_URL_PREFIX</command>
  52       <cmdsynopsis>That part of a URL which refers to a Trax
  53       application that comes after the domain name and before the
  54       controller.  Usually empty.  In the case of a Trax application in
  55       the home directory of user <literal>username</literal>,
  56       <command>TRAX_URL_PREFIX</command> would be set to 
  57       '<literal>~username</literal>'.
  58       </cmdsynopsis>
  59      </listitem>
  60  
  61      <listitem><command>TRAX_VIEWS_EXTENTION</command>
  62       <cmdsynopsis>File extension for views, default
  63       'phtml'.</cmdsynopsis>
  64      </listitem>
  65  
  66     </itemizedlist>
  67    </refsect2>
  68    <refsect2 id="{@id ref_globals}">
  69     <title>Globals</title>
  70     <itemizedlist>
  71  
  72      <listitem><command>$GLOBALS['ACTIVE_RECORD_DB']</command>
  73       <cmdsynopsis>Database connection resource for the currently open
  74       database connection, or {@link http://pear.php.net PEAR} or
  75       {@link http://pear.php.net/package/DB DB} error if
  76       the connection attempt failed.  Set in 
  77      {@link ActiveRecord::establish_connection()}.
  78       </cmdsynopsis>
  79      </listitem>
  80  
  81      <listitem><command>$GLOBALS['ACTIVE_RECORD_SQL_LOG']</command>
  82       <cmdsynopsis>An array which contains a log of SQL queries sent to
  83       the DBMS, one query per element.  Created only when TRAX_MODE is
  84       'development'.  Written in {@link ActiveRecord::log_query()}.
  85      </cmdsynopsis>
  86      </listitem>
  87  
  88  
  89      <listitem><command>$GLOBALS['COUNTRIES']</command>
  90       <cmdsynopsis>
  91        List of countries.  Set in {@link form_options_helper.php}.
  92       </cmdsynopsis>
  93      </listitem>
  94  
  95      <listitem><command>$GLOBALS['current_action_name']</command>
  96       <cmdsynopsis>
  97       Name of action parsed from the URL.
  98       Set in {@link ActionController::process_route()}
  99       Value stored before knowing whether the method for this action
 100       actually exists in the relevant controller.
 101       </cmdsynopsis>
 102      </listitem>
 103  
 104      <listitem><command>$GLOBALS['current_controller_name']</command>
 105       <cmdsynopsis>
 106       Name of the controller as parsed from the URL.  The name is in
 107       lower case without the "_controller" suffix.
 108       Set in {@link ActionController::process_route()}.  Not set until
 109       the controller PHP file has been opened and the controller object
 110       created successfully.
 111       </cmdsynopsis>
 112      </listitem>
 113  
 114      <listitem><command>$GLOBALS['current_controller_object']</command>
 115       <cmdsynopsis>
 116       Successfully created controller object.
 117       Set in {@link ActionController::process_route()}
 118       </cmdsynopsis>
 119      </listitem>
 120  
 121      <listitem><command>$GLOBALS['current_controller_path']</command>
 122       <cmdsynopsis>
 123       Controller URL path below <command>TRAX_URL_PREFIX</command>.
 124       Set in {@link ActionController::process_route()}.  Not set until
 125       the controller PHP file has been opened and the controller object
 126       created successfully.
 127       </cmdsynopsis>
 128      </listitem>
 129  
 130      <listitem><command>$GLOBALS['DEFAULT_DATE_OPTIONS']</command>
 131       <cmdsynopsis>Referenced in {@link FormHelper}
 132       </cmdsynopsis>
 133      </listitem>
 134  
 135      <listitem><command>$GLOBALS['DEFAULT_FIELD_OPTIONS']</command>
 136       <cmdsynopsis>Referenced in {@link FormHelper}
 137       </cmdsynopsis>
 138      </listitem>
 139  
 140      <listitem><command>$GLOBALS['DEFAULT_RADIO_OPTIONS']</command>
 141       <cmdsynopsis>Referenced in {@link FormHelper}
 142       </cmdsynopsis>
 143      </listitem>
 144  
 145      <listitem><command>$GLOBALS['DEFAULT_TEXT_AREA_OPTIONS']</command>
 146       <cmdsynopsis>Referenced in {@link FormHelper}
 147       </cmdsynopsis>
 148      </listitem>
 149  
 150      <listitem><command>$GLOBALS['JAVASCRIPT_DEFAULT_SOURCES']</command>
 151       <cmdsynopsis>Referenced in {@link AssetTagHelper} constructor
 152       </cmdsynopsis>
 153      </listitem>
 154  
 155      <listitem><command>$GLOBALS['TRAX_DB_SETTINGS']</command>
 156       <cmdsynopsis>
 157       Array with keys 'test', 'development' and 'production' specifying
 158       the database connection parameters for each of the three modes of
 159       operation. 
 160       Set in file {@link environment.php config/environment.php}
 161       from values parsed from file database.ini.
 162       Used when opening a connection to the database.
 163       </cmdsynopsis>
 164      </listitem>
 165  
 166      <listitem><command>$GLOBALS['TRAX_INCLUDES']</command>
 167       <cmdsynopsis>Array with keys "models", "views", "controllers",
 168        "helpers", "layouts", "config", "environments", "lib", "app",
 169       "log" and  "vendor".  Values are the subdirectories of
 170       <command>TRAX_ROOT</command> where Trax files of the
 171       corresponding category are stored.  Used to create filesystem
 172       paths to access Trax files.
 173       Set in file {@link environment.php config/environment.php}
 174       </cmdsynopsis>
 175      </listitem>
 176  
 177     </itemizedlist>
 178    </refsect2>
 179  
 180  <!--
 181  Local variables:
 182  mode: xml
 183  c-basic-offset: 1
 184  indent-tabs-mode: nil
 185  End:
 186  -->
 187   </refsect1>