settings/Directory.setting.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17 /*
  18  * Settings metadata file
  19  */
  20
  21 return [
  22   'uploadDir' => [
  23     'bootstrap_comment' => 'This is a boot setting which may be loaded during bootstrap. Defaults are loaded via SettingsBag::getSystemDefaults().',
  24     'group_name' => 'Directory Preferences',
  25     'group' => 'directory',
  26     'name' => 'uploadDir',
  27     'type' => 'String',
  28     'html_type' => 'text',
  29     'quick_form_type' => 'Element',
  30     'default' => NULL,
  31     'add' => '4.1',
  32     'title' => ts('Temporary Files Directory'),
  33     'is_domain' => 1,
  34     'is_contact' => 0,
  35     'help_text' => 'File system path where temporary CiviCRM files - such as import data files - are uploaded.',
  36   ],
  37   'imageUploadDir' => [
  38     'bootstrap_comment' => 'This is a boot setting which may be loaded during bootstrap. Defaults are loaded via SettingsBag::getSystemDefaults().',
  39     'group_name' => 'Directory Preferences',
  40     'group' => 'directory',
  41     'name' => 'imageUploadDir',
  42     'type' => 'String',
  43     'html_type' => 'text',
  44     'quick_form_type' => 'Element',
  45     'default' => NULL,
  46     'add' => '4.1',
  47     'title' => ts('Image Directory'),
  48     'is_domain' => 1,
  49     'is_contact' => 0,
  50     'description' => ts('File system path where image files are uploaded. Currently, this path is used for images associated with premiums (CiviContribute thank-you gifts).'),
  51     'help_text' => NULL,
  52   ],
  53   'customFileUploadDir' => [
  54     'bootstrap_comment' => 'This is a boot setting which may be loaded during bootstrap. Defaults are loaded via SettingsBag::getSystemDefaults().',
  55     'group_name' => 'Directory Preferences',
  56     'group' => 'directory',
  57     'name' => 'customFileUploadDir',
  58     'type' => 'String',
  59     'html_type' => 'text',
  60     'quick_form_type' => 'Element',
  61     'default' => NULL,
  62     'add' => '4.1',
  63     'title' => ts('Custom Files Directory'),
  64     'is_domain' => 1,
  65     'is_contact' => 0,
  66     'description' => ts('Path where documents and images which are attachments to contact records are stored (e.g. contact photos, resumes, contracts, etc.). These attachments are defined using \'file\' type custom fields.'),
  67     'help_text' => NULL,
  68   ],
  69   'customTemplateDir' => [
  70     'bootstrap_comment' => 'This is a boot setting which may be loaded during bootstrap. Defaults are loaded via SettingsBag::getSystemDefaults().',
  71     'group_name' => 'Directory Preferences',
  72     'group' => 'directory',
  73     'name' => 'customTemplateDir',
  74     'type' => 'String',
  75     'html_type' => 'text',
  76     'quick_form_type' => 'Element',
  77     'default' => NULL,
  78     'add' => '4.1',
  79     'title' => ts('Custom Template Directory'),
  80     'is_domain' => 1,
  81     'is_contact' => 0,
  82     'description' => ts('Path where site specific templates are stored if any. This directory is searched first if set. Custom JavaScript code can be added to templates by creating files named templateFile.extra.tpl. (learn more...)'),
  83     'help_text' => NULL,
  84   ],
  85   'customPHPPathDir' => [
  86     'bootstrap_comment' => 'This is a boot setting which may be loaded during bootstrap. Defaults are loaded via SettingsBag::getSystemDefaults().',
  87     'group_name' => 'Directory Preferences',
  88     'group' => 'directory',
  89     'name' => 'customPHPPathDir',
  90     'type' => 'String',
  91     'html_type' => 'text',
  92     'quick_form_type' => 'Element',
  93     'default' => NULL,
  94     'add' => '4.1',
  95     'title' => ts('Custom PHP Directory'),
  96     'is_domain' => 1,
  97     'is_contact' => 0,
  98     'description' => ts('Path where site specific PHP code files are stored if any. This directory is searched first if set.'),
  99     'help_text' => NULL,
 100   ],
 101   'extensionsDir' => [
 102     'bootstrap_comment' => 'This is a boot setting which may be loaded during bootstrap. Defaults are loaded via SettingsBag::getSystemDefaults().',
 103     'group_name' => 'Directory Preferences',
 104     'group' => 'directory',
 105     'name' => 'extensionsDir',
 106     'type' => 'String',
 107     'html_type' => 'text',
 108     'quick_form_type' => 'Element',
 109     'default' => NULL,
 110     'add' => '4.1',
 111     'title' => ts('Extensions Directory'),
 112     'is_domain' => 1,
 113     'is_contact' => 0,
 114     'description' => ts('Path where CiviCRM extensions are stored.'),
 115     'help_text' => NULL,
 116   ],
 117
 118 ];