client_helpers/_helper_config.php at master · Indicia-Team/client_helpers · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
<?php

/**
 * @file
 * An optional file that provides settings for the Client Helper PHP library.
 *
 * When the Client Helper PHP library is run as a standalone library, this file
 * should be copied to create a file called helper_config.php and the values of
 * the variables declared set to provide appropriate configuration for the
 * Indicia code. Those marked as optional can be ommitted, though if ommitting
 * an API key this will disable the relevant area of functionality.
 *
 * When the Client Helper PHP library is run from inside Drupal or another
 * content managemet system, this file is not required. Instead the CMS should
 * set each variable in helper_base before using the library code.
 *
 * Indicia, the OPAL Online Recording Toolkit.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see http://www.gnu.org/licenses/gpl.html.
 *
 * @license http://www.gnu.org/licenses/gpl.html GPL 3.0
 * @link https://github.com/Indicia-Team/client_helpers
 */

class helper_config {

  /**
   * Base URL of the warehouse we are linked to.
   *
   * @var string
   */
  public static $base_url = '';

  /**
   * Base URL of the GeoServer we are linked to if GeoServer is used. Optional.
   *
   * @var string
   */
  public static $geoserver_url = '';

  /**
   * A temporary location for uploaded images. Optional.
   *
   * Images are stored here when uploaded by a recording form but before they
   * are sent to the warehouse.
   *
   * @var string
   */
  public static $interim_image_folder = '';

  /**
   * Google API key for place searches. Optional.
   *
   * @var string
   */
  public static $google_api_key = '';

  /**
   * Google Maps JavaScript API key. Optional.
   *
   * @var string
   */
  public static $google_maps_api_key = '';

  /**
   * Bing Maps API key. Optional.
   *
   * @var string
   */
  public static $bing_api_key = '';

  /**
   * Ordnance Survey Maps API key. Optional.
   *
   * @var string
   */
  public static $os_api_key = '';

  /**
   * Setting which allows the host (e.g. Drupal) handle translation. Optional.
   *
   * For example, when TRUE, a call to lang::get() is delegated to Drupal's t()
   * function.
   *
   * @var bool
   */
  public static $delegate_translation_to_hostsite = FALSE;

  /**
   * Setting which allows the host site (e.g. Drupal) handle caching.
   *
   * Defaults to true but only delegates if there are hostsite_cache_get() and
   * hostsite_cache_get() functions available.
   *
   * @var bool
   */
  public static $delegate_caching_to_hostsite = TRUE;

  /**
   * Allow the check on maximum file size for image uploads to be set.
   *
   * @var string
   */
  public static $upload_max_filesize = '4M';

}