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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
<?php
/**
* Class Civi
*
* The "Civi" class provides a facade for accessing major subsystems,
* such as the service-container and settings manager. It serves as a
* bridge which allows procedural code to access important objects.
*
* General principles:
* - Each function provides access to a major subsystem.
* - Each function performs a simple lookup.
* - Each function returns an interface.
* - Whenever possible, interfaces should be well-known (e.g. based
* on a standard or well-regarded provider).
*/
class Civi {
/**
* A central location for static variable storage.
* @var array
* @code
* `Civi::$statics[__CLASS__]['foo'] = 'bar';
* @endcode
*/
public static $statics = array();
/**
* Retrieve a named cache instance.
*
* @param string $name
* The name of the cache. The 'default' cache is biased toward
* high-performance caches (eg memcache/redis/apc) when
* available and falls back to single-request (static) caching.
* Ex: 'short' or 'default' is useful for high-speed, short-lived cache data.
* This is appropriate if you believe that latency (millisecond-level
* read time) is the main factor. For example: caching data from
* a couple SQL queries.
* Ex: 'long' can be useful for longer-lived cache data. It's appropriate if
* you believe that longevity (e.g. surviving for several hours or a day)
* is more important than millisecond-level access time. For example:
* caching the result of a simple metadata-query.
*
* @return CRM_Utils_Cache_Interface
* NOTE: Beginning in CiviCRM v5.4, the cache instance complies with
* PSR-16 (\Psr\SimpleCache\CacheInterface).
*/
public static function cache($name = 'default') {
return \Civi\Core\Container::singleton()->get('cache.' . $name);
}
/**
* Get the service container.
*
* @return \Symfony\Component\DependencyInjection\ContainerInterface
*/
public static function container() {
return Civi\Core\Container::singleton();
}
/**
* Get the event dispatcher.
*
* @return \Symfony\Component\EventDispatcher\EventDispatcherInterface
*/
public static function dispatcher() {
return Civi\Core\Container::singleton()->get('dispatcher');
}
/**
* @return \Civi\Core\Lock\LockManager
*/
public static function lockManager() {
return \Civi\Core\Container::getBootService('lockManager');
}
/**
* @return \Psr\Log\LoggerInterface
*/
public static function log() {
return Civi\Core\Container::singleton()->get('psr_log');
}
/**
* Obtain the core file/path mapper.
*
* @return \Civi\Core\Paths
*/
public static function paths() {
return \Civi\Core\Container::getBootService('paths');
}
/**
* Fetch a service from the container.
*
* @param string $id
* The service ID.
* @return mixed
*/
public static function service($id) {
return \Civi\Core\Container::singleton()->get($id);
}
/**
* Reset all ephemeral system state, e.g. statics,
* singletons, containers.
*/
public static function reset() {
self::$statics = array();
Civi\Core\Container::singleton();
}
/**
* @return CRM_Core_Resources
*/
public static function resources() {
return CRM_Core_Resources::singleton();
}
/**
* Obtain the contact's personal settings.
*
* @param NULL|int $contactID
* For the default/active user's contact, leave $domainID as NULL.
* @param NULL|int $domainID
* For the default domain, leave $domainID as NULL.
* @return \Civi\Core\SettingsBag
* @throws CRM_Core_Exception
* If there is no contact, then there's no SettingsBag, and we'll throw
* an exception.
*/
public static function contactSettings($contactID = NULL, $domainID = NULL) {
return \Civi\Core\Container::getBootService('settings_manager')->getBagByContact($domainID, $contactID);
}
/**
* Obtain the domain settings.
*
* @param int|null $domainID
* For the default domain, leave $domainID as NULL.
* @return \Civi\Core\SettingsBag
*/
public static function settings($domainID = NULL) {
return \Civi\Core\Container::getBootService('settings_manager')->getBagByDomain($domainID);
}
}
|
