PEAR
[ class tree: PEAR ] [ index: PEAR ] [ all elements ]

Source for file Config-init.php

Documentation is available at Config-init.php

  1. <?php
  2. // quick-load, small memory footprint command configuration
  3. $implements = array(
  4.         'config-show' => array(
  5.             'summary' => 'Show All Settings',
  6.             'function' => 'doConfigShow',
  7.             'shortcut' => 'csh',
  8.             'options' => array(
  9.                 'channel' => array(
  10.                     'shortopt' => 'c',
  11.                     'doc' => 'show configuration variables for another channel',
  12.                     'arg' => 'CHAN',
  13.                     ),
  14. ),
  15.             'doc' => '[layer]
  16. Displays all configuration values.  An optional argument
  17. may be used to tell which configuration layer to display.  Valid
  18. configuration layers are "user", "system" and "default". To display
  19. configurations for different channels, set the default_channel
  20. configuration variable and run config-show again.
  21. ',
  22.             ),
  23.         'config-get' => array(
  24.             'summary' => 'Show One Setting',
  25.             'function' => 'doConfigGet',
  26.             'shortcut' => 'cg',
  27.             'options' => array(
  28.                 'channel' => array(
  29.                     'shortopt' => 'c',
  30.                     'doc' => 'show configuration variables for another channel',
  31.                     'arg' => 'CHAN',
  32.                     ),
  33. ),
  34.             'doc' => '<parameter> [layer]
  35. Displays the value of one configuration parameter.  The
  36. first argument is the name of the parameter, an optional second argument
  37. may be used to tell which configuration layer to look in.  Valid configuration
  38. layers are "user", "system" and "default".  If no layer is specified, a value
  39. will be picked from the first layer that defines the parameter, in the order
  40. just specified.  The configuration value will be retrieved for the channel
  41. specified by the default_channel configuration variable.
  42. ',
  43.             ),
  44.         'config-set' => array(
  45.             'summary' => 'Change Setting',
  46.             'function' => 'doConfigSet',
  47.             'shortcut' => 'cs',
  48.             'options' => array(
  49.                 'channel' => array(
  50.                     'shortopt' => 'c',
  51.                     'doc' => 'show configuration variables for another channel',
  52.                     'arg' => 'CHAN',
  53.                     ),
  54. ),
  55.             'doc' => '<parameter> <value> [layer]
  56. Sets the value of one configuration parameter.  The first argument is
  57. the name of the parameter, the second argument is the new value.  Some
  58. parameters are subject to validation, and the command will fail with
  59. an error message if the new value does not make sense.  An optional
  60. third argument may be used to specify in which layer to set the
  61. configuration parameter.  The default layer is "user".  The
  62. configuration value will be set for the current channel, which
  63. is controlled by the default_channel configuration variable.
  64. ',
  65.             ),
  66.         'config-help' => array(
  67.             'summary' => 'Show Information About Setting',
  68.             'function' => 'doConfigHelp',
  69.             'shortcut' => 'ch',
  70.             'options' => array(),
  71.             'doc' => '[parameter]
  72. Displays help for a configuration parameter.  Without arguments it
  73. displays help for all configuration parameters.
  74. ',
  75.            ),
  76.         'config-create' => array(
  77.             'summary' => 'Create a Default configuration file',
  78.             'function' => 'doConfigCreate',
  79.             'shortcut' => 'coc',
  80.             'options' => array(
  81.                 'windows' => array(
  82.                     'shortopt' => 'w',
  83.                     'doc' => 'create a config file for a windows install',
  84.                     ),
  85.             ),
  86.             'doc' => '<root path> <filename>
  87. Create a default configuration file with all directory configuration
  88. variables set to subdirectories of <root path>, and save it as <filename>.
  89. This is useful especially for creating a configuration file for a remote
  90. PEAR installation (using the --remoteconfig option of install, upgrade,
  91. and uninstall).
  92. ',
  93.             ),
  94.         );
  95. ?>

Documentation generated on Mon, 11 Mar 2019 14:15:31 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.